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

# router.Path

{% note info %}

The constructor of the router.Path class is hidden, as this class is not intended for autonomous initialization.

{% endnote %}

Extends [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md).

Object that describes part of the route (a path). The constructor is not available in the package.full (a standard set of modules). This module is loaded on demand. The route can contain several paths, and each path connects two waypoints.

**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** ||
|| [balloon](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#balloon) | [geoObject.Balloon](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Balloon.md) | Balloon for a geo object.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#balloon). ||
|| [editor](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#editor) | [IGeometryEditor](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometryEditor.md) | Editor for the geo object geometry.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#editor). ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#events) | [event.Manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/event.Manager.md) | Event manager.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#events). ||
|| [geometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#geometry) | [IGeometry](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeometry.md)\|null | Geo object geometry.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#geometry). ||
|| [hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#hint) | [geoObject.Hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md) | Geo object hint.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#hint). ||
|| [options](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#options) | [option.Manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/option.Manager.md) | Geo object options manager.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#options). ||
|| [properties](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#properties) | [data.Manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/data.Manager.md) | Geo object data manager.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#properties). ||
|| [state](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#state) | [data.Manager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/data.Manager.md) | State of the geo object. Defined by the following fields: 
- active: Boolean - Indicates that a balloon is open on the geo object.
- hover: Boolean - Indicates that the mouse is currently pointed at the geo object.
- drag: Boolean - Indicates that the geo object is being dragged

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#state). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [balloonclose](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonclose) | Closing the balloon. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonclose). ||
|| [balloonopen](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonopen) | Opening a balloon on a geo object. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-balloonopen). ||
|| [beforedrag](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedrag) | Event preceding the "drag" event. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- pixelOffset - Array of two numbers that describe the pixel offset at this step.
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.
Names of methods that are accessible via [Event.callMethod](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#callMethod): 
- setPixelOffset - This method is for correcting the value of the pixel offset that will 	actually be applied. It takes an argument with the new pixel offset in the form of an array of two numbers.
If the [Event.preventDefault](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#preventDefault) method is called for this event, a subsequent drag event will be canceled.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedrag). ||
|| [beforedragstart](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedragstart) | Event preceding the "dragstart" event. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.
If the [Event.preventDefault](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#preventDefault) method is called for this event, any subsequent dragging, as well as the "dragstart" event, will be canceled.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-beforedragstart). ||
|| [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). ||
|| [drag](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-drag) | Dragging a geo object. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- pixelOffset - Array of two numbers that describe the pixel offset at this step.
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-drag). ||
|| [dragend](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragend) | End of geo object dragging. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragend). ||
|| [dragstart](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragstart) | Start of geo object dragging. 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: 
- position - Coordinates relative to the document. Array in the format [pageX, pageY].
- domEvent - Source DOM event (as a [DomEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/DomEvent.md) object), if there is one.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-dragstart). ||
|| [editorstatechange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-editorstatechange) | Change in the state of the editor for the geo object's 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 - Original event of the geometry editor.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-editorstatechange). ||
|| [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). ||
|| [hintclose](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintclose) | Closing the hint. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintclose). ||
|| [hintopen](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintopen) | Opening a hint on a geo object. Instance of the [Event](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class.

Inherited from [GeoObject](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#event-hintopen). ||
|| [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). ||
|| [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.Path.md#getHumanJamsTime)() | String | Returns a string representation of path driving time with measurement units, with consideration for traffic. ||
|| [getHumanLength](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getHumanLength)() | String | Returns a string representation of path length with measurement units. ||
|| [getHumanTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getHumanTime)() | String | Returns a string representation of path driving time with measurement units. ||
|| [getJamsTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getJamsTime)() | Integer | Returns the path driving time in seconds, with consideration for traffic. ||
|| [getLength](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getLength)() | Number | Returns path length 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). ||
|| [getSegments](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getSegments)() | [router.Segment](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Segment.md)[] | Returns path segments. ||
|| [getTime](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/router.Path.md#getTime)() | Integer | Returns the path driving time in seconds. ||
|| [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).||
|#

## Methods details {#method_detail}

### getHumanJamsTime {#getHumanJamsTime}

```javascript
{String} getHumanJamsTime()
```

**Returns** a string representation of path driving time with measurement units, with consideration for traffic.

### getHumanLength {#getHumanLength}

```javascript
{String} getHumanLength()
```

**Returns** a string representation of path length with measurement units.

### getHumanTime {#getHumanTime}

```javascript
{String} getHumanTime()
```

**Returns** a string representation of path driving time with measurement units.

### getJamsTime {#getJamsTime}

```javascript
{Integer} getJamsTime()
```

**Returns** the path driving time in seconds, with consideration for traffic.

### getLength {#getLength}

```javascript
{Number} getLength()
```

**Returns** path length in meters.

### getSegments {#getSegments}

```javascript
{router.Segment[]} getSegments()
```

**Returns** path segments.

### getTime {#getTime}

```javascript
{Integer} getTime()
```

**Returns** the path driving time in seconds.