Balloon

Расширяет IDomEventEmitter.

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

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

Конструктор

Balloon(map[, data[, options]])

Параметры:

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

Тип: Map

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

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 или ключ макета).

options.contentBodyLayout

Тип: Function|String

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

options.contentFooterLayout

Тип: Function|String

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

options.contentHeaderLayout

Тип: Function|String

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

options.contentLayout

Тип: Function|String

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

options.interactivityModel

Тип: String

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

options.layout

Тип: Function|String

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

options.maxHeight

Тип: Number

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

options.maxWidth

Тип: Number

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

options.minHeight

Тип: Number

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

options.minWidth

Тип: Number

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

options.offset

Тип: Number[]

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

options.projection

Тип: IProjection

Проекция координат в глобальные пиксели.

options.shadow true

Тип: Boolean

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

options.shadowLayout

Тип: Function|String

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

options.zIndex

Тип: String

z-index балуна.

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

Пример:

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

Поля

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

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

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

События

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

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

autopanend

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

click

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

close

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

contextmenu

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

dblclick

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

mousedown

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

mouseenter

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

mouseleave

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

mousemove

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

mouseup

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

multitouchend

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

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

multitouchmove

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

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

multitouchstart

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях.

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

open

Открытие балуна. Экземпляр класса Event.

userclose

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

wheel

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в domEvent.manager.

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

Методы

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

Balloon

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

close()

Balloon

Закрывает балун.

getData()

Object

Returns данные балуна.

getOverlay()

overlay.html.Balloon

Returns ссылку на оверлей балуна.

getPosition()

Number[]

Returns координаты балуна.

isOpen()

Boolean

Возвращает состояние балуна: открыт/закрыт.

open([position[, preventAutoPan]])

Balloon

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

setData(data)

Balloon

Устанавливает данные балуна.

setPosition(position[, preventAutoPan])

Balloon

Устанавливает новую позицию балуна. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях.

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

autopanbegin

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

autopanend

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

close

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

open

Открытие балуна. Экземпляр класса Event.

userclose

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

Описание методов

autoPan

{Balloon} autoPan()

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

Returns ссылку на себя.

close

{Balloon} close()

Закрывает балун.

Returns ссылку на себя.

getData

{Object} getData()

Returns данные балуна.

getOverlay

{overlay.html.Balloon} getOverlay()

Returns ссылку на оверлей балуна.

getPosition

{Number[]} getPosition()

Returns координаты балуна.

isOpen

{Boolean} isOpen()

Возвращает состояние балуна: открыт/закрыт.

Returns true, если балун открыт, false - в обратном случае.

Пример:

// Открываем балун при двойном щелчке на карте
// или просто обновляем содержимое (случайное число),
// если балун уже был открыт.
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

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

Returns ссылку на себя.

Параметры:

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

Тип: Number[]

Координаты балуна.

preventAutoPan false

Тип: Boolean

Флаг, отключающий автоматический сдвиг карты для данного вызова.

setData

{Balloon} setData(data)

Устанавливает данные балуна.

Returns ссылку на себя.

Параметры:

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

Тип: Object

Данные.

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

setPosition

{Balloon} setPosition(position[, preventAutoPan])

Устанавливает новую позицию балуна. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях.

Returns ссылку на себя.

Параметры:

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

Тип: Number[]

Новые координаты.

preventAutoPan false

Тип: Boolean

Флаг, отключающий автоматический сдвиг карты для данного вызова.

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