Balloon
Балун — всплывающее облако, которое может отображать любое HTML-содержимое. Обычно балун существует на карте в единственном экземпляре, управление им происходит через специальные менеджеры (например, карты, геообъектов, слоев активных областей и т. д.). Не создавайте их самостоятельно, если в этом нет необходимости.
Конструктор | Поля | События | Методы
Конструктор
Balloon(map[, options])
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Ссылка на объект карты. |
— |
Тип: Object Опции. |
|
true |
Тип: Boolean Сдвигать карту, чтобы отобразить открывшийся балун. |
|
false |
Тип: Boolean Включает автомасштабирование при невозможности отобразить карту после перемещения на том же масштабе. |
|
500 |
Тип: Number Длительность перемещения к точке балуна (в мс). |
|
34 |
Тип: Number|Number[] Отступ или отступы от краев видимой области карты при выполнении действия autoPan. Значение может быть задано в виде одного числа (равный отступ для всех сторон), в виде двух чисел (для вертикальные и горизонтальные отступы) и в виде четырех чисел (в порядке: верхний, правый, нижний и левый отступ). Следует иметь в виду, данное значение будет суммироваться со значением рассчитыванным в менеджере отступов map.margin.Manager. |
|
true |
Тип: Boolean Нужно ли учитывать отступы карты map.margin.Manager при выполнении действия autoPan. |
|
true |
Тип: Boolean Флаг наличия кнопки закрытия. |
|
700 |
Тип: Number Задержка закрытия (в мс). |
|
— |
Тип: Function|String Макет для содержимого балуна. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета). |
|
— |
Тип: String Ключ модели интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage. |
|
islands#balloon |
Тип: Function|String Внешний макет балуна. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета). |
|
— |
Тип: Number Максимальная высота, в пикселах. |
|
— |
Тип: Number Максимальная ширина, в пикселах. |
|
— |
Тип: Number Минимальная высота, в пикселах. |
|
— |
Тип: Number Минимальная ширина, в пикселах. |
|
— |
Тип: Number[] Дополнительное смещение позиции относительно точки привязки. |
|
150 |
Тип: Number Задержка открытия (в мс). |
|
'balloon' |
Тип: String Ключ пейна, в который помещается оверлей балуна. |
|
null |
Тип: Function|String Макет для содержимого балуна в режиме панели. Если опция не задана, то используется значение опции contentLayout. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета). |
|
— |
Тип: Number Максимальная высота балуна-панели. Задаётся как коэфициент отношения к высоте карты: числом от 0 до 1. |
|
— |
Тип: Number Максимальная площадь карты, при которой балун будет отображаться в виде панели. Можно отключить режим панели, задав значение 0, и наоборот, всегда отображать балун в виде панели, задав значение Infinity. |
|
true |
Тип: Boolean Флаг наличия тени. |
|
— |
Тип: Function|String Макет тени. (Тип: конструктор объекта с интерфейсом ILayout или ключ макета). |
|
— |
Тип: Number[] Дополнительное смещение позиции тени относительно точки привязки. |
|
— |
Тип: String z-index балуна. |
*\Обязательный параметр/опция.
Пример:
// Создание независимого экземпляра балуна и отображение его в центре карты.
var balloon = new ymaps.Balloon(myMap);
// Здесь родительскими устанавливаются опции карты,
// где содержатся значения по умолчанию для обязательных опций.
balloon.options.setParent(myMap.options);
// Открываем балун в центре карты:
balloon.open(myMap.getCenter());
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
||
Менеджер опций. Унаследовано от ICustomizable. |
События
Имя |
Описание |
Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event. |
|
Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event. |
|
Событие, предшествующее событию Balloon.userclose. Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event. |
|
Закрытие инфо-объекта. Унаследовано от IPopup. |
|
Открытие инфо-объекта. Унаследовано от IPopup. |
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
|
Закрытие балуна пользователем. Экземпляр класса Event. |
Методы
Имя |
Возвращает |
Описание |
autoPan() |
Перемещает карту таким образом, чтобы балун оказался видимым. Унаследован от IBalloon. |
|
Закрывает инфо-объект. Унаследован от IPopup. |
||
getData() |
Возвращает данные инфо-объекта. Унаследован от IPopup. |
|
Возвращает объект-обещание вернуть оверлей. Унаследован от IPopup. |
||
Возвращает оверлей, если тот существует. Унаследован от IPopup. |
||
Возвращает координаты инфо-объекта. Унаследован от IPopup. |
||
isOpen() |
Boolean |
Возвращает состояние инфо-объекта: открыт/закрыт. Унаследован от IPopup. |
Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях. Унаследован от IPopup. |
||
Задаёт инфо-объекту новые данные. Унаследован от IPopup. |
||
Задаёт инфо-объекту новую позицию. Унаследован от IPopup. |
Описание событий
autopanbegin
Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event.
autopanend
Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event.
beforeuserclose
Событие, предшествующее событию Balloon.userclose. Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event.
userclose
Закрытие балуна пользователем. Экземпляр класса Event.
Обязательный параметр.