IEvent
Event that is fired by the IEventManager event manager.
Constructor
IEvent()Methods
| Name | Returns | Description |
|---|---|---|
| allowMapEvent() |
Allows the propagation of the event to the map. |
|
| callMethod(name) |
Calls the specified method from the source event. The second and following arguments are passed to the method with the call. |
|
| get(name) | Object |
Returns an event property for a key. Using this method, you can get access both to the properties of the source event and to additional properties provided by the Yandex.Maps API. |
| getSourceEvent() | IEvent|null |
Returns source event. |
| isDefaultPrevented() | Boolean |
Returns true if the default reaction to the event has been canceled. |
| isImmediatePropagationStopped() | Boolean |
Returns true if the event processing has been interrupted. |
| isMapEventAllowed() | Boolean |
Returns true if the map event is enabled. |
| isPropagationStopped() | Boolean |
Returns true if event propagation has been interrupted. |
| preventDefault() |
Cancels the default reaction to an event within the Yandex.Maps API event system. |
|
| 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. |
|
| stopPropagation() |
Stops event propagation in the Yandex.Maps API event system. |
| Name | Returns | Description |
|---|---|---|
| allowMapEvent() |
Allows the propagation of the event to the map. |
|
| callMethod(name) |
Calls the specified method from the source event. The second and following arguments are passed to the method with the call. |
|
| get(name) | Object |
Returns an event property for a key. Using this method, you can get access both to the properties of the source event and to additional properties provided by the Yandex.Maps API. |
| getSourceEvent() | IEvent|null |
Returns source event. |
| isDefaultPrevented() | Boolean |
Returns true if the default reaction to the event has been canceled. |
| isImmediatePropagationStopped() | Boolean |
Returns true if the event processing has been interrupted. |
| isMapEventAllowed() | Boolean |
Returns true if the map event is enabled. |
| isPropagationStopped() | Boolean |
Returns true if event propagation has been interrupted. |
| preventDefault() |
Cancels the default reaction to an event within the Yandex.Maps API event system. |
|
| 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. |
|
| stopPropagation() |
Stops event propagation in the Yandex.Maps API event system. |
Methods details
allowMapEvent
{} allowMapEvent()Allows the propagation of the event to the map.
callMethod
{} callMethod(name)Calls the specified method from the source event. The second and following arguments are passed to the method with the call.
Parameters:
* Mandatory parameter/option.
get
{Object} get(name)Returns an event property for a key. Using this method, you can get access both to the properties of the source event and to additional properties provided by the Yandex.Maps API.
Returns property value.
Parameters:
* Mandatory parameter/option.
getSourceEvent
{IEvent|null} getSourceEvent()Returns source event.
isDefaultPrevented
{Boolean} isDefaultPrevented()Returns true if the default reaction to the event has been canceled.
isImmediatePropagationStopped
{Boolean} isImmediatePropagationStopped()Returns true if the event processing has been interrupted.
isMapEventAllowed
{Boolean} isMapEventAllowed()Returns true if the map event is enabled.
isPropagationStopped
{Boolean} isPropagationStopped()Returns true if event propagation has been interrupted.
preventDefault
{} preventDefault()Cancels the default reaction to an event within the Yandex.Maps API event system.
stopImmediatePropagation
{} 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.
stopPropagation
{} stopPropagation()Stops event propagation in the Yandex.Maps API event system.