--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md --- # router.Route Расширяет [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md), [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md). Объект, описывающий проложенный маршрут. **См.:** [route](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/route.md) ## Конструктор {#constructor} ```javascript router.Route(json[, options]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `json`[*](*parametr) | — | Тип: Object Описание маршрута в формате json. || || `options`| — | Тип: Object Опции маршрута. || || `options.mapStateAutoApply`| false | Тип: Boolean Флаг, позволяющий автоматически установить центр и коэффициент масштабирования карты так, чтобы построенный маршрут был виден целиком. || || `options.zoomMargin`| 0 | Тип: Number\|Number[] Отступы от границ видимой области карты при изменении коэффициента масштабирования. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left. || |# \* Обязательный параметр/опция. ## Поля {#fields} #| || **Имя** | **Тип** | **Описание** || || [editor](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#editor) | [router.Editor](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Editor.md) | Редактор маршрутов. || || [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events). || || [geometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#geometry) | [IGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeometry.md) | Геометрия геообъекта. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#geometry). || || [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options). || || [properties](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#properties) | [IDataManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDataManager.md) | Менеджер данных геообъекта. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#properties). || || [state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#state) | [IDataManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDataManager.md) | Состояние геообъекта. Определяется следующими полями: • active - признак того, что на геообъекте открыт балун. • hover - признак того, что в данный момент на геообъект наведен указатель мыши. • drag - признак того, что геообъект перетаскивается. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#state). || |# ## События {#events} #| || **Имя** | **Описание** || || [boundsapply](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#boundsapply) | Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply. || || [click](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#click). || || [contextmenu](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#contextmenu). || || [dblclick](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#dblclick). || || [geometrychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#geometrychange) | Изменение геометрии геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие геометрии. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#geometrychange). || || [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md#mapchange) | Сменилась карта. Поля данных: • oldMap - старая карта; • newMap - новая карта. Унаследовано от [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md#mapchange). || || [mousedown](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousedown). || || [mouseenter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseenter). || || [mouseleave](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseleave). || || [mousemove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousemove). || || [mouseup](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseup). || || [multitouchend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchend). || || [multitouchmove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchmove). || || [multitouchstart](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchstart). || || [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange). || || [overlaychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#overlaychange) | Изменение оверлея геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • newOverlay - новый оверлей, либо null, если оверлея нет; • oldOverlay - старый оверлей, либо null, если оверлея нет. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#overlaychange). || || [parentchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#parentchange) | Сменился родительский объект. Поля данных: • oldParent - старый родитель; • newParent - новый родитель. Унаследовано от [IChild](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#parentchange). || || [pixelgeometrychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#pixelgeometrychange) | Изменение пиксельной геометрии геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • newPixelGeometry - новая пиксельная геометрия; • oldPixelGeometry - старая пиксельная геометрия. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#pixelgeometrychange). || || [propertieschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#propertieschange) | Изменение данных геообъекта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). Имена полей, доступных через метод Event.get: • originalEvent - оригинальное событие менеджера данных. Унаследовано от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#propertieschange). || || [wheel](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#wheel). || |# ## Методы {#methods} #| || **Имя** | **Возвращает** | **Описание** || || [getHumanJamsTime](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Path.md#getHumanJamsTime)() | String | Returns строковое представление времени проезда пути с единицами измерения с учетом пробок. || || [getHumanLength](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Path.md#getHumanLength)() | String | Returns строковое представление длины пути с единицами измерения. || || [getHumanTime](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Path.md#getHumanTime)() | String | Returns строковое представление времени проезда маршрута с единицами измерения. || || [getJamsTime](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Path.md#getJamsTime)() | Integer | Returns время проезда маршрута в секундах с учетом пробок. || || [getLength](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Path.md#getLength)() | Number | Returns длину пути в метрах. || || [getMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Map.md) | Returns ссылку на карту. Унаследован от [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md#getMap). || || [getOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#getOverlay)() | [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md)\|null | Returns оверлей геообъекта, либо null. Унаследован от [IGeoObject](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IGeoObject.md#getOverlay). || || [getParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md) | Returns ссылку на родительский объект. Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent). || || [getPaths](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#getPaths)() | [GeoObjectArray](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/GeoObjectArray.md) | Returns коллекцию путей, из которых состоит маршрут. || || [getTime](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#getTime)() | Integer | Returns время проезда маршрута в секундах. || || [getViaPoints](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#getViaPoints)() | [GeoObjectArray](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/GeoObjectArray.md) | Returns коллекцию транзитных точек маршрута. || || [getWayPoints](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/router.Route.md#getWayPoints)() | [GeoObjectArray](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/GeoObjectArray.md) | Returns коллекцию путевых точек маршрута. || || [setParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent). || |# ## Описание полей {#description-fields} ### editor ```javascript {router.Editor} editor ``` Редактор маршрутов. **Пример:** ```javascript // Начало редактирования маршрута. ymaps.route(['Москва', 'Питер'], function (route) { route.editor.start(); // ... // Завершение редактирования маршрута. route.editor.stop(); }); ``` ## Описание событий {#description-events} ### boundsapply Событие выставления границ маршрута карте при заданной опции options.mapStateAutoApply. ### update Событие обновления маршрута при включенном редакторе маршрутов. ## Описание методов {#description-methods} ### getHumanJamsTime ```javascript {String} getHumanJamsTime() ``` **Returns** строковое представление времени проезда маршрута с единицами измерения с учетом пробок. ### getHumanLength ```javascript {String} getHumanLength() ``` **Returns** строковое представление длины маршрута с единицами измерения. ### getHumanTime ```javascript {String} getHumanTime() ``` **Returns** строковое представление времени проезда маршрута с единицами измерения. ### getJamsTime ```javascript {Integer} getJamsTime() ``` **Returns** время проезда маршрута в секундах с учетом пробок. ### getLength ```javascript {Number} getLength() ``` **Returns** длину маршрута в метрах. ### getPaths ```javascript {GeoObjectArray} getPaths() ``` **Returns** коллекцию путей, из которых состоит маршрут. ### getTime ```javascript {Integer} getTime() ``` **Returns** время проезда маршрута в секундах. ### getViaPoints ```javascript {GeoObjectArray} getViaPoints() ``` **Returns** коллекцию транзитных точек маршрута. ### getWayPoints ```javascript {GeoObjectArray} getWayPoints() ``` **Returns** коллекцию путевых точек маршрута. [*parametr]:Обязательный параметр/опция.