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

# objectManager.Hint

Расширяет [IHintManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHintManager.md).

Менеджер хинта объектного слоя. Позволяет управлять хинтом объектного слоя, открывать и скрывать его. Использует внутри себя менеджер хинтов карты [map.Hint](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.Hint.md). Объектные слои содержат экземпляры этого класса, доступные как myObjectManager.objects.hint и myObjectManager.clusters.hint. Не создавайте экземпляры этого класса без необходимости.

**См.:** [Hint](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Hint.md)

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
objectManager.Hint(collection)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`collection`](#param-collection)[*](*star) | — | Тип: IReadOnlyCollection

Объектный слой. ||
|#

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

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
||  [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## События {#events-summary}

#|
|| **Имя** | **Описание** ||
|| [close](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-close) | Закрытие инфо-объекта. Названия полей доступны через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект, на котором был закрыт инфо-объект.

Унаследовано от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-close). ||
|| [open](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-open) | Открытие инфо-объекта. Названия полей доступны через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- target - ссылка на объект, на котором был открыт инфо-объект.

Унаследовано от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#event-open). ||
|#

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [close](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#close)(\[[force](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#close-param-force)]) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Скрывает всплывающую подсказку. ||
|| [destroy](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#destroy)() | | Отключает менеджер инфо-объекта.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#destroy). ||
|| [getData](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#getData)() | Object\|null | Возвращает хэш с описанием объекта, на котором показан хинт или null, если хинт не был показан. ||
|| [getOptions](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOptions)() | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md)\|null | Возвращает менеджер опций или null.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOptions). ||
|| [getOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlay)() | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Возвращает объект-обещание вернуть оверлей.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlay). ||
|| [getOverlaySync](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlaySync)() | [IOverlay](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md)\|null | Возвращает оверлей, если тот существует.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getOverlaySync). ||
|| [getPosition](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getPosition)() | Number[]\|null | Возвращает координаты инфо-объекта или `null`.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#getPosition). ||
|| [isOpen](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#isOpen)([id](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#isOpen-param-id)) | Boolean | Метод, определяющий, показана ли всплывающая подсказка на объекте с переданным идентификатором. ||
|| [open](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#open)([objectId](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#open-param-objectId)[, [position](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#open-param-position)]) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Показывает всплывающую подсказку на объекте с переданным идентификатором. ||
|| [setData](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#setData)([objectData](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/objectManager.Hint.md#setData-param-objectData)) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт новые данные для отображения всплывающей подсказки. ||
|| [setOptions](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions)([options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions-param-options)) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новые опции.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setOptions). ||
|| [setPosition](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setPosition)([position](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setPosition-param-position)) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Задаёт инфо-объекту новую позицию.

Унаследован от [IPopupManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPopupManager.md#setPosition). ||
|#

## Описание методов {#method_detail}

### close {#close}

```javascript
{vow.Promise} close([force])
```

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

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

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`force`](#close-param-force) | false | Тип: Boolean

Мгновенное закрытие. ||
|#


**Пример:**

```javascript
// Закроем все всплывающие подсказки на слое.
objectManager.objects.hint.close();
objectManager.clusters.hint.close();
```

### getData {#getData}

```javascript
{Object|null} getData()
```

**Возвращает** хэш с описанием объекта, на котором показан хинт или null, если хинт не был показан.

**Пример:**

```javascript
var cluster = objectManager.clusters.hint.getData();
if (cluster) {
    alert('Кластер отображает подсказку.');}
```

### isOpen {#isOpen}

```javascript
{Boolean} isOpen(id)
```

Метод, определяющий, показана ли всплывающая подсказка на объекте с переданным идентификатором.

**Возвращает** состояние подсказки: показана/скрыта.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`id`](#isOpen-param-id)[*](*star) | — | Тип: Object

Идентификатор объекта. ||
|#

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

**Пример:**

```javascript
// Скроем подсказку при клике на объекте.
objectManager.objects.add('click', function (e) {
    var objectId = e.get('objectId');
    if (objectManager.objects.hint.isOpen(objectId)) {
        objectManager.objects.hint.close();
    }
});
```

### open {#open}

```javascript
{vow.Promise} open(objectId[, position])
```

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

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

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`objectId`](#open-param-objectId)[*](*star) | — | Тип: Object

Идентификатор объекта, на котором надо открыть подсказку. ||
|| [`position`](#open-param-position) | — | Тип: Number[]

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

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

**Пример:**

```javascript
objectManager.clusters.hint.open(objectId);
```

### setData {#setData}

```javascript
{vow.Promise} setData(objectData)
```

Задаёт новые данные для отображения всплывающей подсказки.

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

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`objectData`](#setData-param-objectData)[*](*star) | — | Тип: Object

Хэш с описанием объекта, на котором открыт хинт. Соответствует описанию объекта, который подается на вход ObjectManager.add. ||
|#

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

**Пример:**

```javascript
objectManager.objects.hint.setData(objectManager.objects.getById(objectId));
```

<!-- XLIFF_FARM_NDg1MTA1_CACHING -->

[*star]: Обязательный параметр.