Event

Расширяет IEvent.

Объект-событие. Предоставляет методы для доступа к полям и методам объекта originalObject с возможностью их переопределения.

Конструктор

Event(originalEvent[, isPropagationStopped[, isDefaultPrevented]])

Создаёт объект-событие.

Параметры:

Параметр

Значение по умолчанию

Описание

originalEvent*

Тип: Object

Исходные данные.

isPropagationStopped

false

Тип: Boolean

true - пропагирование запрещено, false - нет.

isDefaultPrevented

false

Тип: Boolean

true - действие по умолчанию запрещено, false - нет.

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

Методы

Имя

Возвращает

Описание

callMethod(name)

Object

Вызывает указанный метод. Операция эквивалентна поиску поля через get и вызову с передачей в качестве контекста originalEvent. Все аргументы после первого передаются в качестве параметров вызываемому методу.

get(name)

Object

Возвращает значение поля из originalEvent. originalEvent всегда имеет следующие поля:
• type - строковый тип события;

• target - ссылка на объект, породивший событие.

isDefaultPrevented()

Boolean

Проверяет, отменена ли реакция по умолчанию на событие в рамках системы событий API Яндекс.Карт.

isImmediatePropagationStopped()

Boolean

Определяет, прекращено ли распространение события в системе событий API Яндекс.Карт.

isPropagationStopped()

Boolean

Проверяет, остановлено ли распространение события по иерархии объектов и коллекций в системе событий API Яндекс.Карт.

preventDefault()

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

stopImmediatePropagation()

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

stopPropagation()

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

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

callMethod

{Object} callMethod(name)

Вызывает указанный метод. Операция эквивалентна поиску поля через get и вызову с передачей в качестве контекста originalEvent. Все аргументы после первого передаются в качестве параметров вызываемому методу.

Returns значение.

Параметры:

Параметр

Значение по умолчанию

Описание

name*

Тип: String

Имя метода.

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

get

{Object} get(name)

Возвращает значение поля из originalEvent. originalEvent всегда имеет следующие поля:

• type - строковый тип события;

• target - ссылка на объект, породивший событие.

Returns значение.

Параметры:

Параметр

Значение по умолчанию

Описание

name*

Тип: String

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

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

Пример:

// Синхронизируем два объекта между собой.
object1.events.add(["add", "remove"], function (event) {
    object2[event.get("type")](event.get("child"));
});

isDefaultPrevented

{Boolean} isDefaultPrevented()

Проверяет, отменена ли реакция по умолчанию на событие в рамках системы событий API Яндекс.Карт.

Returns true, если реакция на событие по умолчанию отменена, false - в противном случае.

isImmediatePropagationStopped

{Boolean} isImmediatePropagationStopped()

Определяет, прекращено ли распространение события в системе событий API Яндекс.Карт.

Returns true - распространение прекращено, false - нет.

isPropagationStopped

{Boolean} isPropagationStopped()

Проверяет, остановлено ли распространение события по иерархии объектов и коллекций в системе событий API Яндекс.Карт.

Returns true - распространение по иерархии отменено, false - нет.

preventDefault

{} preventDefault()

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

stopImmediatePropagation

{} stopImmediatePropagation()

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

stopPropagation

{} stopPropagation()

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

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

Предыдущая
Следующая