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

# geoObject.Hint

Extends [IHintManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHintManager.md).

Geo object hint manager. Allows a geo object to manage a hint by opening it and hiding it. Passes data to the hint in the format [IGeoObjectPopupData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IGeoObjectPopupData.md). Uses the map hint manager [map.Hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.Hint.md) internally. Geo objects contain an instance of this class, which is available as myGeoObject.hint. Don't create new instances of this class unless necessary.

**See** [Hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Hint.md)[GeoObject.hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/GeoObject.md#hint)

[Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary)

## Constructor {#constructor-summary}

```javascript
geoObject.Hint(geoObject)
```

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`geoObject`](#param-geoObject)[*](*star) | — | Type: Object

Geo object. ||
|#

\* Mandatory parameter/option.

## Fields {#properties-summary}

#|
|| **Name** | **Type** | **Description** ||
|| [events](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md)| Event manager.

Inherited from [IEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventEmitter.md#events). ||
|#

## Events {#events-summary}

#|
|| **Name** | **Description** ||
|| [close](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-close)| Closing the info object. Names of fields available via [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get): 
- target - Reference to the object where the closing occurred.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-close). ||
|| [open](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-open)| Opening the info object. Names of fields available via [Event.get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md#get): 
- target - Reference to the object where the opening occurred.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#event-open). ||
|#

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [close](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#close)(\[[force](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#close-param-force)]) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Closes the info object.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#close). ||
|| [destroy](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#destroy)() | | Disables the info object manager.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#destroy). ||
|| [getData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getData)() | Object\|null
| Returns the data of the info object or 'null'.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getData). ||
|| [getOptions](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOptions)() | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md)\|null
| Returns the options manager or 'null'.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOptions). ||
|| [getOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlay)() | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Returns the promise object to return the overlay.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlay). ||
|| [getOverlaySync](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlaySync)() | [IOverlay](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md)\|null
| Returns the overlay, if one exists.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getOverlaySync). ||
|| [getPosition](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getPosition)() | Number[]\|null
| Returns the coordinates of the info object or 'null'.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#getPosition). ||
|| [isOpen](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#isOpen)() | Boolean
| Returns the info object state: open/closed.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#isOpen). ||
|| [open](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#open)(\[[position](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#open-param-position)[, [data](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#open-param-data)[, [options](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#open-param-options)]]]) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Opens the hint for the geo object. ||
|| [setData](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#setData)(\[[data](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/geoObject.Hint.md#setData-param-data)]) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Sets new user data. ||
|| [setOptions](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions)([options](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions-param-options)) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Defines new options for the info object.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setOptions). ||
|| [setPosition](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setPosition)([position](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setPosition-param-position)) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md)
| Specifies a new position for the info object.

Inherited from [IPopupManager](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IPopupManager.md#setPosition). ||
|#

## Methods details {#method_detail}

### open {#open}

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

Opens the hint for the geo object.

**Returns** Promise object.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`position`](#open-param-position) | — | Type: Number[]

Coordinates of the point where the hint is opened. By default: the geometric center of gravity of the geoobject. The projection of the coordinates can be specified in the options, otherwise the geo object projection is used. ||
|| [`data`](#open-param-data) | — | Type: Object

Data to add to the _userData_ field for the object of data passed to the hint. ||
|| [`options`](#open-param-options) | — | Type: Object

Options. ||
|#


### setData {#setData}

```javascript
{vow.Promise} setData([data])
```

Sets new user data.

**Returns** Promise object.

**Parameters:**

#|
|| **Parameter** | **Default value** | **Description**  ||
|| [`data`](#setData-param-data) | — | Type: Object

Data to add to the _userData_ field for the object of data passed to the hint. ||
|#


[*star]: Mandatory parameter/option.