multiRouter.ViaPointModel
Примечание
Конструктор класса multiRouter.ViaPointModel скрыт, так как данный класс не предназначен для самостоятельной инициализации.
Расширяет IEventEmitter.
Модель данных транзитной точки мультимаршрута. Транзитные точки не подразумевают остановку. Таким образом, при прохождении через транзитную точку, сегмент пути маршрута не прерывается.
Создает модель данных транзитной точки мультимаршрута.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Геометрия транзитной точки мультимаршрута. |
||
Ссылка на родительскую модель маршрута. |
||
Данные транзитной точки мультимаршрута. Доступны следующие поля:
|
События
Имя |
Описание |
Изменена опорная точка. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
|
Обновление модели новыми данными. Экземпляр класса Event. |
Методы
Имя |
Возвращает |
Описание |
destroy() |
Уничтожает модель. |
|
Object |
Возвращает соответствующую опорную точку. |
|
Integer |
Возвращает индекс соответствующей опорной точки во множестве опорных точек родительского мультимаршрута. |
|
Задает описание соответствующей опорной точки. Опорная точка может быть задана одним из следующих способов:
|
||
Обновляет модель новыми данными. |
Описание полей
geometry
{geometry.base.Point} geometry
Геометрия транзитной точки мультимаршрута.
multiRoute
{multiRouter.MultiRouteModel} 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, описывающая опорную точку.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Описание опорной точки. |
* Обязательный параметр/опция.
update
{} update(viaPointJson)
Обновляет модель новыми данными.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object JSON-данные. |
* Обязательный параметр/опция.
Обязательный параметр.