--- metadata: - name: generator content: Diplodoc Platform v5.39.1 alternate: - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt # IHotspotShape Расширяет [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). Интерфейс фигуры, определяющей геометрию активной области. {% note info %} Не поддерживается начиная с версии 2.1. {% endnote %} [Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary) ## Конструктор {#constructor-summary} ```javascript IHotspotShape() ``` ## Поля {#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). || || [containerchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#event-containerchange) | Изменение контейнера. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). || || [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). || || [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). || || [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/IHotspotShape.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} #| || **Имя** | **Возвращает** | **Описание** || || [getContainer](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#getContainer)() | IHotspotContainer | Возвращает контейнер активных областей. || || [getGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#getGeometry)() | Object | Возвращает реальную геометрию фигуры. || || [getId](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#getId)() | Number | Возвращает идентификатор объекта. || || [getProperties](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#getProperties)() | Object | Возвращает данные объекта. || || [getShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#getShape)() | [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md) | Возвращает фигуру, описывающую активную область. || || [setGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setGeometry)([geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setGeometry-param-geometry)) | | Задает реальную геометрию фигуры. || || [setId](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setId)([id](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setId-param-id)) | | Задает идентификатор объекта. || || [setProperties](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setProperties)([properties](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setProperties-param-properties)) | | Задает данные объекта. || || [setShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setShape)([shape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IHotspotShape.md#setShape-param-shape)) | | || |# ## Описание событий {#event_detail} ## containerchange {#containerchange} Изменение контейнера. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ### shapechange {#shapechange} Изменение фигуры, описывающей активную область. Экземпляр класса [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/Event.md). ## Описание методов {#method_detail} ### getContainer {#getContainer} ```javascript {IHotspotContainer} getContainer() ``` **Возвращает** контейнер активных областей. ### getGeometry {#getGeometry} ```javascript {Object} getGeometry() ``` **Возвращает** реальную геометрию фигуры. ### getId {#getId} ```javascript {Number} getId() ``` **Возвращает** идентификатор объекта. ### getProperties {#getProperties} ```javascript {Object} getProperties() ``` **Возвращает** данные объекта. ### getShape {#getShape} ```javascript {IShape} getShape() ``` **Возвращает** фигуру, описывающую активную область. ### setGeometry {#setGeometry} ```javascript {} setGeometry(geometry) ``` Задает реальную геометрию фигуры. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`geometry`](#setGeometry-param-geometry)[*](*star) | — | Тип: Object Реальная геометрия фигуры. || |# \* Обязательный параметр/опция. ### setId {#setId} ```javascript {} setId(id) ``` Задает идентификатор объекта. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`id`](#setId-param-id)[*](*star) | — | Тип: Number Идентификатор объекта. || |# \* Обязательный параметр/опция. ### setProperties {#setProperties} ```javascript {} setProperties(properties) ``` Задает данные объекта. **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`properties`](#setProperties-param-properties)[*](*star) | — | Тип: Object Данные объекта. || |# \* Обязательный параметр/опция. ### setShape {#setShape} ```javascript {} setShape(shape) ``` **Параметры:** #| || **Параметр** | **Значение по умолчанию** | **Описание** || || [`shape`](#setShape-param-shape)[*](*star) | — | Тип: [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/IShape.md) Фигура, описывающая активную область. || |# \* Обязательный параметр/опция. [*star]: Обязательный параметр.