geoObject.Hint

Расширяет IHintManager .

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

См.: Hint GeoObject.hint

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

Конструктор

geoObject.Hint(geoObject)

Параметры:

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

Тип: 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

Устанавливает новые пользовательские данные.

setOptions (options)

vow.Promise

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

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

setPosition (position)

vow.Promise

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

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

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

open

Открывает хинт геообъекта.

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

Параметры:

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

Тип: Number[]

Координаты открытия. По умолчанию: геометрический центр тяжести геообъекта. Проекцию координат можно указать в опциях, иначе используется проекция геообъекта.

data

Тип: Object

Данные, добавляемые в поле userData объекта данных, передаваемых хинту.

options

Тип: Object

Опции.

setData

{
              vow.Promise
            } setData([data])

Устанавливает новые пользовательские данные.

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

Параметры:

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

Тип: Object

Данные, добавляемые в поле userData объекта данных, передаваемых хинту.