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

# IPane

Extends [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md).

Interface for a map pane. The map pane is an object that hosts its DOM element with a certain zIndex inside the map container. A pane can serve as a container to hold representations of various map elements, such as tiles, overlays, static map controls, etc. A pane can also act as a non-transparent screen for DOM events where you can listen to mouse events.

[Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
IPane()
```

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager.

Inherited from [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [overflowchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#event-overflowchange) | Change to the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. Instance of [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md). ||
|| [zindexchange](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#event-zindexchange) | Change to the zIndex value of a pane. Instance of [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md). ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [destroy](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#destroy)() | | Destroys the pane. ||
|| [getElement](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#getElement)() | HTMLElement | Returns a reference to the pane's DOM container. ||
|| [getMap](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#getMap)() | [Map](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md) | Returns the map that the pane belongs to. ||
|| [getOverflow](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#getOverflow)() | String | Returns value of the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. This parameter can take one of the following string values: 
- "visible" - When you go off the map container, the content of the pane remains visible.
- "hidden" - The viewport for the pane content is limited by the map container. ||
|| [getZIndex](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPane.md#getZIndex)() | Number | Returns the zIndex of the pane. ||
|#

## Events details {#event_detail}

### overflowchange {#overflowchange}

Change to the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. Instance of [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md).
# zindexchange

Change to the zIndex value of a pane. Instance of [IEvent](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEvent.md).

## Methods details {#method_detail}

### destroy {#destroy}

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

Destroys the pane.

### getElement {#getElement}

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

**Returns** a reference to the pane's DOM container.

# getMap {#getMap}

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

**Returns** the map that the pane belongs to.

### getOverflow {#getOverflow}

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

**Returns** value of the "overflow" parameter, which defines visibility of the pane contents when going outside of the map container. This parameter can take one of the following string values: 
- "visible" - When you go off the map container, the content of the pane remains visible.
- "hidden" - The viewport for the pane content is limited by the map container.

### getZIndex {#getZIndex}

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

**Returns** the zIndex of the pane.