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

# YMaps.Hotspots.Layer

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

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

Имя | Описание
----- | -----
[YMaps.Hotspots.Layer](hotspots.layer.md#constructor)(objectSource, options) | Создает слой активных областей. Каждая отдельная область в составе слоя представляет собой объект [YMaps.Hotspots.Object](hotspots.object.md).


## Поля

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

## События

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

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;||
||[BalloonOpen](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.layer.md#event-BalloonOpen) | Открытие балуна у объекта слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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) в составе активной области, над которой произошло событие.||
||[Click](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.layer.md#event-Click) | Щелчок мыши по объекту слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-DblClick) | Двойной щелчок мыши по объекту слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-MouseDown) | Над объектом слоя нажата кнопка мыши.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-MouseEnter) | Курсор наведен на объект слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-MouseLeave) | Курсор убран с объекта слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-MouseMove) | Движение мышью над объектом слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.layer.md#event-MouseUp) | Нажатая кнопка мыши отпущена.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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) в составе активной области, над которой произошло событие.||
|#

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getMap](hotspots.layer.md#getMap)() | [YMaps.Map](map.md) | Возвращает карту, на которую добавлен слой активных областей.
[getObjectSource](hotspots.layer.md#getObjectSource)() | [YMaps.Hotspots.ObjectSource](hotspots.objectsource.md) | Возвращает источник объектов слоя активных областей.
[getOptions](hotspots.layer.md#getOptions)() | [YMaps.Hotspots.LayerOptions](hotspots.layeroptions.md) | Возвращает опции слоя.
[setOptions](hotspots.layer.md#setOptions)(options, restoreDefault) |  | Задает опции слоя.
[update](hotspots.layer.md#update)() |  | Обновляет слой активных областей. После выполнения этой команды будут перезапрошены объекты в текущем тайле.


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

```javascript
YMaps.Hotspots.Layer(objectSource, options)
```

Создает слой активных областей. Каждая отдельная область в составе слоя представляет собой объект [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md).

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

Имя | Тип | Описание
----- | ----- | -----
`objectSource` | [YMaps.Hotspots.IObjectSource](hotspots.iobjectsource.md) | Источник объектов слоя.
`options` | [YMaps.Hotspots.LayerOptions](hotspots.layeroptions.md) | Опции слоя.

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

### Events {#Events}

```javascript
Object Events
```

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

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

### BalloonClose {#BalloonClose}

```javascript
BalloonClose
```

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

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

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

```javascript
BalloonOpen
```

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

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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) в составе активной области, над которой произошло событие.
### Click {#Click}

```javascript
Click
```

Щелчок мыши по объекту слоя.

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

- ссылку на слой;
- ссылку на объект-активную область [YMaps.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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.Hotspots.Object](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/hotspots.object.md), над которым произошло событие;
- объект [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}

### getMap {#getMap}

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

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

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

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

### getObjectSource {#getObjectSource}

```javascript
{YMaps.Hotspots.ObjectSource} getObjectSource()
```

Возвращает источник объектов слоя активных областей.

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

Тип | Описание
----- | -----
[YMaps.Hotspots.ObjectSource](hotspots.objectsource.md) | Источник объектов.

### getOptions {#getOptions}

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

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

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

Тип | Описание
----- | -----
[YMaps.Hotspots.LayerOptions](hotspots.layeroptions.md) | Опции слоя.

### setOptions {#setOptions}

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

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

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`options` | [YMaps.Hotspots.LayerOptions](hotspots.layeroptions.md) |  |  | Опции слоя.
`restoreDefault` | Boolean | ![](../_images/check.png) | false | true - восстановить значения по умолчанию для незаданных опций, false - не восстанавливать.

### update {#update}

```javascript
update()
```

Обновляет слой активных областей. После выполнения этой команды будут перезапрошены объекты в текущем тайле.