---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.MouseEvent

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

Имя | Описание
----- | -----
[YMaps.MouseEvent](mouseevent.md#constructor)(e, map) | Создает объект события мыши на карте.

## Методы

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


## Подробное описание конструктора {#constructor}

```javascript
YMaps.MouseEvent(e, map)
```

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

**Параметры:**

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

## Подробное описание методов {#method_detail}

### getCoordPoint {#getCoordPoint}

```javascript
{YMaps.ICoordPoint} getCoordPoint(unbounded)
```

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

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`unbounded` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий тип возвращаемой точки: ограниченная или нет.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Географические координаты места события на карте.

### getEvent {#getEvent}

```javascript
{DOMEvent} getEvent()
```

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

**Возвращает:**

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

### getGeoPoint {#getGeoPoint}

```javascript
{YMaps.ICoordPoint} getGeoPoint(unbounded)
```

То же, что и [YMaps.MouseEvent.getCoordPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md#getCoordPoint).

**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`unbounded` | Boolean | ![](../_images/check.png) | false | Флаг, указывающий тип возвращаемой точки: ограниченная или нет.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Координаты точки места события.

### getLocalPixels {#getLocalPixels}

```javascript
{YMaps.Point} getLocalPixels()
```

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

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Point](point.md) | Локальные пиксельные координаты события на карте.

### isMapEventPrevented {#isMapEventPrevented}

```javascript
{Boolean} isMapEventPrevented()
```

Возвращает true, если для текущего события мыши действие карты по умолчанию подавлено с помощью метода [YMaps.MouseEvent.preventMapEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md#preventMapEvent), в противном случае - false.

**См.:** [YMaps.MouseEvent.preventMapEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md#preventMapEvent)

**Возвращает:**

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

### preventMapEvent {#preventMapEvent}

```javascript
preventMapEvent()
```

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

**Пример:**

```javascript
// Подавление события мыши 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();
});
```