router.Editor

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

Расширяет ICustomizable, IEventEmitter.

Редактор маршрутов. Конструктор недоступен в package.full (стандартный набор модулей). Данный модуль загружается по требованию.

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

Поля

ИмяТипОписание
eventsIEventManager

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

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

optionsIOptionManager

Менеджер опций.

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

stateIDataManager

Менеджер состояния редактора маршрута.

Поля данных, доступные посредством методов get и set:

  • routeloading: Boolean - признак того, что в данный момент идет загрузка данных из сервиса маршрутизации.
  • waypointsdrag: Boolean - признак того, что в данный момент происходит перетаскивание путевой точки.
  • viapointsdrag: Boolean - признак того, что в данный момент происходит перетаскивание транзитной точки.

События

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

Изменение в опциях объекта.

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

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([options])

Включает редактор маршрута.

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])

Включает редактор маршрута.

Параметры:

ПараметрЗначение по умолчаниюОписание
options

Тип: Object

Опции.

options.addViaPointstrue

Тип: Boolean

true - добавление транзитных точек разрешено, false - запрещено.

options.addWayPointsfalse

Тип: Boolean

true - добавление путевых точек при клике на карте разрешено, false - запрещено.

options.editViaPointstrue

Тип: Boolean

true - редактирование (перемещение) транзитных точек разрешено, false - запрещено.

options.editWayPointstrue

Тип: Boolean

true - редактирование (перемещение) путевых точек разрешено, false - запрещено.

options.removeViaPointstrue

Тип: Boolean

true - удаление транзитных точек двойным кликом разрешено, false - запрещено.

options.removeWayPointsfalse

Тип: Boolean

true - удаление путевых точек двойным кликом разрешено, false - запрещено.

stop

{} stop()

Выключает редактор маршрута.