clusterer.Balloon

Расширяет IBalloonManager.

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

См.: Balloon

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

Конструктор

clusterer.Balloon(clusterer)

Параметры:

Параметр

Значение по умолчанию

Описание

clusterer*

Тип: Clusterer

Кластеризатор.

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

Поля

Имя

Тип

Описание

events

IEventManager

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

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

open

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

  • target - ссылка на менеджер балуна кластеризатора;
  • cluster - ссылка на объект-кластер.
    Экземпляр класса Event.

События

Имя

Описание

autopanbegin

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

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

autopanend

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

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

beforeuserclose

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

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

close

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

  • target - ссылка на менеджер балуна кластеризатора;
  • cluster - ссылка на объект-кластер.
    Экземпляр класса Event.

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.

setData(data)

vow.Promise

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

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

setOptions(options)

vow.Promise

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

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

setPosition(position)

vow.Promise

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

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

Описание полей

open

open

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

  • target - ссылка на менеджер балуна кластеризатора;
  • cluster - ссылка на объект-кластер.
    Экземпляр класса Event.

Пример:

clusterer.balloon.events.add('open', function (e) {
    var clusterPlacemark = e.get('cluster');
});

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

close

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

  • target - ссылка на менеджер балуна кластеризатора;
  • cluster - ссылка на объект-кластер.
    Экземпляр класса Event.
Предыдущая
Следующая