API Docs for: 1.0.0
Show:

eLabSDK.Wizard Class

Extends eLabSDK.Base
Module: eLabSDK

Class that allows the creation of a wizard

Constructor

eLabSDK.Wizard

() async

Example:

Methods

_checkForRequiredData

(
  • panel
)

Check if required data is availale to launch the wizard panel, display a log if logging enabled

Parameters:

  • panel Object

_createMainContainer

(
  • panel
)

Create the main container

Parameters:

  • panel Object

_handleNavigationButtonDisplay

(
  • panel
)

Display or hide buttons depending on which panel index is active

Parameters:

  • panel Object

activateMenuItem

(
  • panel
)

Activate the triggered side menu item

Parameters:

  • panel Object

addPanel

(
  • panel
)

Adds a panel to the wizard

Parameters:

  • panel Object

close

()

Close the wizard, closes the dialog

createSideMenu

(
  • panel
)

Create the navigation tree

Parameters:

  • panel Object

insert

(
  • config
)

Insert a new panel to the currently active wizard

Parameters:

  • config Obj

lockNavigation

(
  • config
)

Prevent the user from moving to a previous/next panel

Parameters:

  • config Obj

nextPanel

(
  • panel
)

Displays the next panel

Parameters:

  • panel Object

remove

(
  • config
)

Remove a panel from the currently active wizard

Parameters:

  • config Obj

start

()

Starts the wizard, creates the dialog and adds the contents stored in _wizardContent

unLockNavigation

(
  • config
)

Re-enable navigation

Parameters:

  • config Obj

Properties

_currentPanel

Object

_previousPanel

Object

_wizardContent

Object

Stores the wizard panels