IDomEvent

Расширяет IEvent.

Объект DOM-события в системе API Яндекс.Карт. Оборачивает оригинальное DOM-событие браузера с целью нормализации имен полей данных. Т.е. посредством методов get и callMethod можно получать доступ к полям и методам оригинального DOM-события. При этом автоматически выполняется приведение к стандарту для тех полей и методов, реализация которых различна в разных браузерах. Так, event.callMethod('stopPropagation') остановит распространение DOM-события во всех браузерах, включая Internet Explorer.

Конструктор | Методы

Конструктор

IDomEvent(originalEvent)

Параметры:

Параметр Значение по умолчанию Описание
originalEvent *

Тип: Object

Исходное DOM-событие.

* Обязательный параметр/опция.

Методы

Имя Возвращает Описание
allowMapEvent()

Разрешает распространение данного события на карту.

Унаследован от IEvent.

callMethod(name)

Вызывает указанный метод у исходного события. Второй и последующие аргументы передаются методу при вызове.

Унаследован от IEvent.

get(name)

Object

Возвращает заданное свойство события. С помощью этого метода можно получать доступ как к свойствам исходного события, так и к дополнительным свойствам, предоставляемым API карт.

getSourceEvent()

IDomEvent

Возвращает исходное DOM-событие.

isDefaultPrevented()

Boolean

Возвращает true, если реакция по умолчанию на событие отменена.

Унаследован от IEvent.

isImmediatePropagationStopped()

Boolean

Возвращает true, если обработка события прервана.

Унаследован от IEvent.

isMapEventAllowed()

Boolean

Возвращает true, если событие карты разрешено.

Унаследован от IEvent.

isPropagationStopped()

Boolean

Возвращает true, если распространение события прервано,

Унаследован от IEvent.

preventDefault()

Отменяет реакцию по умолчанию на событие в рамках системы событий API Яндекс.Карт. Вызов этого метода не влияет на обработку браузером действия по умолчанию исходного DOM-события.

stopImmediatePropagation()

Прекращает обработку события в системе событий API Яндекс.Карт. Т.е. после вызова данного метода ни один обработчик данного события не будет вызван. Вызов этого метода не влияет на обработку исходного DOM-события на уровне браузера.

stopPropagation()

Прекращает распространение DOM-события в системе событий API Яндекс.Карт. Вызов этого метода не влияет на распространение исходного DOM-события по DOM-дереву.

Описание методов

get

{Object} get(name)

Возвращает заданное свойство события. С помощью этого метода можно получать доступ как к свойствам исходного события, так и к дополнительным свойствам, предоставляемым API карт.

Возвращает значение свойства.

Параметры:

Параметр Значение по умолчанию Описание
name *

Тип: String

Имя свойства. Поддерживаются дополнительные свойства:
  • 'propagatedData' - данные события, которые сохраняются при его пропагировании (распространении по DOM-дереву);
  • 'position' - необязательное поле, которое содержит координаты события относительно документа.

* Обязательный параметр/опция.

getSourceEvent

{IDomEvent} getSourceEvent()

Возвращает исходное DOM-событие.

preventDefault

{} preventDefault()

Отменяет реакцию по умолчанию на событие в рамках системы событий API Яндекс.Карт. Вызов этого метода не влияет на обработку браузером действия по умолчанию исходного DOM-события.

stopImmediatePropagation

{} stopImmediatePropagation()

Прекращает обработку события в системе событий API Яндекс.Карт. Т.е. после вызова данного метода ни один обработчик данного события не будет вызван. Вызов этого метода не влияет на обработку исходного DOM-события на уровне браузера.

stopPropagation

{} stopPropagation()

Прекращает распространение DOM-события в системе событий API Яндекс.Карт. Вызов этого метода не влияет на распространение исходного DOM-события по DOM-дереву.