geoObject.Balloon
Расширяет IBalloonManager.
Менеджер балуна геообъекта. Позволяет управлять балуном геообъекта, открывать и скрывать его. Передает балуну данные в формате IGeoObjectPopupData. Использует внутри себя менеджер балуна карты map.Balloon. Геообъекты содержат экземпляр этого класса, доступный как myGeoObject.balloon. Не создавайте экземпляры этого класса без необходимости.
Конструктор | Поля | События | Методы
Конструктор
geoObject.Balloon(geoObject)
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Геообъект. |
* Обязательный параметр/опция.
Поля
Имя |
Тип |
Описание |
Менеджер событий. Унаследовано от IEventEmitter. |
События
Имя |
Описание |
Начало автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IBalloonManager. |
|
Окончание автоматического перемещения центра карты, вызванного методом autoPan. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IBalloonManager. |
|
Событие, предшествующее событию Balloon.userclose. Позволяет отменить пользовательское действие посредством вызова метода preventDefault. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IBalloonManager. |
|
Закрытие инфо-объекта. Названия полей доступны через метод Event.get:
Унаследовано от IPopupManager. |
|
Открытие инфо-объекта. Названия полей доступны через метод Event.get:
Унаследовано от IPopupManager. |
|
Закрытие балуна пользователем. Экземпляр класса Event. Имена полей, доступных через метод Event.get:
Унаследовано от IBalloonManager. |
Методы
Имя |
Возвращает |
Описание |
autoPan() |
Перемещает карту таким образом, чтобы балун оказался видимым. Унаследован от IBalloonManager. |
|
Закрывает инфо-объект. Унаследован от IPopupManager. |
||
destroy() |
Отключает менеджер инфо-объекта. Унаследован от IPopupManager. |
|
getData() |
Object|null |
Возвращает данные инфо-объекта или null. Унаследован от IPopupManager. |
IOptionManager|null |
Возвращает менеджер опций или null. Унаследован от IPopupManager. |
|
Возвращает объект-обещание вернуть оверлей. Унаследован от IPopupManager. |
||
IOverlay|null |
Возвращает оверлей, если тот существует. Унаследован от IPopupManager. |
|
Number[]|null |
Возвращает координаты инфо-объекта или Унаследован от IPopupManager. |
|
isOpen() |
Boolean |
Возвращает состояние инфо-объекта: открыт/закрыт. Унаследован от IPopupManager. |
Открывает балун геообъекта. |
||
Устанавливает новые пользовательские данные. |
||
Задаёт инфо-объекту новые опции. Унаследован от IPopupManager. |
||
Задаёт инфо-объекту новую позицию. Унаследован от IPopupManager. |
Описание методов
open
{vow.Promise} open([position[, data[, options]]])
Открывает балун геообъекта.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Number[] Координаты открытия. По умолчанию: точка на геообъекте, ближайшая к текущему центру карты. Проекцию координат можно указать в опциях, иначе используется проекция геообъекта. |
|
— |
Тип: Object Данные, добавляемые в поле userData объекта данных, передаваемых балуну. |
|
— |
Тип: Object Опции. |
setData
{vow.Promise} setData([data])
Устанавливает новые пользовательские данные.
Возвращает объект-promise.
Параметры:
Параметр |
Значение по умолчанию |
Описание |
— |
Тип: Object Данные, добавляемые в поле userData объекта данных, передаваемых балуну. |
Обязательный параметр.