YMaps.MouseEvent

Событие мыши на карте. Объект передается в обработчики событий мыши на карте.

Конструктор

Имя Описание
YMaps.MouseEvent(e, map) Создает объект события мыши на карте.

Методы

Имя Возвращает Описание
getCoordPoint(unbounded) YMaps.ICoordPoint Возвращает географические координаты места события на карте.
getEvent() DOMEvent Возвращает указатель на произошедшее DOM-событие.
getGeoPoint(unbounded) YMaps.ICoordPoint То же, что и YMaps.MouseEvent.getCoordPoint.
getLocalPixels() YMaps.Point Возвращает локальные пиксельные координаты события на карте.
isMapEventPrevented() Boolean Возвращает true, если для текущего события мыши действие карты по умолчанию подавлено с помощью метода YMaps.MouseEvent.preventMapEvent, в противном случае - false.
preventMapEvent() Подавляет генерацию события карты по умолчанию для указанного события мыши, при этом соответствующее пред-событие не подавляется.

Подробное описание конструктора

YMaps.MouseEvent(e, map)

Создает объект события мыши на карте.

Параметры:

Имя Тип Описание
e DOMEvent|Object Указатель на событие мыши. Может быть как DOM-событием, так и объектом-событием jQuery.
map YMaps.Map Карта, на которой произошло событие.

Подробное описание методов

getCoordPoint

{YMaps.ICoordPoint} getCoordPoint(unbounded)

Возвращает географические координаты места события на карте.

Параметры:

Имя Тип Необязательный По умолчанию Описание
unbounded Boolean false Флаг, указывающий тип возвращаемой точки: ограниченная или нет.

Возвращает:

Тип Описание
YMaps.ICoordPoint Географические координаты места события на карте.

getEvent

{DOMEvent} getEvent()

Возвращает указатель на произошедшее DOM-событие.

Возвращает:

Тип Описание
DOMEvent Указатель на DOM-событие.

getGeoPoint

{YMaps.ICoordPoint} getGeoPoint(unbounded)

То же, что и YMaps.MouseEvent.getCoordPoint.

Параметры:

Имя Тип Необязательный По умолчанию Описание
unbounded Boolean false Флаг, указывающий тип возвращаемой точки: ограниченная или нет.

Возвращает:

Тип Описание
YMaps.ICoordPoint Координаты точки места события.

getLocalPixels

{YMaps.Point} getLocalPixels()

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

Возвращает:

Тип Описание
YMaps.Point Локальные пиксельные координаты события на карте.

isMapEventPrevented

{Boolean} isMapEventPrevented()

Возвращает true, если для текущего события мыши действие карты по умолчанию подавлено с помощью метода YMaps.MouseEvent.preventMapEvent, в противном случае - false.

См.: YMaps.MouseEvent.preventMapEvent

Возвращает:

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

preventMapEvent

preventMapEvent()

Подавляет генерацию события карты по умолчанию для указанного события мыши, при этом соответствующее пред-событие не подавляется. Вызов метода приводит к отмене действия карты по умолчанию для указанного события.

Пример:

// Подавление события мыши click.
// По умолчанию событию мыши click соответствует событие карты {@link YMaps.Map.Events.Click}. 
// После вызова метода preventMapEvent для события click будет подавляться
// генерация события {@link YMaps.Map.Events.Click} и карта перестанет реагировать на щелчки мыши.
// При этом, по каждому щелчку по-прежнему будет генерироваться пред-событие {@link YMaps.Map.Events.BeforeClick}.
YMaps.Events.observe(map, map.Events.BeforeClick, function (e) {
    e.preventMapEvent();
});