router.Editor

Редактор маршрутов.

Конструктор | События | Методы

Конструктор

router.Editor(route[, options])

Параметры:

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

Тип: router.Route

Маршрут, к которому должен быть привязан редактор.

options

Тип: Object

Опции.

options.addViaPoints true

Тип: Boolean

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

options.addWayPoints false

Тип: Boolean

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

options.editViaPoints true

Тип: Boolean

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

options.editWayPoints true

Тип: Boolean

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

options.removeViaPoints true

Тип: Boolean

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

options.removeWayPoints false

Тип: Boolean

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

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

События

Имя Описание
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()

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

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

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

Опции редактора.

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

Пример:

ymaps.route(['Москва, метро Смоленская', 'Москва, метро Арбатская'], {
    mapStateAutoApply: true
}).then(function (route) {
    myMap.geoObjects.add(route);
    // Включаем редактор.
    route.editor.start({
        addWayPoints: true
    });
});

stop

{} stop()

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

Пример:

route.editor.stop();