HelpScreen

HelpScreen

new HelpScreen(optionsopt)

Source:

A single help screen, which is expected to be used in a sequence of screens (HelpSequence). It is positioned near the element it's explaining, usually pointing to it, and gives an indication of how far along in the HelpSequence this screen is.

Parameters:
Name Type Attributes Description
options Object <optional>

Object with the following properties:

Properties
Name Type Attributes Default Description
onNext function

The function to invoke when the user wants to go to next screen.
message String

Gets or sets the html formatted message displayed on the help screen.
highlightedComponentId String

Class name of component that should be highlighted.
rectangle Object <optional>

DOMRect rectangle for element help is describing.
preDisplayHook PreDisplayHookCallback <optional>

Gets or sets a callback that is invoked before the screen is displayed.
postDisplayHook PostDisplayHookCallback <optional>

Gets or sets a callback that is invoked after the screen is displayed.
currentScreenNumber Number <optional>
 0

The screen that this represents, e.g. the second in a series (zero indexed).
totalNumberOfScreens Number <optional>
 0

Number of screens in this help series.
positionLeft RelativePosition <optional>
 0

Left position relative to rectangle.
positionTop RelativePosition <optional>
 0

Top position relative to rectangle.
offsetLeft Number <optional>
 0

How many pixels from left position relative to rectangle to shift help screen.
offsetTop Number <optional>
 0

How many pixels from top position relative to rectangle to shift help screen.
width Number <optional>
 300

Width of help screen in pixels.
caretTop Number <optional>
 -5

Top position of the caret in pixels.
caretLeft Number <optional>
 -5

Left position of the caret in pixels.

Members

caretLeft :Number

Source:

Left position of the caret in pixels

Type:
  • Number

caretTop :Number

Source:

Top position of the caret in pixels

Type:
  • Number

currentScreenNumber :Number

Source:

Which is the current screen the user is on?

Type:
  • Number

highlightedComponentId :String

Source:

Class name of component that should be highlighted.

Type:
  • String

offsetLeft :Number

Source:

Left offset in pixels, relative to positionLeft

Type:
  • Number

offsetTop :Number

Source:

Top offset in pixels, relative to positionTop

Type:
  • Number

onNext :function

Source:

Gets or sets a callback that is invoked when the user goes to the next screen.

Type:
  • function

positionLeft :RelativePosition

Source:

Left position relative to rectangle

Type:
  • RelativePosition

positionTop :RelativePosition

Source:

Top position relative to rectangle

Type:
  • RelativePosition

postDisplayHook :PostDisplayHookCallback

Source:

Gets or sets a callback that is invoked after the screen is displayed.

Type:

preDisplayHook :PreDisplayHookCallback

Source:

Gets or sets a callback that is invoked before the screen is displayed.

Type:

rectangle :Object

Source:

Bounding rectangle for element help is describing

Type:
  • Object

totalNumberOfScreens :Number

Source:

How many screens in this series?

Type:
  • Number

width :Number

Source:
Default Value:
  • 300

Width of help screen in pixels.

Type:
  • Number

Methods

message()

Source:

Gets or sets the html formatted message displayed on the help screen.