--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt # Hint Расширяет [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md). Хинт - всплывающая подсказка, которая может отображать любое HTML-содержимое. Хинты возвращаются из методов show менеджеров хинта ([карты](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/map.Hint.md#show), [геообъектов](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/geoObject.Hint.md#show), [слоёв активных областей](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/hotspot.layer.Hint.md#show) и т.д.). Не создавайте их самостоятельно, если в этом нет необходимости. ## Конструктор {#constructor} ```javascript Hint(map[, data[, options]]) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `map`[*](*parametr) | — | Тип: [Map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Map.md) Ссылка на объект карты. || || `data`[*] | — | Тип: Object Данные. || || `options`[*] | — | Тип: Object Опции. || || `options.contentLayout`[*] | — | Тип: Function\|String Макет для содержимого хинта. (Тип: конструктор объекта с интерфейсом ILayout). || || `options.fitPane`[*] | true | Тип: Boolean Флаг, заставляющий хинт сдвигать свою позицию, чтобы не выходить за границы контейнера. || || `options.hideTimeout`[*] | 700 | Тип: Number Задержка закрытия (в мс). || || `options.holdByMouse`[*] | true | Тип: Boolean Флаг, оменяющий закрытие хинта, находящегося под курсором. || || `options.interactivityModel`[*] | — | Тип: String Ключ модели интерактивности. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/interactivityModel.storage.md). || || `options.layout`[*] | — | Тип: Function\|String Внешний макет хинта. (Тип: конструктор объекта с интерфейсом ILayout). || || `options.overlay`[*] | overlay.Label | Тип: [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md) Класс оверлея. || || `options.pane`[*] | outers | Тип: [IPane](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPane.md)\|String Контейнер оверлея хинта. "outers" - вне карты, "floats" - в пределах карты. || || `options.showTimeout`[*] | 150 | Тип: Number Задержка открытия (в мс). || || `options.zIndex`[*] | — | Тип: String z-index подсказки. || |# \* Обязательный параметр/опция. **Пример:** ```javascript // Создаем независимый экземпляр хинта и показываем его в центре карты. (new ymaps.Hint(myMap, { content: 'Hello' }, { projection: ymaps.projection.wgs84Mercator, layout: ymaps.templateLayoutFactory.createClass('$[content]') })).show(myMap.getCenter()); ``` ## Поля {#fields} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#events). || |# ## События {#events} #| || **Имя** | **Описание** || || [beforedestroy](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#beforedestroy) | Событие, предшествующее уничтожению хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [click](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#click). || || [contextmenu](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#contextmenu). || || [dblclick](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#dblclick). || || [destroy](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#destroy) | Уничтожение хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [hide](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#hide) | Скрытие хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [mousedown](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousedown). || || [mouseenter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseenter). || || [mouseleave](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseleave). || || [mousemove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mousemove). || || [mouseup](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#mouseup). || || [multitouchend](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchend). || || [multitouchmove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchmove). || || [multitouchstart](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#multitouchstart). || || [show](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#show) | Отображение хинта на карте. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). || || [wheel](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Более детально описание в [domEvent.manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDomEventEmitter.md#wheel). || |# ## Методы {#method} #| || **Имя** | **Возвращает** | **Описание** || || [destroy](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#destroy)([[callback](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#destroy-param-callback), [urgently](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#destroy-param-urgently)) | [Hint](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md) | Уничтожает хинт. Предварительно генерирует событие beforedestroy, при отмене которого уничтожения хинта не произойдет. После уничтожения хинта генерируется событие destroy. || || [getData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#getData)() | Object | Returns данные хинта. || || [getOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#getOverlay)() | [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md) | Returns оверлей хинта. || || [getPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#getPosition)() | Number[] | Returns позицию хинта. || || [hide](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#hide)([urgently](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#hide-param-urgently)) | [Hint](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md) | Скрывает хинт. || || [isShown](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#isShown)() | Boolean | Возвращает состояние хинта: открыт/скрыт. || || [setData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#setData)([data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#setData-param-data)) | [Hint](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md) | Устанавливает данные хинта. || || [setPosition](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#setPosition)([position](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#setPosition-param-position)) | [Hint](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md) | Устанавливает координаты хинта в проекции, заданной в опциях. || || [show](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#show)([[position](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md#show-param-position)]) | [Hint](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Hint.md) | Отображает хинт на карте в точке с заданными координатами. Если хинт уже отображен, перемещает его в указанную точку. || |# ## Описание событий {#description-events} ### beforedestroy Событие, предшествующее уничтожению хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### destroy Уничтожение хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### hide Скрытие хинта. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ### show Отображение хинта на карте. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ## Описание методов {#description-methods} ### destroy ```javascript {Hint} destroy([callback, urgently) ``` Уничтожает хинт. Предварительно генерирует событие beforedestroy, при отмене которого уничтожения хинта не произойдет. После уничтожения хинта генерируется событие destroy. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `callback` | — | Тип: Function Функция, которая будет вызвана после уничтожения балуна. Если событие beforedestroy было отменено, в функцию первым параметром будет передано сообщение о том, что хинт не был уничтожен. || || `urgently`[*](*parametr) | — | Тип: Boolean Скрыть хинт сразу, без временной задержки и без учета положения курсора. || |# \* Обязательный параметр/опция. ### getData ```javascript {Object} getData() ``` **Returns** данные хинта. ### getOverlay ```javascript {IOverlay} getOverlay() ``` **Returns** оверлей хинта. ### getPosition ```javascript {Number[]} getPosition() ``` **Returns** позицию хинта. ### hide ```javascript {Hint} hide(urgently) ``` Скрывает хинт. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `urgently`[*](*parametr) | — | Тип: Boolean Скрыть хинт сразу, без временной задержки и без учета положения курсора. || |# \* Обязательный параметр/опция. ### isShown ```javascript {Boolean} isShown() ``` Возвращает состояние хинта: открыт/скрыт. **Returns** true, если хинт открыт, false - в обратном случае. **Пример:** ```javascript // Открываем хинт (по таймауту в 1 сек.): var hint = myMap.hint.show(myMap.getCenter(), { content: 'loading' }, { showTimeout: 1000 }); // Выполняем AJAX-запрос: $.getJSON('hint-data.json') .success(function (data) { // Обновляем данные если хинт открыт, иначе вешаемся на событие открытия: if (hint.isShown()) { hint.setData(data); } else { myMap.hint.events.add('show', function () { hint.setData(data); }); } }); ``` ### setData ```javascript {Hint} setData(data) ``` Устанавливает данные хинта. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `data`[*](*parametr) | — | Тип: Object Данные. || |# \* Обязательный параметр/опция. ### setPosition ```javascript {Hint} setPosition(position) ``` Устанавливает координаты хинта в проекции, заданной в опциях. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `position`[*](*parametr) | — | Тип: Number[] Новая позиция. || |# \* Обязательный параметр/опция. ### show ```javascript {Hint} show([position]) ``` Отображает хинт на карте в точке с заданными координатами. Если хинт уже отображен, перемещает его в указанную точку. **Returns** ссылку на себя. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || `position`[*](*parametr) | — | Тип: Number[] Координаты хинта. || |# \* Обязательный параметр/опция. **Пример:** ```javascript // Показывает хинт на карте, а затем скрывает и вновь показывает его с интервалом в 1 сек. var hint = myMap.hint.show(myMap.getCenter(), 'Test'); setInterval(function () { hint.isShown() ? hint.hide() : hint.show(myMap.getCenter()); }, 1000); ``` [*parametr]:Обязательный параметр/опция.