Constructor
new GuidedTourController(documentModule, requestService, configServer)
Constructor for GuidedTourController The controller reads data from a database to build one or more guided tours Each guided tour is a succession of "steps" Each step has a document + tour text + doc text (steps are instances of the TourStep class) Multiple guided tours are supported (only one tour is finished for the demo) For the demo : options.preventUserFromChangingTour allows to hide the buttons for changing tour
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
documentModule | DocumentModule | The document module. | |||||||||
requestService | RequestService | The request service | |||||||||
configServer | object | The server configuration. Properties
|
Classes
Methods
getCurrentStep() → {*}
Returns the current tour step
Current step
- Type:
- *
getCurrentTour() → {GuidedTour}
Returns the current guided tour if there are any
Current guided tour
- Type:
- GuidedTour
getGuidedTours()
Get all guided tour from a database
getNextStep() → {*}
Sets the current step to the next step and returns it.
Next step
- Type:
- *
getNextTour() → {GuidedTour}
Sets the current guided tour to the next guided tour and returns it.
Next guided tour
- Type:
- GuidedTour
getPreviousStep() → {*}
Sets the current step to the previous step and returns it.
Previous step
- Type:
- *
getPreviousTour() → {GuidedTour}
Sets the current guided tour to the previous guided tour and returns it.
Previous guided tour
- Type:
- GuidedTour
reset()
Reset browser at the begining of the guided tours