MapEvent

Расширяет Event.

Объект, описывающий произошедшее над картой событие. Имена полей, доступных через метод Event.get:

  • coords - географические координаты точки, в которой произошло событие;
  • globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
  • pagePixels - координаты события в глобальных пикселях от левого верхнего угла страницы (также доступно под именем position);
  • clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
  • domEvent - исходное DOM-событие (в виде объекта DomEvent), если оно имеется.

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

Конструктор

MapEvent(originalEvent[, sourceEvent])

Параметры:

Параметр

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

Описание

originalEvent*

—

Тип: Object

Данные, связанные с событием. Должны содержать поле "map" указывающее на карту, над которой произошло событие.

sourceEvent

—

Тип: IEvent

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

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

Пример:

// Откроем балун в точке клика по карте.
map.events.add('click', function (e) {
    map.balloon.open(e.get('coords'), 'Щелк!');});

Методы

Имя

Возвращает

Описание

allowMapEvent()

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

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

callMethod(name)

Object

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

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

get(name)

Object

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

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

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

getSourceEvent()

IEvent|null

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

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

isDefaultPrevented()

Boolean

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

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

isImmediatePropagationStopped()

Boolean

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

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

isMapEventAllowed()

Boolean

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

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

isPropagationStopped()

Boolean

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

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

preventDefault()

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

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

stopImmediatePropagation()

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

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

stopPropagation()

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

Унаследован от Event.
Предыдущая
map.ZoomRange
Следующая
mapType.storage