--- metadata: - name: generator content: Diplodoc Platform v5.64.2 alternate: - https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md - https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/router.Route.md - href: https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md type: text/markdown title: Markdown version - href: https://yandex.com/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234 rel: describedby --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/jsapi-v2-1/doc/en/llms.txt?revision=r21950234 # router.Route {% note info %} The constructor of the router.Route class is hidden, as this class is not intended for autonomous initialization. {% endnote %} Extends [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md). Object that describes the plotted route. The constructor is not available in the package.full (a standard set of modules). This module is loaded on demand. **See** [route](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/route.md) [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary) ## Fields {#properties-summary} #| || **Name** | **Type** | **Description** || || [editor](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#editor) | [router.Editor](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Editor.md) | Route editor. || || [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events). || || [geometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#geometry) | [IGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md)\|null | Geo object geometry. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#geometry). || || [options](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md) | Options manager. Inherited from [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options). || || [properties](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#properties) | [IDataManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDataManager.md) | Geo object data. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#properties). || || [state](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#state) | [IDataManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDataManager.md) | State of the geo object. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#state). || |# ## Events {#events-summary} #| || **Name** | **Description** || || [boundsapply](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#event-boundsapply) | Event for applying the route boundaries to the map with the options.mapStateAutoApply option set. || || [click](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click). || || [contextmenu](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [dblclick](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). || || [geometrychange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-geometrychange) | Change to the geo object geometry. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: - originalEvent: [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md) - Original event of the geometry. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-geometrychange). || || [mapchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#event-mapchange) | Map reference changed. Data fields: - oldMap - Old map. - newMap - New map. Inherited from [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#event-mapchange). || || [mousedown](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). || || [mouseleave](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [optionschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Change to the object options. Inherited from [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [overlaychange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-overlaychange) | Change to the geo object overlay. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: - overlay: [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null - Reference to the overlay. - oldOverlay: [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null - Previous overlay of the geo object. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-overlaychange). || || [parentchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange) | The parent object reference changed. Data fields: - oldParent - Old parent. - newParent - New parent. Inherited from [IChild](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChild.md#event-parentchange). || || [propertieschange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-propertieschange) | Change to the geo object data. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: - originalEvent: [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md) - Original event of the data manager. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#event-propertieschange). || || [update](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#event-update) | Route updating event when the route editor is enabled. || || [wheel](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Methods {#methods-summary} #| || **Name** | **Returns** | **Description** || || [getHumanJamsTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getHumanJamsTime)() | String | Returns a string representation of route driving time with measurement units, with consideration for traffic. || || [getHumanLength](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getHumanLength)() | String | Returns a string representation of route length with measurement units. || || [getHumanTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getHumanTime)() | String | Returns a string representation of route driving time with measurement units. || || [getJamsTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getJamsTime)() | Integer | Returns the route driving time in seconds, with consideration for traffic. || || [getLength](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getLength)() | Number | Returns the length of the route in meters. || || [getMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#getMap)() | [Map](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md) | Returns reference to the map. Inherited from [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md#getMap). || || [getOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlay)() | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Returns the promise object, which is confirmed by the overlay object at the time it is actually created, or is rejected with an appropriate error message. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlay). || || [getOverlaySync](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlaySync)() | [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null | The method provides synchronous access to the overlay. Inherited from [IGeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObject.md#getOverlaySync). || || [getParent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IParentOnMap.md)\|null | Returns link to the parent object, or null if the parent element was not set. Inherited from [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#getParent). || || [getPaths](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getPaths)() | [GeoObjectCollection](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObjectCollection.md) | Returns a collection of paths that make up the route. || || [getTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getTime)() | Integer | Returns the route driving time in seconds. || || [getViaPoints](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getViaPoints)() | [GeoObjectCollection](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObjectCollection.md) | Returns a collection of throughpoints on the route. || || [getWayPoints](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Route.md#getWayPoints)() | [GeoObjectCollection](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObjectCollection.md) | Returns a collection of waypoints on the route. || || [setParent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md) | Sets the parent object. If the null value is passed, the manager element will only be deleted from the current parent object. Inherited from [IChildOnMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IChildOnMap.md#setParent). || |# ## Fields details {#field_detail} ### editor {#editor} ```javascript {router.Editor} editor ``` Route editor. **Example:** ```javascript // Start of route editing. ymaps.route(['Moscow', 'Petersburg'], function (route) { route.editor.start(); // ... // End of route editing. route.editor.stop(); }); ``` ## Events details {#event_detail} ### boundsapply {#boundsapply} Event for applying the route boundaries to the map with the options.mapStateAutoApply option set. ### update {#update} Route updating event when the route editor is enabled. ## Methods details {#method_detail} ### getHumanJamsTime {#getHumanJamsTime} ```javascript {String} getHumanJamsTime() ``` **Returns** a string representation of route driving time with measurement units, with consideration for traffic. ### getHumanLength {#getHumanLength} ```javascript {String} getHumanLength() ``` **Returns** a string representation of route length with measurement units. ### getHumanTime {#getHumanTime} ```javascript {String} getHumanTime() ``` **Returns** a string representation of route driving time with measurement units. ### getJamsTime {#getJamsTime} ```javascript {Integer} getJamsTime() ``` **Returns** the route driving time in seconds, with consideration for traffic. ### getLength {#getLength} ```javascript {Number} getLength() ``` **Returns** the length of the route in meters. ### getPaths {#getPaths} ```javascript {GeoObjectCollection} getPaths() ``` **Returns** a collection of paths that make up the route. ### getTime {#getTime} ```javascript {Integer} getTime() ``` **Returns** the route driving time in seconds. ### getViaPoints {#getViaPoints} ```javascript {GeoObjectCollection} getViaPoints() ``` **Returns** a collection of throughpoints on the route. ### getWayPoints {#getWayPoints} ```javascript {GeoObjectCollection} getWayPoints() ``` **Returns** a collection of waypoints on the route.