---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md
---
# router.Editor

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

## Конструктор {#constructor}

```javascript
router.Editor(route[, options])
```

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `route`[*](*parametr) | — | Тип: [router.Route](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md)

Маршрут, к которому должен быть привязан редактор. ||
|| `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 - запрещено. ||
|#

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

## События {#events}

#|
|| **Имя** | **Описание** ||
|| [routeupdate](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#routeupdate) | Обновление маршрута. Через значение флага e.get('rough') можно определить событие бросилось после завершения редактирования или во время. Если вы хотите в своем приложении обновлять информацию, связанную с маршрутом, то нужно делать проверку e.get('rough') == false, чтобы избежать частой обработки этого события. ||
|| [start](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#start) | Включение редактора. ||
|| [stop](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#stop) | Выключение редактора. ||
|| [viapointadd](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#viapointadd) | Добавление транзитной точки. Добавляемую транзитную точку можно получить через e.get('viaPoint') ||
|| [viapointdragend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#viapointdragend) | Завершение перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint') ||
|| [viapointdragstart](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#viapointdragstart) | Начало перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint') ||
|| [viapointremove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#viapointremove) | Удаление транзитной точки. Удаляемую транзитную точку можно получить через e.get('viaPoint') ||
|| [waypointadd](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#waypointadd) | Добавление путевой точки. Добавляемую путевую точку можно получить через e.get('wayPoint') ||
|| [waypointdragend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#waypointdragend) | Завершение перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint') ||
|| [waypointdragstart](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#waypointdragstart) | Начало перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint') ||
|| [waypointremove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#waypointremove) | Удаление путевой точки. Удаляемую путевую точку можно получить через e.get('wayPoint') ||
|#

## Методы {#methods}

#|
|| **Имя** | **Описание** ||
|| [start](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#start)([options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#start-param-options)) | Включает редактор маршрута. ||
|| [stop](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md#stop)() | Выключает редактор маршрута. ||
|#

## Описание событий {#description-events}

### 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')

## Описание методов {#description-methods}

### start

```javascript
{} start(options)
```

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

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `options`[*](*parametr) | — | Тип: Object

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


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

**Пример:**

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

### stop

```javascript
{} stop()
```

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

**Пример:**

```javascript
route.editor.stop();
```

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