--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOverlay.md - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt # IOverlay Расширяет [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md), [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md). Интерфейс оверлея. [Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) ## Конструктор {#constructor-summary} ```javascript IOverlay() ``` ## Поля {#properties-summary} #| || **Имя** | **Тип** | **Описание** || || [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IEventManager.md) | Менеджер событий. Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#events). || || [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOptionManager.md) | Менеджер опций. Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#options). || |# ## События {#events-summary} #| || **Имя** | **Описание** || || [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Однократное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-click). || || [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Вызов контекстного меню на элементе. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [datachange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-datachange) | Изменение данных. Поля данных: - oldData - старые данные; - newData - новые данные. || || [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Двойное нажатие левой кнопки мыши на объекте. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). || || [emptinesschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-emptinesschange) | Изменение признака пустоты оверлея. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [geometrychange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-geometrychange) | Изменение геометрии. Поля данных: - oldGeometry - старая пиксельная геометрия; - newGeometry - новая пиксельная геометрия. || || [mapchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-mapchange) | Сменилась карта. Поля данных: - oldMap - старая карта; - newMap - новая карта. || || [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Нажатие кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Наведение курсора на объект. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). || || [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Вывод курсора за пределы объекта. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Перемещение курсора над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Отпускание кнопки мыши над объектом. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | Окончание мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent. Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Повторящееся событие при мультисенсорном управлении. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: - clientX - координата касания X относительно видимой области браузера; - clientY - координата касания Y относительно видимой области браузера; - pageX - координата касания X касания относительно начала документа; - pageY - координата касания Y касания относительно начала документа. Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Начало мультисенсорного управления. Данное событие доступно только на устройствах, которые поддерживают множественные сенсорные прикосновения. Возвращает реализацию интерфейса IMultiTouchEvent c информацией о прикосновениях. Определяет свойство touches, которое содержит список прикосновений. Каждое прикосновение описано объектом, которое содержит поля: - clientX - координата касания X относительно видимой области браузера; - clientY - координата касания Y относительно видимой области браузера; - pageX - координата касания X касания относительно начала документа; - pageY - координата касания Y касания относительно начала документа. Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта. Унаследовано от [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [shapechange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#event-shapechange) | Изменение фигуры области охватывающей оверлей. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Скролл мышкой. При использовании следует иметь в виду, что при сенсорном вводе события мыши будут эмулироваться. Экземпляр класса [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/MapEvent.md). Более детальное описание доступно в [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/domEvent.manager.md). Унаследовано от [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Методы {#methods-summary} #| || **Имя** | **Возвращает** | **Описание** || || [getData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getData)() | Object | Возвращает объект данных оверлея. || || [getGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getGeometry)() | [IPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelGeometry.md) | Возвращает текущую пиксельную геометрию. || || [getMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getMap)() | [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md)\|null | Возвращает ссылку на текущую карту. || || [getShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#getShape)() | [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md)\|null | Возвращает фигуру, описывающую форму области, охватывающей оверлей в глобальных пиксельных координатах, либо null, если нет возможности рассчитать фигуру. || || [isEmpty](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#isEmpty)() | Boolean | Возвращает true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие. || || [setData](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setData)([data](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setData-param-data)) | | Задает данные оверлея. || || [setGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setGeometry)([geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setGeometry-param-geometry)) | | Задает пиксельную геометрию оверлея. || || [setMap](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setMap)([map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IOverlay.md#setMap-param-map)) | | Задает карту, на которой должен отобразиться оверлей. || |# ## Описание событий {#event_detail} ### datachange {#datachange} Изменение данных. Поля данных: - oldData - старые данные; - newData - новые данные. ### emptinesschange {#emptinesschange} Изменение признака пустоты оверлея. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ### geometrychange {#geometrychange} Изменение геометрии. Поля данных: - oldGeometry - старая пиксельная геометрия; - newGeometry - новая пиксельная геометрия. ### mapchange {#mapchange} Сменилась карта. Поля данных: - oldMap - старая карта; - newMap - новая карта. ### shapechange {#shapechange} Изменение фигуры области охватывающей оверлей. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ## Описание методов {#method_detail} ### getData {#getData} ```javascript {Object} getData() ``` **Возвращает** объект данных оверлея. ### getGeometry {#getGeometry} ```javascript {IPixelGeometry} getGeometry() ``` **Возвращает** текущую пиксельную геометрию. ### getMap {#getMap} ```javascript {Map|null} getMap() ``` **Возвращает** ссылку на текущую карту. ### getShape {#getShape} ```javascript {IShape|null} getShape() ``` **Возвращает** фигуру, которая описывает форму области, охватывающей оверлей в глобальных пиксельных координатах, либо null, если нет возможности рассчитать фигуру. ### isEmpty {#isEmpty} ```javascript {Boolean} isEmpty() ``` **Возвращает** true, если макет пуст, т.е. не имеет содержимого. Данный признак используется для сокрытия пустых объектов, таких как хинт, балун и другие. ### setData {#setData} ```javascript {} setData(data) ``` Задает данные оверлея. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`data`](#setData-param-data)[*](*star) | — | Тип: Object Данные оверлея. || |# \* Обязательный параметр/опция. ### setGeometry {#setGeometry} ```javascript {} setGeometry(geometry) ``` Задает пиксельную геометрию оверлея. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`geometry`](#setGeometry-param-geometry)[*](*star) | — | Тип: [IPixelGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IPixelGeometry.md) Геометрия в глобальных пиксельных координатах. || |# \* Обязательный параметр/опция. ### setMap {#setMap} ```javascript {} setMap(map) ``` Задает карту, на которой должен отобразиться оверлей. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`map`](#setMap-param-map)[*](*star) | — | Тип: [Map](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Map.md)\|null Ссылка на карту. || |# \* Обязательный параметр/опция. [*star]: Обязательный параметр.