---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hint.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Hint

Всплывающая подсказка.

Данный класс не имеет конструктора.

Объект класса YMaps.Hint существует для каждой карты в единственном экземпляре и доступен в объекте карты как [YMaps.Map.hint](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/map.md#hint).

## Поля

Имя | Описание
----- | -----
[Events](hint.md#Events) | Список обрабатываемых событий подсказки.

## События

Имя | Описание
----- | -----
[Hide](hint.md#event-Hide) | Скрытие подсказки.
[Show](hint.md#event-Show) | Показ подсказки.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getContentLayout](hint.md#getContentLayout)() | [YMaps.ILayout](ilayout.md) | Возвращает макет содержимого всплывающей подсказки.
[getLayout](hint.md#getLayout)() | [YMaps.IHintLayout](ihintlayout.md) | Возвращает макет подсказки.
[hide](hint.md#hide)(hideTimeout) |  | Скрывает всплывающую подсказку.
[isShown](hint.md#isShown)() | Boolean | Возвращает текущее состояние всплывающей подсказки: true - подсказка показана на карте, false - подсказка скрыта.
[moveTo](hint.md#moveTo)(position) |  | Перемещает всплывающую подсказку в заданную позицию.
[setContent](hint.md#setContent)(content) |  | Устанавливает содержимое всплывающей подсказки.
[setOptions](hint.md#setOptions)(options) |  | Устанавливает опции всплывающей подсказки.
[show](hint.md#show)(position, content, options) |  | Показывает всплывающую подсказку с заданными параметрами.

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

Список обрабатываемых событий подсказки.

## Подробное описание событий {#event_detail}

### Hide {#Hide}

```javascript
Hide
```

Скрытие подсказки. В callback-функцию передается указатель на подсказку.
### Show {#Show}

```javascript
Show
```

Показ подсказки. В callback-функцию передается указатель на подсказку.
## Подробное описание методов {#method_detail}

### getContentLayout {#getContentLayout}

```javascript
{YMaps.ILayout} getContentLayout()
```

Возвращает макет содержимого всплывающей подсказки. Если подсказка не отображена, то возвращает null.

**Пример:**

```javascript
var layout = map.hint.getContentLayout();
layout.getRootNodes().css('font-style', 'italic');
```

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.ILayout](ilayout.md) | Макет содержимого всплывающей подсказки.

### getLayout {#getLayout}

```javascript
{YMaps.IHintLayout} getLayout()
```

Возвращает макет подсказки. Если подсказка не отображена, то возвращает null.

**Пример:**

```javascript
var layout = map.hint.getLayout();
YMaps.jQuery(layout.getRootNodes()).addClass('my-hint-class');
```

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.IHintLayout](ihintlayout.md) | Макет подсказки.

### hide {#hide}

```javascript
hide(hideTimeout)
```

Скрывает всплывающую подсказку.

Подсказка может быть скрыта либо немедленно, либо через заданный интервал времени (если указан параметр hideTimeout).


{% note info %}

Всплывающая подсказка не будет скрыта, если курсор мыши находится над подсказкой и опция holdOnMouseOver установлена в true.

{% endnote %}


**Параметры:**

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`hideTimeout` | Number | ![](../_images/check.png) |  | Интервал времени (в миллисекундах), спустя который всплывающая подсказка должна быть скрыта.

### isShown {#isShown}

```javascript
{Boolean} isShown()
```

Возвращает текущее состояние всплывающей подсказки: true - подсказка показана на карте, false - подсказка скрыта.

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - всплывающая подсказка показана на карте, false - скрыта.

### moveTo {#moveTo}

```javascript
moveTo(position)
```

Перемещает всплывающую подсказку в заданную позицию.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`position` | [YMaps.Point](point.md) | Позиция, в которую требуется переместить всплывающую подсказку. Задается локальными пиксельными координатами, см. [Преобразование координат](../../dg/concepts/coordinates_conversion.md).

### setContent {#setContent}

```javascript
setContent(content)
```

Устанавливает содержимое всплывающей подсказки. Если в параметре content передана строка, то контейнером для содержимого подсказки станет элемент div. Переданная строка станет значением свойства innerHTML элемента div.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`content` | String|HTMLElement|[YMaps.ILayout](ilayout.md) | Содержимое всплывающей подсказки (строка, DOM-элемент или макет).

### setOptions {#setOptions}

```javascript
setOptions(options)
```

Устанавливает опции всплывающей подсказки.

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`options` | [YMaps.HintOptions](hintoptions.md) | Опции всплывающей подсказки.

### show {#show}

```javascript
show(position, content, options)
```

Показывает всплывающую подсказку с заданными параметрами.

**Пример:**

```javascript
// Показывает подсказку в центре карты.
map.hint.show(map.converter.coordinatesToLocalPixels(map.getCenter()), 'Центр карты', {showTimeout: 500});
```

**Параметры:**

Имя | Тип | Описание
----- | ----- | -----
`position` | [YMaps.Point](point.md) | Позиция, в которой требуется показать всплывающую подсказку. Задается локальными пиксельными координатами, см. [Преобразование координат](../../dg/concepts/coordinates_conversion.md).
`content` | String|HTMLElement|[YMaps.ILayout](ilayout.md) | Содержимое всплывающей подсказки.
`options` | [YMaps.MapHintOptions](maphintoptions.md) | Опции всплывающей подсказки.