IHotspotLayerObject
Extends ICustomizable, IDomEventEmitter.
Interface for the hotspot layer object.
Note
A figure describing the hotspot should be set in global pixel coordinates.
Constructor | Fields | Events | Methods
Constructor
IHotspotLayerObject()
Fields
Name |
Type |
Description |
Event manager. Inherited from IDomEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
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 class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
|
End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface. Inherited from IDomEventEmitter. |
|
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:
Inherited from IDomEventEmitter. |
|
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:
Inherited from IDomEventEmitter. |
|
Change to the object options. Inherited from ICustomizable. |
|
Change to the shape that defines a hotspot. Instance of the Event class. |
|
Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. Instance of the MapEvent class. More information is available in domEvent.manager. Inherited from IDomEventEmitter. |
Methods
Name |
Returns |
Description |
Object |
Returns the actual geometry of an object. |
|
Returns object describing a hotspot. |
||
getId() |
Number |
Returns object ID. |
Object |
Returns object data. |
|
Defines the actual geometry of the object. |
||
Sets the object ID. |
||
Sets the object's data. |
Events details
shapechange
Change to the shape that defines a hotspot. Instance of the Event class.
Methods details
getGeometry
{Object} getGeometry()
Returns the actual geometry of an object.
getHotspot
{IHotspot} getHotspot()
Returns object describing a hotspot.
getId
{Number} getId()
Returns object ID.
getProperties
{Object} getProperties()
Returns object data.
setGeometry
{} setGeometry(geometry)
Defines the actual geometry of the object.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object The actual geometry of an object. |
* Mandatory parameter/option.
setId
{} setId(id)
Sets the object ID.
Parameters:
Parameter |
Default value |
Description |
|
— |
Type: Number Object ID. |
* Mandatory parameter/option.
setProperties
{} setProperties(properties)
Sets the object's data.
Parameters:
Parameter |
Default value |
Description |
— |
Type: Object Object data. |
* Mandatory parameter/option.
Mandatory parameter/option.