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

multiRouter.ViaPointModel

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

Расширяет IEventEmitter.

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

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

Создает модель данных транзитной точки мультимаршрута.

Поля

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

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

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

geometry geometry.base.Point

Геометрия транзитной точки мультимаршрута.

multiRoute multiRouter.MultiRouteModel

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

properties data.Manager

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

  • index: Integer – порядковый номер точки;
  • lodIndex: Integer - порядковый номер транзитной точки во множестве всех координат соответствующего ей пути маршрута.

События

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

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

  • oldReferencePoint: Object - описание предыдущей опорной точки.

update

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

Методы

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

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

getReferencePoint()

Object

Возвращает соответствующую опорную точку.

getReferencePointIndex()

Integer

Возвращает индекс соответствующей опорной точки во множестве опорных точек родительского мультимаршрута.

setReferencePoint(referencePoint)

Задает описание соответствующей опорной точки. Опорная точка может быть задана одним из следующих способов:

  • строка, содержащая почтовый адрес опорной точки;
  • массив, содержащий широту и долготу опорной точки;
  • геометрия geometry.Point, описывающая опорную точку.

update(viaPointJson)

Обновляет модель новыми данными.

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

geometry

Геометрия транзитной точки мультимаршрута.

multiRoute

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

properties

{data.Manager} properties

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

  • index: Integer – порядковый номер точки;
  • lodIndex: Integer - порядковый номер транзитной точки во множестве всех координат соответствующего ей пути маршрута.

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

referencepointchange

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

  • oldReferencePoint: Object - описание предыдущей опорной точки.

update

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

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

destroy

{} destroy()

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

getReferencePoint

{Object} getReferencePoint()

Возвращает соответствующую опорную точку.

getReferencePointIndex

{Integer} getReferencePointIndex()

Возвращает индекс соответствующей опорной точки во множестве опорных точек родительского мультимаршрута.

setReferencePoint

{} setReferencePoint(referencePoint)

Задает описание соответствующей опорной точки. Опорная точка может быть задана одним из следующих способов:

  • строка, содержащая почтовый адрес опорной точки;
  • массив, содержащий широту и долготу опорной точки;
  • геометрия geometry.Point, описывающая опорную точку.

Параметры:

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

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

]no-highlight]

Тип: Object

Описание опорной точки.

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

update

{} update(viaPointJson)

Обновляет модель новыми данными.

Параметры:

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

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

]no-highlight]

Тип: Object

JSON-данные.

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