Documentation
Reference
2.1.55 (current version)
collection
interactivityModel
Interfaces

router.Route

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

Extends IGeoObject.

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

Fields | Events | Methods

Fields

NameTypeDescription
editorrouter.Editor

Route editor.

eventsIEventManager

Event manager.

Inherited from IDomEventEmitter.

geometryIGeometry|null

Geo object geometry.

Inherited from IGeoObject.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

propertiesIDataManager

Geo object data.

Inherited from IGeoObject.

stateIDataManager

State of the geo object.

Inherited from IGeoObject.

Events

NameDescription
boundsapply

Event for applying the route boundaries to the map with the options.mapStateAutoApply option set.

click

Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

contextmenu

Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

dblclick

Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

geometrychange

Change to the geo object geometry. Instance of the Event class. Names of fields that are available via the Event#get method:

  • originalEvent: IEvent - Original event of the geometry.

Inherited from IGeoObject.

mapchange

Map reference changed. Data fields:

  • oldMap - Old map.
  • newMap - New map.

Inherited from IParentOnMap.

mousedown

Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseenter

Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseleave

Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mousemove

Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

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. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

multitouchend

End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface.

Inherited from IDomEventEmitter.

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.

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.

optionschange

Change to the object options.

Inherited from ICustomizable.

overlaychange

Change to the geo object overlay. Instance of the Event class. Names of fields that are available via the Event#get method:

  • overlay: IOverlay|null - Reference to the overlay.
  • oldOverlay: IOverlay|null - Previous overlay of the geo object.

Inherited from IGeoObject.

parentchange

The parent object reference changed.

Data fields:

  • oldParent - Old parent.
  • newParent - New parent.

Inherited from IChild.

propertieschange

Change to the geo object data. Instance of the Event class. Names of fields that are available via the Event#get method:

  • originalEvent: IEvent - Original event of the data manager.

Inherited from IGeoObject.

update

Route updating event when the route editor is enabled.

wheel

Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
getHumanJamsTime()

String

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

getHumanLength()

String

Returns a string representation of route length with measurement units.

getHumanTime()

String

Returns a string representation of route driving time with measurement units.

getJamsTime()

Integer

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

getLength()

Number

Returns the length of the route in meters.

getMap()

Map

Returns reference to the map.

Inherited from IParentOnMap.

getOverlay()

vow.Promise

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.

getOverlaySync()

IOverlay|null

The method provides synchronous access to the overlay.

Inherited from IGeoObject.

getParent()

IControlParent|null

Returns link to the parent object, or null if the parent element was not set.

Inherited from IChildOnMap.

getPaths()

GeoObjectCollection

Returns a collection of paths that make up the route.

getTime()

Integer

Returns the route driving time in seconds.

getViaPoints()

GeoObjectCollection

Returns a collection of throughpoints on the route.

getWayPoints()

GeoObjectCollection

Returns a collection of waypoints on the route.

setParent(parent)

IChildOnMap

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.

Fields details

editor

{router.Editor} editor

Route editor.

Example:

// Start of route editing.
ymaps.route(['Moscow', 'Petersburg'], function (route) {
    route.editor.start();
    // ...
    // End of route editing.
    route.editor.stop();
});

Events details

boundsapply

Event for applying the route boundaries to the map with the options.mapStateAutoApply option set.

update

Route updating event when the route editor is enabled.

Methods details

getHumanJamsTime

{String} getHumanJamsTime()

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

getHumanLength

{String} getHumanLength()

Returns a string representation of route length with measurement units.

getHumanTime

{String} getHumanTime()

Returns a string representation of route driving time with measurement units.

getJamsTime

{Integer} getJamsTime()

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

getLength

{Number} getLength()

Returns the length of the route in meters.

getPaths

{GeoObjectCollection} getPaths()

Returns a collection of paths that make up the route.

getTime

{Integer} getTime()

Returns the route driving time in seconds.

getViaPoints

{GeoObjectCollection} getViaPoints()

Returns a collection of throughpoints on the route.

getWayPoints

{GeoObjectCollection} getWayPoints()

Returns a collection of waypoints on the route.