MapEvent

Расширяет Event.

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

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

Конструктор

MapEvent(originalEvent, map)

Параметры:

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

Тип: Object

Данные, связанные с событием.

map *

Тип: Map

Карта, над которой произошло событие.

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

Примеры:

1.

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

2.

// Симулируем двойной клик над картой
map.events.fire('dblclick', new ymaps.MapEvent({
    type: 'dblclick',
    position: [300, 400],
    target: map
}, map));

// Также можно передавать в метод fire просто хэш с данными.
// Менеджер событий карты автоматически создаст объект MapEvent.
map.events.fire('dblclick', {
    position: [300, 400]
});

Методы

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

Object

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

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

get(name)

Object

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

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

getMap()

Map

Returns карту, над которой произошло событие.

isDefaultPrevented()

Boolean

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

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

isImmediatePropagationStopped()

Boolean

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

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

isPropagationStopped()

Boolean

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

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

preventDefault()

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

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

stopImmediatePropagation()

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

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

stopPropagation()

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

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

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

getMap

{Map} getMap()

Returns карту, над которой произошло событие.