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

# IRoutePanel

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

Интерфейс панели маршрута.

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

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

```javascript
IRoutePanel()
```

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

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

Унаследовано от [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#options) | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Названия опций:
- allowSwitch: Boolean = true – показать на панели кнопку, позволяющую менять местами начальную и конечную точки маршрута;
- reverseGeocoding: Boolean = true – включить ли обратное геокодирование при построение маршрута;
- adjustMapMargin: Boolean = false – будет ли панель маршрута регистрировать свои размеры в [map.margin.Manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md).
- types: Object = { auto: true, masstransit: true, pedestrian: true, bicycle: true, taxi: false } – типы маршрутизации, которые будут доступны для выбора пользователю. При изменении опции возможных типов маршрута, текущий выбранный тип автоматически меняется. Например, если был выбран пешеходный маршрут, а после этого вебмастер разрешил только автомобильные и на общественном транспорте, то автоматически выберется автомобильный. Доступные типы маршрутизации отображаются в панели только в том случае, если задано два или более типа. Обратите внимание если вы используете политику безопасности контента: для использования типа "такси" нужно обновить правила CSP на [новейшую версию](https://tech.yandex.com/maps/doc/jsapi/2.1/dg/concepts/load-docpage/#load__using-csp). ||
|| [state](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#state) | [IDataManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Менеджер состояний. Названия состояний:
- type: String – тип маршрутизации [IMultiRouteParams.routingMode](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IMultiRouteParams.md#routingMode);
- fromEnabled: Boolean – включить возможность задавать пункт отправления в поле ввода;
- from: String – адрес или координаты пункта отправления;
- toEnabled: Boolean – включить возможность задавать пункт назначения в поле ввода;
- to: String – адрес или координаты пункта назначения. ||
|#

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

#|
|| **Имя** | **Описание** ||
|| [disable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#event-disable) | Зависимости панели не загружены. ||
|| [enable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#event-enable) | Панель маршрутизации и ее зависимости загружены и готовы к использованию. ||
|#


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [enable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#enable)() | | Загружает все зависимости панели. ||
|| [geolocate](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#geolocate)([name](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#geolocate-param-name)) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задать местоположение пользователя в качестве начальной или конечной точки маршрута. ||
|| [getRoute](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#getRoute)() | [multiRouter.MultiRoute](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md) | 
{% note warning %}

Данный метод является устаревшим. См. [IRoutePanel.getRouteAsync](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#getRouteAsync).

{% endnote %}


Возвращает построенный маршрут. ||
|| [getRouteAsync](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#getRouteAsync)() | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md).<[multiRouter.MultiRoute](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md)> | Возвращает [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md), который будет разрешен построенным маршрутом. Promise отклоняется при возникновении ошибки. ||
|| [isEnable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#isEnable)() | Boolean | Возвращает true, если панель полностью загружена, false – иначе. ||
|| [switchPoints](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#switchPoints)() | | Меняет местами начальную и конечную точки маршрута. Изменения автоматически отобразятся в полях ввода на панели маршрута. ||
|#

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

### options {#options}

```javascript
{IOptionManager} options
```

Менеджер опций. Названия опций:
- allowSwitch: Boolean = true – показать на панели кнопку, позволяющую менять местами начальную и конечную точки маршрута;
- reverseGeocoding: Boolean = true – включить ли обратное геокодирование при построение маршрута;
- adjustMapMargin: Boolean = false – будет ли панель маршрута регистрировать свои размеры в [map.margin.Manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md).
- types: Object = { auto: true, masstransit: true, pedestrian: true, bicycle: true, taxi: false } – типы маршрутизации, которые будут доступны для выбора пользователю. При изменении опции возможных типов маршрута, текущий выбранный тип автоматически меняется. Например, если был выбран пешеходный маршрут, а после этого вебмастер разрешил только автомобильные и на общественном транспорте, то автоматически выберется автомобильный. Доступные типы маршрутизации отображаются в панели только в том случае, если задано два или более типа. Обратите внимание если вы используете политику безопасности контента: для использования типа "такси" нужно обновить правила CSP на [новейшую версию](https://tech.yandex.com/maps/doc/jsapi/2.1/dg/concepts/load-docpage/#load__using-csp).

### state {#state}

```javascript
{IDataManager} state
```

Менеджер состояний. Названия состояний:
- type: String – тип маршрутизации [IMultiRouteParams.routingMode](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IMultiRouteParams.md#routingMode);
- fromEnabled: Boolean – включить возможность задавать пункт отправления в поле ввода;
- from: String – адрес или координаты пункта отправления;
- toEnabled: Boolean – включить возможность задавать пункт назначения в поле ввода;
- to: String – адрес или координаты пункта назначения.

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

### disable {#disable}

Зависимости панели не загружены.

### enable {#enable}

Панель маршрутизации и ее зависимости загружены и готовы к использованию.

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

### enable {#enable}

```javascript
{} enable()
```

Загружает все зависимости панели.

### geolocate {#geolocate}

```javascript
{vow.Promise} geolocate(name)
```

Задать местоположение пользователя в качестве начальной или конечной точки маршрута.

**Возвращает** объект-promise. см. [geolocation](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/geolocation.md).

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

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

В качестве какой точки маршрута (начальной или конечной) нужно использовать местоположение пользователя. Принимает значение 'from' или 'to'. ||
|#

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

### getRoute {#getRoute}

```javascript
{multiRouter.MultiRoute} getRoute()
```

**Данный метод является устаревшим. **See [IRoutePanel.getRouteAsync](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IRoutePanel.md#getRouteAsync).

**Возвращает** построенный маршрут.

### getRouteAsync {#getRouteAsync}

```javascript
{vow.Promise.<multiRouter.MultiRoute>} getRouteAsync()
```

Возвращает [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md), который:

- будет **разрешен** построенным маршрутом (объектом [multiRouter.MultiRoute](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md)),
- либо **отклонен** с ошибкой.

### isEnable {#isEnable}

```javascript
{Boolean} isEnable()
```

**Возвращает** true, если панель полностью загружена, false – иначе.

### switchPoints {#switchPoints}

```javascript
{} switchPoints()
```

Меняет местами начальную и конечную точки маршрута. Изменения автоматически отобразятся в полях ввода на панели маршрута.

<!-- XLIFF_FARM_OTlkNjg1_CACHING -->

[*star]: Обязательный параметр.