---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.RouteEditor.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# control.RouteEditor

Расширяет Button.

Элемент управления "Редактор маршрутов".

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

```javascript
control.RouteEditor([params[, options]])
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `params` | — | Тип: Object

Параметры кнопки. ||
|| `options` | — | Тип: Object

Опции элемента управления. ||
|| `options.position` | \{ top: 5, left: 98 \} | Тип: Object

Положение элемента управления над картой. Задается в виде объекта со следующими полями: 
• top - отступ от верхнего края контейнера карты в пикселах;

• right - отступ от правого края контейнера карты в пикселах;

• bottom - отступ от нижнего края контейнера карты в пикселах;

• left - отступ от левого края контейнера карты в пикселах.

Если при этом заданы одновременно и top, и bottom, то значение bottom игнорируется. Аналогично, если заданы одновременно и left, и right, то значение right игнорируется. Если элемент управления добавляется в группу элементов (например, в тулбар или раскрывающийся список), то значение position не применяется. ||
|| `options.visible` | true | Тип: Boolean

Признак того, что элемент управления отображается. ||
|#

**Пример:**

```javascript
// добавляем контрол на карту
map.controls.add('routeEditor');

// можно добавить контрол через тулбар
map.controls.add(new ymaps.control.ToolBar([
    new ymaps.control.RouteEditor()
]));
```
## Методы {#method}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getRoute](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.RouteEditor.md#getRoute)() | [router.Route](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md) | Returns маршрут. ||
|#

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

### getRoute

```javascript
{router.Route} getRoute()
```

**Returns** маршрут.