IDomEvent

Расширяет IEvent.

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

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

Конструктор

IDomEvent(originalEvent)

Параметры:

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

Тип: Object

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

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

Методы

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

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

get(name)

Object

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

isImmediatePropagationStopped()

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

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

callMethod

{} callMethod(name)

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

Параметры:

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

Тип: String

Имя метода.

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

get

{Object} get(name)

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

Returns значение свойства.

Параметры:

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

Тип: String

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

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

isImmediatePropagationStopped

{} isImmediatePropagationStopped()

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