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

# multiRouter.MultiRoute

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

Мультимаршрут на карте. Позволяет отображать на карте маршрут и несколько альтернатив к нему. Предоставляет интерфейс выбора активного маршрута.

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

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

```javascript
multiRouter.MultiRoute(model[, options])
```

Создает мультимаршрут на карте.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`model`](#param-model)[*](*star) | — | Тип: [multiRouter.MultiRouteModel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRouteModel.md)\|[IMultiRouteModelJson](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IMultiRouteModelJson.md)

Модель данных мультимаршрута, либо объект описания модели. В случае передачи объекта описания, модель на его основе создается автоматически. ||
|| [`options`](#param-options) | — | Тип: Object

Опции мультимаршрута. Для задания опций составных частей маршрутов доступны следующие префиксы:
- `wayPoint` – опции путевых точек;
- `wayPointStart` – опции отображения начальной путевой точки;
- `wayPointFinish` – опции отображения конечной путевой точки;
- `viaPoint` – опции транзитных точек;
- `pin` - опции точечных маркеров на маршруте;
- `editor` – опции редактора мультимаршрута (см. [multiRouter.Editor](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.Editor.md)).
Для задания опций единичных маршрутов доступны следующие префиксы:
- `route` – опции маршрутов, в том числе неактивных;
- `routeActive` – опции активного маршрута.
Причем опции заданные с префиксом "routeActive" более приоритетны по отношению к опциям с префиксом "route". Для задания опций составных частей маршрутов общественного транспорта доступны следующие префиксы.
- `routeMarker` – опции меток сегментов маршрута;
- `routeWalkMarker` – опции меток пеших сегментов маршрута;
- `routeTransferMarker` – опции меток сегментов переходов;
- `routeTransportMarker` – опции меток транспортных сегментов маршрута;
- `routeWalkSegment` – опции линий пеших сегментов маршрута;
- `routeTransferMarker` – опции линий сегментов переходов;
- `routeTransportSegment` – опции линий транспортных сегментов маршрута;
- `routePedestrianSegment` – опции линий сегментов пешеходного маршрута.
Также данные префиксы доступны в "routeActive*" варианте. ||
|| [`options.activeRouteAutoSelection`](#param-options.activeRouteAutoSelection) | true | Тип: Boolean

После обновления данных автоматически выбирать в качестве активного маршрут с минимальным временем проезда. ||
|| [`options.boundsAutoApply`](#param-options.boundsAutoApply) | false | Тип: Boolean

При добавлении мультимаршрута на карту позволяет автоматически установить центр и коэффициент масштабирования так, чтобы мультимаршрут был виден целиком. ||
|| [`options.dragUpdateInterval`](#param-options.dragUpdateInterval) | — | Тип: String\|Number

Величина временного интервала перестроения маршрута при перетаскивании опорных точек. Может быть задана в миллисекундах, либо оптимальное значение будет рассчитываться автоматически. Значение данной опции транслируется в параметр [IMultiRouteParams.requestSendInterval](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IMultiRouteParams.md#requestSendInterval) модели мультимаршрута. ||
|| [`options.preventDragUpdate`](#param-options.preventDragUpdate) | false | Тип: Boolean

Позволяет отключить обновление маршрута во время перетаскивания опорных точек. ||
|| [`options.useMapMargin`](#param-options.useMapMargin) | true | Тип: Boolean

Нужно ли учитывать отступы карты [map.margin.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md). ||
|| [`options.zoomMargin`](#param-options.zoomMargin) | 0 | Тип: Number\|Number[]

Отступы от границ видимой области карты при изменении коэффициента масштабирования. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left. При включенной опции "useMapMargin" значение "zoomMargin" складывается со значениями, которые были рассчитаны в менеджере отступов [map.margin.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Manager.md). ||
|#

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

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

**1.**

```javascript
// Создадим мульти-маршрут и добавим его на карту.
var multiRoute = new ymaps.multiRouter.MultiRoute({
    referencePoints: ['Москва, Ленинский проспект", "Москва, Кулаков переулок'],
}, {
    editorDrawOver: false,
    wayPointDraggable: true,
    viaPointDraggable: true,
    // Зададим собственное оформление линий мультимаршрута.
    routeStrokeColor: "000088",
    routeActiveStrokeColor: "ff0000",
    pinIconFillColor: "ff0000",
    boundsAutoApply: true,
    zoomMargin: 30
});
myMap.geoObjects.add(multiRoute);
```

**2.**

```javascript
// Создадим мультимаршрут и добавим его на карту.
var multiRoute = new ymaps.multiRouter.MultiRoute({
    referencePoints: ['Москва, Ленинский проспект', 'Москва, Кулаков переулок', 'Зеленоград'],
});
myMap.geoObjects.add(multiRoute);

// Once multi-route is loaded.
multiRoute.events.once('update', function () {
    // Установим первый маршрут, у которого нет перекрытых
    // участков, в качестве активного. Откроем его балун.
    var routes = multiRoute.getRoutes();
    for (var i = 0, l = routes.getLength(); i < l; i++) {
        var route = routes.get(i);
        if (!route.properties.get('blocked')) {
            multiRoute.setActiveRoute(route);
            route.balloon.open();
            break;
        }
    }
});
```

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

#|
|| **Имя** | **Тип** | **Описание** ||
|| [editor](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#editor) | [multiRouter.EditorAddon](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.EditorAddon.md) | Редактор мультимаршрута. ||
|| [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events). ||
|| [geometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry) | [IGeometry](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeometry.md)\|null | Геометрия геообъекта.

Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#geometry). ||
|| [model](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#model) | [multiRouter.MultiRouteModel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRouteModel.md) | Модель данных мультимаршрута. ||
|| [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). ||
|| [properties](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#properties) | [IDataManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Данные геообъекта.

Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#properties). ||
|| [state](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#state) | [IDataManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDataManager.md) | Состояние геообъекта.

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

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

#|
|| **Имя** | **Описание** ||
|| [activeroutechange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-activeroutechange) | Изменение активного маршрута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- oldActiveRoute: multiRouter.driving.Route\|multiRouter.masstransit.Route\|null - предыдущий активный маршрут. ||
|| [balloonclose](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-balloonclose) | Закрытие балуна. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalTarget: multiRouter.pedestrian.Route\|multiRouter.driving.Route\|multiRouter.masstransit.Route\|null - маршрут, балун которого был закрыт. ||
|| [balloonopen](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-balloonopen) | Открытие балуна. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalTarget: multiRouter.pedestrian.Route\|multiRouter.driving.Route\|multiRouter.masstransit.Route\|null - маршрут, на котором был открыт балун. ||
|| [boundsautoapply](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-boundsautoapply) | Событие возникает в момент установки центра и коэффициента масштабирования карты для оптимального отображения мультимаршрута. Также смотрите описание опции boundsAutoApply. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [boundschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-boundschange) | Изменение координат географической области, охватывающей мультимаршрут. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [click](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click). ||
|| [contextmenu](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). ||
|| [dblclick](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). ||
|| [geometrychange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange) | Изменение геометрии геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalEvent: [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие геометрии.

Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-geometrychange). ||
|| [mapchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Сменилась карта. Поля данных:
- oldMap - старая карта;
- newMap - новая карта.

Унаследовано от [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#event-mapchange). ||
|| [mousedown](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). ||
|| [mouseenter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). ||
|| [mouseleave](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). ||
|| [mousemove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). ||
|| [mouseup](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). ||
|| [multitouchend](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). ||
|| [multitouchmove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). ||
|| [multitouchstart](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). ||
|| [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). ||
|| [overlaychange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange) | Изменение оверлея геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- overlay: [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - ссылка на оверлей;
- oldOverlay: [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null - предыдущий оверлей геообъекта.

Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-overlaychange). ||
|| [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). ||
|| [pixelboundschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-pixelboundschange) | Изменение пиксельных координат области, охватывающей мультимаршрут. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [propertieschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange) | Изменение данных геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalEvent: [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md) - оригинальное событие менеджера данных.

Унаследовано от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#event-propertieschange). ||
|| [update](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-update) | Обновление мультимаршрута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [wheel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

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


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getActiveRoute](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getActiveRoute)() | [multiRouter.driving.Route](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.driving.Route.md)\|[multiRouter.masstransit.Route](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Route.md)\|null | Возвращает активный маршрут. ||
|| [getBounds](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getBounds)() | Number[][]\|null | Возвращает географические координаты области, охватывающей мультимаршрут. ||
|| [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту.

Унаследован от [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md#getMap). ||
|| [getOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание, который подтверждается объектом оверлея в момент его фактического создания, либо отклоняется с передачей соответствующей ошибки.

Унаследован от [IGeoObject](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlay). ||
|| [getOverlaySync](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Метод предоставляет синхронный доступ к оверлею.

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

Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent). ||
|| [getPixelBounds](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getPixelBounds)() | Number[][]\|null | Возвращает глобальные пиксельные координаты области, охватывающей мультимаршрут. ||
|| [getRoutes](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getRoutes)() | [GeoObjectCollection](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md) | Возвращает дочернюю коллекцию единичных маршрутов мультимаршрута. ||
|| [getViaPoints](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getViaPoints)() | [GeoObjectCollection](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md) | Возвращает дочернюю коллекцию транзитных точек мультимаршрута. ||
|| [getWayPoints](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#getWayPoints)() | [GeoObjectCollection](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/GeoObjectCollection.md) | Возвращает дочернюю коллекцию путевых точек мультимаршрута. ||
|| [setActiveRoute](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#setActiveRoute)([route](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#setActiveRoute-param-route)) | | Устанавливает активный маршрут. При этом предыдущий активный маршрут деактивируется, и генерируется событие [multiRouter.MultiRoute.activeroutechange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-activeroutechange). ||
|| [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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


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

### editor {#editor}

```javascript
{multiRouter.EditorAddon} editor
```

Редактор мультимаршрута.

**Пример:**

```javascript
// Начало редактирования маршрута.
ymaps.route(['Москва', 'Питер'], { multiRoute: true })
    .done(function (multiRoute) {
        myMap.geoObjects.add(multiRoute);
        multiRoute.editor.start({
            addWayPoints: true,
            removeWayPoints: true
        });
        // ...
        // Завершение редактирования маршрута.
      route.editor.stop();
});
```

### model {#model}

```javascript
{multiRouter.MultiRouteModel} model
```

Модель данных мультимаршрута.

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

### activeroutechange {#activeroutechange}

Изменение активного маршрута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- oldActiveRoute: multiRouter.driving.Route|multiRouter.masstransit.Route|null - предыдущий активный маршрут.

### balloonclose {#balloonclose}

Закрытие балуна. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalTarget: multiRouter.pedestrian.Route|multiRouter.driving.Route|multiRouter.masstransit.Route|null - маршрут, балун которого был закрыт.

### balloonopen {#balloonopen}

Открытие балуна. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- originalTarget: multiRouter.pedestrian.Route|multiRouter.driving.Route|multiRouter.masstransit.Route|null - маршрут, на котором был открыт балун.

### boundsautoapply {#boundsautoapply}

Событие возникает в момент установки центра и коэффициента масштабирования карты для оптимального отображения мультимаршрута. Также смотрите описание опции boundsAutoApply. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### boundschange {#boundschange}

Изменение координат географической области, охватывающей мультимаршрут. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### pixelboundschange {#pixelboundschange}

Изменение пиксельных координат области, охватывающей мультимаршрут. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### update {#update}

Обновление мультимаршрута. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

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

### getActiveRoute {#getActiveRoute}

```javascript
{multiRouter.driving.Route|multiRouter.masstransit.Route|null} getActiveRoute()
```

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

### getBounds {#getBounds}

```javascript
{Number[][]|null} getBounds()
```

**Возвращает** географические координаты области, охватывающей мультимаршрут.

### getPixelBounds {#getPixelBounds}

```javascript
{Number[][]|null} getPixelBounds()
```

**Возвращает** глобальные пиксельные координаты области, охватывающей мультимаршрут.

### getRoutes {#getRoutes}

```javascript
{GeoObjectCollection} getRoutes()
```

**Возвращает** дочернюю коллекцию единичных маршрутов мультимаршрута.

### getViaPoints {#getViaPoints}

```javascript
{GeoObjectCollection} getViaPoints()
```

**Возвращает** дочернюю коллекцию транзитных точек мультимаршрута.

### getWayPoints {#getWayPoints}

```javascript
{GeoObjectCollection} getWayPoints()
```

**Возвращает** дочернюю коллекцию путевых точек мультимаршрута.

### setActiveRoute {#setActiveRoute}

```javascript
{} setActiveRoute(route)
```

Устанавливает активный маршрут. При этом предыдущий активный маршрут деактивируется, и генерируется событие [multiRouter.MultiRoute.activeroutechange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.MultiRoute.md#event-activeroutechange).

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`route`](#setActiveRoute-param-route)[*](*star) | — | Тип: [multiRouter.driving.Route](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.driving.Route.md)|[multiRouter.masstransit.Route](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/multiRouter.masstransit.Route.md)\|null

Устанавливает активный маршрут. ||
|#

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

<!-- XLIFF_FARM_NjEzMGE2_CACHING -->

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