Constructor
new MarkerTour(markersnon-null, datanon-null)
Create the Tour instance
Parameters:
| Name | Type | Description |
|---|---|---|
markers |
Markers | The Markers |
data |
MarkerTourData | The tour data |
Classes
Members
currentMarker :Marker|undefined
The current opened Marker
Type:
- Marker | undefined
(constant, non-null) data :MarkerTourData
The tour data
Type:
- MarkerTourData
(constant) id :string
The tour ID
Type:
- string
started :boolean
Started state
Type:
- boolean
(constant) title :string
The tour title
Type:
- string
Methods
(async) getInfo() → (non-null) {Promise.<!Object>}
Return step information and total duration of multi-image tour
Returns:
Promise of the tour title, steps and total duration
- Type
- Promise.<!Object>
(async) goto(i, immediateopt, startTimeopt) → (non-null) {Promise}
Go to a tour step
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
i |
number | The tour step index | ||
immediate |
boolean |
<optional> |
false
|
Don't do any animations |
startTime |
number |
<optional> |
Optional starting time for a video tour under the step Marker |
Returns:
When the tour step has been succesfully opened
- Type
- Promise
next()
Go to next step
prev()
Go to previous step
resume() → (non-null) {Promise}
Resume the tour
Returns:
When the tour has resumed
- Type
- Promise
(async) start(stepopt, skipGotoopt, immediateopt, startTimeopt) → (non-null) {Promise}
Start the tour
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
step |
number |
<optional> |
The step where to start | |
skipGoto |
boolean |
<optional> |
false
|
Do a virtual start, don't go to any step |
immediate |
boolean |
<optional> |
false
|
Don't do any animating |
startTime |
number |
<optional> |
Start any video tour under a marker at this time |
Returns:
When the tour has started
- Type
- Promise
(async) stop(eopt, nullable, forceopt, keepCurrentViewopt, noSaveStateopt) → (non-null) {Promise}
Stop the tour
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
e |
VirtualEventData |
<optional> <nullable> |
Optional event | |
force |
boolean |
<optional> |
false
|
Force stop, even if keepOpen |
keepCurrentView |
boolean |
<optional> |
false
|
Don't animate back to starting view |
noSaveState |
boolean |
<optional> |
false
|
Don't save the current tour state for resuming later |
Returns:
When the tour has succesfully stopped
- Type
- Promise