Class: Data

Help4.widget.help.Data(params, derivedopt)

Data handler for help widget.

Constructor

new Data(params, derivedopt)

Parameters:
Name Type Attributes Description
params Help4.widget.help.Data.Params
derived Object <optional>
Properties:
Name Type Description
__widget Help4.widget.help.Widget the widget
__catalogueBackend Help4.widget.help.CatalogueBackend the catalogue backend
catalogues Help4.widget.help.Catalogues the catalogue for the current screen
help Help4.widget.help.HelpSelection the help selection for the current screen
helpIds Object
Source:

Extends

Members

ACCEPTED_ATTRIBUTES :Array.<string>

see Help4.widget.help.Project
Type:
  • Array.<string>
Source:

catalogues :Help4.widget.help.Catalogue

Type:
Source:

Methods

(protected) ____defineDataFunctions()

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) _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>

(protected) _onAfterRetrieve(key)

called after a retrieve operation completed
Parameters:
Name Type Description
key string the value that has changed
Overrides:
Source:

(async, protected) _onRetrieveReady(key) → {Promise.<void>}

called after a retrieve operation completed; retrieve will await this function
Parameters:
Name Type Description
key string
Overrides:
Source:
Returns:
Type
Promise.<void>

(async, protected) _retrieveHelp() → {Promise.<void>}

Source:
Returns:
Type
Promise.<void>

activate() → {Promise.<void>}

update data on activate
Overrides:
Source:
Returns:
Type
Promise.<void>

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

clean()

cleans all stored data
Overrides:
Source:

destroy()

destroys this instance
Overrides:
Source:

(generator) entries()

allows to iterate the existing data
Overrides:
Source:
Yields:
[number, *]}

getCatalogueProject(search, catalogueKeyopt, nullable, attributeNameopt, nullable) → {Help4.widget.help.CatalogueProject|Object}

gets a project from currently loaded catalogue
Parameters:
Name Type Attributes Default Description
search string
catalogueKey Help4.widget.help.CatalogueKeys <optional>
<nullable>
 null
attributeName string <optional>
<nullable>
 'id'
Source:
Returns:
Type
Help4.widget.help.CatalogueProject | Object

(async) getHelp() → {Promise.<Array.<Help4.widget.help.Project>>}

Source:
Returns:
Type
Promise.<Array.<Help4.widget.help.Project>>

(async) getHelpTiles() → {Promise.<Array.<Help4.widget.help.ProjectTile>>}

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

getProjects(screenId, catalogueType, catalogueKey) → {Array.<Help4.widget.help.Project>}

Will return the projects for the corresponding screenId, catalogueType and catalogueKey
Parameters:
Name Type Description
screenId string
catalogueType string
catalogueKey string
Source:
Returns:
Type
Array.<Help4.widget.help.Project>

initialize()

update data on initialize returns {Promise}
Overrides:
Source:

isDestroyed() → {boolean}

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

(async) loadProject(projectId, catalogueType) → {Promise.<?{pub: ?Help4.widget.help.Project, head: ?Help4.widget.help.Project}>}

loads a project regardless of catalogue information
Parameters:
Name Type Description
projectId string
catalogueType Help4.widget.help.CatalogueTypes
Source:
Returns:
Type
Promise.<?{pub: ?Help4.widget.help.Project, head: ?Help4.widget.help.Project}>

onScreen() → {boolean}

Source:
Returns:
Type
boolean

update() → {Promise.<void>}

update data on update
Overrides:
Source:
Returns:
Type
Promise.<void>

waitCataloguesLoaded(screenId) → {Promise.<void>}

Will return once the catalogues for the corresponding screen are loaded.
Parameters:
Name Type Description
screenId string
Source:
Returns:
Type
Promise.<void>

waitHelpLoaded() → {Promise.<void>}

Will return once the help for the corresponding screen is loaded.
Source:
Returns:
Type
Promise.<void>

(static) descriptorToId(info) → {string}

Parameters:
Name Type Description
info Help4.widget.help.TileDescriptor | Help4.widget.help.CatalogueSelection | Help4.widget.help.Project
Source:
Returns:
Type
string

(static) idToDescriptor(id) → {Help4.widget.help.TileDescriptor|Help4.widget.help.CatalogueSelection}

Parameters:
Name Type Description
id string
Source:
Returns:
Type
Help4.widget.help.TileDescriptor | Help4.widget.help.CatalogueSelection

Type Definitions

Params

Type:
  • Object
Properties:
Name Type Description
widget Help4.widget.help.Widget the owner widget
catalogueBackend Help4.widget.help.CatalogueBackend the corresponding backend connector
Source: