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

# clusterer.Balloon

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

Менеджер балуна кластеризатора. Позволяет управлять балуном кластера, открывать и скрывать его. Использует внутри себя менеджер балуна карты [map.Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.Balloon.md). Кластеризаторы содержат экземпляр этого класса, доступный как myClusterer.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
clusterer.Balloon(clusterer)
```

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

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

Кластеризатор. ||
|#

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

## Поля {#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).||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/clusterer.Balloon.md#open) | | Открытие балуна на кластере. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на менеджер балуна кластеризатора;
- cluster - ссылка на объект-кластер.
Экземпляр класса Event. ||
|#


## События {#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/clusterer.Balloon.md#event-close) | Закрытие балуна.
- target - ссылка на менеджер балуна кластеризатора;
- cluster - ссылка на объект-кластер.
Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).||
|| [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/IPopupManager.md#close)(\[[force](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#close-param-force)]) | [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#close).||
|| [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/IPopupManager.md#getData)() | Object\|null | Возвращает данные инфо-объекта или null.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getData).||
|| [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/IPopupManager.md#isOpen)() | Boolean | Возвращает состояние инфо-объекта: открыт/закрыт.

Унаследован от [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#isOpen).||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setData-param-data)) | [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#setData).||
|| [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). ||
|#

# Описание полей {#field_detail}

### open {#open}

```javascript
open
```

Открытие балуна на кластере. Имена полей, доступных через метод [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на менеджер балуна кластеризатора;
- cluster - ссылка на объект-кластер.
Экземпляр класса Event.

**Пример:**

```javascript
clusterer.balloon.events.add('open', function (e) {
    var clusterPlacemark = e.get('cluster');
});
```

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

### close

Закрытие балуна.
- target - ссылка на менеджер балуна кластеризатора;
- cluster - ссылка на объект-кластер.
Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

<!-- XLIFF_FARM_YTljMGNh_CACHING -->

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