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

# map.Balloon

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

Map balloon manager. Each map already has its own balloon manager, available as myMap.balloon. Only one balloon controlled by this manager can be open on the map at a time. Don't create new instances of this class unless necessary.

**See** [Balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Balloon.md)[Map.balloon](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md#balloon)

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

## Constructor {#constructor-summary}

```javascript
map.Balloon(map)
```

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`map`](#param-map)[*](*star) | — | Type: [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Map.md)

Reference to a map object. ||
|#

\* Mandatory parameter/option.

## 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). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [autopanbegin](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-autopanbegin) | Start of automatic shifting of the map center initiated by the autoPan method. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- target - Reference to the [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonOwner.md) object.

Inherited from [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-autopanbegin). ||
|| [autopanend](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-autopanend) | End of automatic shifting of the map center initiated by the autoPan method. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- target - Reference to the [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonOwner.md) object.

Inherited from [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-autopanend). ||
|| [beforeuserclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-beforeuserclose) | The event which precedes [Balloon.event:userclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Balloon.md#event-userclose). Allows you to cancel the user's action by calling the preventDefault method. Instance of the Event class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- target - Reference to the [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonOwner.md) object.

Inherited from [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-beforeuserclose). ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-close) | Closing the info object. Names of fields available via [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get): 
- target - Reference to the object where the closing occurred.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-close). ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-open) | Opening the info object. Names of fields available via [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get): 
- target - Reference to the object where the opening occurred.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-open). ||
|| [userclose](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#event-userclose) | Balloon closed by the user. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. Names of fields that are available via the [Event.get](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get) method: 
- target - Reference to the [IBalloonOwner](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonOwner.md) object.

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

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [autoPan](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.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.

Inherited from [IBalloonManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IBalloonManager.md#autoPan). ||
|| [close](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#close)(\[[force](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.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 [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#close). ||
|| [destroy](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#destroy)() | | Disables the info object manager.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#destroy). ||
|| [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getData)() | Object\|null | Returns the data of the info object or 'null'.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getData). ||
|| [getOptions](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOptions)() | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md)\|null | Returns the options manager or 'null'.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOptions). ||
|| [getOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.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 [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlay). ||
|| [getOverlaySync](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlaySync)() | [IOverlay](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null | Returns the overlay, if one exists.

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

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

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#isOpen). ||
|| [open](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#open)(\[[position](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#open-param-position)[, [data](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#open-param-data)[, [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#open-param-options)]]]) | [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.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#open). ||
|| [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.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 [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setData). ||
|| [setOptions](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions)([options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions-param-options)) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Defines new options for the info object.

Inherited from [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions). ||
|| [setPosition](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setPosition)([position](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.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 [IPopupManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setPosition). ||
|#


[*star]: Mandatory parameter/option.