---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.2
alternate:
  - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/hotspot.Layer.md
  - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md
  - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt?revision=r21950234

# hotspot.Layer

Расширяет [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md), [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md).

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

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

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

```javascript
hotspot.Layer(objectSource[, options])
```

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

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`objectSource`](#param-objectSource)[*](*star) | — | Тип: [IHotspotObjectSource](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotObjectSource.md)

Источник объектов слоя. ||
|| [`options`](#param-options) | — | Тип: Object

Опции слоя. Опции для балунов [Balloon](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Balloon.md) и хинтов [Hint](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Hint.md) хотспотного слоя нужно указывать с префиксами 'balloon' и 'hint'. ||
|| [`options.cursor`](#param-options.cursor) | 'pointer' | Тип: String

Тип курсора. ||
|| [`options.dontChangeCursor`](#param-options.dontChangeCursor) | false | Тип: Boolean

Опция, позволяющая запретить изменение курсора при наведении на объект слоя. По умолчанию курсоры изменяются. ||
|| [`options.hasBalloon`](#param-options.hasBalloon) | true | Тип: Boolean

Флаг, показывающий, есть ли у слоя балуны. Если значение флага false, у слоя не будет создано поле .balloon. ||
|| [`options.hasHint`](#param-options.hasHint) | true | Тип: Boolean

Флаг, показывающий, есть ли у слоя хинты. Если значение флага false, у слоя не будет создано поле .hint. ||
|| [`options.interactivityModel`](#param-options.interactivityModel) | 'default#layer' | Тип: String

Модель интерактивности слоя. Доступные ключи и их значения перечислены в описании [interactivityModel.storage](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/interactivityModel.storage.md). ||
|| [`options.openBalloonOnClick`](#param-options.openBalloonOnClick) | true | Тип: Boolean

Опция, позволяющая запретить открытие балуна при клике на хотспотном объекте. По умолчанию открытие балуна разрешено; ||
|| [`options.openEmptyBalloon`](#param-options.openEmptyBalloon) | false | Тип: String

Открывать балун с пустым содержимым. ||
|| [`options.openEmptyHint`](#param-options.openEmptyHint) | false | Тип: String

Показывать всплывающую подсказку с пустым содержимым. ||
|| [`options.openHintOnHover`](#param-options.openHintOnHover) | true | Тип: Boolean

Опция, позволяющая запретить показ хинта при наведении на хотспотный объект. По умолчанию показ хинтов разрешен. ||
|| [`options.pane`](#param-options.pane) | 'events' | Тип: [IEventPane](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventPane.md)

Контейнер элементов карты, на котором слушаются события. ||
|| [`options.zIndex`](#param-options.zIndex) | — | Тип: Number

Значение zIndex слоя. Когда активный объект ищется в пределах одного слоя, то при одновременном попадании курсора в два объекта выбирается объект с наибольшми значением zIndex. При дальнейшей работе - например при определении, фигура какого слоя является более приоритетной, используется значение zIndex слоя. Обратите внимание, что zIndex слоя будет определять взаимное расположение объектов слоя и одиночных объектов, добавленных в определенные пейны карты. Например, если вы хотите наложить хотспотные объекты поверх площадных объектов, стоит задать хотспотному слою zIndex=201. См. [map.pane.Manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.pane.Manager.md). ||
|#

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

**Пример:**

```javascript
// Создаем источник хотспотных данных. Не указываем значение ключа,
// поэтому имя функции-обработчика (padding jsonp запроса) будет генерироваться динамически.
var objectSource = new ymaps.hotspot.ObjectSource('tiles/?%с'),
    hotspotLayer = new ymaps.hotspot.Layer(objectSource, {
        zIndex: 100,
        // Разрешаем показывать балун без содержимого.
        showEmptyBalloon: true
    });
```

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [balloon](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#balloon) | [hotspot.layer.Balloon](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Balloon.md) | Балун хотспотного слоя. ||
|| [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventEmitter.md#events). ||
|| [hint](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#hint) | [hotspot.layer.Hint](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Hint.md) | Хинт хотспотного слоя. ||
|| [options](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций.

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

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

#|
|| **Имя** | **Описание** ||
|| [addtomap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-addtomap) | Слой добавлен на карту. ||
|| [balloonclose](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-balloonclose) | Закрытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [balloonopen](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-balloonopen) | Открытие балуна на хотспотном слое. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [click](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [contextmenu](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [dblclick](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [hintclose](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-hintclose) | Закрытие хинта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [hintopen](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-hintopen) | Открытие хинта на хотспотном слое. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ||
|| [mousedown](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [mouseenter](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [mouseleave](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [mousemove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [mouseup](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [multitouchend](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [multitouchmove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [multitouchstart](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|| [optionschange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). ||
|| [parentchange](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

- oldParent - старый родитель;
- newParent - новый родитель.

Унаследовано от [IChild](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChild.md#event-parentchange). ||
|| [removefrommap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-removefrommap) | Слой удален с карты. ||
|| [wheel](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется. ||
|#


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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getMap)() | [Map](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md) | Возвращает ссылку на карту. ||
|| [getObjectInPosition](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getObjectInPosition)([coords](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getObjectInPosition-param-coords)) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Метод, позволяющий получить объект слоя в указанной географической точке на текущем масштабе. Если данные для тайла, в который попадает точка, не подгружены, вызов метода спровоцирует их загрузку. После этого поиск будет производиться по загруженным данным. ||
|| [getObjectsInPosition](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getObjectsInPosition)([coords](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getObjectsInPosition-param-coords)) | [vow.Promise](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Метод, позволяющий получить объект слоя в указанной географической точке на текущем масштабе. Если данные для тайла, в который попадает точка, не подгружены, вызов метода спровоцирует их загрузку. После этого поиск будет производиться по загруженным данным. ||
|| [getObjectSource](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#getObjectSource)() | [IHotspotObjectSource](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotObjectSource.md) | Возвращает источник объектов слоя активных областей. ||
|| [getParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IParentOnMap.md)\|null | Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#getParent). ||
|| [setParent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md) | Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

Унаследован от [IChildOnMap](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IChildOnMap.md#setParent). ||
|| [update](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.Layer.md#update)() | | Обновляет слой активных областей. После выполнения этой команды загруженные ранее объекты удаляются из контейнера и запрашиваются новые данные. ||
|#

## Описание полей {#field_detail}

### balloon {#balloon }

```javascript
{hotspot.layer.Balloon} balloon
```

Балун хотспотного слоя.

### hint {#hint}

```javascript
{hotspot.layer.Hint} hint
```

Хинт хотспотного слоя.

## Описание событий {#event_detail}

### addtomap {#addtomap}

Слой добавлен на карту.

### balloonclose {#balloonclose}

Закрытие балуна. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### balloonopen {#balloonopen}

Открытие балуна на хотспотном слое. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### click {#click}

Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### contextmenu {#contextmenu}

Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### dblclick {#dblclick}

Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### hintclose {#hintclose}

Закрытие хинта. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### hintopen {#hintopen}

Открытие хинта на хотспотном слое. Экземпляр класса [Event](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md).

### mousedown {#mousedown}

Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### mouseenter {#mouseenter}

Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### mouseleave {#mouseleave}

Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### mousemove {#mousemove}

Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### mouseup {#mouseup}

Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### multitouchend {#multitouchend}

Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### multitouchmove {#multitouchmove}

Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### multitouchstart {#multitouchstart}

Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Имена полей, доступных через метод IMultiTouchEvent.get:
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

### removeFromMap {#removeFromMap}

Слой удален с карты.

### wheel {#wheel}

Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Экземпляр класса Event. Имена полей, доступных через метод [Event.get](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md#get):
- activeObject ([hotspot.layer.Object](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/hotspot.layer.Object.md)) — объект слоя, на котором произошло событие;
- coords - географические координаты точки, в которой произошло событие;
- globalPixels - координаты события в глобальных пикселях от левого верхнего угла мира;
- pagePixels - координаты события в пикселях от левого верхнего угла страницы;
- clientPixels - координаты события в пикселях от левого верхнего угла окна браузера;
- domEvent - исходное DOM-событие (в виде объекта [DomEvent](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/DomEvent.md)), если оно имеется.

## Описание методов {#method_detail}

### getMap {#getMap}

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

**Возвращает** ссылку на карту.

### getObjectInPosition {#getObjectInPosition}

```javascript
{vow.Promise} getObjectInPosition(coords)
```

Метод, позволяющий получить объект слоя в указанной географической точке на текущем масштабе. Если данные для тайла, в который попадает точка, не подгружены, вызов метода спровоцирует их загрузку. После этого поиск будет производиться по загруженным данным.

**Возвращает** Promise, который будет разрешен объектом слоя, в который попадает заданная точка. Если точка попадает в несколько объектов слоя, вернется объект с максимальным значением zIndex.

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

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

Географические координаты точки. ||
|#

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

### getObjectsInPosition {#getObjectsInPosition}

```javascript
{vow.Promise} getObjectsInPosition(coords)
```

Метод, позволяющий получить объект слоя в указанной географической точке на текущем масштабе. Если данные для тайла, в который попадает точка, не подгружены, вызов метода спровоцирует их загрузку. После этого поиск будет производиться по загруженным данным.

**Возвращает** Promise, который будет разрешен массивом объектов слоя, в которые попадает заданная точка.

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

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

Географические координаты точки. ||
|#

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

### getObjectSource  {#getObjectSource}

```javascript
{IHotspotObjectSource} getObjectSource()
```

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

**Пример:**

```javascript
// Обновление источника данных для слоя активных областей.
hotspotLayer.getObjectSource().setTileUrlTemplate('newSource/?%c');
hotspotLayer.update();
```

### update {#update}

```javascript
{} update()
```

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

<!-- XLIFF_FARM_ZWQ4N2Zl_CACHING -->

[*star]: Обязательный параметр.