map.Balloon
Расширяет IEventEmitter.
Менеджер балуна карты. У каждой карты уже есть собственный менеджер балуна, доступный как map.balloon. В один момент на карте может быть открыт только один балун, управляемый менеджером. Не создавайте экземпляры этого класса без необходимости.
См.: Map.balloon
Конструктор
map.Balloon(map)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Map Ссылка на объект карты. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
События
Имя |
Описание |
Произошло закрытие балуна. Экземпляр класса Event. |
|
Произошло открытие балуна. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
|
Методы
Имя |
Возвращает |
Описание |
close() |
Закрывает балун. |
|
isOpen() |
Boolean |
Проверяет состояние балуна на карте. |
Открывает балун на карте в заданной точке. Возвращает экземпляр класса Balloon. |
Описание событий
close
Произошло закрытие балуна. Экземпляр класса Event.
open
Произошло открытие балуна. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
• balloon - ссылка на экземпляр класса Balloon.
Описание методов
close
{} close()
Закрывает балун.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: |
* Обязательный параметр/опция.
isOpen
{Boolean} isOpen()
Проверяет состояние балуна на карте.
Returns true, если балун на карте открыт, false - в обратном случае.
Пример:
// Открываем балун при двойном щелчке на карте
// или просто обновляем содержимое (случайное число),
// если балун уже был открыт.
var balloon = null;
myMap.events.add('dblclick', function () {
if (myMap.balloon.isOpen()) {
balloon.setData({ content: Math.random() });
} else {
balloon = myMap.balloon.open(myMap.getCenter(), Math.random());
}
});
open
{Balloon} open(position[, data[, options]])
Открывает балун на карте в заданной точке. Возвращает экземпляр класса Balloon.
Returns балун.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Number[] Позиция балуна. Указывается в гео-координатах текущей проекции. |
|
— |
Тип: Object|String Данные для отображения. |
|
— |
Тип: Object Опции. |
* Обязательный параметр/опция.
Пример:
// Открываем балун на карте, через 1 секунду меняем его содержимое, еще через 5 секунд закрываем.
var balloon = myMap.balloon.open(myMap.getCenter(), { content: 'Hello Yandex!' }, { closeButton: true });
setTimeout(function () {
balloon.setData({ content: 'Этот балун закроется через 3 секунды.' })
setTimeout(function () { myMap.balloon.close(); }, 3000);
}, 1000)
Обязательный параметр/опция.