[NOT YET IMPLEMENTED] Interactive clickable hotspots that can track objects on screen and trigger JavaScript or Overlays.

Methods

Clickable(di)

Item Value
Scope Constructor
Returns Clickable

Parameters

Parameter Description
Object di DI object

Initialise clickable plugin. This will loop through all the hotspots Clickable.hotspots and animate their positions, firing events when they are clicked


Properties

hotspots

Item Value
Scope public
Returns Array

An array of all hotspot objects


shown

Item Value
Scope public
Returns Array

An array of hotspot objects that have been shown


clicked

Item Value
Scope public
Returns Array

An array of hotspot objects that have been clicked


enabled

Item Value
Scope public
Returns Boolean

Returns if clickable enabled


Events

clickablePluginInitialised

Fired on plugin being initialised


clickablePluginReady

Fired on plugin being ready to interact with


clickableEnabled

Fired when Clickable.enable() is called


clickableDisabled

Fired when Clickable.disable() is called


hotspotClicked

Fired when a hotspot is clicked

{
    hotspotId:234
}

Listeners

timeupdate

It listens to the Video.timeupdate event so it can sync the hotspots


enableClickable

Enable clickable events / hotspots


disableClickable

Disable clickable - hotspots will not be shown


showHotspot

Parameters

Parameter Description
String hotspotId Id of the hotspot to be shown

This will show a hotspot

{
    hotspotId: 'a32fds3'
}

hotspotClicked

Parameters

Parameter Description
String hotspotId Id of the hotspot that has been clicked

This will trigger the event associated with that hotspot

{
    hotspotId: 'a32fds3'
}