@panoramax/web-viewer 3.2.3 → 4.0.0-develop-9f9cf858

package/docs/reference/components/ui/widgets/Legend.md

@@ -0,0 +1,49 @@
+<a name="Panoramax.components.ui.widgets.Legend"></a>
+
+## Panoramax.components.ui.widgets.Legend ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-legend  
+**Slot**: `editors` External links to map editors, or any tool that may be helpful. Defaults to OSM tools (iD & JOSM).  
+
+* [.Legend](#Panoramax.components.ui.widgets.Legend) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new Legend()](#new_Panoramax.components.ui.widgets.Legend_new)
+    * [.properties](#Panoramax.components.ui.widgets.Legend+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.widgets.Legend_new"></a>
+
+### new Legend()
+Legend widget, handling switch between map and photo components.
+Also displays a default "About Panoramax" message.
+
+**Example**  
+```html
+<!-- Default legend -->
+<pnx-widget-legend
+  _parent=${viewer}
+  focus="map"
+  picture="PICTURE-ID-IF-ANY"
+/>
+
+<!-- With custom editor links -->
+<pnx-widget-legend
+  _parent=${viewer}
+  focus="map"
+  picture="PICTURE-ID-IF-ANY"
+>
+  <div slot="editors"><a href="http://my.own.tool">Edit in my own tool</a></div>
+</pnx-widget-legend>
+```
+<a name="Panoramax.components.ui.widgets.Legend+properties"></a>
+
+### legend.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>Legend</code>](#Panoramax.components.ui.widgets.Legend)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| [focus] | <code>string</code> | The focused main component (map, pic) |
+| [picture] | <code>string</code> | The picture ID |
+

package/docs/reference/components/ui/widgets/MapFiltersButton.md

@@ -0,0 +1,33 @@
+<a name="Panoramax.components.ui.widgets.MapFiltersButton"></a>
+
+## Panoramax.components.ui.widgets.MapFiltersButton ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-mapfilters  
+
+* [.MapFiltersButton](#Panoramax.components.ui.widgets.MapFiltersButton) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new MapFiltersButton()](#new_Panoramax.components.ui.widgets.MapFiltersButton_new)
+    * [.properties](#Panoramax.components.ui.widgets.MapFiltersButton+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.widgets.MapFiltersButton_new"></a>
+
+### new MapFiltersButton()
+Collapsible button showing off map filters menus.
+
+**Example**  
+```html
+<pnx-widget-mapfilters user-search="" _parent=${viewer} />
+```
+<a name="Panoramax.components.ui.widgets.MapFiltersButton+properties"></a>
+
+### mapFiltersButton.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>MapFiltersButton</code>](#Panoramax.components.ui.widgets.MapFiltersButton)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [user-search] | <code>boolean</code> | <code>false</code> | Should user search filter show up ? |
+| [quality-score] | <code>boolean</code> | <code>false</code> | Should quality score filter show up ? |
+

package/docs/reference/components/ui/widgets/MapLayersButton.md

@@ -0,0 +1,15 @@
+<a name="Panoramax.components.ui.widgets.MapLayersButton"></a>
+
+## Panoramax.components.ui.widgets.MapLayersButton ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-maplayers  
+<a name="new_Panoramax.components.ui.widgets.MapLayersButton_new"></a>
+
+### new MapLayersButton()
+Collapsible button showing off map filters menus.
+
+**Example**  
+```html
+<pnx-widget-maplayers _parent=${viewer} />
+```

package/docs/reference/components/ui/widgets/OSMEditors.md

@@ -0,0 +1,15 @@
+<a name="Panoramax.components.ui.widgets.OSMEditors"></a>
+
+## Panoramax.components.ui.widgets.OSMEditors ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-osmeditors  
+<a name="new_Panoramax.components.ui.widgets.OSMEditors_new"></a>
+
+### new OSMEditors()
+OSM Editors component offers direct links to OpenStreetMap's iD and JOSM editors.
+
+**Example**  
+```html
+<pnx-widget-osmeditors _parent=${viewer} />
+```

package/docs/reference/components/ui/widgets/PictureLegendActions.md

@@ -0,0 +1,32 @@
+<a name="Panoramax.components.ui.widgets.PictureLegendActions"></a>
+
+## Panoramax.components.ui.widgets.PictureLegendActions ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-picture-legend-actions  
+
+* [.PictureLegendActions](#Panoramax.components.ui.widgets.PictureLegendActions) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new PictureLegendActions()](#new_Panoramax.components.ui.widgets.PictureLegendActions_new)
+    * [.properties](#Panoramax.components.ui.widgets.PictureLegendActions+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.widgets.PictureLegendActions_new"></a>
+
+### new PictureLegendActions()
+Picture Legend Actions is a menu showing up complementary actions for picture legend.
+
+**Example**  
+```html
+<pnx-picture-legend-actions _parent=${viewer} />
+```
+<a name="Panoramax.components.ui.widgets.PictureLegendActions+properties"></a>
+
+### pictureLegendActions.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>PictureLegendActions</code>](#Panoramax.components.ui.widgets.PictureLegendActions)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [full] | <code>boolean</code> | <code>false</code> | Show advanced actions |
+

package/docs/reference/components/ui/widgets/Player.md

@@ -0,0 +1,33 @@
+<a name="Panoramax.components.ui.widgets.Player"></a>
+
+## Panoramax.components.ui.widgets.Player ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-player  
+
+* [.Player](#Panoramax.components.ui.widgets.Player) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new Player()](#new_Panoramax.components.ui.widgets.Player_new)
+    * [.properties](#Panoramax.components.ui.widgets.Player+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.widgets.Player_new"></a>
+
+### new Player()
+Player widget shows prev/play/pause/next/more buttons in a unified toolbar.
+
+**Example**  
+```html
+<pnx-widget-player _parent=${viewer} />
+```
+<a name="Panoramax.components.ui.widgets.Player+properties"></a>
+
+### player.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>Player</code>](#Panoramax.components.ui.widgets.Player)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [playing] | <code>boolean</code> | <code>false</code> | Is sequence currently playing ? |
+| [size] | <code>string</code> | <code>&quot;xl&quot;</code> | Group size (md, xl) |
+

package/docs/reference/components/ui/widgets/Zoom.md

@@ -0,0 +1,15 @@
+<a name="Panoramax.components.ui.widgets.Zoom"></a>
+
+## Panoramax.components.ui.widgets.Zoom ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui.widgets</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-widget-zoom  
+<a name="new_Panoramax.components.ui.widgets.Zoom_new"></a>
+
+### new Zoom()
+Widget for +/- zoom on PSV or Map.
+
+**Example**  
+```html
+<pnx-widget-zoom _parent=${viewer} />
+```

package/docs/reference/utils/API.md

@@ -0,0 +1,334 @@
+<a name="Panoramax.utils.API"></a>
+
+## Panoramax.utils.API
+**Kind**: static class of <code>Panoramax.utils</code>  
+**Emits**: [<code>ready</code>](#Panoramax.utils.API+event_ready), [<code>broken</code>](#Panoramax.utils.API+event_broken)  
+
+* [.API](#Panoramax.utils.API)
+    * [new API(endpoint, [options])](#new_Panoramax.utils.API_new)
+    * _instance_
+        * [.onceReady()](#Panoramax.utils.API+onceReady) ⇒ <code>Promise</code>
+        * [.isReady()](#Panoramax.utils.API+isReady) ⇒ <code>boolean</code>
+        * [.getAvailableFeatures()](#Panoramax.utils.API+getAvailableFeatures) ⇒ <code>Array.&lt;string&gt;</code>
+        * [.getUnavailableFeatures()](#Panoramax.utils.API+getUnavailableFeatures) ⇒ <code>Array.&lt;string&gt;</code>
+        * [.getSequenceItems(seqId, [next], [data])](#Panoramax.utils.API+getSequenceItems) ⇒ <code>Promise</code>
+        * [.getPicturesAroundCoordinatesUrl(lat, lon, [factor], [limit], [seqId])](#Panoramax.utils.API+getPicturesAroundCoordinatesUrl) ⇒ <code>string</code>
+        * [.getPicturesAroundCoordinates(lat, lon, [factor], [limit], [seqId])](#Panoramax.utils.API+getPicturesAroundCoordinates) ⇒ <code>Promise</code>
+        * [.getPictureMetadataUrl(picId, [seqId])](#Panoramax.utils.API+getPictureMetadataUrl) ⇒ <code>string</code>
+        * [.getMapStyle()](#Panoramax.utils.API+getMapStyle) ⇒ <code>Promise</code> \| <code>object</code>
+        * [.getUserMapStyle(userId, [skipReadyCheck])](#Panoramax.utils.API+getUserMapStyle) ⇒ <code>Promise</code>
+        * [.getPictureThumbnailURLForSequence(seqId, [seq])](#Panoramax.utils.API+getPictureThumbnailURLForSequence) ⇒ <code>Promise</code>
+        * [.getPictureThumbnailURL(picId, [seqId])](#Panoramax.utils.API+getPictureThumbnailURL) ⇒ <code>Promise</code>
+        * [.getRSSURL([bbox])](#Panoramax.utils.API+getRSSURL) ⇒ <code>string</code> \| <code>null</code>
+        * [.getSequenceMetadataUrl(seqId)](#Panoramax.utils.API+getSequenceMetadataUrl) ⇒ <code>string</code>
+        * [.getDataBbox()](#Panoramax.utils.API+getDataBbox) ⇒ <code>LngLatBoundsLike</code>
+        * [.searchUsers(query)](#Panoramax.utils.API+searchUsers) ⇒ <code>Promise</code>
+        * [.getUserName(userId)](#Panoramax.utils.API+getUserName) ⇒ <code>Promise</code>
+        * [.sendReport(data)](#Panoramax.utils.API+sendReport) ⇒ <code>Promise</code>
+        * ["broken"](#Panoramax.utils.API+event_broken)
+        * ["ready"](#Panoramax.utils.API+event_ready)
+    * _static_
+        * [.isValidHttpUrl(str)](#Panoramax.utils.API.isValidHttpUrl) ⇒ <code>boolean</code>
+        * [.isIdValid(id)](#Panoramax.utils.API.isIdValid) ⇒ <code>boolean</code>
+
+<a name="new_Panoramax.utils.API_new"></a>
+
+### new API(endpoint, [options])
+API contains various utility functions to communicate with Panoramax/STAC API
+
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| endpoint | <code>string</code> |  | The endpoint. It corresponds to the <a href="https://github.com/radiantearth/stac-api-spec/blob/main/overview.md#example-landing-page">STAC landing page</a>, with all links describing the API capabilites. |
+| [options] | <code>object</code> |  | Options |
+| [options.style] | <code>string</code> \| <code>object</code> |  | General map style |
+| [options.tiles] | <code>string</code> |  | API route serving pictures & sequences vector tiles |
+| [options.skipReadLanding] | <code>boolean</code> | <code>false</code> | True to not call API landing page automatically |
+| [options.fetch] | <code>object</code> |  | Set custom options for fetch calls made against API ([same syntax as fetch options parameter](https://developer.mozilla.org/en-US/docs/Web/API/fetch#parameters)) |
+| [options.users] | <code>Array.&lt;string&gt;</code> |  | List of initial user IDs to load map styles for |
+
+<a name="Panoramax.utils.API+onceReady"></a>
+
+### api.onceReady() ⇒ <code>Promise</code>
+Resolves when the API is ready to be used.
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Fulfil**: <code>string</code> "API is ready" when initialization is complete.  
+**Reject**: <code>string</code> Error message  
+<a name="Panoramax.utils.API+isReady"></a>
+
+### api.isReady() ⇒ <code>boolean</code>
+Checks if the API is ready to be used.
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>boolean</code> - True if the API is ready, false otherwise.  
+<a name="Panoramax.utils.API+getAvailableFeatures"></a>
+
+### api.getAvailableFeatures() ⇒ <code>Array.&lt;string&gt;</code>
+List of available features offered by API
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>Array.&lt;string&gt;</code> - Keywords of enabled features  
+<a name="Panoramax.utils.API+getUnavailableFeatures"></a>
+
+### api.getUnavailableFeatures() ⇒ <code>Array.&lt;string&gt;</code>
+List of unavailable features on API
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>Array.&lt;string&gt;</code> - Keywords of disabled features  
+<a name="Panoramax.utils.API+getSequenceItems"></a>
+
+### api.getSequenceItems(seqId, [next], [data]) ⇒ <code>Promise</code>
+Get sequence GeoJSON representation
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Fulfil**: <code>object</code> Sequence GeoJSON  
+**Reject**: <code>Error</code> If API is not ready or for any network issue  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| seqId | <code>string</code> |  | The sequence ID |
+| [next] | <code>string</code> | <code>null</code> | The next link URL (only for internals) |
+| [data] | <code>object</code> | <code></code> | The previous dataset (only for internals) |
+
+<a name="Panoramax.utils.API+getPicturesAroundCoordinatesUrl"></a>
+
+### api.getPicturesAroundCoordinatesUrl(lat, lon, [factor], [limit], [seqId]) ⇒ <code>string</code>
+Get full URL for listing pictures around a specific location
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>string</code> - The corresponding URL  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| lat | <code>number</code> |  | Latitude |
+| lon | <code>number</code> |  | Longitude |
+| [factor] | <code>number</code> | <code>0.0005</code> | The radius to search around (in degrees) |
+| [limit] | <code>number</code> |  | Max amount of pictures to retrieve |
+| [seqId] | <code>string</code> |  | The sequence ID to filter on (by default, no filter) |
+
+<a name="Panoramax.utils.API+getPicturesAroundCoordinates"></a>
+
+### api.getPicturesAroundCoordinates(lat, lon, [factor], [limit], [seqId]) ⇒ <code>Promise</code>
+Get list of pictures around a specific location
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Fulfil**: <code>object</code> The GeoJSON feature collection  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| lat | <code>number</code> | Latitude |
+| lon | <code>number</code> | Longitude |
+| [factor] | <code>number</code> | The radius to search around (in degrees) |
+| [limit] | <code>number</code> | Max amount of pictures to retrieve |
+| [seqId] | <code>string</code> | The sequence ID to filter on (by default, no filter) |
+
+<a name="Panoramax.utils.API+getPictureMetadataUrl"></a>
+
+### api.getPictureMetadataUrl(picId, [seqId]) ⇒ <code>string</code>
+Get full URL for retrieving a specific picture metadata
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>string</code> - The corresponding URL  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| picId | <code>string</code> | The picture unique identifier |
+| [seqId] | <code>string</code> | The sequence ID |
+
+<a name="Panoramax.utils.API+getMapStyle"></a>
+
+### api.getMapStyle() ⇒ <code>Promise</code> \| <code>object</code>
+Get JSON style for general vector tiles
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>Promise</code> \| <code>object</code> - Promise if first load, MapLibre JSON style otherwise  
+**Fulfil**: <code>object</code> The MapLibre JSON style  
+**Reject**: <code>Error</code> If API is not ready, or no style defined.  
+<a name="Panoramax.utils.API+getUserMapStyle"></a>
+
+### api.getUserMapStyle(userId, [skipReadyCheck]) ⇒ <code>Promise</code>
+Get JSON style for specific-user vector tiles
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Fulfil**: <code>object</code> The MapLibre JSON style  
+**Reject**: <code>Error</code> If API is not ready, or no style defined.  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| userId | <code>string</code> |  | The user UUID |
+| [skipReadyCheck] | <code>boolean</code> | <code>false</code> | Skip check for API readyness |
+
+<a name="Panoramax.utils.API+getPictureThumbnailURLForSequence"></a>
+
+### api.getPictureThumbnailURLForSequence(seqId, [seq]) ⇒ <code>Promise</code>
+Get a picture thumbnail URL for a given sequence
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+**Fulfil**: <code>string\|null</code> Promise resolving on the picture thumbnail URL, or null if not found  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| seqId | <code>string</code> | The sequence ID |
+| [seq] | <code>object</code> | The sequence metadata (with links) if already loaded |
+
+<a name="Panoramax.utils.API+getPictureThumbnailURL"></a>
+
+### api.getPictureThumbnailURL(picId, [seqId]) ⇒ <code>Promise</code>
+Get thumbnail URL for a specific picture
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+**Fulfil**: <code>string\|null</code> The corresponding URL on resolve, or null if no thumbnail could be found  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| picId | <code>string</code> | The picture unique identifier |
+| [seqId] | <code>string</code> | The sequence ID |
+
+<a name="Panoramax.utils.API+getRSSURL"></a>
+
+### api.getRSSURL([bbox]) ⇒ <code>string</code> \| <code>null</code>
+Get the RSS feed URL with map parameters (if map is enabled)
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>string</code> \| <code>null</code> - The URL, or null if no RSS feed is available  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [bbox] | <code>LngLatBounds</code> | The map current bounding box, or null if not available |
+
+<a name="Panoramax.utils.API+getSequenceMetadataUrl"></a>
+
+### api.getSequenceMetadataUrl(seqId) ⇒ <code>string</code>
+Get full URL for retrieving a specific sequence metadata
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>string</code> - The corresponding URL  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| seqId | <code>string</code> | The sequence ID |
+
+<a name="Panoramax.utils.API+getDataBbox"></a>
+
+### api.getDataBbox() ⇒ <code>LngLatBoundsLike</code>
+Get available data bounding box
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>LngLatBoundsLike</code> - The bounding box or null if not available  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+<a name="Panoramax.utils.API+searchUsers"></a>
+
+### api.searchUsers(query) ⇒ <code>Promise</code>
+Look for user ID based on user name query
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Throws**:
+
+- <code>Error</code> If API is not ready or user search not available
+
+**Fulfil**: <code>object\|null</code> List of potential users  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| query | <code>string</code> | The user name to look for |
+
+<a name="Panoramax.utils.API+getUserName"></a>
+
+### api.getUserName(userId) ⇒ <code>Promise</code>
+Get user name based on its ID
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Throws**:
+
+- <code>Error</code> If API is not ready
+
+**Fulfil**: <code>string\|null</code> The user name (or null if not found)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| userId | <code>string</code> | The user UUID |
+
+<a name="Panoramax.utils.API+sendReport"></a>
+
+### api.sendReport(data) ⇒ <code>Promise</code>
+Send a report to API
+
+**Kind**: instance method of [<code>API</code>](#Panoramax.utils.API)  
+**Fulfil**: <code>object</code> The JSON API response  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| data | <code>object</code> | The input form data |
+
+<a name="Panoramax.utils.API+event_broken"></a>
+
+### "broken"
+Event when API is broken.
+This happens on any API loading or map styling issue.
+
+**Kind**: event emitted by [<code>API</code>](#Panoramax.utils.API)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| detail.error | <code>Error</code> | The original error |
+
+<a name="Panoramax.utils.API+event_ready"></a>
+
+### "ready"
+Event when API is ready to use.
+This happens after initial API read and map styles load.
+
+**Kind**: event emitted by [<code>API</code>](#Panoramax.utils.API)  
+<a name="Panoramax.utils.API.isValidHttpUrl"></a>
+
+### API.isValidHttpUrl(str) ⇒ <code>boolean</code>
+Checks URL string validity
+
+**Kind**: static method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>boolean</code> - True if valid  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| str | <code>string</code> | The URL to check |
+
+<a name="Panoramax.utils.API.isIdValid"></a>
+
+### API.isIdValid(id) ⇒ <code>boolean</code>
+Checks picture or sequence ID validity
+
+**Kind**: static method of [<code>API</code>](#Panoramax.utils.API)  
+**Returns**: <code>boolean</code> - True if valid  
+**Throws**:
+
+- <code>Error</code> If not valid
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| id | <code>string</code> | The ID to check |
+

package/docs/reference/utils/InitParameters.md

@@ -0,0 +1,68 @@
+<a name="Panoramax.utils.InitParameters"></a>
+
+## Panoramax.utils.InitParameters
+**Kind**: static class of <code>Panoramax.utils</code>  
+
+* [.InitParameters](#Panoramax.utils.InitParameters)
+    * [new InitParameters([componentAttrs], [urlParams], [browserStorage])](#new_Panoramax.utils.InitParameters_new)
+    * [.getParentInit()](#Panoramax.utils.InitParameters+getParentInit)
+    * [.getParentPostInit()](#Panoramax.utils.InitParameters+getParentPostInit)
+    * [.getPSVInit()](#Panoramax.utils.InitParameters+getPSVInit)
+    * [.getPSVPostInit()](#Panoramax.utils.InitParameters+getPSVPostInit)
+    * [.getMapInit()](#Panoramax.utils.InitParameters+getMapInit)
+    * [.getMapPostInit()](#Panoramax.utils.InitParameters+getMapPostInit)
+
+<a name="new_Panoramax.utils.InitParameters_new"></a>
+
+### new InitParameters([componentAttrs], [urlParams], [browserStorage])
+Merges all URL parameters and component attributes into a single set of coherent settings.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [componentAttrs] | <code>object</code> | HTML attributes from parent component |
+| [urlParams] | <code>object</code> | Parameters extracted from URL |
+| [browserStorage] | <code>object</code> | Parameters read from local/session storage |
+
+<a name="Panoramax.utils.InitParameters+getParentInit"></a>
+
+### initParameters.getParentInit()
+Get core component initialization parameters.
+They must be passed as soon as possible.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)  
+<a name="Panoramax.utils.InitParameters+getParentPostInit"></a>
+
+### initParameters.getParentPostInit()
+Get core component post-initialization parameters.
+They must be passed after first rendering or init.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)  
+<a name="Panoramax.utils.InitParameters+getPSVInit"></a>
+
+### initParameters.getPSVInit()
+Get Photo Sphere Viewer initialization parameters.
+They must be passed as soon as possible.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)  
+<a name="Panoramax.utils.InitParameters+getPSVPostInit"></a>
+
+### initParameters.getPSVPostInit()
+Get Photo Sphere Viewer post-initialization parameters.
+They must be passed after first rendering or init.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)  
+<a name="Panoramax.utils.InitParameters+getMapInit"></a>
+
+### initParameters.getMapInit()
+Get MapLibre GL initialization parameters.
+They must be passed as soon as possible.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)  
+<a name="Panoramax.utils.InitParameters+getMapPostInit"></a>
+
+### initParameters.getMapPostInit()
+Get MapLibre GL post-initialization parameters.
+They must be passed after first rendering or init.
+
+**Kind**: instance method of [<code>InitParameters</code>](#Panoramax.utils.InitParameters)