Constructor
new Marker(markersnon-null, jsonnon-null)
Create the marker
Parameters:
| Name | Type | Description |
|---|---|---|
markers |
Markers | The Markers controller |
json |
MarkerData | The JSON data for this marker |
Classes
Members
(constant, non-null) custom :MarkerSettingsCustomData
Custom JSON
Type:
- MarkerSettingsCustomData
(constant, non-null) data :MarkerSettingsData
Marker settings
Type:
- MarkerSettingsData
(constant) id :string
The ID
Type:
- string
(constant, non-null) json :MarkerData
The marker JSON data
Type:
- MarkerData
(constant) open :function
Bound open function
Type:
- function
opened :boolean
Opened state
Type:
- boolean
(constant) slug :string|null
Slug
Type:
- string | null
(nullable) tour :Tour
The tour instance
Type:
Methods
(async) close(eopt, nullable, forceopt, noFlyBackopt, keepSecondaryopt, staySplitopt) → (non-null) {Promise}
Close this marker
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
e |
Event |
<optional> <nullable> |
Optional event | |
force |
boolean |
<optional> |
false
|
Force the closing |
noFlyBack |
boolean |
<optional> |
false
|
Don't fly the camera back to the opening view |
keepSecondary |
boolean |
<optional> |
false
|
Keep any secondary split screen image opened |
staySplit |
boolean |
<optional> |
false
|
Stay in split-screen mode |
Returns:
When the marker is fully closed
- Type
- Promise
open(inTouropt, immediateopt, startTimeopt) → (non-null) {Promise}
Open the marker
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
inTour |
boolean |
<optional> |
false
|
There is a current marker tour active |
immediate |
boolean |
<optional> |
false
|
Don't animate the camera |
startTime |
number |
<optional> |
Start the optional videotour at this time |
Returns:
When marker is opened
- Type
- Promise
toggle(eopt, nullable)
Toggle the marker open/closed
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
e |
Event |
<optional> <nullable> |
Optional event |