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

# overlay.hotspot.Base

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

Базовый хотспотный оверлей.

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

```javascript
overlay.hotspot.Base([geometry[, data[, options]]])
```

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

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

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

Данные. ||
|| `options` | — | Тип: Object

Опции. ||
|| `options.cursor` | — | Тип: String

Курсор при наведении мыши. ||
|| `options.interactivityModel` | 'default#geoObject' | Тип: String

Модель интерактивности. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/interactivityModel.storage.md). ||
|#

## Поля {#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). ||
|| [datachange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#datachange) | Изменение данных. Поля данных:
• oldData - старые данные;

• newData - новые данные.

Унаследовано от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#datachange). ||
|| [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). ||
|| [geometrychange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#geometrychange) | Изменение геометрии. Поля данных: 
• oldGeometry - старая пиксельная геометрия;

• newGeometry - новая пиксельная геометрия.

Унаследовано от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#geometrychange). ||
|| [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#mapchange) | Сменилась карта. Поля данных: 
• oldMap - старая карта;

• newMap - новая карта.

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [createHotspotGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/overlay.hotspot.Base.md#createHotspotGeometry)([geometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/overlay.hotspot.Base.md#createHotspotGeometry-param-geometry), [data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/overlay.hotspot.Base.md#createHotspotGeometry-param-data)) | [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md) | Returns новая пиксельная геометрия для хотспота. ||
|| [getData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getData)() | Object | Returns объект данных макета.

Унаследован от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getData). ||
|| [getGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getGeometry)() | [IPixelGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IPixelGeometry.md) | Returns текущую пиксельную геометрию.

Унаследован от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getGeometry). ||
|| [getMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getMap)() | [Map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Map.md)\|null | Returns ссылку на текущую карту.

Унаследован от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#getMap). ||
|| [setData](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setData)([data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setData-param-data)) |  | Задает данные оверлея.

Унаследован от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setData). ||
|| [setGeometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setGeometry)([geometry](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setGeometry-param-geometry)) |  | Задает пиксельную геометрию оверлея.

Унаследован от [IOverlay](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setGeometry). ||
|| [setMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setMap)([map](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOverlay.md#setMap-param-map)) |  | Задает карту, на которой должен отобразиться оверлей.

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

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

### createHotspotGeometry

```javascript
{IPixelGeometry} createHotspotGeometry(geometry, data)
```

**Returns** новая пиксельная геометрия для хотспота.

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

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

Пиксельная геометрия. ||
|| `data`[*](*parametr) | — | Тип: [IDataManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IDataManager.md)

Менеджер данных. ||
|#


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

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