--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt # Balloon Расширяет [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md). Балун - всплывающее облако, которое может отображать любое HTML-содержимое. Балуны возвращаются из методов open менеджеров балуна ([карты](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/map.Balloon.md#open), [геообъектов](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/geoObject.Balloon.md#open), [слоёв активных областей](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/hotspot.layer.Balloon.md#open) и т.д.). Не создавайте их самостоятельно, если в этом нет необходимости. ## Конструктор {#constructor} ```javascript Balloon(map[, data[, options]]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `map`[*](*parametr) | — | Тип: [Map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Map.md) Ссылка на объект карты. || || `data` | — | Тип: Object Данные. || || `options` | — | Тип: Object Опции. || || `options.autoPan` | true | Тип: Boolean Сдвигать карту, чтобы отобразить открывшийся балун. || || `options.autoPanDuration` | 500 | Тип: Number Длительность перемещения к точке балуна (в мс). || || `options.autoPanMargin` | — | Тип: Number Отступ от угла viewport-а карты при действии autoPan. || || `options.closeButton` | true | Тип: Boolean Флаг наличия кнопки закрытия. || || `options.closeButtonLayout` | — | Тип: Function\|String Макет кнопки закрытия. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.contentBodyLayout` | — | Тип: Function\|String Макет для основной части содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.contentFooterLayout` | — | Тип: Function\|String Макет для нижней части содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.contentHeaderLayout` | — | Тип: Function\|String Макет для заголовка содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.contentLayout` | — | Тип: Function\|String Макет для заголовка содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.interactivityModel` | — | Тип: String Ключ модели интерактивности. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/interactivityModel.storage.md). || || `options.layout` | — | Тип: Function\|String Макет для заголовка содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.maxHeight` | — | Тип: Number Максимальная высота, в пикселах. || || `options.maxWidth` | — | Тип: Number Максимальная ширина, в пикселах. || || `options.minHeight` | — | Тип: Number Минимальная высота, в пикселах. || || `options.minWidth` | — | Тип: Number Минимальная ширина, в пикселах. || || `options.offset` | — | Тип: Number[] Дополнительное смещение позиции относительно точки привязки. || || `options.projection` | — | Тип: [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md) Проекция координат в глобальные пиксели. || || `options.shadow` | true | Тип: Boolean Флаг наличия тени. || || `options.shadowLayout` | — | Тип: Function\|String Макет для заголовка содержимого балуна. (Тип: конструктор объекта с интерфейсом [ILayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ILayout.md) или ключ макета). || || `options.zIndex` | — | Тип: String z-index балуна. || |# \* Обязательный параметр/опция. **Пример:** ```javascript // Создание независимого экземпляра балуна и отображение его в центре карты. var balloon = new ymaps.Balloon(myMap); // Здесь родительскими устанавливаются опции карты, // где содержатся значения по умолчанию для обязательных опций. balloon.options.setParent(myMap.options); // Открываем балун в центре карты: balloon.open(myMap.getCenter()); ``` ## Поля {#fields} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events). || |# ## События {#events} #| || **Имя** | **Описание** || || [autopanbegin](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#event-autopanbegin) | Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [autopanend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#event-autopanend) | Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [click](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-click). || || [close](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#event-close) | Закрытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [contextmenu](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [dblclick](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-dblclick). || || [mousedown](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseenter).|| || [mouseleave](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [open](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#event-open) | Открытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [userclose](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#event-userclose) | Закрытие балуна пользователем. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [wheel](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Методы {#method} #| || **Имя** | **Возвращает** | **Описание** || || [autoPan](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#autoPan)() | [Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md) | Автоматически cмещает центр карты таким образом, чтобы балун оказался в видимой области. || || [close](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#close)() | [Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md) | Закрывает балун.|| || [getData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#getData)() | Object | Returns данные балуна.|| || [getOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#getOverlay)() | [overlay.html.Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/overlay.html.Balloon.md) | Returns ссылку на оверлей балуна. || || [getPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#getPosition)() | Number[] | Returns координаты балуна.|| || [isOpen](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#isOpen)() | Boolean | Возвращает состояние балуна: открыт/закрыт.|| || [open](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#open)([[position](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#open-param-position)[, [preventAutoPan](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#open-param-preventAutoPan)]]) | [Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md) | Открывает балун на карте в точке с заданными координатами. Если балун уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md), которая содержится в опциях. || || [setData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#setData)([data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#setData-param-data)) | [Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md) | Устанавливает данные балуна. || || [setPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#setPosition)([position](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#setPosition-param-position)[, [preventAutoPan](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md#setPosition-param-preventAutoPan)]) | [Balloon](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Balloon.md) | Устанавливает новую позицию балуна. Формат и суть координат определяется проекцией [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md), которая содержится в опциях.|| |# ## Описание событий {#event-description} ### autopanbegin Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### autopanend Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### close Закрытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### open Открытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### userclose Закрытие балуна пользователем. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ## Описание методов ### autoPan ```javascript {Balloon} autoPan() ``` Автоматически cмещает центр карты таким образом, чтобы балун оказался в видимой области. **Returns** ссылку на себя. ### close ```javascript {Balloon} close() ``` Закрывает балун. **Returns** ссылку на себя. ### getData ```javascript {Object} getData() ``` **Returns** данные балуна. ### getOverlay ```javascript {overlay.html.Balloon} getOverlay() ``` **Returns** ссылку на оверлей балуна. ### getPosition ```javascript {Number[]} getPosition() ``` **Returns** координаты балуна. ### isOpen ```javascript {Boolean} isOpen() ``` Возвращает состояние балуна: открыт/закрыт. **Returns** true, если балун открыт, false - в обратном случае. **Пример:** ```javascript // Открываем балун при двойном щелчке на карте // или просто обновляем содержимое (случайное число), // если балун уже был открыт. var balloon = null; myMap.events.add('dblclick', function () { if (balloon && balloon.isOpen()) { balloon.setData({ content: Math.random() }); } else { balloon = myMap.balloon.open(myMap.getCenter(), Math.random()); } }); ``` ### open ```javascript {Balloon} open([position[, preventAutoPan]]) ``` Открывает балун на карте в точке с заданными координатами. Если балун уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md), которая содержится в опциях. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `position` | — | Тип: Number[] Координаты балуна. || || `preventAutoPan` | false | Тип: Boolean Флаг, отключающий автоматический сдвиг карты для данного вызова. || |# ### setData ```javascript {Balloon} setData(data) ``` Устанавливает данные балуна. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `data `[*](*parametr) | — | Тип: Object Данные. || |# \* Обязательный параметр/опция. ### setPosition ```javascript {Balloon} setPosition(position[, preventAutoPan]) ``` Устанавливает новую позицию балуна. Формат и суть координат определяется проекцией [IProjection](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IProjection.md), которая содержится в опциях. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `position`[*](*parametr) | — | Тип: Number[] Новые координаты. || || `preventAutoPan` | false | Тип: Boolean Флаг, отключающий автоматический сдвиг карты для данного вызова. || |# \* Обязательный параметр/опция. [*parametr]:Обязательный параметр/опция.