YMaps.Hint
Всплывающая подсказка.
Данный класс не имеет конструктора.
Объект класса YMaps.Hint существует для каждой карты в единственном экземпляре и доступен в объекте карты как YMaps.Map.hint.
Поля
Имя | Описание |
---|---|
Events | Список обрабатываемых событий подсказки. |
События
Имя | Описание |
---|---|
Hide | Скрытие подсказки. |
Show | Показ подсказки. |
Методы
Имя | Возвращает | Описание |
---|---|---|
getContentLayout() | YMaps.ILayout | Возвращает макет содержимого всплывающей подсказки. |
getLayout() | YMaps.IHintLayout | Возвращает макет подсказки. |
hide(hideTimeout) | Скрывает всплывающую подсказку. | |
isShown() | Boolean | Возвращает текущее состояние всплывающей подсказки: true - подсказка показана на карте, false - подсказка скрыта. |
moveTo(position) | Перемещает всплывающую подсказку в заданную позицию. | |
setContent(content) | Устанавливает содержимое всплывающей подсказки. | |
setOptions(options) | Устанавливает опции всплывающей подсказки. | |
show(position, content, options) | Показывает всплывающую подсказку с заданными параметрами. |
Подробное описание полей
Events
Object Events
Список обрабатываемых событий подсказки.
Подробное описание событий
Hide
Hide
Скрытие подсказки. В callback-функцию передается указатель на подсказку.
Show
Show
Показ подсказки. В callback-функцию передается указатель на подсказку.
Подробное описание методов
getContentLayout
{YMaps.ILayout} getContentLayout()
Возвращает макет содержимого всплывающей подсказки. Если подсказка не отображена, то возвращает null.
Пример:
var layout = map.hint.getContentLayout();
layout.getRootNodes().css('font-style', 'italic');
Возвращает:
Тип | Описание |
---|---|
YMaps.ILayout | Макет содержимого всплывающей подсказки. |
getLayout
{YMaps.IHintLayout} getLayout()
Возвращает макет подсказки. Если подсказка не отображена, то возвращает null.
Пример:
var layout = map.hint.getLayout();
YMaps.jQuery(layout.getRootNodes()).addClass('my-hint-class');
Возвращает:
Тип | Описание |
---|---|
YMaps.IHintLayout | Макет подсказки. |
hide
hide(hideTimeout)
Скрывает всплывающую подсказку.
Подсказка может быть скрыта либо немедленно, либо через заданный интервал времени (если указан параметр hideTimeout).
Примечание
Всплывающая подсказка не будет скрыта, если курсор мыши находится над подсказкой и опция holdOnMouseOver установлена в true.
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
hideTimeout |
Number | Интервал времени (в миллисекундах), спустя который всплывающая подсказка должна быть скрыта. |
isShown
{Boolean} isShown()
Возвращает текущее состояние всплывающей подсказки: true - подсказка показана на карте, false - подсказка скрыта.
Возвращает:
Тип | Описание |
---|---|
Boolean | true - всплывающая подсказка показана на карте, false - скрыта. |
moveTo
moveTo(position)
Перемещает всплывающую подсказку в заданную позицию.
Параметры:
Имя | Тип | Описание |
---|---|---|
position |
YMaps.Point | Позиция, в которую требуется переместить всплывающую подсказку. Задается локальными пиксельными координатами, см. Преобразование координат. |
setContent
setContent(content)
Устанавливает содержимое всплывающей подсказки. Если в параметре content передана строка, то контейнером для содержимого подсказки станет элемент div. Переданная строка станет значением свойства innerHTML элемента div.
Параметры:
Имя | Тип | Описание |
---|---|---|
content |
String | HTMLElement |
setOptions
setOptions(options)
Устанавливает опции всплывающей подсказки.
Параметры:
Имя | Тип | Описание |
---|---|---|
options |
YMaps.HintOptions | Опции всплывающей подсказки. |
show
show(position, content, options)
Показывает всплывающую подсказку с заданными параметрами.
Пример:
// Показывает подсказку в центре карты.
map.hint.show(map.converter.coordinatesToLocalPixels(map.getCenter()), 'Центр карты', {showTimeout: 500});
Параметры:
Имя | Тип | Описание |
---|---|---|
position |
YMaps.Point | Позиция, в которой требуется показать всплывающую подсказку. Задается локальными пиксельными координатами, см. Преобразование координат. |
content |
String | HTMLElement |
options |
YMaps.MapHintOptions | Опции всплывающей подсказки. |