multiRouter.driving.RouteModel

Примечание

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

Расширяет IEventEmitter.

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

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

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

Поля

Имя

Тип

Описание

events

IEventManager

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

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

multiRoute

multiRouter.MultiRouteModel

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

properties

data.Manager

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

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

События

Имя

Описание

update

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

  • pathsChange: Boolean - признак изменений в наборе путей.

Методы

Имя

Возвращает

Описание

destroy()

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

getPaths()

multiRouter.driving.PathModel[]

Возвращает массив путей маршрута.

getType()

String

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

update(routeJson)

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

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

multiRoute

{multiRouter.MultiRouteModel} multiRoute

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

properties

{data.Manager} properties

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

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

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

update

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

  • pathsChange: Boolean - признак изменений в наборе путей.

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

destroy

{} destroy()

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

getPaths

{multiRouter.driving.PathModel[]} getPaths()

Возвращает массив путей маршрута.

getType

{String} getType()

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

update

{} update(routeJson)

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

Параметры:

Параметр

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

Описание

routeJson*

Тип: Object

JSON-данные.

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

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