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

# objectManager.Balloon

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

Менеджер балуна коллекций ObjectManager. Позволяет управлять балуном объекта, открывать и скрывать его. Использует внутри себя менеджер балуна карты [map.Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.Balloon.md). Коллекции объектов в составе [ObjectManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ObjectManager.md) содержат экземпляр этого класса, доступный как myObjectManager.objects.balloon и myObjectsLayer.clusters.balloon. Не создавайте экземпляры этого класса без необходимости.

**См.:**[Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Balloon.md)

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

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

```javascript
objectManager.Balloon(collection)
```

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

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

Коллекция объектов. ||
|#

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

## Поля {#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}

#|
|| **Имя** | **Описание** ||
|| [autopanbegin](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-autopanbegin) | Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonOwner.md).

Унаследовано от [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-autopanbegin). ||
|| [autopanend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-autopanend) | Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonOwner.md).

Унаследовано от [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-autopanend). ||
|| [beforeuserclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-beforeuserclose) | Событие, предшествующее событию [Balloon.userclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Balloon.md#event-userclose). Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonOwner.md).

Унаследовано от [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-beforeuserclose). ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-close) | Закрытие инфо-объекта. Названия полей доступны через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект, на котором был закрыт инфо-объект.

Унаследовано от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-close). ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-open) | Открытие инфо-объекта. Названия полей доступны через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект, на котором был открыт инфо-объект.

Унаследовано от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-open). ||
|| [userclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#event-userclose) | Закрытие балуна пользователем. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonOwner.md).

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

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [autoPan](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#autoPan)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Перемещает карту таким образом, чтобы балун оказался видимым.

Унаследован от [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IBalloonManager.md#autoPan). ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#close)(\[[force](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#close-param-force)]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Закрывает открытый балун. ||
|| [destroy](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#destroy)() | | Отключает менеджер инфо-объекта.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#destroy). ||
|| [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#getData)() | Object\|null | Возвращает хэш с описание объекта, на котором открыт балун или null, если балун не был открыт. ||
|| [getOptions](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOptions)() | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md)\|null | Возвращает менеджер опций или null.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOptions). ||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlay)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание вернуть оверлей.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlay). ||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Возвращает оверлей, если тот существует.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlaySync). ||
|| [getPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getPosition)() | Number[]\|null | Возвращает координаты инфо-объекта или `null`.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getPosition). ||
|| [isOpen](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#isOpen)([id](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#isOpen-param-id)) | Boolean | Метод, определяющий, открыт ли балун на объекте с переданным идентификатором. ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#open)([objectId](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#open-param-objectId), [anchorPixelPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#open-param-anchorPixelPosition)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Открывает балун на объекте с переданным идентификатором. ||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#setData)([objectData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Balloon.md#setData-param-objectData)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт новые данные для отображения балуна. ||
|| [setOptions](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions)([options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions-param-options)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новые опции.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions). ||
|| [setPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setPosition)([position](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setPosition-param-position)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новую позицию.

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

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

### close {#close}

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

Закрывает открытый балун.

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

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

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

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


**Пример:**

```javascript
// Закроем все балуны на слое.
objectManager.objects.balloon.close();
objectManager.clusters.balloon.close();
```

### getData {#getData}

```javascript
{Object|null} getData()
```

**Возвращает** хэш с описание объекта, на котором открыт балун или null, если балун не был открыт.

**Пример:**

```javascript
var cluster = objectManager.clusters.balloon.getData();
if (cluster) {
    alert('Сейчас открыт балун кластера с ' + cluster.properties.geoObjects.length + ' объектами.');;}
```

### isOpen {#isOpen}

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

Метод, определяющий, открыт ли балун на объекте с переданным идентификатором.

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

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

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

Идентификатор объекта. ||
|#

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

**Пример:**

```javascript
// При повторном клике на метку будем закрывать балун.
objectManager.objects.options.set('hideIconOnBalloonOpen', false);
objectManager.objects.events.add('click', function (e) {
    var objectId = e.get('objectId');
    if (objectManager.objects.balloon.isOpen(objectId)) {
        objectManager.objects.balloon.close();
    }
});
```

### open {#open}

```javascript
{vow.Promise} open(objectId, anchorPixelPosition)
```

Открывает балун на объекте с переданным идентификатором.

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

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

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

Идентификатор объекта, на котором надо открыть балун. ||
|| [`anchorPixelPosition`](#open-param-anchorPixelPosition)[*](*star) | — | Тип: ||
|#

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

**Пример:**

```javascript
// Загрузка данных объекта перед открытием балуна.
// Отменим автоматическое открытие балуна по клику на объекте.
objectManager.options.set('geoObjectOpenBalloonOnClick', false);
objectManager.objects.events.add('click', function (e) {
    var objectId = e.get('objectId');
      // По клику на объекте вызовем подгрузку данных для объекта.
    loadObjectData(objectId).then(function (data) {
        // Как только данные будут готовы, зададим их объекту и откроем балун.
        objectManager.objects.getById(objectId).properties = data;
        objectManager.objects.balloon.open(objectId);
    });
});
```

### setData {#setData}

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

Задаёт новые данные для отображения балуна.

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

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

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

Хэш с описанием объекта, на котором открыт балун. Соответствует описанию объекта, который подается на вход ObjectManager.add. ||
|#

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

**Пример:**

```javascript
// Подгрузка данных после открытия балуна на объекте.
objectManager.objects.events.add('balloonopen', function (e) {
    var objectId = e.get('objectId'),
        object = objectManager.objects.getById(objectId);
    if (!object.properties) {
        loadObjectData(objectId).then(function (data) {
            if (objectManager.balloon.isOpen(objectid)) {
                object.properties = data;
                objectManager.objects.balloon.setData(object);
            }
        });
    }
});
```

<!-- XLIFF_FARM_Mzk1NTRl_CACHING -->

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