---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.2
alternate:
  - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Editor.md
  - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Editor.md
  - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Editor.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234

# router.Editor

{% note info %}

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

{% endnote %}

Расширяет [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md).

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

[Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
||  [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). ||
|| [state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Editor.md#state) | [IDataManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Менеджер состояния редактора маршрута.

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

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

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

#|
|| **Имя** | **Описание** ||
|| [optionschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

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

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

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

## Описание полей {#field_detail}

### state   {#state}

```javascript
{IDataManager} state
```

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

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

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

## Описание событий {#event_detail}

### routeupdate {#routeupdate}

Обновление маршрута. Через значение флага e.get('rough') можно определить событие бросилось после завершения редактирования или во время. Если вы хотите в своем приложении обновлять информацию, связанную с маршрутом, то нужно делать проверку e.get('rough') == false, чтобы избежать частой обработки этого события.

### start {#start}

Включение редактора.

### stop {#stop}

Выключение редактора.

### viapointadd {#viapointadd}

Добавление транзитной точки. Добавляемую транзитную точку можно получить через e.get('viaPoint')

### viapointdragend {#viapointdragend}

Завершение перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint')

### viapointdragstart {#viapointdragstart}

Начало перетаскивания транзитной точки. Путевую точку можно получить через e.get('viaPoint')

### viapointremove {#viapointremove}

Удаление транзитной точки. Удаляемую транзитную точку можно получить через e.get('viaPoint')

### waypointadd {#waypointadd}

Добавление путевой точки. Добавляемую путевую точку можно получить через e.get('wayPoint')

### waypointdragend {#waypointdragend}

Завершение перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint')

### waypointdragstart {#waypointdragstart}

Начало перетаскивания путевой точки. Путевую точку можно получить через e.get('wayPoint')

### waypointremove {#waypointremove}

Удаление путевой точки. Удаляемую путевую точку можно получить через e.get('wayPoint')

## Описание методов {#method_detail}

### start {#start}

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

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

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

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

Опции. ||
|| [`options.addViaPoints`](#start-param-options.addViaPoints) | true | Тип: Boolean

true - добавление транзитных точек разрешено, false - запрещено. ||
|| [`options.addWayPoints`](#start-param-options.addWayPoints) | false | Тип: Boolean

true - добавление путевых точек при клике на карте разрешено, false - запрещено. ||
|| [`options.editViaPoints`](#start-param-options.editViaPoints) | true | Тип: Boolean

true - редактирование (перемещение) транзитных точек разрешено, false - запрещено. ||
|| [`options.editWayPoints`](#start-param-options.editWayPoints) | true | Тип: Boolean

true - редактирование (перемещение) путевых точек разрешено, false - запрещено. ||
|| [`options.removeViaPoints`](#start-param-options.removeViaPoints) | true | Тип: Boolean

true - удаление транзитных точек двойным кликом разрешено, false - запрещено. ||
|| [`options.removeWayPoints`](#start-param-options.removeWayPoints) | false | Тип: Boolean

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


### stop {#stop}

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

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

<!-- XLIFF_FARM_YWQ3ODdi_CACHING -->