Class: HotspotController

Help4.widget.tour.HotspotController(view)

Hotspot controller for tour playback view

Constructor

new HotspotController(view)

Parameters:
Name Type Description
view Help4.widget.tour.View
Properties:
Name Type Description
_view Help4.widget.tour.View
Source:

Extends

Methods

(protected) ____defineStaticProperties()

auto define all to be cleaned properties
Overrides:
Source:
Throws:
Error

(protected) ____getClassConfig() → {Help4.jscore.Base.Params}

Overrides:
Source:
Returns:
Type
Help4.jscore.Base.Params

(protected) ____mergeDerivedParam(level0, type, value)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
type string
value *
Overrides:
Source:
Throws:
Error

(protected) ____mergeDerivedParams(level0, level1)

Parameters:
Name Type Description
level0 Help4.jscore.Base.Params
level1 Help4.jscore.Base.Params
Overrides:
Source:
Throws:
Error

(protected) ____resolveDerivedParams(classConfig)

Parameters:
Name Type Description
classConfig Help4.jscore.Base.Params
Overrides:
Source:

(protected) _destroyControl(…keys)

destroys class properties
Parameters:
Name Type Attributes Description
keys string <repeatable>
Overrides:
Source:

(protected) _fireEvent(event) → {Help4.jscore.Base}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

(async, protected) _fireEvent2(event) → {Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Promise.<Array.<Help4.EmbeddedEvent.EventResponse>>

(protected) _fireEventSync(event) → {Array.<Help4.EmbeddedEvent.EventResponse>}

fires an event that can be observed from outside
Parameters:
Name Type Description
event Object the event to be fired
Overrides:
Source:
Returns:
Type
Array.<Help4.EmbeddedEvent.EventResponse>

addListener(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

addListenerSync(eventType, listener) → {Help4.jscore.Base}

add an event listener
Parameters:
Name Type Description
eventType string | Array.<string> event type to be observed
listener Help4.EmbeddedEvent.Listener the callback function
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

create(isRefreshopt) → {Help4.widget.tour.HotspotController}

create hotspot control
Parameters:
Name Type Attributes Default Description
isRefresh boolean <optional>
 false
Source:
Returns:
Type
Help4.widget.tour.HotspotController

destroy()

destroy instance
Overrides:
Source:

(async) focusElement(tile) → {Promise.<boolean>}

sets focus to hotspot element
Parameters:
Name Type Description
tile Help4.widget.help.ProjectTile
Source:
Returns:
Type
Promise.<boolean>

get(tileIdopt, nullable) → (nullable) {Help4.control2.hotspot.Connected}

get hotspot control
Parameters:
Name Type Attributes Description
tileId string <optional>
<nullable>
Source:
Returns:
Type
Help4.control2.hotspot.Connected

isDestroyed() → {boolean}

whether instance is destroyed
Overrides:
Source:
Returns:
Type
boolean

remove(tileIdopt, nullable) → (nullable) {Help4.control2.hotspot.Connected}

remove hotspot control
Parameters:
Name Type Attributes Default Description
tileId string <optional>
<nullable>
 null
Source:
Returns:
Type
Help4.control2.hotspot.Connected

removeListener(eventType, listener) → {Help4.jscore.Base}

remove an event listener
Parameters:
Name Type Description
eventType string | Array.<string>
listener Help4.EmbeddedEvent.Listener
Overrides:
Source:
Returns:
Type
Help4.jscore.Base

update() → {Help4.widget.tour.HotspotController}

Source:
Returns:
Type
Help4.widget.tour.HotspotController

Type Definitions

ControlParams

Type:
  • Object
Properties:
Name Type Attributes Description
animationType string
delta Help4.control2.SizeWidthHeight
hotspotType string
icon string
number number <nullable>
point Help4.control2.PositionXY
pos string
rect Help4.control2.AreaXYWH
size string
spotlight boolean
spotlightBlur number
spotlightOffset number
spotlightOpacity number
title string <nullable>
active boolean
visible boolean
_metadata Object
Properties
Name Type Description
tileId string
hotspotId string
controlStyle string
controlType string <optional>
ariaLabel string <optional>
Source: