API Docs for:
Show:

Wizard Class

Defined in: c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:554

Represents a tutorial

Methods

getStepPosition

(
  • step
)

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:851

Returns the position of the step passed as argument or (by default) the current step

Parameters:

  • step Object

    The step object to get position

hideStep

(
  • callback
)

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:836

Hides the step

Parameters:

  • callback Function

    A callback function to be called in the ending of the hiding process

isAlreadyWatched

() Boolean

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:896

Checks if the current user already watched this wizard

Returns:

Boolean:

A boolean indicating if the user watched this wizard

isEligible

() Boolean

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:861

Checks if a wizard should be shown in the current context (running each evaluator defined for this wizard)

Returns:

Boolean:

A boolean indicating if this wizard should be available in the current context

next

(
  • callback
)

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:805

Shows the next step of the wizard

Parameters:

  • callback Function

    A callback function to be called

pollForCheckCompletedStep

()

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:908

A Polling function to check if the current step is completed

showStep

(
  • step
  • callback
)

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:715

Shows a specific step

Parameters:

  • step Object

    The step to be shown

  • callback Function

    A callback function to be called

storyLine

()

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:662

Sets the storyline for the wizard