Events
The plug-in exposes Shepherd tour and step events along with additional data available through the this.data variable. The available events to listen to on the page designer level are the following:
- Tour Start
- Tour Cancel
- Tour Complete
- Tour Show
- Step Complete
- Step Before Hide
- Step Before Show
- Step Hide
- Step Show
- Step Cancel
- Step Destroy
All events expose the same data except for Tour Show and Tour Start. See the table below for details.
| Property | Type | Description |
|---|---|---|
| this.data.da | Object | Contains information about dynamic action implementing the tour / step |
| this.data.da.id | String | Dynamic action id stored in Oracle APEX tables |
| this.data.da.name | String | Dynamic action name |
| this.data.tour | Object | A plug-in object containing information about tour |
| this.data.tour.name | String | A tour name defined by a developer |
| this.data.tour.instance | Tour | A shepherd Tour object |
| this.data.step | Object | A plug-in object containing information about tour step Not available for Tour Start |
| this.data.step.affectedElements | jQuery Object | A jQuery reference to the step affected elements. Not available for Tour Start |
| this.data.step.instance | Step | A shepherd Step object. Not available for Tour Start |
| this.data.step.id | String | A step static id defined by a developer. Not available for Tour Start |
| this.data.step.idx | Number | A step index among other tour steps. Not available for Tour Start |
| this.data.step.previous | Step | A tour previous step instance. Available only for Tour Show |