---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/control.RoutePanel.md
  - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.RoutePanel.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt

# control.RoutePanel

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

Панель маршрутизации. Ключ в хранилище [control.storage](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.storage.md) – 'routePanelControl'.

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

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

```javascript
control.RoutePanel([parameters])
```

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

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

Параметры элемента управления. ||
|| [`parameters.options`](#param-parameters.options) | — | Тип: Object

Опции элемента управления. Для задания основных опций [IRoutePanel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md) используйте префикс 'routePanel'. Обратите внимание, параметр routePanelAdjustMapMargin по умолчанию принимает значение true. ||
|| [`parameters.options.autofocus`](#param-parameters.options.autofocus) | true | Тип: Boolean

Должна ли панель автоматически получать фокус после ее добавления на карту. ||
|| [`parameters.options.float`](#param-parameters.options.float) | "left" | Тип: String

Сторона, по которой нужно выравнивать элемент управления. Может принимать три значения: "left", "right" или "none". При значении "left" или "right" элементы управления выстраиваются друг за другом, начиная от левого или правого края карты соответственно. При значении "none" элементы управления позиционируется только по значениям опций left, right, bottom, top относительно границ карты. Также смотрите описание опции position. ||
|| [`parameters.options.floatIndex`](#param-parameters.options.floatIndex) | 0 | Тип: Number

Приоритет расположения элемента управления. Элемент с максимальным приоритетом находится ближе к указанному в свойстве float краю карты. Не работает при float = "none". ||
|| [`parameters.options.maxWidth`](#param-parameters.options.maxWidth) | '210px' | Тип: String

CSS-ширина всплывающего окна. Может задаваться как в пикселях, так и в процентах. Обратите внимание, что если указывать в процентах, ширина будет определяться относительно размеров кнопки, а не карты. Минимальное значение 176px, максимальное – 400px. ||
|| [`parameters.options.position`](#param-parameters.options.position) | — | Тип: Object

Объект, описывающий позицию элемента управления. ||
|| [`parameters.options.position.bottom`](#param-parameters.options.position.bottom) | — | Тип: Number\|String

Положение относительно нижнего края карты. ||
|| [`parameters.options.position.left`](#param-parameters.options.position.left) | — | Тип: Number\|String

Положение относительно левого края карты. ||
|| [`parameters.options.position.right`](#param-parameters.options.position.right) | — | Тип: Number\|String

Положение относительно правого края карты. ||
|| [`parameters.options.position.top`](#param-parameters.options.position.top) | — | Тип: Number\|String

Положение относительно верхнего края карты. ||
|| [`parameters.options.showHeader`](#param-parameters.options.showHeader) | false | Тип: Boolean

Показывать ли заголовок панели. ||
|| [`parameters.options.title`](#param-parameters.options.title) | 'Routes' | Тип: String

Заголовок панели. Отображается только в том случае, если опция 'showHeader' выставлена в true. ||
|| [`parameters.options.visible`](#param-parameters.options.visible) | true | Тип: Boolean

Признак того, что элемент управления отображается. ||
|| [`parameters.state`](#param-parameters.state) | — | Тип: Object

Объект, описывающий состояние элемента управления. ||
|#


**Примеры:** 

**1.**

```javascript
// Пример 1.
// Добавим на карту панель маршрутизации.
myMap.controls.add('routePanelControl')
```

**2.**

```javascript
// Пример 2
// Создадим панель маршрутизации шириной в 300 пикселей.
// В качестве заголовка панели установим начальную точку.  
myMap.controls.add('routePanelControl', {
    maxWidth: 300,
});
var routePanel = myMap.controls.get('routePanelControl').routePanel;
routePanel.options.set('adjustMapMargin', true);
routePanel.state.set({
    fromEnabled: false,
    from: "Москва",
    to: "Санкт-Петербург",
    type: "auto"
});
```

## Поля {#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/IControl.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

Унаследовано от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#options). ||
|| [routePanel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/control.RoutePanel.md#routePanel) | [IRoutePanel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md) | Панель маршрутизации. ||
|#

## События {#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). ||
|| [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

- oldParent - старый родитель;
- newParent - новый родитель.

Унаследовано от [IChild](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). ||
|#

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent)() | [IControlParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControlParent.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#getParent). ||
|| [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от [IControl](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IControl.md#setParent). ||
|#

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

### routePanel {#routePanel}

```javascript
{IRoutePanel} routePanel
```

Панель маршрутизации.

<!-- XLIFF_FARM_OWUzYTMy_CACHING -->