YMaps.Balloon

Расширяет YMaps.IOverlay.

Балун.

Объект балуна создается картой и существует в единственном экземпляре.

Управление балуном осуществляется с помощью методов YMaps.Map.openBalloon и YMaps.Map.closeBalloon.

См.: Балун

Конструктор

Имя Описание
YMaps.Balloon(options)

Создает балун (balloon) с текстом, картинкой или любым другим HTML-содержимым.

Поля

Имя Описание
Events Список обрабатываемых событий балуна.

События

Имя Описание
Close Щелчок по кнопке закрытия балуна.
CloseButtonClick Щелчок по кнопке закрытия балуна.

Методы

Имя Возвращает Описание
getContent() String|HTMLElement|YMaps.ILayout Возвращает содержимое балуна, установленное с помощью метода YMaps.Balloon.setContent.
getContentLayout() YMaps.ILayout Возвращает макет содержимого балуна.
getCoordPoint() YMaps.ICoordPoint Возвращает координаты балуна на карте.
getGeoPoint() YMaps.ICoordPoint То же, что и YMaps.Balloon.getCoordPoint.
getLayout() YMaps.IBalloonLayout Возвращает макет балуна.
getOptions() YMaps.BalloonOptions Возвращает опции балуна.
mapAutoPan(callback) Сдвигает карту таким образом, чтобы балун было видно целиком. C помощью опции YMaps.BalloonOptions.margin, можно задать минимальный отступ балуна от края карты (в пикселах).
setContent(content) Устанавливает содержимое балуна.
setCoordPoint(coordPoint) Позиционирует балун в точку с заданными координатами.
setGeoPoint(coordPoint) То же, что и YMaps.Balloon.setCoordPoint.
setOptions(options, restoreDefault) Устанавливает опции балуна.
update() Полностью перестраивает балун.

Наследуемые методы

Из YMaps.IOverlay:
onAddToMap, onMapUpdate, onRemoveFromMap

Подробное описание конструктора

YMaps.Balloon(options)

Создает балун (balloon) с текстом, картинкой или любым другим HTML-содержимым.

Балун состоит из области, в которой показывается HTML-содержимое и клиновидного "хвостика", указывающего определенную точку на карте. Балун, например, всплывает при щелчке мыши по метке. Балун является оверлеем.

См.: Балун

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.BalloonOptions Опции балуна.

Подробное описание полей

Events

Object Events

Список обрабатываемых событий балуна.

Подробное описание событий

Close

Close

Щелчок по кнопке закрытия балуна. Для подписки на событие закрытия балуна используйте событие карты YMaps.Event.BalloonClose. В callback-функцию передается указатель на балун.

CloseButtonClick

CloseButtonClick

Щелчок по кнопке закрытия балуна. Для подписки на событие закрытия балуна используйте событие карты YMaps.Event.BalloonClose. В callback-функцию передается указатель на балун.

Подробное описание методов

getContent

{String|HTMLElement|YMaps.ILayout} getContent()

Возвращает содержимое балуна, установленное с помощью метода YMaps.Balloon.setContent.

Возвращает:

Тип Описание
String|HTMLElement|YMaps.ILayout Содержимое балуна.

getContentLayout

{YMaps.ILayout} getContentLayout()

Возвращает макет содержимого балуна. Если балун не добавлен на карту, то возвращает null.

Пример:

var layout = map.getBalloon().getContentLayout();
layout.getRootNodes().css('font-weight', 'bold');

Возвращает:

Тип Описание
YMaps.ILayout Макет содержимого балуна.

getCoordPoint

{YMaps.ICoordPoint} getCoordPoint()

Возвращает координаты балуна на карте.

Возвращает:

Тип Описание
YMaps.ICoordPoint Координаты балуна.

getGeoPoint

{YMaps.ICoordPoint} getGeoPoint()

То же, что и YMaps.Balloon.getCoordPoint.

Возвращает:

Тип Описание
YMaps.ICoordPoint Координаты балуна.

getLayout

{YMaps.IBalloonLayout} getLayout()

Возвращает макет балуна. Если балун не добавлен на карту, то возвращает null.

Пример:

map.openBalloon(map.getCenter(), '<button class="my-button">Hello world</button>');
var layout = map.getBalloon().getLayout();
YMaps.jQuery(layout.getRootNodes()).find('.my-button').click(function() {
    alert('Hello world');
});

Возвращает:

Тип Описание
YMaps.IBalloonLayout Макет балуна.

getOptions

{YMaps.BalloonOptions} getOptions()

Возвращает опции балуна.

Возвращает:

Тип Описание
YMaps.BalloonOptions Объект опций.

mapAutoPan

mapAutoPan(callback)

Сдвигает карту таким образом, чтобы балун было видно целиком. C помощью опции YMaps.BalloonOptions.margin, можно задать минимальный отступ балуна от края карты (в пикселах).

Параметры:

Имя Тип Описание
callback Function Функция-обработчик для события окончания сдвига карты. Параметром передается результат сдвига карты: YMaps.State.SUCCESS - успешно, YMaps.State.FAILURE - неуспешно.

setContent

setContent(content)

Устанавливает содержимое балуна. Если в параметре content передана строка, то контейнером для содержимого балуна станет элемент div. Переданная строка станет значением свойства innerHTML элемента div.

Параметры:

Имя Тип Описание
content String|HTMLElement|YMaps.ILayout Содержимое балуна (строка, DOM-элемент или макет).

setCoordPoint

setCoordPoint(coordPoint)

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

Параметры:

Имя Тип Описание
coordPoint YMaps.ICoordPoint Координаты балуна на карте.

setGeoPoint

setGeoPoint(coordPoint)

То же, что и YMaps.Balloon.setCoordPoint.

Параметры:

Имя Тип Описание
coordPoint YMaps.ICoordPoint Координаты балуна на карте.

setOptions

setOptions(options, restoreDefault)

Устанавливает опции балуна.

Примеры:

1.

// Передает опции с помощью метода карты openBalloon() и открывает балун.
map.openBalloon(new YMaps.GeoPoint(37, 55), 'Здесь был Я.', {hasCloseButton: false, mapAutoPan: 0});

2.

// Передает опции после открытия балуна, не задействуя метод openBalloon.
map.getBalloon().setOptions({hasCloseButton: false, mapAutoPan: 0});

Параметры:

Имя Тип Необязательный По умолчанию Описание
options YMaps.BalloonOptions Объект опций.
restoreDefault Boolean false Незаданные опции установить в значения по умолчанию.

update

update()

Полностью перестраивает балун. Вызывается, если необходимо обновить балун.