router.Editor
Примечание
Конструктор класса router.Editor скрыт, так как данный класс не предназначен для самостоятельной инициализации.
Расширяет ICustomizable, IEventEmitter.
Редактор маршрутов. Конструктор недоступен в package.full (стандартный набор модулей). Данный модуль загружается по требованию.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
||
Менеджер состояния редактора маршрута. Поля данных, доступные посредством методов get и set:
|
События
Имя |
Описание |
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Обновление маршрута. Через значение флага e.get('rough') можно определить событие бросилось после завершения редактирования или во время. Если вы хотите в своем приложении обновлять информацию, связанную с маршрутом, то нужно делать проверку e.get('rough') == false, чтобы избежать частой обработки этого события. |
|
Включение редактора. |
|
Выключение редактора. |
|
Добавление транзитной точки. Добавляемую транзитную точку можно получить через e.get('viaPoint') |
|
Завершение перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint') |
|
Начало перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint') |
|
Удаление транзитной точки. Удаляемую транзитную точку можно получить через e.get('viaPoint') |
|
Добавление путевой точки. Добавляемую путевую точку можно получить через e.get('wayPoint') |
|
Завершение перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint') |
|
Начало перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint') |
|
Удаление путевой точки. Удаляемую путевую точку можно получить через e.get('wayPoint') |
Методы
Имя |
Возвращает |
Описание |
Включает редактор маршрута. |
||
stop() |
Выключает редактор маршрута. |
Описание полей
state
{IDataManager} state
Менеджер состояния редактора маршрута.
Поля данных, доступные посредством методов get и set:
- routeloading: Boolean - признак того, что в данный момент идет загрузка данных из сервиса маршрутизации.
- waypointsdrag: Boolean - признак того, что в данный момент происходит перетаскивание путевой точки.
- viapointsdrag: Boolean - признак того, что в данный момент происходит перетаскивание транзитной точки.
Описание событий
routeupdate
Обновление маршрута. Через значение флага e.get('rough') можно определить событие бросилось после завершения редактирования или во время. Если вы хотите в своем приложении обновлять информацию, связанную с маршрутом, то нужно делать проверку e.get('rough') == false, чтобы избежать частой обработки этого события.
start
Включение редактора.
stop
Выключение редактора.
viapointadd
Добавление транзитной точки. Добавляемую транзитную точку можно получить через e.get('viaPoint')
viapointdragend
Завершение перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint')
viapointdragstart
Начало перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint')
viapointremove
Удаление транзитной точки. Удаляемую транзитную точку можно получить через e.get('viaPoint')
waypointadd
Добавление путевой точки. Добавляемую путевую точку можно получить через e.get('wayPoint')
waypointdragend
Завершение перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint')
waypointdragstart
Начало перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint')
waypointremove
Удаление путевой точки. Удаляемую путевую точку можно получить через e.get('wayPoint')
Описание методов
start
{} start([options])
Включает редактор маршрута.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Опции. |
|
true |
Тип: Boolean true - добавление транзитных точек разрешено, false - запрещено. |
|
false |
Тип: Boolean true - добавление путевых точек при клике на карте разрешено, false - запрещено. |
|
true |
Тип: Boolean true - редактирование (перемещение) транзитных точек разрешено, false - запрещено. |
|
true |
Тип: Boolean true - редактирование (перемещение) путевых точек разрешено, false - запрещено. |
|
true |
Тип: Boolean true - удаление транзитных точек двойным кликом разрешено, false - запрещено. |
|
false |
Тип: Boolean true - удаление путевых точек двойным кликом разрешено, false - запрещено. |
stop
{} stop()
Выключает редактор маршрута.