--- 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/en/llms.txt # IHotspotShape Extends [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md), [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md). Interface of a shape that defines the hotspot geometry. {% note info %} Not supported, beginning from version 2.1. {% endnote %} [Constructor](#constructor-summary) | [Fields](#properties-summary) | [Events](#events-summary) | [Methods](#methods-summary) ## Constructor {#constructor-summary} ```javascript IHotspotShape() ``` ## Fields {#properties-summary} #| || **Name** | **Type** | **Description** || || [events](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events) | [IEventManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IEventManager.md) | Event manager. Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#events). || || [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IOptionManager.md) | Options manager. Inherited from [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#options). || |# ## Events {#events-summary} #| || **Name** | **Description** || || [click](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click) | Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-click). || || [containerchange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#event-containerchange) | Change to the container. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. || || [contextmenu](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu) | Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-contextmenu). || || [dblclick](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick) | Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-dblclick). || || [mousedown](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown) | Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousedown). || || [mouseenter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter) | Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseenter). || || [mouseleave](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave) | Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseleave). || || [mousemove](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove) | Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mousemove). || || [mouseup](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup) | Letting go of the mouse button over an object. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-mouseup). || || [multitouchend](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend) | End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchend). || || [multitouchmove](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove) | Repeating event during multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchmove). || || [multitouchstart](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart) | Start of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface with information about touches. Defines the touches property, which contains a list of touches. Every touch is described by an object that contains the following fields: - clientX - X coordinate of the touch relative to the viewable area of the browser. - clientY - Y coordinate of the touch relative to the viewable area of the browser. - pageX - X coordinate of the touch relative to the beginning of the document. - pageY - Y coordinate of the touch relative to the beginning of the document. Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-multitouchstart). || || [optionschange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange) | Change to the object options. Inherited from [ICustomizable](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ICustomizable.md#event-optionschange). || || [shapechange](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#event-shapechange) | Change to the shape that defines a hotspot. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. || || [wheel](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel) | Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the [MapEvent](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/MapEvent.md) class. More information is available in [domEvent.manager](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/domEvent.manager.md). Inherited from [IDomEventEmitter](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IDomEventEmitter.md#event-wheel). || |# ## Methods {#methods-summary} #| || **Name** | **Returns** | **Description** || || [getContainer](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#getContainer)() | IHotspotContainer | Returns the hotspot container. || || [getGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#getGeometry)() | Object | Returns the actual shape geometry. || || [getId](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#getId)() | Number | Returns object ID. || || [getProperties](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#getProperties)() | Object | Returns object data. || || [getShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#getShape)() | [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IShape.md) | Returns shape describing a hotspot. || || [setGeometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setGeometry)([geometry](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setGeometry-param-geometry)) | | Sets the actual geometry of the shape. || || [setId](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setId)([id](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setId-param-id)) | | Sets the object ID. || || [setProperties](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setProperties)([properties](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setProperties-param-properties)) | | Sets the object's data. || || [setShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setShape)([shape](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IHotspotShape.md#setShape-param-shape)) | | || |# ## Events details {#event_detail} ### containerchange {#containerchange} Change to the container. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. ### shapechange {#shapechange} Change to the shape that defines a hotspot. Instance of the [Event](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/Event.md) class. ## Methods details {#method_detail} ### getContainer {#getContainer} ```javascript {IHotspotContainer} getContainer() ``` **Returns** the hotspot container. ### getGeometry {#getGeometry} ```javascript {Object} getGeometry() ``` **Returns** the actual shape geometry. ### getId {#getId} ```javascript {Number} getId() ``` **Returns** object ID. ### getProperties {#getProperties} ```javascript {Object} getProperties() ``` **Returns** object data. ### getShape {#getShape} ```javascript {IShape} getShape() ``` **Returns** shape describing a hotspot. ### setGeometry {#setGeometry} ```javascript {} setGeometry(geometry) ``` Sets the actual geometry of the shape. **Parameters:** #| || **Parameter** | **Default value** | **Description** || || [`geometry`](#setGeometry-param-geometry)[*](*star) | — | Type: Object Actual shape geometry. || |# \* Mandatory parameter/option. ### setId {#setId} ```javascript {} setId(id) ``` Sets the object ID. **Parameters:** #| || **Parameter** | **Default value** | **Description** || || [`id`](#setId-param-id)[*](*star) | — | Type: Number Object ID. || |# \* Mandatory parameter/option. ### setProperties {#setProperties} ```javascript {} setProperties(properties) ``` Sets the object's data. **Parameters:** #| || **Parameter** | **Default value** | **Description** || || [`properties`](#setProperties-param-properties)[*](*star) | — | Type: Object Object data. || |# \* Mandatory parameter/option. ### setShape {#setShape} ```javascript {} setShape(shape) ``` **Parameters:** #| || **Parameter** | **Default value** | **Description** || || [`shape`](#setShape-param-shape)[*](*star) | — | Type: [IShape](https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/IShape.md) Shape describing a hotspot. || |# \* Mandatory parameter/option. [*star]: Mandatory parameter/option.