Class: Help

Help4.widget.companionCore.data.Help()

help functionality

Constructor

new Help()

Source:

Methods

(static) decodeUrHotspot(hotspotAnchornullable, returnOtheropt, returnToMigrateopt) → {Object|Object|Object|null}

UrHarmonization uses IdSelectorUI5 in UI5 apps and UrHarmonizationSelector in non-UI5 apps if the selector is UR return it, otherwise mark it for migration
Parameters:
Name Type Attributes Default Description
hotspotAnchor string <nullable>
returnOther boolean <optional>
 false
returnToMigrate boolean <optional>
 false
Source:
Returns:
Type
Object | Object | Object | null

(async, static) evaluateTileConditions(tiles, params) → {Promise.<Array.<Help4.widget.help.ConditionProjectTile>>}

extend tiles with a condition result
Parameters:
Name Type Description
tiles Array.<Help4.widget.help.ProjectTile>
params Object
Properties
Name Type Description
whatsnew boolean
Source:
Returns:
Type
Promise.<Array.<Help4.widget.help.ConditionProjectTile>>

(async, static) filterTilesByCondition(tiles, params) → {Promise.<Array.<Help4.widget.help.ProjectTile>>}

filter tiles by condition and deliver a tile descriptor result
Parameters:
Name Type Description
tiles Array.<Help4.widget.help.ProjectTile>
params Object
Properties
Name Type Description
whatsnew boolean
Source:
Returns:
Type
Promise.<Array.<Help4.widget.help.ProjectTile>>

(static) filterUrTiles(tiles) → {Array.<Help4.widget.help.ProjectTile>}

filters out UR catalogue tiles if assigned tiles with the same hotspotId exist
Parameters:
Name Type Description
tiles Array.<Help4.widget.help.ProjectTile>
Source:
Returns:
Type
Array.<Help4.widget.help.ProjectTile>

(async, static) getAvailableTiles(params) → {Promise.<Array.<Help4.widget.help.ProjectTile>>}

deliver all tiles that are not permanently invisible
Parameters:
Name Type Description
params Object
Properties
Name Type Description
whatsnew boolean
screenId string
Source:
Returns:
Type
Promise.<Array.<Help4.widget.help.ProjectTile>>

(static) helpTileToTileParams(tile, params, descriptor) → {Help4.widget.help.TileParams}

transforms a project tile data into control tile data
Parameters:
Name Type Description
tile Help4.widget.help.ProjectTile
params Object
descriptor Help4.widget.help.view2.Tile.Descriptor
params.hotspotVisible boolean
Source:
Returns:
Type
Help4.widget.help.TileParams