Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

hotspot.layer.Balloon

Расширяет IBalloonManager.

Менеджер балуна хотспотного слоя. Позволяет управлять балуном хотспотного слоя, открывать и скрывать его. Использует внутри себя менеджер балуна карты map.Balloon. Хотспотные слои содержат экземпляр этого класса, доступный как myHotspotLayer.balloon. Не создавайте экземпляры этого класса без необходимости.

См.: Balloon hotspot.Layer.balloon

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

Конструктор

hotspot.layer.Balloon(hotspotLayer)

Параметры:

ПараметрЗначение по умолчаниюОписание
hotspotLayer *
[no-highlight[

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

]no-highlight]

Тип: Object

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

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

Поля

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

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

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

События

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

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

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

autopanend

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

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

beforeuserclose

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

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

close

Закрытие инфо-объекта. Названия полей доступны через метод Event.get:

  • target - ссылка на объект, на котором был закрыт инфо-объект.

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

open

Открытие инфо-объекта. Названия полей доступны через метод Event.get:

  • target - ссылка на объект, на котором был открыт инфо-объект.

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

userclose

Закрытие балуна пользователем. Экземпляр класса Event. Имена полей, доступных через метод Event.get:

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

Методы

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

vow.Promise

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

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

close([force])

vow.Promise

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

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

destroy()

Отключает менеджер инфо-объекта.

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

getData()

Object|null

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

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

getOptions()

IOptionManager|null

Возвращает менеджер опций или null.

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

getOverlay()

vow.Promise

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

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

getOverlaySync()

IOverlay|null

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

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

getPosition()

Number[]|null

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

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

isOpen()

Boolean

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

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

open([position[, data[, options]]])

vow.Promise

Открывает балун в указанной позиции.

setData(data)

vow.Promise

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

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

setOptions(options)

vow.Promise

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

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

setPosition(position)

vow.Promise

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

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

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

open

Открывает балун в указанной позиции.

Возвращает объект-promise.

Параметры:

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

Тип: Number[]

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

data

Тип: Object

Данные.

options

Тип: Object

Опции.