IPopup
Расширяет ICustomizable, IEventEmitter.
Интерфейс инфо-объекта.
Конструктор | Поля | События | Методы
Конструктор
IPopup()
Поля
|
Имя |
Тип |
Описание |
|
Менеджер событий. Унаследовано от IEventEmitter. |
||
|
Менеджер опций. Унаследовано от ICustomizable. |
События
|
Имя |
Описание |
|
Закрытие инфо-объекта. |
|
|
Открытие инфо-объекта. |
|
|
Изменение в опциях объекта. Унаследовано от ICustomizable. |
Методы
|
Имя |
Возвращает |
Описание |
|
Закрывает инфо-объект. |
||
|
getData() |
Возвращает данные инфо-объекта. |
|
|
Возвращает объект-обещание вернуть оверлей. |
||
|
Возвращает оверлей, если тот существует. |
||
|
Возвращает координаты инфо-объекта. |
||
|
isOpen() |
Boolean |
Возвращает состояние инфо-объекта: открыт/закрыт. |
|
Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях. |
||
|
Задаёт инфо-объекту новые данные. |
||
|
Задаёт инфо-объекту новую позицию. |
Описание событий
close
Закрытие инфо-объекта.
open
Открытие инфо-объекта.
Описание методов
close
{vow.Promise} close([force])
Закрывает инфо-объект.
Возвращает объект-promise.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
false |
Тип: Boolean Мгновенное закрытие. |
getData
{} getData()
Возвращает данные инфо-объекта.
getOverlay
{vow.Promise} getOverlay()
Возвращает объект-обещание вернуть оверлей.
getOverlaySync
{IOverlay} getOverlaySync()
Возвращает оверлей, если тот существует.
getPosition
{} getPosition()
Возвращает координаты инфо-объекта.
isOpen
{Boolean} isOpen()
Возвращает состояние инфо-объекта: открыт/закрыт.
open
{vow.Promise} open([position[, data]])
Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях.
Возвращает объект-promise.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Number[] Точка, где необходимо расположить балун. |
|
|
— |
Тип: Object|String|HTMLElement Данные оверлея. |
setData
{vow.Promise} setData(data)
Задаёт инфо-объекту новые данные.
Возвращает объект-promise.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
||
|
|
— |
Тип: Object |
String |
HTMLElement Данные инфо-объекта. |
* Обязательный параметр/опция.
setPosition
{vow.Promise} setPosition(position)
Задаёт инфо-объекту новую позицию.
Возвращает объект-promise.
Параметры:
|
Параметр |
Значение по умолчанию |
Описание |
|
— |
Тип: Number[] Координаты инфо-объекта. |
* Обязательный параметр/опция.
Обязательный параметр.