Balloon

Расширяет IBalloon , Popup .

Балун — всплывающее облако, которое может отображать любое HTML-содержимое. Обычно балун существует на карте в единственном экземпляре, управление им происходит через специальные менеджеры (например, карты, геообъектов, слоев активных областей и т. д.). Не создавайте их самостоятельно, если в этом нет необходимости.

Конструктор | Поля | События | Методы

Конструктор

Balloon(map[, options])

Параметры:

Параметр Значение по умолчанию Описание
map *

Тип: Map

Ссылка на объект карты.

options

Тип: Object

Опции.

options.autoPan true

Тип: Boolean

Сдвигать карту, чтобы отобразить открывшийся балун.

options.autoPanCheckZoomRange false

Тип: Boolean

Включает автомасштабирование при невозможности отобразить карту после перемещения на том же масштабе.

options.autoPanDuration 500

Тип: Number

Длительность перемещения к точке балуна (в мс).

options.autoPanMargin 34

Тип: Number|Number[]

Отступ или отступы от краев видимой области карты при выполнении действия autoPan. Значение может быть задано в виде одного числа (равный отступ для всех сторон), в виде двух чисел (для вертикальные и горизонтальные отступы) и в виде четырех чисел (в порядке: верхний, правый, нижний и левый отступ). Следует иметь в виду, данное значение будет суммироваться со значением рассчитыванным в менеджере отступов map.margin.Manager .

options.autoPanUseMapMargin true

Тип: Boolean

Нужно ли учитывать отступы карты map.margin.Manager при выполнении действия autoPan.

options.closeButton true

Тип: Boolean

Флаг наличия кнопки закрытия.

options.closeTimeout 700

Тип: Number

Задержка закрытия (в мс).

options.contentLayout

Тип: Function|String

Макет для содержимого балуна. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.interactivityModel

Тип: String

Ключ модели интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage .

options.layout islands#balloon

Тип: Function|String

Внешний макет балуна. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.maxHeight

Тип: Number

Максимальная высота, в пикселах.

options.maxWidth

Тип: Number

Максимальная ширина, в пикселах.

options.minHeight

Тип: Number

Минимальная высота, в пикселах.

options.minWidth

Тип: Number

Минимальная ширина, в пикселах.

options.offset

Тип: Number[]

Дополнительное смещение позиции относительно точки привязки.

options.openTimeout 150

Тип: Number

Задержка открытия (в мс).

options.pane 'balloon'

Тип: String

Ключ пейна, в который помещается оверлей балуна.

options.panelContentLayout null

Тип: Function|String

Макет для содержимого балуна в режиме панели. Если опция не задана, то используется значение опции contentLayout. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.panelMaxHeightRatio

Тип: Number

Максимальная высота балуна-панели. Задаётся как коэфициент отношения к высоте карты: числом от 0 до 1.

options.panelMaxMapArea

Тип: Number

Максимальная площадь карты, при которой балун будет отображаться в виде панели. Можно отключить режим панели, задав значение 0, и наоборот, всегда отображать балун в виде панели, задав значение Infinity.

options.shadow true

Тип: Boolean

Флаг наличия тени.

options.shadowLayout

Тип: Function|String

Макет тени. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета).

options.shadowOffset

Тип: Number[]

Дополнительное смещение позиции тени относительно точки привязки.

options.zIndex

Тип: String

z-index балуна.

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

Пример:

// Создание независимого экземпляра балуна и отображение его в центре карты.
var balloon = new ymaps.Balloon(myMap);
// Здесь родительскими устанавливаются опции карты,
// где содержатся значения по умолчанию для обязательных опций.
balloon.options.setParent(myMap.options);
// Открываем балун в центре карты:
balloon.open(myMap.getCenter());

Поля

Имя Тип Описание
events IEventManager

Менеджер событий.

Унаследовано от IEventEmitter .

options IOptionManager

Менеджер опций.

Унаследовано от ICustomizable .

События

Имя Описание
autopanbegin

Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event .

autopanend

Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event .

beforeuserclose

Событие, предшествующее событию Balloon.userclose . Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event .

close

Закрытие инфо-объекта.

Унаследовано от IPopup .

open

Открытие инфо-объекта.

Унаследовано от IPopup .

optionschange

Изменение в опциях объекта.

Унаследовано от ICustomizable .

userclose

Закрытие балуна пользователем. Экземпляр класса Event .

Методы

Имя Возвращает Описание
autoPan ()

vow.Promise

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

Унаследован от IBalloon .

close ([force])

vow.Promise

Закрывает инфо-объект.

Унаследован от IPopup .

getData ()

Возвращает данные инфо-объекта.

Унаследован от IPopup .

getOverlay ()

vow.Promise

Возвращает объект-обещание вернуть оверлей.

Унаследован от IPopup .

getOverlaySync ()

IOverlay

Возвращает оверлей, если тот существует.

Унаследован от IPopup .

getPosition ()

Возвращает координаты инфо-объекта.

Унаследован от IPopup .

isOpen ()

Boolean

Возвращает состояние инфо-объекта: открыт/закрыт.

Унаследован от IPopup .

open ([position[, data]])

vow.Promise

Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection , которая содержится в опциях.

Унаследован от IPopup .

setData (data)

vow.Promise

Задаёт инфо-объекту новые данные.

Унаследован от IPopup .

setPosition (position)

vow.Promise

Задаёт инфо-объекту новую позицию.

Унаследован от IPopup .

Описание событий

autopanbegin

Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event .

autopanend

Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event .

beforeuserclose

Событие, предшествующее событию Balloon.userclose . Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event .

userclose

Закрытие балуна пользователем. Экземпляр класса Event .