eLABSDK V1.0

API Docs for: 1.0.0
Show:

eLabSDK.Wizard

Extends eLabSDK.Base
Module: eLabSDK

Summary

Class that allows the creation of a wizard

Constructor

eLabSDK.Wizard

Syntax

eLabSDK.Wizard

() async

Summary

Example:

Methods

_checkForRequiredData

Syntax

_checkForRequiredData

(
  • panel
)

Summary

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

Parameters:

  • panel Object

_createMainContainer

Syntax

_createMainContainer

(
  • panel
)

Summary

Create the main container

Parameters:

  • panel Object

_handleNavigationButtonDisplay

Syntax

_handleNavigationButtonDisplay

(
  • panel
)

Summary

Display or hide buttons depending on which panel index is active

Parameters:

  • panel Object

activateMenuItem

Syntax

activateMenuItem

(
  • panel
)

Summary

Activate the triggered side menu item

Parameters:

  • panel Object

addPanel

Syntax

addPanel

(
  • panel
)

Summary

Adds a panel to the wizard

Parameters:

  • panel Object

close

Syntax

close

()

Summary

Close the wizard, closes the dialog

createSideMenu

Syntax

createSideMenu

(
  • panel
)

Summary

Create the navigation tree

Parameters:

  • panel Object

insert

Syntax

insert

(
  • config
)

Summary

Insert a new panel to the currently active wizard

Parameters:

  • config Obj

lockNavigation

Syntax

lockNavigation

(
  • config
)

Summary

Prevent the user from moving to a previous/next panel

Parameters:

  • config Obj

nextPanel

Syntax

nextPanel

(
  • panel
)

Summary

Displays the next panel

Parameters:

  • panel Object

remove

Syntax

remove

(
  • config
)

Summary

Remove a panel from the currently active wizard

Parameters:

  • config Obj

start

Syntax

start

()

Summary

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

unLockNavigation

Syntax

unLockNavigation

(
  • config
)

Summary

Re-enable navigation

Parameters:

  • config Obj

Properties

_currentPanel

Syntax

_currentPanel

Object

Summary

_previousPanel

Syntax

_previousPanel

Object

Summary

_wizardContent

Syntax

_wizardContent

Object

Summary

Stores the wizard panels