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

# IPane

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

Интерфейс пейна карты. Пейн карты представляет собой объект, размещающий внутри контейнера карты свой DOM-элемент с определенным zIndex. Пейн может служить контейнером для размещения отображений различных элементов карты, таких как тайлы, оверлеи, статические элементы управления картой и т.д. Также пейн может выполнять роль непрозрачного для DOM-событий экрана, на котором могут слушаться события мыши.

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

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

```javascript
IPane()
```

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## События {#events-summary}

#|
|| **Имя** | **Описание** ||
|| [overflowchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#event-overflowchange) | Изменение параметра "overflow", определяющего видимость содержимого пейна при выходе за пределы контейнера карты. Экземпляр [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md). ||
|| [zindexchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#event-zindexchange) | Изменение значения zIndex пейна. Экземпляр [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md). ||
|#


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [destroy](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#destroy)() | | Уничтожает пейн. ||
|| [getElement](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#getElement)() | HTMLElement | Возвращает ссылку на DOM-контейнер пейна. ||
|| [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает карту, которой принадлежит пейн. ||
|| [getOverflow](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#getOverflow)() | String | Возвращает значение параметра "overflow", определяющего видимость содержимого пейна при выходе за пределы контейнера карты. Данный параметр может принимать одно из следующих строковых значений:
- "visible" - при выходе за пределы контейнера карты содержимое пейна остается видимым;
- "hidden" - область отображения содержимого пейна ограничена контейнером карты. ||
|| [getZIndex](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md#getZIndex)() | Number | Возвращает zIndex пейна. ||
|#

## Описание событий {#event_detail}

### overflowchange {#overflowchange}

Изменение параметра "overflow", определяющего видимость содержимого пейна при выходе за пределы контейнера карты. Экземпляр [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md).

### zindexchange {#zindexchange}

Изменение значения zIndex пейна. Экземпляр [IEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEvent.md).

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

### destroy {#destroy}

```javascript
{} destroy()
```

Уничтожает пейн.

### getElement {#getElement}

```javascript
{HTMLElement} getElement()
```

**Возвращает** ссылку на DOM-контейнер пейна.

### getMap {#getMap}

```javascript
{Map} getMap()
```

**Возвращает** карту, которой принадлежит пейн.

### getOverflow {#getOverflow}

```javascript
{String} getOverflow()
```

**Возвращает** значение параметра "overflow", определяющего видимость содержимого пейна при выходе за пределы контейнера карты. Данный параметр может принимать одно из следующих строковых значений:
- "visible" - при выходе за пределы контейнера карты содержимое пейна остается видимым;
- "hidden" - область отображения содержимого пейна ограничена контейнером карты.

### getZIndex {#getZIndex}

```javascript
{Number} getZIndex()
```

**Возвращает** zIndex пейна.

<!-- XLIFF_FARM_YWY0ZWIz_CACHING -->