Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

multiRouter.driving.SegmentModel

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

Расширяет IEventEmitter.

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

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

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

Поля

ИмяТипОписание
events IEventManager

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

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

geometry geometry.base.LineString

Геометрия сегмента.

path multiRouter.driving.PathModel

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

properties data.Manager

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

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

События

ИмяОписание
update

Обновление модели новыми данными. Экземпляр класса Event.

Методы

ИмяВозвращаетОписание
destroy()

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

getType()

String

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

getViaPoints()

multiRouter.ViaPointModel[]

Возвращает массив транзитных точек сегмента.

update(segmentJson)

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

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

geometry

Геометрия сегмента.

path

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

properties

{data.Manager} properties

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

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

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

update

Обновление модели новыми данными. Экземпляр класса Event.

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

destroy

{} destroy()

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

getType

{String} getType()

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

getViaPoints

{multiRouter.ViaPointModel[]} getViaPoints()

Возвращает массив транзитных точек сегмента.

update

{} update(segmentJson)

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

Параметры:

ПараметрЗначение по умолчаниюОписание
segmentJson *
[no-highlight[

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

]no-highlight]

Тип: Object

JSON-данные.

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