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

# map.pane.Manager

Менеджер пейна карты. У каждой карты уже есть свой менеджер пейнов, доступный как map.panes. Не создавайте экземпляры этого класса без необходимости. Список ключей доступных по умолчанию пейнов карты и их zIndex'ы:
- 'ground': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 100) — самый нижний пейн, предназначенный для размещения подложки карты;
- 'areas': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 200) - панель для объектов с площадью, таких как многоугольники.
- 'shadows': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 300) — пейн теней объектов карты, находящихся выше;
- 'places': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 400) — пейн точечных объектов, таких как метки;
- 'events': [pane.EventsPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.EventsPane.md) (zIndex: 500) — пейн, предназначенный для слушания событий карты;
- 'overlaps': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 600) — пейн для объектов, не требующих использования активных областей для реализации своей интерактивности;
- 'balloon': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 700) — пейн балуна;
- 'outerBalloon': [pane.MovablePane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.MovablePane.md) (zIndex: 800) — внешний пейн балуна;
- 'controls': [pane.StaticPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.StaticPane.md) (zIndex: 900) — пейн элементов управления карты;
- 'hint': [pane.StaticPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.StaticPane.md) (zIndex: 1100) — пейн всплывающей подсказки;
- 'outerHint': [pane.StaticPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/pane.StaticPane.md) (zIndex: 1200) — внешний пейн всплывающей подсказки;

**См.:** [Map.panes](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md#panes)

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

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

```javascript
map.pane.Manager(map)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`map`](#param-map)[*](*star) | — | Тип: [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md)

Карта. ||
|#

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

**Пример:**

```javascript
// Добавим водяной знак над контейнером карты.
// Для этого изменим background у контейнера событий.
map.panes.get('events').getElement().style.backgroundImage = 'my/background/image';
```

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [append](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#append)([key](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#append-param-key), [pane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#append-param-pane)) | | Добавляет новый пейн в карту. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты. ||
|| [destroy](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#destroy)() | | Деструктор. ||
|| [get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#get)([key](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#get-param-key)) | [IPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md)\|null | Возвращает пейн карты с заданным ключом, либо null, если такой пейн в данной карте отсутствует. ||
|| [getLower](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#getLower)() | String | Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого нижнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты. ||
|| [getUpper](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#getUpper)() | String | Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого верхнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты. ||
|| [insertBefore](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#insertBefore)([key](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#insertBefore-param-key), [pane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#insertBefore-param-pane), [referenceKey](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#insertBefore-param-referenceKey)) | | Вставляет новый пейн перед другим пейном карты. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты. ||
|| [remove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#remove)([pane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md#remove-param-pane)) | | Удаляет пейн из карты. ||
|#

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

### append {#append}

```javascript
{} append(key, pane)
```

Добавляет новый пейн в карту. Ключ добавляемого пейна должен быть уникальным в рамках текущего набора ключей пейнов карты.

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

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

Ключ добавляемого пейна. ||
|| [`pane`](#append-param-pane)[*](*star) | — | Тип: [IPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md)

Добавляемый пейн. ||
|#

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

### destroy {#destroy}

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

Деструктор.

### get {#get}

```javascript
{IPane|null} get(key)
```

**Возвращает** пейн карты с заданным ключом, либо null, если такой пейн в данной карте отсутствует.

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

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

Ключ пейна. ||
|#

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

### getLower {#getLower}

```javascript
{String} getLower()
```

Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого нижнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты.

**Возвращает** ключ самого нижнего пейна карты.

### getUpper {#getUpper}

```javascript
{String} getUpper()
```

Принимает в качестве аргументов ключи пейнов карты и возвращает ключ самого верхнего пейна из переданного набора. Если ключи на заданы, поиск выполняется по всем пейнам карты.

**Возвращает** ключ самого верхнего пейна карты.

### insertBefore  {#insertBefore}

```javascript
{} insertBefore(key, pane, referenceKey)
```

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

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

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

Ключ добавляемого пейна. ||
|| [`pane`](#insertBefore-param-pane)[*](*star) | — | Тип: [IPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md)

Добавляемый пейн. ||
|| [`referenceKey`](#insertBefore-param-referenceKey)[*](*star) | — | Тип: String

Ключ пейна, перед которым нужно добавить новый пейн. ||
|#

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

### remove  {#remove}

```javascript
{} remove(pane)
```

Удаляет пейн из карты.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`pane`](#remove-param-pane)[*](*star) | — | Тип: [IPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPane.md)

Удаляемый пейн. ||
|#

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

<!-- XLIFF_FARM_MDRjN2U0_CACHING -->

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