@panoramax/web-viewer 4.4.0-develop-3839b5a4 → 4.4.0-develop-f91f6758

package/docs/reference/utils/MapStyleComposer.md

@@ -1,408 +0,0 @@
-<a name="Panoramax.utils.MapStyleComposer"></a>
-
-## Panoramax.utils.MapStyleComposer
-**Kind**: static class of <code>Panoramax.utils</code>  
-**Emits**: [<code>basemap-added</code>](#Panoramax.utils.MapStyleComposer+event_basemap-added), [<code>basemap-changed</code>](#Panoramax.utils.MapStyleComposer+event_basemap-changed), [<code>dataunderlay-added</code>](#Panoramax.utils.MapStyleComposer+event_dataunderlay-added), [<code>dataunderlay-changed</code>](#Panoramax.utils.MapStyleComposer+event_dataunderlay-changed), [<code>panoramax-added</code>](#Panoramax.utils.MapStyleComposer+event_panoramax-added), [<code>panoramax-changed</code>](#Panoramax.utils.MapStyleComposer+event_panoramax-changed), [<code>theme-changed</code>](#Panoramax.utils.MapStyleComposer+event_theme-changed), [<code>filters-changed</code>](#Panoramax.utils.MapStyleComposer+event_filters-changed), [<code>dataoverlay-added</code>](#Panoramax.utils.MapStyleComposer+event_dataoverlay-added), [<code>dataoverlay-changed</code>](#Panoramax.utils.MapStyleComposer+event_dataoverlay-changed)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| basemap | <code>string</code> | The selected basemap |
-| dataUnderlays | <code>Set</code> | The visible data underlays |
-| panoramax | <code>string</code> | The selected Panoramax endpoint |
-| dataOverlays | <code>Set</code> | The visible data overlays |
-
-
-* [.MapStyleComposer](#Panoramax.utils.MapStyleComposer)
-    * [new MapStyleComposer(parent)](#new_Panoramax.utils.MapStyleComposer_new)
-    * [.getMapStyle()](#Panoramax.utils.MapStyleComposer+getMapStyle) ⇒ <code>object</code>
-    * [.updateMapStyle([reloadSem])](#Panoramax.utils.MapStyleComposer+updateMapStyle)
-    * [.registerSource(id, source)](#Panoramax.utils.MapStyleComposer+registerSource)
-    * [.registerLayer(layer, [beforeId])](#Panoramax.utils.MapStyleComposer+registerLayer)
-    * [.waitFor(type, id)](#Panoramax.utils.MapStyleComposer+waitFor) ⇒ <code>Promise</code>
-    * [.addBasemap(id, style, [switchOn])](#Panoramax.utils.MapStyleComposer+addBasemap)
-    * [.switchBasemap(id)](#Panoramax.utils.MapStyleComposer+switchBasemap)
-    * [.hasManyBasemaps()](#Panoramax.utils.MapStyleComposer+hasManyBasemaps) ⇒ <code>boolean</code>
-    * [.hasStreetsAerialBasemaps()](#Panoramax.utils.MapStyleComposer+hasStreetsAerialBasemaps) ⇒ <code>boolean</code>
-    * [.hasComplementaryBasemaps()](#Panoramax.utils.MapStyleComposer+hasComplementaryBasemaps) ⇒ <code>boolean</code>
-    * [.addDataUnderlay(id, style, [switchOn])](#Panoramax.utils.MapStyleComposer+addDataUnderlay)
-    * [.switchDataUnderlayVisibility(id, visible)](#Panoramax.utils.MapStyleComposer+switchDataUnderlayVisibility)
-    * [.addPanoramaxEndpoint(id, style, [switchOn])](#Panoramax.utils.MapStyleComposer+addPanoramaxEndpoint)
-    * [.switchPanoramaxEndpoint(id)](#Panoramax.utils.MapStyleComposer+switchPanoramaxEndpoint)
-    * [.isPanoramaxEndpointSingleUser()](#Panoramax.utils.MapStyleComposer+isPanoramaxEndpointSingleUser) ⇒ <code>boolean</code>
-    * [.setPanoramaxTheme(theme)](#Panoramax.utils.MapStyleComposer+setPanoramaxTheme)
-    * [.setPanoramaxFilters(filters)](#Panoramax.utils.MapStyleComposer+setPanoramaxFilters)
-    * [.addDataOverlay(id, style, [switchOn])](#Panoramax.utils.MapStyleComposer+addDataOverlay)
-    * [.switchDataOverlayVisibility(id, visible)](#Panoramax.utils.MapStyleComposer+switchDataOverlayVisibility)
-    * ["basemap-added"](#Panoramax.utils.MapStyleComposer+event_basemap-added)
-    * ["basemap-changed"](#Panoramax.utils.MapStyleComposer+event_basemap-changed)
-    * ["dataunderlay-added"](#Panoramax.utils.MapStyleComposer+event_dataunderlay-added)
-    * ["dataunderlay-changed"](#Panoramax.utils.MapStyleComposer+event_dataunderlay-changed)
-    * ["panoramax-added"](#Panoramax.utils.MapStyleComposer+event_panoramax-added)
-    * ["panoramax-changed"](#Panoramax.utils.MapStyleComposer+event_panoramax-changed)
-    * ["theme-changed"](#Panoramax.utils.MapStyleComposer+event_theme-changed)
-    * ["filters-changed"](#Panoramax.utils.MapStyleComposer+event_filters-changed)
-    * ["dataoverlay-added"](#Panoramax.utils.MapStyleComposer+event_dataoverlay-added)
-    * ["dataoverlay-changed"](#Panoramax.utils.MapStyleComposer+event_dataoverlay-changed)
-
-<a name="new_Panoramax.utils.MapStyleComposer_new"></a>
-
-### new MapStyleComposer(parent)
-Map Style Composer allows an easy management of MapLibre styles.
-As Panoramax Viewer composes with many sources and layers, it's helpful.
-There are several "Layer Ranges" (from bottom to top):
-  - Basemap: contextual background, either raster of vector
-  - Data Underlay: vector data below Panoramax data (indoor maps)
-  - Panoramax: pictures, sequences, grid statistics
-  - Data Overlay: vector data on top of Panoramax data (traffic signs...)
-The composer offers helpers to switch between any layer in a specific range.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| parent | <code>Panoramax.components.core.basic</code> | The parent view |
-
-**Example**  
-```js
-const msc = new Panoramax.utils.MapStyleComposer(viewer)
-```
-<a name="Panoramax.utils.MapStyleComposer+getMapStyle"></a>
-
-### mapStyleComposer.getMapStyle() ⇒ <code>object</code>
-Gives MapLibre JSON style to pass to Map constructor or setStyle function.
-This gives ready-to-use sources and layers.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>object</code> - The MapLibre style object  
-<a name="Panoramax.utils.MapStyleComposer+updateMapStyle"></a>
-
-### mapStyleComposer.updateMapStyle([reloadSem])
-Throttled function to force map data refresh.
-This allows to make actual effect of layers adds/switches.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [reloadSem] | <code>boolean</code> | <code>false</code> | Force reload of semantics layers (in case of API switch) |
-
-<a name="Panoramax.utils.MapStyleComposer+registerSource"></a>
-
-### mapStyleComposer.registerSource(id, source)
-Checks if given source already exists in composer, or add it as detached to wait.
-This is useful for sources added directly to MapLibre not through the MapStyleComposer.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | The source ID |
-| source | <code>object</code> | The MapLibre source definition |
-
-<a name="Panoramax.utils.MapStyleComposer+registerLayer"></a>
-
-### mapStyleComposer.registerLayer(layer, [beforeId])
-Checks if given layer already exists in composer, or add it as data under/overlay.
-This is useful for layers added directly to MapLibre not through the MapStyleComposer.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| layer | <code>object</code> | The MapLibre layer definition |
-| [beforeId] | <code>string</code> | The ID of an existing layer to put this one before |
-
-<a name="Panoramax.utils.MapStyleComposer+waitFor"></a>
-
-### mapStyleComposer.waitFor(type, id) ⇒ <code>Promise</code>
-Wait for some layer to be available
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>Promise</code> - Resolves when layer is ready  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| type | <code>string</code> | The kind of layer (panoramax, dataOverlays, dataUnderlays, basemaps) |
-| id | <code>string</code> | The ID of layer to wait for |
-
-<a name="Panoramax.utils.MapStyleComposer+addBasemap"></a>
-
-### mapStyleComposer.addBasemap(id, style, [switchOn])
-Creates a new basemap
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| id | <code>string</code> |  | Identifier for this basemap |
-| style | <code>object</code> |  | The MapLibre-like style definition (object with sources and layers) |
-| [switchOn] | <code>boolean</code> | <code>false</code> | Immediate map display ? |
-
-<a name="Panoramax.utils.MapStyleComposer+switchBasemap"></a>
-
-### mapStyleComposer.switchBasemap(id)
-Makes this basemap now visible, instead of current one.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | The basemap ID |
-
-<a name="Panoramax.utils.MapStyleComposer+hasManyBasemaps"></a>
-
-### mapStyleComposer.hasManyBasemaps() ⇒ <code>boolean</code>
-Does this style contain many different basemaps ?
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>boolean</code> - True if 2 or more basemaps are available  
-<a name="Panoramax.utils.MapStyleComposer+hasStreetsAerialBasemaps"></a>
-
-### mapStyleComposer.hasStreetsAerialBasemaps() ⇒ <code>boolean</code>
-Does this style contains two main basemaps "aerial" & "streets" ?
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>boolean</code> - True if two main basemaps available  
-<a name="Panoramax.utils.MapStyleComposer+hasComplementaryBasemaps"></a>
-
-### mapStyleComposer.hasComplementaryBasemaps() ⇒ <code>boolean</code>
-Does this style contains any other basemaps than two main ones (aerial/streets)
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>boolean</code> - True if other basemaps available  
-<a name="Panoramax.utils.MapStyleComposer+addDataUnderlay"></a>
-
-### mapStyleComposer.addDataUnderlay(id, style, [switchOn])
-Creates a new data underlay
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| id | <code>string</code> |  | Identifier for this basemap |
-| style | <code>object</code> |  | The MapLibre-like style definition (object with sources and layers) |
-| [switchOn] | <code>boolean</code> | <code>false</code> | Immediate map display ? |
-
-<a name="Panoramax.utils.MapStyleComposer+switchDataUnderlayVisibility"></a>
-
-### mapStyleComposer.switchDataUnderlayVisibility(id, visible)
-Change visibility of a given data underlay.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | The Identifier of data underlay to change |
-| visible | <code>boolean</code> | Set to true to make visible, false to hide |
-
-<a name="Panoramax.utils.MapStyleComposer+addPanoramaxEndpoint"></a>
-
-### mapStyleComposer.addPanoramaxEndpoint(id, style, [switchOn])
-Creates a new Panoramax Vector Tile endpoint.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| id | <code>string</code> |  | The identifier for this endpoint |
-| style | <code>object</code> |  | The MapLibre Style JSON object |
-| [switchOn] | <code>boolean</code> | <code>false</code> | Immediate map display ? |
-
-<a name="Panoramax.utils.MapStyleComposer+switchPanoramaxEndpoint"></a>
-
-### mapStyleComposer.switchPanoramaxEndpoint(id)
-Uses this Panoramax Vector Tile endpoint instead of current one.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | The endpoint ID |
-
-<a name="Panoramax.utils.MapStyleComposer+isPanoramaxEndpointSingleUser"></a>
-
-### mapStyleComposer.isPanoramaxEndpointSingleUser() ⇒ <code>boolean</code>
-Is the currently selected Panoramax endpoint showing data of a single user ?
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Returns**: <code>boolean</code> - True if single user  
-<a name="Panoramax.utils.MapStyleComposer+setPanoramaxTheme"></a>
-
-### mapStyleComposer.setPanoramaxTheme(theme)
-Changes the selected Panoramax map theme
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| theme | <code>string</code> | One of "default", "age", "type", "score", "gps" |
-
-<a name="Panoramax.utils.MapStyleComposer+setPanoramaxFilters"></a>
-
-### mapStyleComposer.setPanoramaxFilters(filters)
-Changes the selected Panoramax filters
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| filters | <code>object</code> | Filtering values |
-| [filters.minDate] | <code>string</code> | Start date for pictures (format YYYY-MM-DD) |
-| [filters.maxDate] | <code>string</code> | End date for pictures (format YYYY-MM-DD) |
-| [filters.pic_type] | <code>string</code> | Type of picture to keep (flat, equirectangular) |
-| [filters.qualityscore] | <code>Array.&lt;number&gt;</code> | QualityScore values, as a list of 1 to 5 grades |
-| [filters.gps] | <code>Array.&lt;number&gt;</code> | GPS precision grades, as a list of 1 to 5 grades |
-| [filters.featuresRestrictions] | <code>object</code> | Rules to restrict display of pictures & sequences |
-
-<a name="Panoramax.utils.MapStyleComposer+addDataOverlay"></a>
-
-### mapStyleComposer.addDataOverlay(id, style, [switchOn])
-Creates a new data overlay
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| id | <code>string</code> |  | Identifier for this basemap |
-| style | <code>object</code> |  | The MapLibre-like style definition (object with sources and layers) |
-| [switchOn] | <code>boolean</code> | <code>false</code> | Immediate map display ? |
-
-<a name="Panoramax.utils.MapStyleComposer+switchDataOverlayVisibility"></a>
-
-### mapStyleComposer.switchDataOverlayVisibility(id, visible)
-Change visibility of a given data Overlay.
-
-**Kind**: instance method of [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| id | <code>string</code> | The Identifier of data Overlay to change |
-| visible | <code>boolean</code> | Set to true to make visible, false to hide |
-
-<a name="Panoramax.utils.MapStyleComposer+event_basemap-added"></a>
-
-### "basemap-added"
-Event for basemap added
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.basemap] | <code>string</code> | The added basemap ID |
-
-<a name="Panoramax.utils.MapStyleComposer+event_basemap-changed"></a>
-
-### "basemap-changed"
-Event for basemap changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.basemap] | <code>string</code> | The basemap ID |
-
-<a name="Panoramax.utils.MapStyleComposer+event_dataunderlay-added"></a>
-
-### "dataunderlay-added"
-Event for data underlay added
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.dataUnderlay] | <code>string</code> | The added data underlay ID |
-
-<a name="Panoramax.utils.MapStyleComposer+event_dataunderlay-changed"></a>
-
-### "dataunderlay-changed"
-Event for data underlays changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.dataUnderlay] | <code>string</code> | The data underlay ID |
-| [detail.visible] | <code>boolean</code> | True if visible |
-
-<a name="Panoramax.utils.MapStyleComposer+event_panoramax-added"></a>
-
-### "panoramax-added"
-Event for Panoramax endpoint added
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.endpoint] | <code>string</code> | The added Panoramax endpoint ID |
-
-<a name="Panoramax.utils.MapStyleComposer+event_panoramax-changed"></a>
-
-### "panoramax-changed"
-Event for Panoramax endpoint changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.endpoint] | <code>string</code> | The new selected Panoramax endpoint |
-
-<a name="Panoramax.utils.MapStyleComposer+event_theme-changed"></a>
-
-### "theme-changed"
-Event for Panoramax theme changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.theme] | <code>string</code> | The new selected theme |
-
-<a name="Panoramax.utils.MapStyleComposer+event_filters-changed"></a>
-
-### "filters-changed"
-Event for Panoramax filters changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.minDate] | <code>string</code> | The minimum date in time range (ISO format) |
-| [detail.maxDate] | <code>string</code> | The maximum date in time range (ISO format) |
-| [detail.pic_type] | <code>string</code> | Camera type (equirectangular, flat, null/empty string for both) |
-| [detail.qualityscore] | <code>Array.&lt;number&gt;</code> | QualityScore values, as a list of 1 to 5 grades |
-| [detail.gps] | <code>Array.&lt;number&gt;</code> | GPS precision grades, as a list of 1 to 5 grades |
-| [detail.featuresRestrictions] | <code>object</code> | Rules to restrict display of pictures & sequences |
-
-<a name="Panoramax.utils.MapStyleComposer+event_dataoverlay-added"></a>
-
-### "dataoverlay-added"
-Event for data overlay added
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.dataOverlay] | <code>string</code> | The added data overlay ID |
-
-<a name="Panoramax.utils.MapStyleComposer+event_dataoverlay-changed"></a>
-
-### "dataoverlay-changed"
-Event for data overlays changes
-
-**Kind**: event emitted by [<code>MapStyleComposer</code>](#Panoramax.utils.MapStyleComposer)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| [detail.dataOverlay] | <code>string</code> | The data overlay ID |
-| [detail.visible] | <code>boolean</code> | True if visible |
-

package/docs/reference/utils/PanoraMapProtocol.md

@@ -1,28 +0,0 @@
-<a name="Panoramax.utils.PanoraMapProtocol"></a>
-
-## Panoramax.utils.PanoraMapProtocol
-**Kind**: static class of <code>Panoramax.utils</code>  
-
-* [.PanoraMapProtocol](#Panoramax.utils.PanoraMapProtocol)
-    * [new PanoraMapProtocol()](#new_Panoramax.utils.PanoraMapProtocol_new)
-    * [.tile(params, abort)](#Panoramax.utils.PanoraMapProtocol+tile) ⇒ <code>object</code>
-
-<a name="new_Panoramax.utils.PanoraMapProtocol_new"></a>
-
-### new PanoraMapProtocol()
-PanoraMap Protocol adds a new URI scheme "panora://" (or "panoras://") to MapLibre.
-It allows adding custom information on top of existing Panoramax Vector Tiles.
-
-<a name="Panoramax.utils.PanoraMapProtocol+tile"></a>
-
-### panoraMapProtocol.tile(params, abort) ⇒ <code>object</code>
-Get a single tile
-
-**Kind**: instance method of [<code>PanoraMapProtocol</code>](#Panoramax.utils.PanoraMapProtocol)  
-**Returns**: <code>object</code> - The tile, as expected by MapLibre  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | MapLibre parameters |
-| abort | <code>AbortController</code> | The abort signal handler |
-

package/docs/reference/utils/PresetsManager.md

@@ -1,43 +0,0 @@
-<a name="Panoramax.utils.PresetsManager"></a>
-
-## Panoramax.utils.PresetsManager
-**Kind**: static class of <code>Panoramax.utils</code>  
-
-* [.PresetsManager](#Panoramax.utils.PresetsManager)
-    * [new PresetsManager([lang], [skipLoad])](#new_Panoramax.utils.PresetsManager_new)
-    * [.onceReady()](#Panoramax.utils.PresetsManager+onceReady) ⇒ <code>Promise</code>
-    * [.getPreset()](#Panoramax.utils.PresetsManager+getPreset) ⇒ <code>Promise</code>
-    * [.getPresets()](#Panoramax.utils.PresetsManager+getPresets) ⇒ <code>Promise</code>
-
-<a name="new_Panoramax.utils.PresetsManager_new"></a>
-
-### new PresetsManager([lang], [skipLoad])
-Presets Manager handle retrieval of presets against dedicated endpoint.
-It allows an easily search between all presets, and handles translations.
-
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [lang] | <code>string</code> |  | The user prefered language. Defaults to web browser preferences. |
-| [skipLoad] | <code>boolean</code> | <code>false</code> | Set to true to disable automatic load of API data |
-
-<a name="Panoramax.utils.PresetsManager+onceReady"></a>
-
-### presetsManager.onceReady() ⇒ <code>Promise</code>
-Resolves when the all necessary data was downloaded.
-
-**Kind**: instance method of [<code>PresetsManager</code>](#Panoramax.utils.PresetsManager)  
-<a name="Panoramax.utils.PresetsManager+getPreset"></a>
-
-### presetsManager.getPreset() ⇒ <code>Promise</code>
-Find the best matching preset for a given STAC feature.
-
-**Kind**: instance method of [<code>PresetsManager</code>](#Panoramax.utils.PresetsManager)  
-**Fulfil**: <code>object\|null</code> The preset JSON that best matches, or null if no matches  
-<a name="Panoramax.utils.PresetsManager+getPresets"></a>
-
-### presetsManager.getPresets() ⇒ <code>Promise</code>
-Find all matching presets for a given STAC feature.
-
-**Kind**: instance method of [<code>PresetsManager</code>](#Panoramax.utils.PresetsManager)  
-**Fulfil**: <code>object[]\|null</code> The all JSON presets that best matches, or null if no matches  

package/docs/reference/utils/SemanticsMapProtocol.md

@@ -1,43 +0,0 @@
-<a name="Panoramax.utils.SemanticsMapProtocol"></a>
-
-## Panoramax.utils.SemanticsMapProtocol
-**Kind**: static class of <code>Panoramax.utils</code>  
-
-* [.SemanticsMapProtocol](#Panoramax.utils.SemanticsMapProtocol)
-    * [new SemanticsMapProtocol(parent)](#new_Panoramax.utils.SemanticsMapProtocol_new)
-    * [.clearCache()](#Panoramax.utils.SemanticsMapProtocol+clearCache)
-    * [.tile(params, abort)](#Panoramax.utils.SemanticsMapProtocol+tile) ⇒ <code>object</code>
-
-<a name="new_Panoramax.utils.SemanticsMapProtocol_new"></a>
-
-### new SemanticsMapProtocol(parent)
-Semantics Map Protocol adds a new URI scheme "sem://" to MapLibre.
-It allows loading tile per tile metadata from semantics API, seamlessly.
-You can use them with URI like:
-- `sem:///"semantics.osm|traffic_sign" IS NOT NULL/{z}/{x}/{y}`
-- `sem:///"semantics.osm|traffic_sign"='yes'/{z}/{x}/{y}`
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| parent | [<code>Basic</code>](../components/core/Basic.md/#Panoramax.components.core.Basic) | The parent component |
-
-<a name="Panoramax.utils.SemanticsMapProtocol+clearCache"></a>
-
-### semMapProtocol.clearCache()
-Removes all previously stored tiles in cache.
-
-**Kind**: instance method of [<code>SemanticsMapProtocol</code>](#Panoramax.utils.SemanticsMapProtocol)  
-<a name="Panoramax.utils.SemanticsMapProtocol+tile"></a>
-
-### semMapProtocol.tile(params, abort) ⇒ <code>object</code>
-Get a single tile
-
-**Kind**: instance method of [<code>SemanticsMapProtocol</code>](#Panoramax.utils.SemanticsMapProtocol)  
-**Returns**: <code>object</code> - The tile, as expected by MapLibre  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | MapLibre parameters |
-| abort | <code>AbortController</code> | The abort signal handler |
-

package/docs/reference/utils/URLHandler.md

@@ -1,114 +0,0 @@
-<a name="Panoramax.utils.URLHandler"></a>
-
-## Panoramax.utils.URLHandler
-**Kind**: static class of <code>Panoramax.utils</code>  
-**Emits**: [<code>url-changed</code>](#Panoramax.utils.URLHandler+event_url-changed)  
-
-* [.URLHandler](#Panoramax.utils.URLHandler)
-    * [new URLHandler(parent)](#new_Panoramax.utils.URLHandler_new)
-    * [.listenToChanges()](#Panoramax.utils.URLHandler+listenToChanges)
-    * [.destroy()](#Panoramax.utils.URLHandler+destroy)
-    * [.nextURLParams()](#Panoramax.utils.URLHandler+nextURLParams) ⇒ <code>object</code>
-    * [.nextURLString()](#Panoramax.utils.URLHandler+nextURLString) ⇒ <code>string</code>
-    * [.currentURLParams([readFromHash])](#Panoramax.utils.URLHandler+currentURLParams) ⇒ <code>object</code>
-    * [.currentMapString()](#Panoramax.utils.URLHandler+currentMapString) ⇒ <code>string</code>
-    * [.currentPSVString()](#Panoramax.utils.URLHandler+currentPSVString) ⇒ <code>string</code>
-    * [.nextShortLink()](#Panoramax.utils.URLHandler+nextShortLink) ⇒ <code>str</code>
-    * [.getUnmanagedParameters(prevUrl)](#Panoramax.utils.URLHandler+getUnmanagedParameters)
-    * ["url-changed"](#Panoramax.utils.URLHandler+event_url-changed)
-
-<a name="new_Panoramax.utils.URLHandler_new"></a>
-
-### new URLHandler(parent)
-Updates the URL query part with various parent component information.
-
-Note that you may call `listenToChanges()` for this class to be effective once parent is ready-enough.
-
-
-| Param | Type | Description |
-| --- | --- | --- |
-| parent | [<code>Basic</code>](../components/core/Basic.md/#Panoramax.components.core.Basic) | The parent component |
-
-<a name="Panoramax.utils.URLHandler+listenToChanges"></a>
-
-### urlHandler.listenToChanges()
-Start listening to URL & parent changes through events.
-This leads to parent & URL updates.
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-<a name="Panoramax.utils.URLHandler+destroy"></a>
-
-### urlHandler.destroy()
-Call this function to stop listening to global events.
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-<a name="Panoramax.utils.URLHandler+nextURLParams"></a>
-
-### urlHandler.nextURLParams() ⇒ <code>object</code>
-Compute next values to insert in URL
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>object</code> - Query parameters  
-<a name="Panoramax.utils.URLHandler+nextURLString"></a>
-
-### urlHandler.nextURLString() ⇒ <code>string</code>
-Compute next URL query string (based on `nextURLParams()`)
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>string</code> - The query string  
-<a name="Panoramax.utils.URLHandler+currentURLParams"></a>
-
-### urlHandler.currentURLParams([readFromHash]) ⇒ <code>object</code>
-Transforms current URL query string into key->value object
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>object</code> - Key-value read from current URL query  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| [readFromHash] | <code>boolean</code> | <code>false</code> | Switch to reading from hash URL part (for retro-compatibility) |
-
-<a name="Panoramax.utils.URLHandler+currentMapString"></a>
-
-### urlHandler.currentMapString() ⇒ <code>string</code>
-Get string representation of map position
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>string</code> - zoom/lat/lon or zoom/lat/lon/bearing/pitch  
-<a name="Panoramax.utils.URLHandler+currentPSVString"></a>
-
-### urlHandler.currentPSVString() ⇒ <code>string</code>
-Get PSV view position as string
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>string</code> - x/y/z  
-<a name="Panoramax.utils.URLHandler+nextShortLink"></a>
-
-### urlHandler.nextShortLink() ⇒ <code>str</code>
-Get short link URL (query replaced by Base64)
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Returns**: <code>str</code> - The short link URL  
-<a name="Panoramax.utils.URLHandler+getUnmanagedParameters"></a>
-
-### urlHandler.getUnmanagedParameters(prevUrl)
-Returns a string containing only parameters out of URLHandler scope
-
-**Kind**: instance method of [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| prevUrl | <code>URL</code> | The previously set URL |
-
-<a name="Panoramax.utils.URLHandler+event_url-changed"></a>
-
-### "url-changed"
-URL changed event
-
-**Kind**: event emitted by [<code>URLHandler</code>](#Panoramax.utils.URLHandler)  
-**Properties**
-
-| Name | Type | Description |
-| --- | --- | --- |
-| detail.url | <code>string</code> | The new used URL |
-