---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md
---
# IHotspotShape

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

Интерфейс фигуры, определяющей геометрию активной области.

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

```javascript
IHotspotShape()
```

Создает фигуру, определяющую геометрию активной области.


{% note info %}

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

{% endnote %}

## Поля {#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). ||
|| [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер опций.

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

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

#|
|| **Имя** | **Описание** ||
|| [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). ||
|| [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). ||
|| [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#optionschange). ||
|| [renderedgeometrychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#renderedgeometrychange) | Событие, оповещающее о смене хотспотной геометрии. ||
|| [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). ||
|#

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getContainer](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getContainer)() | IHotspotContainer | Returns контейнер хотспотных шейпов. ||
|| [getGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getGeometry)() | Object | Метод для получения реальной геометрии объекта. ||
|| [getId](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getId)() | Number | Returns идентификатор объекта. ||
|| [getProperties](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getProperties)() | Object | Returns данные объекта. ||
|| [getRenderedGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getRenderedGeometry)() | [IHotspotShapeGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShapeGeometry.md) | Returns пиксельную геометрию хотспотного объекта. ||
|| [setContainer](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setContainer)([container](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setContainer-param-container)) |  | Метод для добавления хотспотного шейпа в контейнер. ||
|| [setGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setGeometry)([geometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setGeometry-param-geometry)) |  | Метод для задания реальной геометрии объекта. ||
|| [setId](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setId)([id](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setId-param-id)) |  |  ||
|| [setProperties](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setProperties)([properties](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setProperties-param-properties)) |  |  ||
|| [setRenderedGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setRenderedGeometry)([renderedGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setRenderedGeometry-param-renderedGeometry)) |  |  ||
|#

## Описание событий {#description-events}

### renderedgeometrychange

Событие, оповещающее о смене хотспотной геометрии.

## Описание методов {#description-methods}

### getContainer

```javascript
{IHotspotContainer} getContainer()
```

**Returns** контейнер хотспотных шейпов.

### getGeometry

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

Метод для получения реальной геометрии объекта.

**Returns** объект-геометрию.

### getId

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

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

### getProperties

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

**Returns** данные объекта.

### getRenderedGeometry

```javascript
{IHotspotShapeGeometry} getRenderedGeometry()
```

**Returns** пиксельную геометрию хотспотного объекта.

### setContainer

```javascript
{} setContainer(container)
```

Метод для добавления хотспотного шейпа в контейнер.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `container`[*](*parametr) | — | Тип: IHotspotContainer

Контейнер, в который добавляется шейп. ||
|#

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

### setGeometry

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

Метод для задания реальной геометрии объекта.

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

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

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

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

### setId

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

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

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

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

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

### setProperties

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

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

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

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

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

### setRenderedGeometry

```javascript
{} setRenderedGeometry(renderedGeometry)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `renderedGeometry`[*](*parametr) | — | Тип: [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md)

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


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

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