---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/balloon.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Balloon

Расширяет [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md).

Балун.

Объект балуна создается картой и существует в единственном экземпляре.

Управление балуном осуществляется с помощью методов [YMaps.Map.openBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#openBalloon) и [YMaps.Map.closeBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#closeBalloon).

**См.:** [Балун](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-add-balloon.md)
# Конструктор

Имя | Описание
----- | -----
[YMaps.Balloon](balloon.md#constructor)(options) | Создает балун (balloon) с текстом, картинкой или любым другим HTML-содержимым.


## Поля

Имя | Описание
----- | -----
[Events](balloon.md#Events) | Список обрабатываемых событий балуна.

# События

Имя | Описание
----- | -----
[Close](balloon.md#event-Close) | Щелчок по кнопке закрытия балуна.
[CloseButtonClick](balloon.md#event-CloseButtonClick) | Щелчок по кнопке закрытия балуна.

# Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getContent](balloon.md#getContent)() | String|HTMLElement|[YMaps.ILayout](ilayout.md) | Возвращает содержимое балуна, установленное с помощью метода [YMaps.Balloon.setContent](balloon.md#setContent).
[getContentLayout](balloon.md#getContentLayout)() | [YMaps.ILayout](ilayout.md) | Возвращает макет содержимого балуна.
[getCoordPoint](balloon.md#getCoordPoint)() | [YMaps.ICoordPoint](icoordpoint.md) | Возвращает координаты балуна на карте.
[getGeoPoint](balloon.md#getGeoPoint)() | [YMaps.ICoordPoint](icoordpoint.md) | То же, что и [YMaps.Balloon.getCoordPoint](balloon.md#getCoordPoint).
[getLayout](balloon.md#getLayout)() | [YMaps.IBalloonLayout](iballoonlayout.md) | Возвращает макет балуна.
[getOptions](balloon.md#getOptions)() | [YMaps.BalloonOptions](balloonoptions.md) | Возвращает опции балуна.
[mapAutoPan](balloon.md#mapAutoPan)(callback) |  | Сдвигает карту таким образом, чтобы балун было видно целиком. C помощью опции [YMaps.BalloonOptions.margin](balloonoptions.md#margin), можно задать минимальный отступ балуна от края карты (в пикселах).
[setContent](balloon.md#setContent)(content) |  | Устанавливает содержимое балуна.
[setCoordPoint](balloon.md#setCoordPoint)(coordPoint) |  | Позиционирует балун в точку с заданными координатами.
[setGeoPoint](balloon.md#setGeoPoint)(coordPoint) |  | То же, что и [YMaps.Balloon.setCoordPoint](balloon.md#setCoordPoint).
[setOptions](balloon.md#setOptions)(options, restoreDefault) |  | Устанавливает опции балуна.
[update](balloon.md#update)() |  | Полностью перестраивает балун.

## Наследуемые методы

Из [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md):
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onAddToMap), [onMapUpdate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onMapUpdate), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onRemoveFromMap)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.Balloon(options)
```

Создает балун (balloon) с текстом, картинкой или любым другим HTML-содержимым.

Балун состоит из области, в которой показывается HTML-содержимое и клиновидного "хвостика", указывающего определенную точку на карте. Балун, например, всплывает при щелчке мыши по метке. Балун является оверлеем.

**См.:** [Балун](https://yandex.ru/dev/jsapi-v1-1/doc/ru/dg/tasks/how-to-add-balloon.md)

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | [YMaps.BalloonOptions](balloonoptions.md) | ![](../_images/check.png) |  | Опции балуна.

## Подробное описание полей {#field_detail}


### Events {#Events}

```javascript
Object Events
```

Список обрабатываемых событий балуна.

## Подробное описание событий {#event_detail}

### Close {#Close}

```javascript
Close
```

Щелчок по кнопке закрытия балуна. Для подписки на событие закрытия балуна используйте событие карты YMaps.Event.BalloonClose. В callback-функцию передается указатель на балун.
### CloseButtonClick {#CloseButtonClick}

```javascript
CloseButtonClick
```

Щелчок по кнопке закрытия балуна. Для подписки на событие закрытия балуна используйте событие карты YMaps.Event.BalloonClose. В callback-функцию передается указатель на балун.

## Подробное описание методов {#method_detail}

### getContent {#getContent}

```javascript
{String|HTMLElement|YMaps.ILayout} getContent()
```

Возвращает содержимое балуна, установленное с помощью метода [YMaps.Balloon.setContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/balloon.md#setContent).

**Возвращает:**

Тип | Описание
----- | -----
String|HTMLElement|[YMaps.ILayout](ilayout.md) | Содержимое балуна.

### getContentLayout {#getContentLayout}

```javascript
{YMaps.ILayout} getContentLayout()
```

Возвращает макет содержимого балуна. Если балун не добавлен на карту, то возвращает null.

**Пример:**

```javascript
var layout = map.getBalloon().getContentLayout();
layout.getRootNodes().css('font-weight', 'bold');
```

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ILayout](ilayout.md) | Макет содержимого балуна.

### getCoordPoint {#getCoordPoint}

```javascript
{YMaps.ICoordPoint} getCoordPoint()
```

Возвращает координаты балуна на карте.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Координаты балуна.

### getGeoPoint {#getGeoPoint}

```javascript
{YMaps.ICoordPoint} getGeoPoint()
```

То же, что и [YMaps.Balloon.getCoordPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/balloon.md#getCoordPoint).

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ICoordPoint](icoordpoint.md) | Координаты балуна.

### getLayout {#getLayout}

```javascript
{YMaps.IBalloonLayout} getLayout()
```

Возвращает макет балуна. Если балун не добавлен на карту, то возвращает null.

**Пример:**

```javascript
map.openBalloon(map.getCenter(), '<button class="my-button">Hello world</button>');
var layout = map.getBalloon().getLayout();
YMaps.jQuery(layout.getRootNodes()).find('.my-button').click(function() {
    alert('Hello world');
});
```

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.IBalloonLayout](iballoonlayout.md) | Макет балуна.

### getOptions {#getOptions}

```javascript
{YMaps.BalloonOptions} getOptions()
```

Возвращает опции балуна.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.BalloonOptions](balloonoptions.md) | Объект опций.

### mapAutoPan {#mapAutoPan}

```javascript
mapAutoPan(callback)
```

Сдвигает карту таким образом, чтобы балун было видно целиком. C помощью опции [YMaps.BalloonOptions.margin](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/balloonoptions.md#margin), можно задать минимальный отступ балуна от края карты (в пикселах).

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

Имя | Тип | Описание
----- | ----- | -----
`callback` | Function | Функция-обработчик для события окончания сдвига карты. Параметром передается результат сдвига карты: [YMaps.State.SUCCESS](state.md#SUCCESS) - успешно, [YMaps.State.FAILURE](state.md#FAILURE) - неуспешно.

### setContent {#setContent}

```javascript
setContent(content)
```

Устанавливает содержимое балуна. Если в параметре content передана строка, то контейнером для содержимого балуна станет элемент div. Переданная строка станет значением свойства innerHTML элемента div.

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

Имя | Тип | Описание
----- | ----- | -----
`content` | String|HTMLElement|[YMaps.ILayout](ilayout.md) | Содержимое балуна (строка, DOM-элемент или макет).

### setCoordPoint {#setCoordPoint}

```javascript
setCoordPoint(coordPoint)
```

Позиционирует балун в точку с заданными координатами.

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

Имя | Тип | Описание
----- | ----- | -----
`coordPoint` | [YMaps.ICoordPoint](icoordpoint.md) | Координаты балуна на карте.

### setGeoPoint {#setGeoPoint}

```javascript
setGeoPoint(coordPoint)
```

То же, что и [YMaps.Balloon.setCoordPoint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/balloon.md#setCoordPoint).

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

Имя | Тип | Описание
----- | ----- | -----
`coordPoint` | [YMaps.ICoordPoint](icoordpoint.md) | Координаты балуна на карте.

### setOptions {#setOptions}

```javascript
setOptions(options, restoreDefault)
```

Устанавливает опции балуна.

**Примеры:**

**1.**

```javascript
// Передает опции с помощью метода карты openBalloon() и открывает балун.
map.openBalloon(new YMaps.GeoPoint(37, 55), 'Здесь был Я.', {hasCloseButton: false, mapAutoPan: 0});
```

**2.**

```javascript
// Передает опции после открытия балуна, не задействуя метод openBalloon.
map.getBalloon().setOptions({hasCloseButton: false, mapAutoPan: 0});
```

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | [YMaps.BalloonOptions](balloonoptions.md) |  |  | Объект опций.
`restoreDefault` | Boolean | ![](../_images/check.png) | false | Незаданные опции установить в значения по умолчанию.

### update {#update}

```javascript
update()
```

Полностью перестраивает балун. Вызывается, если необходимо обновить балун.