Class: TileContainer

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

This can be seen as of type: Help4.widget.help.view2.Tile[]

Constructor

new TileContainer(params)

Parameters:
Name Type Description
params Help4.widget.help.view2.TileContainer.Params
Properties:
Name Type Attributes Description
__widget Help4.widget.help.Widget
__view Help4.widget.help.view2.View
__contentView Help4.control2.container.Container
__tileView Help4.control2.container.Container
selected Help4.widget.help.view2.Tile.Descriptor | null
hovered Help4.widget.help.view2.Tile.Descriptor | null
wmHovered Help4.widget.help.view2.Tile.Descriptor | null
callouts Array.<Help4.widget.help.view2.Tile.Descriptor>
callout Help4.widget.help.view2.Tile.Descriptor <nullable>
announcements Array.<Help4.widget.help.view2.Tile.Descriptor>
announcement Help4.widget.help.view2.Tile.Descriptor | null | false string: currently shown; null: not yet shown; false: do not show again
quickTour Help4.widget.help.view2.Tile.Descriptor <nullable>
stealth boolean
_tilesMap Map.<string, Help4.widget.help.view2.Tile>
_eventBusObserver Help4.observer.EventBusObserver
Source:

Extends

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

destroy()

destroys this instance
Overrides:
Source:

get(descriptor) → {Help4.widget.help.ProjectTile}

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

isDestroyed() → {boolean}

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

(async) leave() → {Promise.<boolean>}

is essentially the same as "this.hovered = false" but will add a wait time
Source:
Returns:
Type
Promise.<boolean>

set(params)

Parameters:
Name Type Description
params Object
Properties
Name Type Attributes Description
projectTiles Array.<Help4.widget.help.ProjectTile>
hotspotStatus Object
stealth boolean <optional>
Source:

showAnnouncement()

show announcement
Source:

showCallout(calloutopt, nullable)

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

stopHotspotAnimation(descriptor) → {boolean}

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

Type Definitions

Params

Type:
  • Object
Properties:
Name Type Attributes Description
widget Help4.widget.help.Widget
view Help4.widget.help.view2.View
contentView Help4.control2.container.Container
tileView Help4.control2.container.Container
stealth boolean
selected Help4.widget.help.view2.Tile.Descriptor <optional>
hovered Help4.widget.help.view2.Tile.Descriptor <optional>
wmHovered Help4.widget.help.view2.Tile.Descriptor <optional>
Source: