Members
-
<readonly> container :HTMLElement
-
Details
-
<readonly> currentMarker :PSVMarker
Last selected marker
-
Details
-
<readonly> hoveringMarker :PSVMarker
Marker under the cursor
-
Details
-
markers :Object.<string, PSVMarker>
All registered markers
-
Details
-
<readonly> parent :PhotoSphereViewer|module:components.PSVComponent
-
Details
-
<readonly> psv :PhotoSphereViewer
-
Details
-
<readonly> svgContainer :SVGElement
-
Details
-
<readonly> visible :boolean
Visibility of the component
-
Details
Methods
-
addMarker( properties [, render ] ) → {PSVMarker}
Adds a new marker to viewer
-
Parameters
Name Type Attributes Default Description propertiesObject renderboolean <optional> true renders the marker immediately
Returns
Throws
Details
-
clearMarkers( [ render ] )
Removes all markers
-
Parameters
Name Type Attributes Default Description renderboolean <optional> true renders the markers immediately
Details
-
<protected> create()
Creates the component
-
Details
-
<protected> destroy()
Destroys the component
-
Details
-
getCurrentMarker() → {PSVMarker}
Returns the last marker selected by the user
-
Returns
Details
-
getMarker( markerId ) → {PSVMarker}
Returns the internal marker object for a marker id
-
Parameters
Name Type Description markerId* Returns
Throws
Details
-
gotoMarker( marker [, duration ] ) → {Promise}
Rotate the view to face the marker
-
Parameters
Name Type Attributes Description marker* durationstring | int <optional> rotates smoothy, see
PhotoSphereViewer#animateReturns
Fires
Details
-
<protected> hide()
Hides the component
-
Details
-
hideMarker( marker )
Hides a marker
-
Parameters
Name Type Description marker* Details
-
hideMarkersList()
Closes side panel if it contains the list of markers
-
Details
-
removeMarker( marker [, render ] )
Removes a marker from the viewer
-
Parameters
Name Type Attributes Default Description marker* renderboolean <optional> true renders the marker immediately
Details
-
renderMarkers()
Updates the visibility and the position of all markers
-
Details
-
<protected> show()
Displays the component
-
Details
-
showMarker( marker )
Shows a marker
-
Parameters
Name Type Description marker* Details
-
showMarkersList()
Opens side panel with list of markers
-
Fires
Details
-
toggleMarker( marker )
Toggles a marker
-
Parameters
Name Type Description marker* Details
-
toggleMarkersList()
Toggles the visibility of markers list
-
Details
-
updateMarker( properties [, render ] ) → {PSVMarker}
Updates the existing marker with the same id
-
Description
Every property can be changed but you can't change its type (Eg:
imagetohtml).Parameters
Name Type Attributes Default Description propertiesObject | PSVMarker renderboolean <optional> true renders the marker immediately
Returns
Details
Events
-
goto-marker-done
Triggered when the animation to a marker is done
-
Parameters
Name Type Description markerPSVMarker Details
-
leave-marker
Triggered when the user puts the cursor away from a marker
-
Parameters
Name Type Description markerPSVMarker Details
-
over-marker
Triggered when the user puts the cursor hover a marker
-
Parameters
Name Type Description markerPSVMarker Details
-
select-marker
Triggered when the user clicks on a marker. The marker can be retrieved from outside the event handler with
module:components.PSVHUD.getCurrentMarker -
Parameters
Name Type Description markerPSVMarker dblclickboolean the simple click is always fired before the double click
Details
-
select-marker-list
Triggered when a marker is selected from the side panel
-
Parameters
Name Type Description markerPSVMarker Details
-
unselect-marker
Triggered when a marker was selected and the user clicks elsewhere
-
Parameters
Name Type Description markerPSVMarker Details
-
filter:render-markers-list
Used to alter the list of markers displayed on the side-panel