Namespace: view2

Help4.widget.help.view2

Source:

Classes

BubbleControl
GlobalHelpDialogControl
HotspotScan
LaserBeam
Tile
TileBubble
TileContainer
TileHotspot
TileLightbox
TileTile
View

Members

(static) BUTTON_CSS :string

Type:
  • string
Source:

(static) GLOBAL_HELP_CSS :string

Type:
  • string
Source:

(static) HIDDEN_CSS :string

Type:
  • string
Source:

(static) LIGHTBOX_CSS :string

Type:
  • string
Source:

(static) PERSISTENCE_REGEXP :RegExp

Type:
  • RegExp
Source:

Methods

(static) allowUpdateFromCache(view) → {Help4.widget.help.view2.AllowUpdateResult}

check whether update from cache is possible
Parameters:
Name Type Description
view Help4.widget.help.view2.View
Source:
Returns:
Type
Help4.widget.help.view2.AllowUpdateResult

(static) containsTileDescriptor(list, descriptor) → {boolean}

Parameters:
Name Type Description
list Array.<Help4.widget.help.view2.Tile.Descriptor> | Array.<Help4.widget.help.TileDescriptor>
descriptor Help4.widget.help.view2.Tile.Descriptor | Help4.widget.help.TileDescriptor
Source:
Returns:
Type
boolean

(static) convertTileDescriptor(descriptor) → {Help4.widget.help.TileDescriptor|Help4.widget.help.view2.Tile.Descriptor}

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

(static) deserialize(view, statusnullable)

deserialize view2 status
Parameters:
Name Type Attributes Description
view Help4.widget.help.view2.View
status Help4.widget.help.view2.SerializedStatus <nullable>
Source:

(static) equalTileDescriptors(descriptor1, descriptor2) → {boolean}

Parameters:
Name Type Description
descriptor1 Help4.widget.help.view2.Tile.Descriptor | Help4.widget.help.TileDescriptor
descriptor2 Help4.widget.help.view2.Tile.Descriptor | Help4.widget.help.TileDescriptor
Source:
Returns:
Type
boolean

(static) extractTileDescriptor(data) → {Help4.widget.help.view2.Tile.Descriptor}

Parameters:
Name Type Description
data Help4.widget.help.ProjectTile | Help4.control2.Control
Source:
Returns:
Type
Help4.widget.help.view2.Tile.Descriptor

(static) fixPersistentCache(view, tiles, screenId) → {boolean}

will fix persist cache after CMP3 -> CMP4 migration
Parameters:
Name Type Description
view Help4.widget.help.view2.View
tiles Array.<Help4.widget.help.ProjectTile>
screenId string
Source:
Returns:
Type
boolean

(static) getByTileDescriptor(list, descriptor) → (nullable) {Object}

Parameters:
Name Type Description
list Array.<Object>
descriptor Help4.widget.help.view2.Tile.Descriptor | Help4.widget.help.TileDescriptor
Deprecated:
  • Yes
Source:
Returns:
Type
Object

(static) getLinkTileUrl(projectTile) → {string}

Parameters:
Name Type Description
projectTile Help4.widget.help.ProjectTile
Source:
Returns:
Type
string

(static) hasHotspot(widget, projectTile) → {boolean}

Parameters:
Name Type Description
widget Help4.widget.help.Widget
projectTile Help4.widget.help.ProjectTile
Source:
Returns:
Type
boolean

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

serialize view2 status
Parameters:
Name Type Description
view Help4.widget.help.view2.View
Source:
Returns:
Type
Help4.widget.help.view2.SerializedStatus

(static) setPersistenceCacheValue(view, name, descriptor) → {boolean}

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

Type Definitions

AllowUpdateResult

Type:
  • Object
Properties:
Name Type Description
screenId string
catalogueKey Help4.widget.help.CatalogueKeys
helpIds Array.<string>
isDataUpdate boolean
Source:

SerializedStatus

Type:
  • Object
Properties:
Name Type Attributes Description
hotspotAnimation Array.<string> <optional>
callouts Array.<string> <optional>
announcementsAlways Array.<string> <optional>
announcementsOnce Array.<string> <optional>
Source: