Class: TipTooltipService

Function: reset

Resets the service by re-initializing it and resets the tipClusters. The re-initialization is called with the original constructor parameters. Attention: Mutations on them are not reset.

reset()

Function: initializeTipClusterIfNotYetExistent

Initializes a tip cluster with the specified identifier if such tip cluster does not already exists.

initializeTipClusterIfNotYetExistent(identifier)
Arguments

  • identifier (String) – Initializes a tip cluster with the specified identifier if such tip cluster does not already exists.

Function: loadLocalPreferences

Loads the local preferences.

loadLocalPreferences()

Function: setLocalTipPreferences

Sets the local preferences for the specified tip. Returns a promise for this task.

setLocalTipPreferences(tip)
Arguments

  • tip (*) – Sets the local preferences for the specified tip. Returns a promise for this task.

Function: setLocalHiddenPreferences

Sets the local hidden preferences for the module. Returns a promise for this task.

setLocalHiddenPreferences()

Function: setHidden

Sets the hidden property and automatically updates the local storage item.

setHidden(hide)
Arguments

  • hide (Boolean) – Sets the hidden property and automatically updates the local storage item.

Function: tipToType

Returns the corresponding type string of the specified tip if it is present in the current tip codes. Returns an empty string otherwise.

tipToType(tip)
Arguments

  • tip (Object) – Returns the corresponding type string of the specified tip if it is present in the current tip codes.

Returns an empty string otherwise.

Function: setCurrentTip

Set the current tip of the tip cluster with the specified identifier to the specified tip.

setCurrentTip(tip, tipClusterIdentifier)
Arguments

  • tip (Object) – Set the current tip of the tip cluster with the specified identifier to the specified tip.

  • tipClusterIdentifier (String) – Set the current tip of the tip cluster with the specified identifier to the specified tip.

Function: resetAllTipCodeTipPreferences

Resets the display properties of all tip code tips. Also resets the hidden property unless otherwise specified.

resetAllTipCodeTipPreferences()

Function: displayTip

Should the specified tip be displayed?

displayTip()

Function: someTipsAreNotDisplayedInTipCluster

Is at least one tip not displayed in the tip cluster with the specified identifier?

someTipsAreNotDisplayedInTipCluster(tipClusterIdentifier)
Arguments

  • tipClusterIdentifier (String) – Is at least one tip not displayed in the tip cluster with the specified identifier?

Function: someTipsAreDisplayedInTipCluster

Is at least one tip displayed in the tip cluster with the specified identifier?

someTipsAreDisplayedInTipCluster(tipClusterIdentifier)
Arguments

  • tipClusterIdentifier (String) – Is at least one tip displayed in the tip cluster with the specified identifier?

Member: ready:

Member: tipCodesFactory:

Member: tipClustersFactory:

Member: DEFAULT_TIP_CLUSTER_IDENTIFIER:

Member: $sce:

Member: hidden:

Member: tipCodes:

Member: tipClusters:

Member: tipClusters[undefined]:

Member: ready:

Member: tipClusters[undefined]:

Member: hidden:

Member: hidden: