Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces
2.1.51 (release candidate)
collection
interactivityModel
Interfaces

IHotspotShape

Extends ICustomizable, IDomEventEmitter.

Interface of a shape that defines the hotspot geometry.

Note. Not supported, beginning from version 2.1.

Constructor | Fields | Events | Methods

Constructor

IHotspotShape()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IDomEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

Events

NameDescription
click

Single left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

containerchange

Change to the container. Instance of the Event class.

contextmenu

Calls the element's context menu. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

dblclick

Double left-click on the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mousedown

Pressing the mouse button over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseenter

Pointing the cursor at the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mouseleave

Moving the cursor off of the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

mousemove

Moving the cursor over the object. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

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. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

multitouchend

End of multitouch. This event is only available on devices that support multitouch. Returns an implementation of the IMultiTouchEvent interface.

Inherited from IDomEventEmitter.

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.

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.

optionschange

Change to the object options.

Inherited from ICustomizable.

shapechange

Change to the shape that defines a hotspot. Instance of the Event class.

wheel

Mouse wheel scrolling. When using, keep in mind that mouse events are emulated when a touch screen is used. More information is available in domEvent.manager.

Inherited from IDomEventEmitter.

Methods

NameReturnsDescription
getContainer()

IHotspotContainer

Returns the hotspot container.

getGeometry()

Object

Returns the actual shape geometry.

getId()

Number

Returns object ID.

getProperties()

Object

Returns object data.

getShape()

IShape

Returns shape describing a hotspot.

setGeometry(geometry)

Sets the actual geometry of the shape.

setId(id)

Sets the object ID.

setProperties(properties)

Sets the object's data.

setShape(shape)

Events details

containerchange

Change to the container. Instance of the Event class.

shapechange

Change to the shape that defines a hotspot. Instance of the Event class.

Methods details

getContainer

{IHotspotContainer} getContainer()

Returns the hotspot container.

getGeometry

{Object} getGeometry()

Returns the actual shape geometry.

getId

{Number} getId()

Returns object ID.

getProperties

{Object} getProperties()

Returns object data.

getShape

{IShape} getShape()

Returns shape describing a hotspot.

setGeometry

{} setGeometry(geometry)

Sets the actual geometry of the shape.

Parameters:

ParameterDefault valueDescription
geometry*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Actual shape geometry.

* Mandatory parameter/option.

setId

{} setId(id)

Sets the object ID.

Parameters:

ParameterDefault valueDescription
id*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Number

Object ID.

* Mandatory parameter/option.

setProperties

{} setProperties(properties)

Sets the object's data.

Parameters:

ParameterDefault valueDescription
properties*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: Object

Object data.

* Mandatory parameter/option.

setShape

{} setShape(shape)

Parameters:

ParameterDefault valueDescription
shape*
[no-highlight[

* Mandatory parameter/option.

]no-highlight]

Type: IShape

Shape describing a hotspot.

* Mandatory parameter/option.