Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

Hint

Расширяет IHint, Popup.

Хинт - всплывающая подсказка, которая может отображать любое HTML-содержимое. Обычно хинт существует на карте в единственном экземпляре, управление им происходит через специальные менеджеры (maps, geo objects, hotspot layers и т.д.). Не создавайте их самостоятельно, если в этом нет необходимости.

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

Конструктор

Hint(map[, options])

Параметры:

ПараметрЗначение по умолчаниюОписание
map *
[no-highlight[

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

]no-highlight]

Тип: Map

Ссылка на объект карты.

options

Тип: Object

Опции.

options.closeTimeout 700

Тип: Number

Задержка закрытия (в мс).

options.contentLayout

Тип: Function|String

Макет для содержимого хинта. (Тип: конструктор объекта с интерфейсом ILayout).

options.fitPane true

Тип: Boolean

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

options.holdByMouse true

Тип: Boolean

Флаг, отменяющий закрытие хинта, находящегося под курсором.

options.interactivityModel

Тип: String

Ключ модели интерактивности. Доступные ключи и их значения перечислены в описании interactivityModel.storage.

options.layout islands#hint

Тип: Function|String

Внешний макет хинта. (Тип: конструктор объекта с интерфейсом ILayout).

options.offset

Тип: Number[]

Дополнительное смещение позиции относительно точки привязки.

options.openTimeout 150

Тип: Number

Задержка открытия (в мс).

options.pane 'outerHint'

Тип: String

Ключ пейна, в который помещается оверлей хинта.

options.zIndex

Тип: String

z-index хинта.

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

Пример:

// Создаем независимый экземпляр хинта и показываем его с собстенным макетом в центре карты с помощью указания гео-координат.
(new ymaps.Hint(myMap, {
    projection: ymaps.projection.wgs84Mercator,
    layout: ymaps.templateLayoutFactory.createClass('{{ content }}')
})).open(myMap.getCenter(), 'Привет');

Поля

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

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

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

options IOptionManager

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

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

События

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

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

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

open

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

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

optionschange

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

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

Методы

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

vow.Promise

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

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

getData()

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

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

getOverlay()

vow.Promise

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

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

getOverlaySync()

IOverlay

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

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

getPosition()

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

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

isOpen()

Boolean

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

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

open([position[, data]])

vow.Promise

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

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

setData(data)

vow.Promise

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

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

setPosition(position)

vow.Promise

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

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