---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.Hotspots.Overlay

Расширяет [YMaps.IInteractiveGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md), [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md).

Активная области на карте, заданная в географических координатах.

Активные области используются для разметки объектов, непосредственно нарисованных на карте. API Яндекс.Карт автоматически обсчитывает движения мыши и, если какое-то действие произошло над активной областью, генерирует соответствующие события и выполняет стандартные сценарии - показ всплывающей подсказки, балуна, автоматическая смена курсора.

Для того, чтобы задать активную область, необходимо описать ее геометрию. Геометрия активной области представляется набором многоугольников и задается в конструкторе.

## Конструктор

Имя | Описание
----- | -----
[YMaps.Hotspots.Overlay](hotspots.overlay.md#constructor)(geometry, options) | Создает активную область.


## Поля

Имя | Описание
----- | -----
[Events](hotspots.overlay.md#Events) | Список событий активной области.

# Наследуемые поля

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [description](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#description), [id](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#id), [metaDataProperty](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#metaDataProperty), [name](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#name)

## События

#|
|| **Имя** | **Описание** ||
||[BalloonClose](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-BalloonClose) | Событие закрытия балуна области.

Обработчик события получает параметром ссылку на активную область.||
||[BalloonOpen](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-BalloonOpen) | Событие открытия балуна области.

Обработчик события получает параметром ссылку на активную область.||
||[Click](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-Click) | Щелчок мыши по области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[DblClick](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-DblClick) | Двойной щелчок мыши по области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[MouseDown](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-MouseDown) | Над областью нажата кнопка мыши.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[MouseEnter](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-MouseEnter) | Курсор наведен на область.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[MouseLeave](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-MouseLeave) | Курсор убран с области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[MouseMove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-MouseMove) | Движение мышью над областью.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
||[MouseUp](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.overlay.md#event-MouseUp) | ажатая кнопка мыши отпущена.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.||
|#

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getGeometry](hotspots.overlay.md#getGeometry)() | Object[] | Возвращает геометрию активной области.
[getMap](hotspots.overlay.md#getMap)() | [YMaps.Map](map.md) | Возвращает карту, на которую добавлена активная область.
[getNumShapes](hotspots.overlay.md#getNumShapes)() | Integer | Возвращает число геометрических фигур, описывающих активную область.
[getOptions](hotspots.overlay.md#getOptions)() | [YMaps.Hotspots.OverlayOptions](hotspots.overlayoptions.md) | Возвращает опции области.
[getShape](hotspots.overlay.md#getShape)(index) | [YMaps.Hotspots.IShape](hotspots.ishape.md) | Возвращает представление геометрической фигуры в составе активной области по ее индексу. Координаты точек отдаются в пикселах на текущем масштабе.
[openBalloon](hotspots.overlay.md#openBalloon)(content, options, point) |  | Открывает балун над активной областью. Если не передана точка открытия, то балун открывается в геометрическом центре первой фигуры области.
[setGeometry](hotspots.overlay.md#setGeometry)(geometry) |  | Устанавливает активной области новую геометрию.
[setOptions](hotspots.overlay.md#setOptions)(options, restoreDefault) |  | Задает опции области.

## Наследуемые методы


Из [YMaps.IOverlay](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onAddToMap), [onMapUpdate](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onMapUpdate), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ioverlay.md#onRemoveFromMap)

Из [YMaps.IInteractiveGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md): 
: [closeBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#closeBalloon), [getBalloon](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloon), [getBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonContent), [getBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getBalloonOptions), [getHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintContent), [getHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#getHintOptions), [setBalloonContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonContent), [setBalloonOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setBalloonOptions), [setHintContent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintContent), [setHintOptions](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#setHintOptions), [update](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/iinteractivegeoobject.md#update)

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [getBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getBounds), [getComputedStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getComputedStyle), [getParentGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getParentGroup), [getStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getStyle), [onAddToGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onAddToGroup), [onRemoveFromGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onRemoveFromGroup), [setBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setBounds), [setStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setStyle)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.Hotspots.Overlay(geometry, options)
```

Создает активную область.

**Пример:**

```javascript
var hOverlay = new YMaps.Hotspots.Overlay([
 {
     shape: 'rect', // shape - вид фигуры; 'rect' соответствует прямоугольнику
     // coords - координаты фигуры; для прямоугольника указываются юго-западный и северо-восточный углы
     coords: [ new YMaps.GeoPoint(10, 10), new YMaps.GeoPoint(20, 20) ]
 },
 // такое объявление - сокращенный способ задания прямоугольника
 [ new YMaps.GeoPoint(30, 10), new YMaps.GeoPoint(40, 20) ],
 {
     shape: 'cpoly', // 'cpoly' соответствует выпуклому многоугольнику
     coords: [
         // coords - массив координат вершин многоугольника
         new YMaps.GeoPoint(50, 10),
         new YMaps.GeoPoint(60, 30),
         new YMaps.GeoPoint(70, 20),
         new YMaps.GeoPoint(60, 10)
     ]
 },
 {
     shape: 'npoly', // 'npoly' соответствует невыпуклому многоугольнику
     coords: [
         // coords - массив координат вершин многоугольника.
         new YMaps.GeoPoint(80, 10),
         new YMaps.GeoPoint(90, 30),
         new YMaps.GeoPoint(100, 10),
         new YMaps.GeoPoint(90, 20)
     ]
 }
]);
```

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`geometry` | Object[] |  |  | Описание геометрии области. Область состоит из множества геометрических фигур. Каждая фигура описывается объектом с двумя полями: shape - форма фигуры, coords - массив точек [YMaps.ICoordPoint](icoordpoint.md). Допустимые значения поля shape: 'rect' - прямоугольник (задается двумя точками: левой нижней и правой верхней), 'cpoly' - выпуклый многоугольник, 'npoly' - невыпуклый многоугольник.
`options` | [YMaps.Hotspots.OverlayOptions](hotspots.overlayoptions.md) | ![](../_images/check.png) |  | Опции.

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

Список событий активной области.

## Подробное описание событий {#event_detail}

### BalloonClose {#BalloonClose}

```javascript
BalloonClose
```

Событие закрытия балуна области.

Обработчик события получает параметром ссылку на активную область.
### BalloonOpen {#BalloonOpen}

```javascript
BalloonOpen
```

Событие открытия балуна области.

Обработчик события получает параметром ссылку на активную область.
### Click {#Click}

```javascript
Click
```

Щелчок мыши по области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### DblClick {#DblClick}

```javascript
DblClick
```

Двойной щелчок мыши по области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### MouseDown {#MouseDown}

```javascript
MouseDown
```

Над областью нажата кнопка мыши.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### MouseEnter {#MouseEnter}

```javascript
MouseEnter
```

Курсор наведен на область.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### MouseLeave {#MouseLeave}

```javascript
MouseLeave
```

Курсор убран с области.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### MouseMove {#MouseMove}

```javascript
MouseMove
```

Движение мышью над областью.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
### MouseUp {#MouseUp}

```javascript
MouseUp
```

ажатая кнопка мыши отпущена.

Обработчик события получает следующие параметры:

- ссылку на активную область;
- объект [YMaps.MouseEvent](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/mouseevent.md), описывающий событие;
- геометрическую фигуру [YMaps.Hotspots.IShape](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.ishape.md) в составе активной области, над которой произошло событие.
## Подробное описание методов {#method_detail}

### getGeometry {#getGeometry}

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

Возвращает геометрию активной области.

**Возвращает:**

Тип | Описание
----- | -----
Object[] | Описание геометрии.

### getMap {#getMap}

```javascript
{YMaps.Map} getMap()
```

Возвращает карту, на которую добавлена активная область.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Map](map.md) | Карту.

### getNumShapes {#getNumShapes}

```javascript
{Integer} getNumShapes()
```

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

**Возвращает:**

Тип | Описание
----- | -----
Integer | Число фигур.

### getOptions {#getOptions}

```javascript
{YMaps.Hotspots.OverlayOptions} getOptions()
```

Возвращает опции области.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Hotspots.OverlayOptions](hotspots.overlayoptions.md) | Опции области.

### getShape {#getShape}

```javascript
{YMaps.Hotspots.IShape} getShape(index)
```

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

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

Имя | Тип | Описание
----- | ----- | -----
`index` | Integer | Индекс фигуры, считая с 0.


**Возвращает:**

Тип | Описание
----- | -----
[YMaps.Hotspots.IShape](hotspots.ishape.md) | Фигура.

### openBalloon {#openBalloon}

```javascript
openBalloon(content, options, point)
```

Открывает балун над активной областью. Если не передана точка открытия, то балун открывается в геометрическом центре первой фигуры области.

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`content` | String|HTMLElement | ![](../_images/check.png) |  | Содержимое балуна.
`options` | [YMaps.MapBalloonOptions](mapballoonoptions.md) | ![](../_images/check.png) |  | Опции балуна.
`point` | [YMaps.ICoordPoint](icoordpoint.md) | ![](../_images/check.png) |  | Точка открытия балуна.

### setGeometry {#setGeometry}

```javascript
setGeometry(geometry)
```

Устанавливает активной области новую геометрию.

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

Имя | Тип | Описание
----- | ----- | -----
`geometry` | Object[] | Описание геометрии.

### setOptions {#setOptions}

```javascript
setOptions(options, restoreDefault)
```

Задает опции области.

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

Имя | Тип | Описание
----- | ----- | -----
`options` | [YMaps.Hotspots.OverlayOptions](hotspots.overlayoptions.md) | Опции области.
`restoreDefault` | Boolean | Восстановить значения по умолчанию.