hotspot.layer.Hint

Расширяет IHintManager.

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

См.: Hint hotspot.Layer.hint

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

Конструктор

hotspot.layer.Hint(hotspotLayer)

Параметры:

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

Тип: Object

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

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

Поля

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

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

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

События

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

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

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

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

Методы

Имя Возвращает Описание
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

Опции.