Documentation
Reference
2.1.56 (current version)
collection
interactivityModel
Interfaces

router.WayPoint

Extends GeoObject.

Object describing a waypoint on the route.

Constructor | Fields | Events | Methods

Constructor

router.WayPoint(feature[, options])

Parameters:

ParameterDefault valueDescription
feature *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Properties and geometry.

options

Type: Object

Options.

* Mandatory parameter/option.

Fields

NameTypeDescription
balloongeoObject.Balloon

Balloon for a geo object.

Inherited from GeoObject.

editorIGeometryEditor

Editor for the geo object geometry.

Inherited from GeoObject.

eventsevent.Manager

Event manager.

Inherited from GeoObject.

geometryIGeometry|null

Geo object geometry.

Inherited from GeoObject.

hintgeoObject.Hint

Geo object hint.

Inherited from GeoObject.

optionsoption.Manager

Geo object options manager.

Inherited from GeoObject.

propertiesdata.Manager

Data manager for a waypoint. If the waypoint was set as an address, the GeocoderMetaData field will contain the geocoder metadata. See geocode.

statedata.Manager

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.

Events

NameDescription
balloonclose

Closing the balloon. Instance of the Event class.

Inherited from GeoObject.

balloonopen

Opening a balloon on a geo object. Instance of the Event class.

Inherited from GeoObject.

beforedrag

Event preceding the "drag" event. Instance of the Event class. Names of fields that are available via the Event#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 object), if there is one.
Names of methods that are accessible via Event#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 method is called for this event, a subsequent drag event will be canceled.

Inherited from GeoObject.

beforedragstart

Event preceding the "dragstart" event. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.
If the Event#preventDefault method is called for this event, any subsequent dragging, as well as the "dragstart" event, will be canceled.

Inherited from GeoObject.

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.

drag

Dragging a geo object. Instance of the Event class. Names of fields that are available via the Event#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 object), if there is one.

Inherited from GeoObject.

dragend

End of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

Inherited from GeoObject.

dragstart

Start of geo object dragging. Instance of the Event class. Names of fields that are available via the Event#get method:

  • position - Coordinates relative to the document. Array in the format [pageX, pageY].
  • domEvent - Source DOM event (as a DomEvent object), if there is one.

Inherited from GeoObject.

editorstatechange

Change in the state of the editor for the geo object's geometry. Instance of the Event class. Names of fields that are available via the Event#get method:

  • originalEvent - Original event of the geometry editor.

Inherited from GeoObject.

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.

hintclose

Closing the hint. Instance of the Event class.

Inherited from GeoObject.

hintopen

Opening a hint on a geo object. Instance of the Event class.

Inherited from GeoObject.

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.

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
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.

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

properties

{data.Manager} properties

Data manager for a waypoint. If the waypoint was set as an address, the GeocoderMetaData field will contain the geocoder metadata. See geocode.