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

# IBalloon

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

Interface for a balloon.

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

## Constructor {#constructor-summary}

```javascript
IBalloon()
```

## Fields {#properties-summary}

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

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

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

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#event-close) | Closing the info object.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#event-close). ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#event-open) | Opening the info object.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#event-open). ||
|| [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Change to the object options.

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

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [autoPan](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloon.md#autoPan)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Moves the map so that the balloon is visible. ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#close)(\[[force](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#close-param-force)]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Closes the info object.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#close). ||
|| [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getData)() | | Returns info object data.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getData). ||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getOverlay)() | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Returns the promise object to return the overlay.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getOverlay). ||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md) | Returns the overlay, if one exists.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getOverlaySync). ||
|| [getPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getPosition)() | | Returns the coordinates of the info object.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#getPosition). ||
|| [isOpen](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#isOpen)() | Boolean | Returns the info object state: open/closed.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#isOpen). ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#open)(\[[position](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#open-param-position)[, [data](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#open-param-data)]]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Opens the info object at the specified position. If the info object is already open, it moves it to the specified point. The format and content of the coordinates is determined by the [IProjection](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IProjection.md) that is in the options.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#open). ||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#setData-param-data)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Defines new data for the info object.

Inherited from [IPopup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#setData). ||
|| [setPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#setPosition)([position](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopup.md#setPosition-param-position)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Specifies a new position for the info object.

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

## Methods details {#method_detail}

### autoPan {#autoPan}

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

Moves the map so that the balloon is visible.

**Returns** Promise object.