multiRouter.driving.PathModel

Примечание

Конструктор класса multiRouter.driving.PathModel скрыт, так как данный класс не предназначен для самостоятельной инициализации.

Расширяет IEventEmitter.

Модель данных пути автомобильного маршрута. Единичный маршрут может содержать несколько путей, каждый путь соединяет две путевые точки.

Поля | События | Методы

Создает модель данных пути автомобильного маршрута.

Поля

Имя

Тип

Описание

events

IEventManager

Менеджер событий.

Унаследовано от IEventEmitter.

properties

data.Manager

Модель данных пути мультимаршрута. Доступны следующие поля:

  • index: Integer - порядковый номер пути в соответствующем маршруте мультимаршрута;
  • type: String - идентификатор типа маршрута, принимающий значение "driving" для автомобильных маршрутов;
  • distance: Object - объект с полями text и value, описывающий протяженность пути в метрах;
  • duration: Object - объект с полями text и value, описывающий время движения по пути в секундах;
  • durationInTraffic: Object - объект с полями text и value, описывающий время проезда пути в секундах с учетом пробок;
  • coordinates: Number[][] - координаты всех точек пути;
  • encodedCoordinates: String - строка закодированных в base64 координат всех точек пути.

route

multiRouter.driving.RouteModel

Ссылка на родительскую модель маршрута.

События

Имя

Описание

update

Обновление модели новыми данными. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • segmentsChange: Boolean – признак изменений в наборе сегментов.

Методы

Имя

Возвращает

Описание

destroy()

Уничтожает модель.

getSegments()

multiRouter.driving.SegmentModel[]

Возвращает массив сегментов пути.

getType()

String

Возвращает идентификатор типа пути маршрута. Для автомобильных маршрутов возвращается строка "driving".

update(pathJson)

Обновляет состояние модели.

Описание полей

properties

{data.Manager} properties

Модель данных пути мультимаршрута. Доступны следующие поля:

  • index: Integer - порядковый номер пути в соответствующем маршруте мультимаршрута;
  • type: String - идентификатор типа маршрута, принимающий значение "driving" для автомобильных маршрутов;
  • distance: Object - объект с полями text и value, описывающий протяженность пути в метрах;
  • duration: Object - объект с полями text и value, описывающий время движения по пути в секундах;
  • durationInTraffic: Object - объект с полями text и value, описывающий время проезда пути в секундах с учетом пробок;
  • coordinates: Number[][] - координаты всех точек пути;
  • encodedCoordinates: String - строка закодированных в base64 координат всех точек пути.

route

{multiRouter.driving.RouteModel} route

Ссылка на родительскую модель маршрута.

Описание событий

update

Обновление модели новыми данными. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

  • segmentsChange: Boolean – признак изменений в наборе сегментов.

Описание методов

destroy

{} destroy()

Уничтожает модель.

getSegments

{multiRouter.driving.SegmentModel[]} getSegments()

Возвращает массив сегментов пути.

getType

{String} getType()

Возвращает идентификатор типа пути маршрута. Для автомобильных маршрутов возвращается строка "driving".

update

{} update(pathJson)

Обновляет состояние модели.

Параметры:

Параметр

Значение по умолчанию

Описание

pathJson*

Тип: Object

JSON-данные.

* Обязательный параметр/опция.

Предыдущая
Следующая