@panoramax/web-viewer 3.2.3-develop-d7e5a16d → 3.2.3-develop-6257391e

package/docs/02_Usage.md

@@ -1,831 +0,0 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-### Table of Contents
-
-*   [CoreView][1]
-*   [Map][2]
-*   [Photo][3]
-*   [Editor][4]
-*   [StandaloneMap][5]
-*   [Viewer][6]
-
-## CoreView
-
-**Extends EventTarget**
-
-Core view is an abstract class used for setting up any of the main Panoramax JS view components.
-
-It is used to prepare API, internationalization, options checks... for Viewer, StandaloneMap and Editor classes.
-
-### Parameters
-
-*   `container` **([string][7] | [Element][8])** The DOM element to create viewer into
-*   `endpoint` **[string][7]** URL to API to use (must be a [STAC API][9])
-*   `options` **[object][10]?** View options. (optional, default `{}`)
-
-    *   `options.selectedSequence` **[string][7]?** The ID of sequence to highlight on load (defaults to none)
-    *   `options.selectedPicture` **[string][7]?** The ID of picture to highlight on load (defaults to none)
-    *   `options.fetchOptions` **[object][10]** Set custom options for fetch calls made against API ([same syntax as fetch options parameter][11]) (optional, default `null`)
-    *   `options.users` **([string][7] | [Array][12]<[string][7]>)?** List of user IDs to default use for display. Defaults to all users.
-    *   `options.style` **([string][7] | [object][10])?** The map's MapLibre style. This can be an a JSON object conforming to the schema described in the [MapLibre Style Specification][13], or a URL string pointing to one. Defaults to OSMFR vector tiles.
-
-### Properties
-
-*   `_t` **[object][10]** The translations labels
-*   `_selectedSeqId` **[string][7]** The selected sequence ID
-*   `_selectedPicId` **[string][7]** The selected picture ID
-*   `_api` **API** The API handler
-*   `_loader` **Loader** The initial loader message
-*   `_options` **[object][10]** The stored options
-*   `container` **[Element][8]** The DOM container
-
-### getClassName
-
-This allows to retrieve an always correct class name.
-This is crap, but avoids issues with Webpack & so on.
-
-Each inheriting class must override this method.
-
-### destroy
-
-Ends all form of life in this object.
-
-This is useful for Single Page Applications (SPA), to remove various event listeners.
-
-### isWidthSmall
-
-Is the view running in a small container (small embed or smartphone)
-
-Returns **[boolean][14]** True if container is small
-
-### isHeightSmall
-
-Is the view running in a small-height container (small embed or smartphone)
-
-Returns **[boolean][14]** True if container height is small
-
-### select
-
-Change the currently picture and/or sequence.
-Calling the method without parameters unselects.
-
-#### Parameters
-
-*   `seqId` **[string][7]?** The sequence UUID (optional, default `null`)
-*   `picId` **[string][7]?** The picture UUID (optional, default `null`)
-*   `force` **[boolean][14]** Force select even if already selected (optional, default `false`)
-
-### select
-
-Event for sequence/picture selection
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.seqId` **[string][7]** The selected sequence ID
-    *   `detail.picId` **[string][7]** The selected picture ID (or null if not a precise picture clicked)
-    *   `detail.prevSeqId` **[string][7]?** The previously selected sequence ID (or null if none)
-    *   `detail.prevPicId` **[string][7]?** The previously selected picture ID (or null if none)
-
-### ready
-
-Event for viewer being ready to use (API loaded)
-
-### broken
-
-Event for viewer failing to initially load
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.error` **[string][7]** The user-friendly error message to display
-
-### map:background-changed
-
-Event for map background changes
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.background` **[string][7]?** The new selected background (aerial, streets)
-
-### map:users-changed
-
-Event for visible users changes
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.usersIds` **[Array][12]<[string][7]>?** The list of newly selected users
-
-### map:sequence-hover
-
-Event when a sequence on map is hovered (not selected)
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.seqId` **[string][7]** The hovered sequence ID
-
-### map:sequence-click
-
-Event when a sequence on map is clicked
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.seqId` **[string][7]** The clicked sequence ID
-    *   `detail.coordinates` **maplibregl.LngLat** The coordinates of user click
-
-### map:picture-click
-
-Event when a picture on map is clicked
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The clicked picture ID
-    *   `detail.seqId` **[string][7]** The clicked picture's sequence ID
-    *   `detail.feature` **[object][10]** The GeoJSON feature of the picture
-
-### psv:picture-loading
-
-Event for picture starting to load
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The picture unique identifier
-    *   `detail.lon` **[number][15]** Longitude (WGS84)
-    *   `detail.lat` **[number][15]** Latitude (WGS84)
-    *   `detail.x` **[number][15]** New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West)
-    *   `detail.y` **[number][15]** New y position (in degrees)
-    *   `detail.z` **[number][15]** New z position (0-100)
-
-### psv:picture-preview-started
-
-Event for picture preview
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The picture ID
-    *   `detail.coordinates` **[Array][12]<[number][15]>** \[x,y] coordinates
-    *   `detail.direction` **[number][15]** The theorical picture orientation
-
-### psv:picture-preview-stopped
-
-Event for end of picture preview
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The picture ID
-
-### psv:view-rotated
-
-Event for viewer rotation
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.x` **[number][15]** New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West)
-    *   `detail.y` **[number][15]** New y position (in degrees)
-    *   `detail.z` **[number][15]** New Z position (between 0 and 100)
-
-### psv:picture-loaded
-
-Event for picture load (low-resolution image is loaded)
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The picture unique identifier
-    *   `detail.lon` **[number][15]** Longitude (WGS84)
-    *   `detail.lat` **[number][15]** Latitude (WGS84)
-    *   `detail.x` **[number][15]** New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West)
-    *   `detail.y` **[number][15]** New y position (in degrees)
-    *   `detail.z` **[number][15]** New z position (0-100)
-
-### psv:picture-tiles-loaded
-
-Event launched when all visible tiles of a picture are loaded
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.picId` **[string][7]** The picture unique identifier
-
-### psv:transition-duration-changed
-
-Event for transition duration change
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.duration` **[string][7]** New duration (in milliseconds)
-
-## Map
-
-**Extends maplibregl.Map**
-
-Map is the component showing pictures and sequences geolocation.
-
-Note that all functions of [MapLibre GL JS class Map][16] are also available.
-
-### Parameters
-
-*   `parent` **[CoreView][1]** The parent view
-*   `container` **[Element][8]** The DOM element to create into
-*   `options` **[object][10]?** The map options (any of [MapLibre GL settings][17] or any supplementary option defined here) (optional, default `{}`)
-
-    *   `options.raster` **[object][10]?** The MapLibre raster source for aerial background. This must be a JSON object following [MapLibre raster source definition][18].
-    *   `options.background` **[string][7]?** Choose default map background to display (streets or aerial, if raster aerial background available). Defaults to street.
-    *   `options.geocoder` **[object][10]?** Optional geocoder settings
-
-        *   `options.geocoder.engine` **[string][7]?** Set the geocoder engine to use (nominatim, ban)
-
-### destroy
-
-Destroy any form of life in this component
-
-### waitForEnoughMapLoaded
-
-Helper to know when enough map background and Panoramax tiles are loaded for a proper display.
-
-Returns **[Promise][19]** Resolves when enough is loaded
-
-### reloadVectorTiles
-
-Force refresh of vector tiles data
-
-### hasTwoBackgrounds
-
-Check if map offers aerial imagery as well as streets rendering.
-
-Returns **[boolean][14]** True if aerial imagery is available for display
-
-### getBackground
-
-Get the currently selected map background
-
-Returns **[string][7]** aerial or streets
-
-### setBackground
-
-Change the shown background in map.
-
-#### Parameters
-
-*   `bg` **[string][7]** The new background to display (aerial or streets)
-
-### getVisibleUsers
-
-Get the currently visible users
-
-Returns **[Array][12]<[string][7]>** List of visible users
-
-### setVisibleUsers
-
-Make given user layers visible on map, and hide all others (if any)
-
-#### Parameters
-
-*   `visibleIds` **([string][7] | [Array][12]<[string][7]>)** The user layers IDs to display (optional, default `[]`)
-
-### filterUserLayersContent
-
-Filter the visible data content in all visible map layers
-
-#### Parameters
-
-*   `dataType` **[string][7]** sequences or pictures
-*   `filter` **[object][10]** The MapLibre GL filter rule to apply
-
-### displayPictureMarker
-
-Shows on map a picture position and heading.
-
-#### Parameters
-
-*   `lon` **[number][15]** The longitude
-*   `lat` **[number][15]** The latitude
-*   `heading` **[number][15]** The heading
-
-### reloadLayersStyles
-
-Forces reload of pictures/sequences layer styles.
-This is useful after a map theme change.
-
-## Photo
-
-**Extends PSViewer**
-
-Photo is the component showing a single picture.
-It uses Photo Sphere Viewer as a basis, and pre-configure dialog with STAC API.
-
-Note that all functions of [PhotoSphereViewer Viewer class][20] are available as well.
-
-### Parameters
-
-*   `parent` **[CoreView][1]** The parent view
-*   `container` **[Element][8]** The DOM element to create into
-*   `options` **[object][10]?** The viewer options. Can be any of [Photo Sphere Viewer options][21] (optional, default `{}`)
-
-    *   `options.transitionDuration` **[number][15]?** The number of milliseconds the transition animation should be.
-    *   `options.shouldGoFast` **[function][22]?** Function returning a boolean to indicate if we may skip loading HD images.
-
-### getPictureMetadata
-
-Access currently shown picture metadata
-
-Returns **[object][10]** Picture metadata
-
-### goToNextPicture
-
-Displays next picture in current sequence (if any)
-
-### goToPrevPicture
-
-Displays previous picture in current sequence (if any)
-
-### goToPosition
-
-Displays in viewer a picture near to given coordinates
-
-#### Parameters
-
-*   `lat` **[number][15]** Latitude (WGS84)
-*   `lon` **[number][15]** Longitude (WGS84)
-
-Returns **[Promise][19]** Resolves on picture ID if picture found, otherwise rejects
-
-### getXY
-
-Get 2D position of sphere currently shown to user
-
-Returns **[object][10]** Position in format { x: heading in degrees (0° = North, 90° = East, 180° = South, 270° = West), y: top/bottom position in degrees (-90° = bottom, 0° = front, 90° = top) }
-
-### getXYZ
-
-Get 3D position of sphere currently shown to user
-
-Returns **[object][10]** Position in format { x: heading in degrees (0° = North, 90° = East, 180° = South, 270° = West), y: top/bottom position in degrees (-90° = bottom, 0° = front, 90° = top), z: zoom (0 = wide, 100 = zoomed in) }
-
-### getPictureOriginalHeading
-
-Get capture orientation of current picture, based on its GPS.
-
-Returns **any** Picture original heading in degrees (0 to 360°)
-
-### getPictureRelativeHeading
-
-Computes the relative heading of currently selected picture.
-This gives the angle of capture compared to sequence path (vehicle movement).
-
-Returns **any** Relative heading in degrees (-180 to 180)
-
-### clearPictureMetadataCache
-
-Clears the Photo Sphere Viewer metadata cache.
-It is useful when current picture or sequence has changed server-side after first load.
-
-### setXYZ
-
-Change the shown position in picture
-
-#### Parameters
-
-*   `x` **[number][15]** X position (in degrees)
-*   `y` **[number][15]** Y position (in degrees)
-*   `z` **[number][15]** Z position (0-100)
-
-### setHigherContrast
-
-Enable or disable higher contrast on picture
-
-#### Parameters
-
-*   `enable` **[boolean][14]** True to enable higher contrast
-
-### getTransitionDuration
-
-Get the duration of stay on a picture during a sequence play.
-
-Returns **[number][15]** The duration (in milliseconds)
-
-### setTransitionDuration
-
-Changes the duration of stay on a picture during a sequence play.
-
-#### Parameters
-
-*   `value` **[number][15]** The new duration (in milliseconds, between 100 and 3000)
-
-### showErrorOverlay
-
-Display an error message to user on screen
-
-#### Parameters
-
-*   `e` **[object][10]** The initial error
-*   `label` **str** The main error label to display
-*   `dissmisable` **[boolean][14]** Is error dissmisable
-
-## Editor
-
-**Extends CoreView**
-
-Editor allows to focus on a single sequence, and preview what you edits would look like.
-It shows both picture and map.
-
-Note that you can use any of the [CoreView][23] class functions as well.
-
-### Parameters
-
-*   `container` **([string][7] | [Element][8])** The DOM element to create viewer into
-*   `endpoint` **[string][7]** URL to API to use (must be a [STAC API][9])
-*   `options` **[object][10]?** View options. (optional, default `{}`)
-
-    *   `options.selectedSequence` **[string][7]** The ID of sequence to highlight on load. Must be always defined.
-    *   `options.selectedPicture` **[string][7]?** The ID of picture to highlight on load (defaults to none)
-    *   `options.fetchOptions` **[object][10]** Set custom options for fetch calls made against API ([same syntax as fetch options parameter][11]) (optional, default `null`)
-    *   `options.raster` **[object][10]?** The MapLibre raster source for aerial background. This must be a JSON object following [MapLibre raster source definition][18].
-    *   `options.background` **[string][7]?** Choose default map background to display (streets or aerial, if raster aerial background available). Defaults to street.
-    *   `options.style` **([string][7] | [object][10])?** The map's MapLibre style. This can be an a JSON object conforming to the schema described in the [MapLibre Style Specification][13], or a URL string pointing to one.
-
-### Properties
-
-*   `map` **[Map][2]** The map widget
-*   `psv` **[Photo][3]** The photo widget
-
-### previewSequenceHeadingChange
-
-Preview on map how the new relative heading would reflect on all pictures.
-This doesn't change anything on API-side, it's just a preview.
-
-#### Parameters
-
-*   `relHeading` **[number][15]?** The new relative heading compared to sequence path. In degrees, between -180 and 180 (0 = front, -90 = left, 90 = right). Set to null to remove preview.
-
-## StandaloneMap
-
-**Extends CoreView**
-
-The standalone map viewer allows to see STAC pictures data as a map.
-It only embeds a map (no 360° pictures viewer) with a minimal picture preview (thumbnail).
-
-Note that you can use any of the [CoreView][23] class functions as well.
-
-### Parameters
-
-*   `container` **([string][7] | [Element][8])** The DOM element to create viewer into
-*   `endpoint` **[string][7]** URL to API to use (must be a [STAC API][9])
-*   `options` **[object][10]?** Map options. Various settings can be passed, either the ones defined here, or any of [MapLibre GL settings][17]. (optional, default `{}`)
-
-    *   `options.selectedSequence` **[string][7]?** The ID of sequence to highlight on load (defaults to none)
-    *   `options.selectedPicture` **[string][7]?** The ID of picture to highlight on load (defaults to none)
-    *   `options.fetchOptions` **[object][10]** Set custom options for fetch calls made against API ([same syntax as fetch options parameter][11]) (optional, default `null`)
-    *   `options.minZoom` **[number][15]** The minimum zoom level of the map (0-24). (optional, default `0`)
-    *   `options.maxZoom` **[number][15]** The maximum zoom level of the map (0-24). (optional, default `24`)
-    *   `options.style` **([string][7] | [object][10])?** The map's MapLibre style. This can be an a JSON object conforming to the schema described in the [MapLibre Style Specification][13], or a URL string pointing to one.
-    *   `options.center` **external:maplibre-gl.LngLatLike** The initial geographical centerpoint of the map. If `center` is not specified in the constructor options, MapLibre GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `[0, 0]` Note: MapLibre GL uses longitude, latitude coordinate order (as opposed to latitude, longitude) to match GeoJSON. (optional, default `[0,0]`)
-    *   `options.zoom` **[number][15]** The initial zoom level of the map. If `zoom` is not specified in the constructor options, MapLibre GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`. (optional, default `0`)
-    *   `options.bounds` **external:maplibre-gl.LngLatBoundsLike?** The initial bounds of the map. If `bounds` is specified, it overrides `center` and `zoom` constructor options.
-    *   `options.users` **[Array][12]<[string][7]>?** The IDs of users whom data should appear on map (defaults to all)
-
-### Properties
-
-*   `map` **[Map][2]** The map widget
-
-### destroy
-
-Ends all form of life in this object.
-
-This is useful for Single Page Applications (SPA), to remove various event listeners.
-
-## Viewer
-
-**Extends CoreView**
-
-Viewer is the main component of Panoramax JS library, showing pictures and map.
-
-Note that you can use any of the [CoreView][23] class functions as well.
-
-### Parameters
-
-*   `container` **([string][7] | [Element][8])** The DOM element to create viewer into
-*   `endpoint` **[string][7]** URL to API to use (must be a [STAC API][9])
-*   `options` **[object][10]?** Viewer options (optional, default `{}`)
-
-    *   `options.selectedPicture` **[string][7]?** Initial picture identifier to display
-    *   `options.position` **[Array][12]<[number][15]>?** Initial position to go to (in \[lat, lon] format)
-    *   `options.hash` **[boolean][14]** Enable URL hash settings (optional, default `true`)
-    *   `options.lang` **[string][7]?** Override language to use (defaults to navigator language, or English if translation not available)
-    *   `options.transition` **int** Duration of stay on a picture during sequence play (excludes loading time) (optional, default `250`)
-    *   `options.fetchOptions` **[object][10]** Set custom options for fetch calls made against API ([same syntax as fetch options parameter][11]) (optional, default `null`)
-    *   `options.users` **([string][7] | [Array][12]<[string][7]>)?** The IDs of users whom data should appear on map (defaults to all). Only works with API having a "user-xyz" or "user-xyz-style" endpoint.
-    *   `options.picturesNavigation` **[string][7]?** The allowed navigation between pictures ("any": no restriction (default), "seq": only pictures in same sequence, "pic": only selected picture)
-    *   `options.map` **([boolean][14] | [object][10])** Enable contextual map for locating pictures. Setting to true or passing an object enables the map. Various settings can be passed, either the ones defined here, or any of [MapLibre GL settings][17] (optional, default `false`)
-
-        *   `options.map.startWide` **[boolean][14]?** Show the map as main element at startup (defaults to false, viewer is wider at start)
-        *   `options.map.minZoom` **[number][15]** The minimum zoom level of the map (0-24). (optional, default `0`)
-        *   `options.map.maxZoom` **[number][15]** The maximum zoom level of the map (0-24). (optional, default `24`)
-        *   `options.map.raster` **[object][10]?** The MapLibre raster source for aerial background. This must be a JSON object following [MapLibre raster source definition][18].
-        *   `options.map.center` **external:maplibre-gl.LngLatLike** The initial geographical centerpoint of the map. If `center` is not specified in the constructor options, MapLibre GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `[0, 0]` Note: MapLibre GL uses longitude, latitude coordinate order (as opposed to latitude, longitude) to match GeoJSON. (optional, default `[0,0]`)
-        *   `options.map.zoom` **[number][15]** The initial zoom level of the map. If `zoom` is not specified in the constructor options, MapLibre GL JS will look for it in the map's style object. If it is not specified in the style, either, it will default to `0`. (optional, default `0`)
-        *   `options.map.bounds` **external:maplibre-gl.LngLatBoundsLike?** The initial bounds of the map. If `bounds` is specified, it overrides `center` and `zoom` constructor options.
-        *   `options.map.geocoder` **[object][10]?** Optional geocoder settings
-
-            *   `options.map.geocoder.engine` **[string][7]?** Set the geocoder engine to use (nominatim, ban)
-        *   `options.map.background` **[string][7]?** Choose default map background to display (streets or aerial, if raster aerial background available). Defaults to street.
-        *   `options.map.theme` **[string][7]** The colouring scheme to use for pictures and sequences on map (default, age, type) (optional, default `default`)
-    *   `options.style` **([string][7] | [object][10])?** The map's MapLibre style. This can be an a JSON object conforming to the schema described in the [MapLibre Style Specification][13], or a URL string pointing to one.
-    *   `options.widgets` **[object][10]?** Settings related to viewer buttons and widgets
-
-        *   `options.widgets.editIdUrl` **[string][7]?** URL to the OpenStreetMap iD editor (defaults to OSM.org iD instance)
-        *   `options.widgets.customWidget` **([string][7] | [Element][8])?** A user-defined widget to add (will be shown over "Share" button)
-        *   `options.widgets.mapAttribution` **[string][7]?** Override the default map attribution (read from MapLibre style)
-        *   `options.widgets.iframeBaseURL` **[string][7]?** Set a custom base URL for the "Share as iframe" menu (defaults to current page)
-
-### Properties
-
-*   `map` **[Map][2]** The map widget
-*   `psv` **[Photo][3]** The photo widget
-
-### destroy
-
-Ends all form of life in this object.
-
-This is useful for Single Page Applications (SPA), to remove various event listeners.
-
-### refreshPSV
-
-Force reload of texture and tiles in Photo Sphere Viewer.
-
-### setPopup
-
-Change full-page popup visibility and content
-
-#### Parameters
-
-*   `visible` **[boolean][14]** True to make it appear
-*   `content` **([string][7] | [Array][12]<[Element][8]>)?** The new popup content (optional, default `null`)
-
-### playSequence
-
-Goes continuously to next picture in sequence as long as possible
-
-### stopSequence
-
-Stops playing current sequence
-
-### isSequencePlaying
-
-Is there any sequence being played right now ?
-
-Returns **[boolean][14]** True if sequence is playing
-
-### toggleSequencePlaying
-
-Starts/stops the reading of pictures in a sequence
-
-### moveCenter
-
-Move the view of main component to its center.
-For map, center view on selected picture.
-For picture, center view on image center.
-
-### moveLeft
-
-Moves the view of main component slightly to the left.
-
-### moveRight
-
-Moves the view of main component slightly to the right.
-
-### moveUp
-
-Moves the view of main component slightly to the top.
-
-### moveDown
-
-Moves the view of main component slightly to the bottom.
-
-### isMapWide
-
-Is the map shown as main element instead of viewer (wide map mode) ?
-
-Returns **[boolean][14]** True if map is wider than viewer
-
-### getPicturesNavigation
-
-Get current pictures navigation mode.
-
-Returns **[string][7]** The picture navigation mode ("any": no restriction, "seq": only pictures in same sequence, "pic": only selected picture)
-
-### setPicturesNavigation
-
-Switch the allowed navigation between pictures.
-
-#### Parameters
-
-*   `pn` **[string][7]** The picture navigation mode ("any": no restriction, "seq": only pictures in same sequence, "pic": only selected picture)
-
-### toggleJOSMLive
-
-Enable or disable JOSM live editing using [Remote][24]
-
-#### Parameters
-
-*   `enabled` **[boolean][14]** Set to true to enable JOSM live
-
-Returns **[Promise][19]** Resolves on JOSM live being enabled or disabled
-
-### setFocus
-
-Change the viewer focus (either on picture or map)
-
-#### Parameters
-
-*   `focus` **[string][7]** The object to focus on (map, pic)
-*   `skipEvent` **[boolean][14]** True to not send focus-changed event (optional, default `false`)
-
-### toggleFocus
-
-Toggle the viewer focus (either on picture or map)
-
-### setUnfocusedVisible
-
-Change the visibility of reduced component (picture or map)
-
-#### Parameters
-
-*   `visible` **[boolean][14]** True to make reduced component visible
-
-### toggleUnfocusedVisible
-
-Toggle the visibility of reduced component (picture or map)
-
-### setFilters
-
-Change the map filters
-
-#### Parameters
-
-*   `filters` **[object][10]** Filtering values
-
-    *   `filters.minDate` **[string][7]?** Start date for pictures (format YYYY-MM-DD)
-    *   `filters.maxDate` **[string][7]?** End date for pictures (format YYYY-MM-DD)
-    *   `filters.type` **[string][7]?** Type of picture to keep (flat, equirectangular)
-    *   `filters.camera` **[string][7]?** Camera make and model to keep
-    *   `filters.theme` **[string][7]?** Map theme to use
-    *   `filters.qualityscore` **[Array][12]<[number][15]>?** QualityScore values, as a list of 1 to 5 grades
-*   `skipZoomIn` **[boolean][14]** If true, doesn't force zoom in to map level >= 7 (optional, default `false`)
-
-### sequence-playing
-
-Event for sequence starting to play
-
-### sequence-stopped
-
-Event for sequence stopped playing
-
-### pictures-navigation-changed
-
-Event for pictures navigation mode change
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.value` **[string][7]** New mode (any, pic, seq)
-
-### josm-live-enabled
-
-Event for JOSM live enabled
-
-### josm-live-disabled
-
-Event for JOSM live disabled
-
-### focus-changed
-
-Event for focus change (either map or picture is shown wide)
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.focus` **[string][7]** Component now focused on (map, pic)
-
-### filters-changed
-
-Event for filters changes
-
-Type: [object][10]
-
-#### Properties
-
-*   `detail` **[object][10]** Event information
-
-    *   `detail.minDate` **[string][7]?** The minimum date in time range (ISO format)
-    *   `detail.maxDate` **[string][7]?** The maximum date in time range (ISO format)
-    *   `detail.type` **[string][7]?** Camera type (equirectangular, flat, null/empty string for both)
-    *   `detail.camera` **[string][7]?** Camera make and model
-    *   `detail.theme` **[string][7]?** Map theme
-    *   `detail.qualityscore` **[Array][12]<[number][15]>?** QualityScore values, as a list of 1 to 5 grades
-
-[1]: #coreview
-
-[2]: #map
-
-[3]: #photo
-
-[4]: #editor
-
-[5]: #standalonemap
-
-[6]: #viewer
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[8]: https://developer.mozilla.org/docs/Web/API/Element
-
-[9]: https://github.com/radiantearth/stac-api-spec/blob/main/overview.md
-
-[10]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[11]: https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters
-
-[12]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
-
-[13]: https://maplibre.org/maplibre-gl-js-docs/style-spec/
-
-[14]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[15]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
-
-[16]: https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/
-
-[17]: https://maplibre.org/maplibre-gl-js-docs/api/map/#map-parameters
-
-[18]: https://maplibre.org/maplibre-style-spec/sources/#raster
-
-[19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[20]: https://photo-sphere-viewer.js.org/api/classes/core.viewer
-
-[21]: https://photo-sphere-viewer.js.org/guide/config.html#standard-options
-
-[22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[23]: #CoreView
-
-[24]: https://josm.openstreetmap.de/wiki/Help/RemoteControlCommands