---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/hotspot.Shape.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# hotspot.Shape

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

Фигура хотспотного объекта.

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

```javascript
hotspot.Shape(feature[, options])
```

Создает фигуру для отображения объекта-хотспота.

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

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

Реальная геометрия объекта. ||
|| `feature.pixelGeometry` | — | Тип: [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md)

Пиксельные координаты фигуры. ||
|| `feature.properties` | — | Тип: Object\|[IDataManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDataManager.md)

Данные объекта. ||
|| `options` | — | Тип: Object

Данные объекта. ||
|| `options.interactivityModel` | 'default#layer' | Тип: String

Ключ модели интерактивности фигуры.
Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/interactivityModel.storage.md). ||
|| `options.zIndex` | — | Тип: Number

zIndex фигуры. ||
|#

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

## Поля {#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) | Событие, оповещающее о смене хотспотной геометрии.

Унаследовано от [IHotspotShape](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). ||
|#

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getContainer](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getContainer)() | IHotspotContainer | Returns контейнер хотспотных шейпов.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getContainer). ||
|| [getGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getGeometry)() | Object | Метод для получения реальной геометрии объекта.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getGeometry). ||
|| [getId](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getId)() | Number | Returns идентификатор объекта.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getId). ||
|| [getProperties](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getProperties)() | Object | Returns данные объекта.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getProperties). ||
|| [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 пиксельную геометрию хотспотного объекта.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#getRenderedGeometry). ||
|| [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)) |  | Метод для добавления хотспотного шейпа в контейнер.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setContainer). ||
|| [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)) |  | Метод для задания реальной геометрии объекта.

Унаследован от [IHotspotShape](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IHotspotShape.md#setGeometry). ||
|| [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)) |  |  ||
|#

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