multiRouter.WayPointModel

Примечание

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

Расширяет IEventEmitter.

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

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

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

Поля

Имя

Тип

Описание

events

IEventManager

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

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

geometry

geometry.base.Point

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

multiRoute

multiRouter.MultiRouteModel

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

properties

data.Manager

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

  • index: Integer – порядковый номер точки;
  • request: String - строка с координатами или адресом, которой задается опорная точка. См. IMultiRouteReferencePoint.
  • address: String - почтовый адрес точки;
  • description: String - описание точки;
  • name: String - название точки;
  • geocoderMetaData: Object-метаданные Геокодера.

События

Имя

Описание

referencepointchange

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

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

update

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

Методы

Имя

Возвращает

Описание

destroy()

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

getReferencePoint()

Object

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

getReferencePointIndex()

Integer

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

setReferencePoint(referencePoint)

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

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

update(wayPointJson)

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

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

geometry

{geometry.base.Point} geometry

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

multiRoute

{multiRouter.MultiRouteModel} multiRoute

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

properties

{data.Manager} properties

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

  • index: Integer – порядковый номер точки;
  • request: String - строка с координатами или адресом, которой задается опорная точка. См. IMultiRouteReferencePoint.
  • address: String - почтовый адрес точки;
  • description: String - описание точки;
  • name: String - название точки;
  • geocoderMetaData: Object-метаданные Геокодера.

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

referencepointchange

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

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

update

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

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

destroy

{} destroy()

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

getReferencePoint

{Object} getReferencePoint()

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

getReferencePointIndex

{Integer} getReferencePointIndex()

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

setReferencePoint

{} setReferencePoint(referencePoint)

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

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

Параметры:

Параметр

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

Описание

referencePoint*

Тип: Object

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

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

update

{} update(wayPointJson)

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

Параметры:

Параметр

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

Описание

wayPointJson*

Тип: Object

JSON-данные.

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

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