IPopup

Расширяет ICustomizable, IEventEmitter.

Интерфейс инфо-объекта.

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

Конструктор

IPopup()

Поля

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

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

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

options IOptionManager

Менеджер опций.

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

События

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

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

open

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

optionschange

Изменение в опциях объекта.

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

Методы

Имя Возвращает Описание
close([force])

vow.Promise

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

getData()

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

getOverlay()

vow.Promise

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

getOverlaySync()

IOverlay

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

getPosition()

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

isOpen()

Boolean

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

open([position[, data]])

vow.Promise

Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях.

setData(data)

vow.Promise

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

setPosition(position)

vow.Promise

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

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

close

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

open

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

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

close

{vow.Promise} close([force])

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

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

Параметры:

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

Тип: Boolean

Мгновенное закрытие.

getData

{} getData()

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

getOverlay

{vow.Promise} getOverlay()

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

getOverlaySync

{IOverlay} getOverlaySync()

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

getPosition

{} getPosition()

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

isOpen

{Boolean} isOpen()

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

open

Открывает инфо-объект в указанной позиции. Если инфо-объект уже открыт, перемещает его в указанную точку. Формат и суть координат определяется проекцией IProjection, которая содержится в опциях.

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

Параметры:

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

Тип: Number[]

Точка, где необходимо расположить балун.

data

Тип: Object|String|HTMLElement

Данные оверлея.

setData

{vow.Promise} setData(data)

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

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

Параметры:

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

Тип: Object|String|HTMLElement

Данные инфо-объекта.

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

setPosition

{vow.Promise} setPosition(position)

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

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

Параметры:

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

Тип: Number[]

Координаты инфо-объекта.

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