Documentation
Reference
2.1.38 (current version)
collection
interactivityModel
Interfaces

DomEvent

Extends IDomEvent.

DOM event in the Yandex.Maps API system. Provides proxy methods for accessing fields and methods of the source DOM event. The returned values are standardized to account for browser variations. The "position" property is also redefined; an array of the type [pageX, pageY] is returned.

Constructor | Methods

Constructor

DomEvent(originalEvent[, type])

Creates a DOM event in the Yandex.Maps API system.

Parameters:

ParameterDefault valueDescription
originalEvent *
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: DomEvent

DOM event.

type

Type: Object

Type of event. If omitted, it is taken from originalEvent.type.

* Mandatory parameter/option.

Methods

NameReturnsDescription
allowMapEvent()

Allows the propagation of the event to the map.

Inherited from IEvent.

callMethod(name)

Calls the specified method from the source event. The second and following arguments are passed to the method with the call.

Inherited from IEvent.

get(name)Object

Returns the value of a property. First it checks whether the property was set via "set", then it checks whether the property exists in "domEvent.overrideStorage". If it's not found, it looks in "originalEvent". Property values are cached.

getSourceEvent()IDomEvent

Returns the source DOM event.

Inherited from IDomEvent.

isDefaultPrevented()Boolean

Returns true if the default reaction to the event has been canceled.

Inherited from IEvent.

isImmediatePropagationStopped()Boolean

Returns true if the event processing has been interrupted.

Inherited from IEvent.

isMapEventAllowed()Boolean

Returns true if the map event is enabled.

Inherited from IEvent.

isPropagationStopped()Boolean

Returns true if the event propagation has been interrupted.

Inherited from IEvent.

preventDefault()

Cancels the default reaction to an event within the Yandex.Maps API event system. Calling this method does not affect how the browser processes the default action for the source DOM event.

Inherited from IDomEvent.

stopImmediatePropagation()

Stops event processing in the Yandex.Maps API event system. I.e. after calling this method, no handler for this event will be called. Calling this method does not affect the processing of the original DOM-event at the browser level.

Inherited from IDomEvent.

stopPropagation()

Stops propagation of the DOM event in the Yandex.Maps API event system. Calling this method does not affect propagation of the source DOM event through the DOM tree.

Inherited from IDomEvent.

Methods details

get

{Object} get(name)

Returns the value of a property. First it checks whether the property was set via "set", then it checks whether the property exists in "domEvent.overrideStorage". If it's not found, it looks in "originalEvent". Property values are cached.

Returns the value.

Parameters:

ParameterDefault valueDescription
name*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: String

Property name.

* Mandatory parameter/option.