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

# IPopup

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

Интерфейс инфо-объекта.

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

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

```javascript
IPopup()
```

## Поля {#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). ||
|| [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

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

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

#|
|| **Имя** | **Описание** ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#event-close) | Закрытие инфо-объекта. ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#event-open) | Открытие инфо-объекта. ||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

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


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#close)(\[[force](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#close-param-force)]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Закрывает инфо-объект. ||
|| [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#getData)() | |Возвращает данные инфо-объекта. ||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#getOverlay)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание вернуть оверлей. ||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md) | Возвращает оверлей, если тот существует. ||
|| [getPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#getPosition)() | | Возвращает координаты инфо-объекта. ||
|| [isOpen](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#isOpen)() | Boolean | Возвращает состояние инфо-объекта: открыт/закрыт. ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#open)(\[[position](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#open-param-position)[, [data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#open-param-data)]]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией [IProjection](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IProjection.md), которая содержится в опциях. ||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#setData-param-data)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новые данные. ||
|| [setPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#setPosition)([position](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopup.md#setPosition-param-position)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новую позицию. ||
|#

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

### close {#close}

Закрытие инфо-объекта.

### open {#open}

Открытие инфо-объекта.

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

### close {#close}

```javascript
{vow.Promise} close([force])
```

Закрывает инфо-объект.

**Возвращает** объект-promise.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`force`](#close-param-force) | false | Тип: Boolean

Мгновенное закрытие. ||
|#


### getData {#getData}

```javascript
{} getData()
```

**Возвращает** данные инфо-объекта.

### getOverlay {#getOverlay}

```javascript
{vow.Promise} getOverlay()
```

**Возвращает** объект-обещание вернуть оверлей.

### getOverlaySync {#getOverlaySync}

```javascript
{IOverlay} getOverlaySync()
```

**Возвращает** оверлей, если тот существует.

### getPosition {#getPosition}

```javascript
{} getPosition()
```

**Возвращает** координаты инфо-объекта.

### isOpen {#isOpen}

```javascript
{Boolean} isOpen()
```

**Возвращает** состояние инфо-объекта: открыт/закрыт.

### open {#open}

```javascript
{vow.Promise} open([position[, data]])
```

Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией [IProjection](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IProjection.md), которая содержится в опциях.

**Возвращает** объект-promise.

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

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

Точка, где необходимо расположить балун. ||
|| [`data`](#open-param-data) | — | Тип: Object\|String\|HTMLElement

Данные оверлея. ||
|#

### setData {#setData}

```javascript
{vow.Promise} setData(data)
```

Задаёт инфо-объекту новые данные.

**Возвращает** объект-promise.

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

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

Данные инфо-объекта. ||
|#

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

### setPosition  {#setPosition}

```javascript
{vow.Promise} setPosition(position)
```

Задаёт инфо-объекту новую позицию.

**Возвращает** объект-promise.

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

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

Координаты инфо-объекта. ||
|#

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

<!-- XLIFF_FARM_YTNkMzQ0_CACHING -->

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