JSDoc: Class: HelpScreen

Class: HelpScreen

HelpScreen(optionsopt)

new HelpScreen(optionsopt)

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

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.