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

# IHotspotLayerObject

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

Интерфейс объекта слоя активных областей.

{% note info %}

Фигура, описывающая активную область, должна задаваться в глобальных пиксельных координатах.

{% endnote %}

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

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

```javascript
IHotspotLayerObject()
```

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

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

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events). ||
|| [options](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

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

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

#|
|| **Имя** | **Описание** ||
|| [click](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click). ||
|| [contextmenu](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). ||
|| [dblclick](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). ||
|| [mousedown](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). ||
|| [mouseenter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). ||
|| [mouseleave](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). ||
|| [mousemove](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). ||
|| [mouseup](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). ||
|| [multitouchend](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent.

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). ||
|| [multitouchmove](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). ||
|| [multitouchstart](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля:
- clientX - координата касания X относительно видимой области браузера;
- clientY - координата касания Y относительно видимой области браузера;
- pageX - координата касания X касания относительно начала документа;
- pageY - координата касания Y касания относительно начала документа.

Унаследовано от [IDomEventEmitter](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). ||
|| [optionschange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [shapechange](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#event-shapechange) | Изменение фигуры, описывающей активную область. Экземпляр класса [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [wheel](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md).

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

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#getGeometry)() | Object | Возвращает реальную геометрию объекта. ||
|| [getHotspot](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#getHotspot)() | [IHotspot](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspot.md) | Возвращает объект описывающий активную область. ||
|| [getId](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#getId)() | Number | Возвращает идентификатор объекта. ||
|| [getProperties](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#getProperties)() | Object | Возвращает данные объекта. ||
|| [setGeometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setGeometry)([geometry](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setGeometry-param-geometry)) | | Задает реальную геометрию объекта. ||
|| [setId](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setId)([id](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setId-param-id)) | | Задает идентификатор объекта. ||
|| [setProperties](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setProperties)([properties](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotLayerObject.md#setProperties-param-properties)) | | Задает данные объекта. ||
|#

## Описание событий {#event_detail}

### shapechange {#shapechange}

Изменение фигуры, описывающей активную область. Экземпляр класса [Event](https://yandex.com/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

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

### getGeometry {#getGeometry}

```javascript
{Object} getGeometry()
```

**Возвращает** реальную геометрию объекта.

### getHotspot {#getHotspot}

```javascript
{IHotspot} getHotspot()
```

**Возвращает** объект, описывающий активную область.

### getId {#getId}

```javascript
{Number} getId()
```

**Возвращает** идентификатор объекта.

### getProperties {#getProperties}

```javascript
{Object} getProperties()
```

**Возвращает** данные объекта.

### setGeometry {#setGeometry}

```javascript
{} setGeometry(geometry)
```

Задает реальную геометрию объекта.

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

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

Реальная геометрия объекта. ||
|#

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

### setId {#setId}

```javascript
{} setId(id)
```

Задает идентификатор объекта.

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

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

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

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

### setProperties {#setProperties}

```javascript
{} setProperties(properties)
```

Задает данные объекта.

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

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

Данные объекта. ||
|#

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

<!-- XLIFF_FARM_MTFmMzIy_CACHING -->

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