Class: View

Help4.widget.help.view2.View(params)

new View(params)

Parameters:
Name Type Description
params Help4.widget.help.view2.View.Params
Properties:
Name Type Attributes Description
__widget Help4.widget.help.Widget
__whatsnew boolean
blockUpdate boolean
stealth boolean
_contentView Help4.control2.container.Container
_tileView Help4.control2.container.Container
_cache Help4.widget.help.view2.View.Cache
_mutual Help4.jscore.MutualExclusion
_updating boolean
_tileContainer Help4.widget.help.view2.TileContainer
_mouseOverControl Help4.control2.Control
_laserBeam Help4.widget.help.view2.LaserBeam <nullable>
_domRefreshExecutor function
_initialized boolean
Source:

Extends

Members

BUBBLE_CLOSE_TIME :number

Type:
  • number
Source:

Methods

(protected) ____defineDataFunctions()

Overrides:
Source:

(protected) ____defineProperties(params, derivedopt, nullable)

Parameters:
Name Type Attributes Default Description
params Object
derived Object <optional>
<nullable>
 null
Properties
Name Type Description
GET Object
SET Object
Overrides:
Source:

(protected) ____defineProperty(args)

Parameters:
Name Type Description
args Object
Properties
Name Type Attributes Default Description
type string <optional>
 'param' for Help4.jscore.DataBase
key string
info Help4.jscore.ControlBase.Param
funGet Help4.jscore.ControlBase.FunGet
funSet Help4.jscore.ControlBase.FunSet
Overrides:
Source:

(protected) ____defineStaticProperties()

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

(protected) ____extendParams(dest, src) → {Object}

Parameters:
Name Type Description
dest Object
src Object
Overrides:
Source:
Returns:
Type
Object

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

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

(protected) ____getData() → {Object}

Overrides:
Source:
Returns:
Type
Object

(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) ____setInitValue(args)

Parameters:
Name Type Description
args Object
Properties
Name Type Description
key string
info Help4.jscore.ControlBase.Param
params Object
funSet Help4.jscore.ControlBase.FunSet
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>

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

closeLightbox()

will close any open lightbox
Source:

destroy()

destroys this instance
Overrides:
Source:

focus()

focus handling
Source:

focusListItem(direction)

focus handling - up/down arrow keys
Parameters:
Name Type Description
direction string
Source:

getContentView() → {Help4.control2.container.Container}

Source:
Returns:
Type
Help4.control2.container.Container

getSeenAnimations() → {Array.<Help4.widget.help.TileDescriptor>}

Source:
Returns:
Type
Array.<Help4.widget.help.TileDescriptor>

getTexts() → {Object}

Source:
Returns:
Type
Object

getTiles() → {Array.<Help4.widget.help.ProjectTile>}

Source:
Returns:
Type
Array.<Help4.widget.help.ProjectTile>

(async) init(statusnullable, selectopt) → {Promise.<void>}

Parameters:
Name Type Attributes Description
status Help4.widget.help.view2.SerializedStatus <nullable>
select Help4.widget.help.view2.Tile.Descriptor <optional>
Source:
Returns:
Type
Promise.<void>

isDestroyed() → {boolean}

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

onWidgetUpdate(event)

Parameters:
Name Type Description
event Object
Properties
Name Type Attributes Description
type Help4.widget.help.view2.View.WidgetUpdateTypes
select Help4.widget.help.view2.Tile.Descriptor <optional>
Source:

select(data)

Parameters:
Name Type Description
data Help4.widget.help.TileDescriptor
Source:

serialize() → {Help4.widget.help.view2.SerializedStatus}

Source:
Returns:
Type
Help4.widget.help.view2.SerializedStatus

setTexts(texts)

Parameters:
Name Type Description
texts Object
Source:

showQuickTour(data)

Parameters:
Name Type Description
data Help4.widget.help.TileDescriptor
Source:

tileSelect(descriptor)

Parameters:
Name Type Description
descriptor Help4.widget.help.view2.Tile.Descriptor
Source:

(async) update(paramsopt) → {Promise.<void>}

Parameters:
Name Type Attributes Default Description
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
status Help4.widget.help.view2.SerializedStatus <optional>
<nullable>
select Help4.widget.help.view2.Tile.Descriptor <optional>
stealth boolean <optional>
isRefresh boolean <optional>
 true
Source:
Returns:
Type
Promise.<void>

wmHotspotHover(descriptoropt, nullable)

Parameters:
Name Type Attributes Default Description
descriptor Help4.widget.help.view2.Tile.Descriptor <optional>
<nullable>
 null
Source:

Type Definitions

Cache

Type:
  • Object
Properties:
Name Type Attributes Description
screenId string <optional>
catalogueKey Help4.widget.help.CatalogueKeys <optional>
helpIds Array.<string> <optional>
tiles Array.<Help4.widget.help.ProjectTile> <optional>
conditionTiles Array.<Help4.widget.help.ProjectTile> <optional>
isDataUpdate boolean <optional>
persist Object <optional>
 information that needs to persist and be (de)serialized
Properties
Name Type Attributes Description
animation Object <optional>
 already seen animations; see Help4.widget.help.TileDescriptor
callout Object <optional>
 already shown callouts; see Help4.widget.help.TileDescriptor
announcement_always Object <optional>
 already shown announcements; see Help4.widget.help.TileDescriptor
announcement_once Object <optional>
 already shown announcements; see Help4.widget.help.TileDescriptor
select string <optional>
stealth boolean <optional>
Source:

Params

Type:
  • Object
Properties:
Name Type Description
widget Help4.widget.help.Widget
stealth boolean
Source:

WidgetUpdateTypes

Type:
  • 'activate' | 'deactivate' | 'playbackActive' | 'controllerOpen' | 'controllerClose' | 'widgetDeactivate' | 'navigate' | 'redraw'
Source: