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

# IDomEvent

Расширяет [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md).

Объект DOM-события в системе API Яндекс Карт. Оборачивает оригинальное DOM-событие браузера с целью нормализации имен полей данных. Т.е. посредством методов get и callMethod можно получать доступ к полям и методам оригинального DOM-события. При этом автоматически выполняется приведение к стандарту для тех полей и методов, реализация которых различна в разных браузерах. Так, event.callMethod('stopPropagation') остановит распространение DOM-события во всех браузерах, включая Internet Explorer.

[Конструктор](#constructor-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
IDomEvent(originalEvent)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`originalEvent`](#param-originalEvent)[*](*star) | — | Тип: Object

Исходное DOM-событие. ||
|#

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

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [allowMapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#allowMapEvent)() | | Разрешает распространение данного события на карту.

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#allowMapEvent). ||
|| [callMethod](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#callMethod)([name](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#callMethod-param-name)) | | Вызывает указанный метод у исходного события. Второй и последующие аргументы передаются методу при вызове.

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#callMethod). ||
|| [get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#get)([name](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#get-param-name)) | Object | Возвращает заданное свойство события. С помощью этого метода можно получать доступ как к свойствам исходного события, так и к дополнительным свойствам, предоставляемым API карт. ||
|| [getSourceEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#getSourceEvent)() | [IDomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md) | Возвращает исходное DOM-событие. ||
|| [isDefaultPrevented](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isDefaultPrevented)() | Boolean | Возвращает true, если реакция по умолчанию на событие отменена.

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isDefaultPrevented). ||
|| [isImmediatePropagationStopped](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isImmediatePropagationStopped)() | Boolean | Возвращает true, если обработка события прервана.

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isImmediatePropagationStopped). ||
|| [isMapEventAllowed](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isMapEventAllowed)() | Boolean | Возвращает true, если событие карты разрешено.

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isMapEventAllowed). ||
|| [isPropagationStopped](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isPropagationStopped)() | Boolean | Возвращает true, если распространение события прервано,

Унаследован от [IEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md#isPropagationStopped). ||
|| [preventDefault](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#preventDefault)() | | Отменяет реакцию по умолчанию на событие в рамках системы событий API Яндекс Карт. Вызов этого метода не влияет на обработку браузером действия по умолчанию исходного DOM-события. ||
|| [stopImmediatePropagation](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#stopImmediatePropagation)() | | Прекращает обработку события в системе событий API Яндекс Карт. Т.е. после вызова данного метода ни один обработчик данного события не будет вызван. Вызов этого метода не влияет на обработку исходного DOM-события на уровне браузера. ||
|| [stopPropagation](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEvent.md#stopPropagation)() | | Прекращает распространение DOM-события в системе событий API Яндекс Карт. Вызов этого метода не влияет на распространение исходного DOM-события по DOM-дереву. ||
|#

## Описание методов {#method_detail}

### get {#get}

```javascript
{Object} get(name)
```

Возвращает заданное свойство события. С помощью этого метода можно получать доступ как к свойствам исходного события, так и к дополнительным свойствам, предоставляемым API карт.

**Возвращает** значение свойства.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`name`](#get-param-name)[*](*star) | — | Тип: String

Имя свойства. Поддерживаются дополнительные свойства:
- 'propagatedData' - данные события, которые сохраняются при его пропагировании (распространении по DOM-дереву);
- 'position' - необязательное поле, которое содержит координаты события относительно документа. ||
|#

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

### getSourceEvent {#getSourceEvent}

```javascript
{IDomEvent} getSourceEvent()
```

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

### preventDefault {#preventDefault}

```javascript
{} preventDefault()
```

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

### stopImmediatePropagation {#stopImmediatePropagation}

```javascript
{} stopImmediatePropagation()
```

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

### stopPropagation {#stopPropagation}

```javascript
{} stopPropagation()
```

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

<!-- XLIFF_FARM_MDFlNzFm_CACHING -->

[*star]: Обязательный параметр.