Class: Core

Help4.widget.companionCore.Core()

core functionality

Constructor

new Core()

Source:

Methods

(static) addStandardViewParameters(widget, params, domModeopt, nullable) → {Object}

Parameters:
Name Type Attributes Default Description
widget Help4.widget.Widget
params Object
domMode 'full' | 'contentDiv' <optional>
<nullable>
 null
Source:
Returns:
Type
Object

(static) broadcastXhrStatus(xhropt, nullable)

Parameters:
Name Type Attributes Default Description
xhr Help4.typedef.XmlHttpResponse <optional>
<nullable>
 null
Source:

(static) disconnectDomRefresh(executor, context)

Parameters:
Name Type Description
executor function
context Help4.widget.Widget.Context
Source:

(static) getCatalogueKey(params) → {Help4.widget.help.CatalogueKeys}

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
configuration Help4.typedef.SystemConfiguration <optional>
context Help4.widget.Widget.Context <optional>
Source:
Returns:
Type
Help4.widget.help.CatalogueKeys

(async, static) getElementHotspotStatus(hotspotAnchor, useDescendentsopt) → {Promise.<?Object>}

Parameters:
Name Type Attributes Default Description
hotspotAnchor string
useDescendents boolean <optional>
 false
Source:
Returns:
Type
Promise.<?Object>

(static) observeDomRefresh(executor, context, scopeopt)

Parameters:
Name Type Attributes Description
executor function
context Help4.widget.Widget.Context
scope Object <optional>
Source:

(static) projectTileToHotspotData(projectTile, hotspotStatusopt) → {Object}

simulate hotspot data without creating the (slow) class instance
Parameters:
Name Type Attributes Default Description
projectTile Help4.widget.help.ProjectTile
hotspotStatus Object <optional>
 {}
Source:
Returns:
Type
Object

(static) tileToTileData(tile) → {Help4.data.TileData}

Parameters:
Name Type Description
tile Help4.widget.help.ProjectTile
Source:
Returns:
Type
Help4.data.TileData

(async, static) updateTileListView(params) → {Promise.<boolean>}

update a tile list view
Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Default Description
isDestroyed function
isRefresh boolean <optional>
 true
structural Object
visual Object <optional>
<nullable>
 null
Source:
Returns:
Type
Promise.<boolean>

(async, static) waitControllerPlaybackServiceReady(widget, resumeTimeopt) → {Promise.<void>}

some views require the playback service to evaluate e.g. conditions; wait until the service is ready
Parameters:
Name Type Attributes Default Description
widget Help4.widget.Widget
resumeTime number <optional>
 100
Source:
Returns:
Type
Promise.<void>