Class: Tour

Help4.widget.companionCore.data.Tour()

tour functionality

Constructor

new Tour()

Source:

Methods

(async, static) getFilteredTourProjects(paramsopt) → {Promise.<Array.<Help4.widget.help.CatalogueProject>>}

filter by conditions and hidden information
Parameters:
Name Type Attributes Default Description
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
whatsnew boolean <optional>
 false
catalogueKey Help4.widget.help.CatalogueKeys <optional>
<nullable>
 null
projects Array.<Help4.widget.help.CatalogueProject> <optional>
<nullable>
 null
Source:
Returns:
Type
Promise.<Array.<Help4.widget.help.CatalogueProject>>

(static) getTourProjects(paramsopt) → {Array.<Help4.widget.help.CatalogueProject>}

get tour projects
Parameters:
Name Type Attributes Default Description
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
whatsnew boolean <optional>
 false
catalogueKey Help4.widget.help.CatalogueKeys <optional>
<nullable>
 null
projects Array.<Help4.widget.help.CatalogueProject> <optional>
 null
Source:
Returns:
Type
Array.<Help4.widget.help.CatalogueProject>

(static) tourProjectsToTileParams(projects, paramsopt) → {Array.<Help4.widget.tourlist.TileParams>}

convert projects into tile params for panel integration
Parameters:
Name Type Attributes Default Description
projects Array.<Help4.widget.help.CatalogueProject>
params Object <optional>
 {}
Properties
Name Type Attributes Default Description
whatsnew boolean <optional>
 false
Source:
Returns:
Type
Array.<Help4.widget.tourlist.TileParams>