DomEvent

Расширяет IDomEvent .

DOM-событие в системе API Яндекс.Карт. Предоставляет прокси-методы для доступа к полям и методам исходного DOM-события. Возвращаемые значения нормализованы с учётом особенностей различных браузеров. Также переопределено свойство position, возвращается массив вида [pageX, pageY].

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

Конструктор

DomEvent(originalEvent[, type])

Создаёт DOM-событие в системе API Яндекс.Карт.

Параметры:

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

Тип: DomEvent

DOM-событие.

type

Тип: Object

Тип события. Если не указан, берётся из originalEvent.type.

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

Методы

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

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

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

callMethod (name)

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

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

get (name)

Object

Возвращает значение некоторого свойства. Сначала проверяется, не было ли свойство задано через set, затем проверяется наличие свойства в domEvent.overrideStorage. Если не найдено — то проверяется в originalEvent. Значения свойств кэшируются.

getSourceEvent ()

IDomEvent

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

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

isDefaultPrevented ()

Boolean

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

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

isImmediatePropagationStopped ()

Boolean

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

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

isMapEventAllowed ()

Boolean

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

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

isPropagationStopped ()

Boolean

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

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

preventDefault ()

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

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

stopImmediatePropagation ()

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

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

stopPropagation ()

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

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

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

get

{Object} get(name)

Возвращает значение свойства. Сначала проверяется, не было ли свойство задано через set, затем проверяется наличие свойства в domEvent.overrideStorage. Если не найдено — то проверяется в originalEvent. Значения свойств кэшируются.

Параметры:

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

Тип: String

Имя свойства.

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