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

package/docs/reference/components/ui/QualityScore.md

@@ -0,0 +1,45 @@
+<a name="Panoramax.components.ui.QualityScore"></a>
+
+## Panoramax.components.ui.QualityScore ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Emits**: [<code>change</code>](#Panoramax.components.ui.QualityScore+event_change)  
+**Element**: pnx-quality-score  
+
+* [.QualityScore](#Panoramax.components.ui.QualityScore) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new QualityScore()](#new_Panoramax.components.ui.QualityScore_new)
+    * [.properties](#Panoramax.components.ui.QualityScore+properties) : <code>Object</code>
+    * ["change"](#Panoramax.components.ui.QualityScore+event_change)
+
+<a name="new_Panoramax.components.ui.QualityScore_new"></a>
+
+### new QualityScore()
+Quality Score element displays the picture quality grade.
+
+**Example**  
+```html
+<!-- Read-only -->
+<pnx-quality-score grade="5" ._t=${viewer._t} />
+
+<!-- Input -->
+<pnx-quality-score grade="5" input="pnx-qs-input" @change=${() => alert('changed')} ._t=${viewer._t} />
+```
+<a name="Panoramax.components.ui.QualityScore+properties"></a>
+
+### qualityScore.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>QualityScore</code>](#Panoramax.components.ui.QualityScore)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [grade] | <code>number</code> \| <code>string</code> | <code>0</code> | The grade (5=A, 1=E, 0=none selected), or a list of grades |
+| [input] | <code>string</code> | <code>false</code> | If set, score is an input and value is used as ID prefix |
+
+<a name="Panoramax.components.ui.QualityScore+event_change"></a>
+
+### "change"
+Event for grade change
+
+**Kind**: event emitted by [<code>QualityScore</code>](#Panoramax.components.ui.QualityScore)  

package/docs/reference/components/ui/SearchBar.md

@@ -0,0 +1,63 @@
+<a name="Panoramax.components.ui.SearchBar"></a>
+
+## Panoramax.components.ui.SearchBar ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Emits**: [<code>result</code>](#Panoramax.components.ui.SearchBar+event_result)  
+**Element**: pnx-search-bar  
+
+* [.SearchBar](#Panoramax.components.ui.SearchBar) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new SearchBar()](#new_Panoramax.components.ui.SearchBar_new)
+    * [.properties](#Panoramax.components.ui.SearchBar+properties) : <code>Object</code>
+    * ["result"](#Panoramax.components.ui.SearchBar+event_result)
+
+<a name="new_Panoramax.components.ui.SearchBar_new"></a>
+
+### new SearchBar()
+Search Bar Element displays an interactive search widget.
+
+**Example**  
+```html
+<pnx-search-bar
+  id="my-search-bar"
+  placeholder="Search something..."
+  .searcher=${mysearchfct}
+  ._parent=${viewer}
+  reduceable="false"
+  reduced="false"
+  size="xxl" @result=${e => console.log(e.detail)}
+>
+  <!-- Optional icon for display on left-side of search bar -->
+</pnx-search-bar>
+```
+<a name="Panoramax.components.ui.SearchBar+properties"></a>
+
+### searchBar.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>SearchBar</code>](#Panoramax.components.ui.SearchBar)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [id] | <code>string</code> |  | The ID attribute set on component and prefix for input as well |
+| [placeholder] | <code>string</code> |  | Default text to display on empty field |
+| [reduceable] | <code>boolean</code> | <code>false</code> | Can the search bar be collapsed (for mobile view) |
+| [reduced] | <code>boolean</code> | <code>false</code> | Is the search bar currently collapsed ? |
+| [value] | <code>string</code> |  | The default input value |
+| [size] | <code>string</code> | <code>&quot;md&quot;</code> | The component sizing (md, xxl) |
+| [searcher] | <code>function</code> |  | Search callback, function that takes as parameter the input text value, and resolves on list of results ({title, subtitle} and any other data you'd like to get on validation) |
+| [no-menu-closure] | <code>boolean</code> | <code>false</code> | Set to true to ignore menu closure events |
+
+<a name="Panoramax.components.ui.SearchBar+event_result"></a>
+
+### "result"
+Event for search result clicked
+
+**Kind**: event emitted by [<code>SearchBar</code>](#Panoramax.components.ui.SearchBar)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| detail | <code>object</code> \| <code>null</code> | The data associated to clicked item (format based on searcher function results), or null on reset |
+

package/docs/reference/components/ui/TogglableGroup.md

@@ -0,0 +1,39 @@
+<a name="Panoramax.components.ui.TogglableGroup"></a>
+
+## Panoramax.components.ui.TogglableGroup ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+**Kind**: static class of <code>Panoramax.components.ui</code>  
+**Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>  
+**Element**: pnx-togglable-group  
+**Slot**: `button` The button on which click leads to open/close menu  
+**Slot**: `default` The menu to make shown/hidden on button click  
+
+* [.TogglableGroup](#Panoramax.components.ui.TogglableGroup) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new TogglableGroup()](#new_Panoramax.components.ui.TogglableGroup_new)
+    * [.properties](#Panoramax.components.ui.TogglableGroup+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.TogglableGroup_new"></a>
+
+### new TogglableGroup()
+Togglable Group element allows to make a menu appear/disappear based on button click.
+
+**Example**  
+```html
+<pnx-togglable-group padded="false" ._parent=${viewer}>
+  <pnx-button slot="button">
+    Open menu
+  </pnx-button>
+  <div>Menu content</div>
+</pnx-togglable-group>
+```
+<a name="Panoramax.components.ui.TogglableGroup+properties"></a>
+
+### togglableGroup.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>TogglableGroup</code>](#Panoramax.components.ui.TogglableGroup)  
+**Properties**
+
+| Name | Type | Description |
+| --- | --- | --- |
+| [padded] | <code>string</code> | If set, adds a 15px padding to the menu panel. |
+

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

@@ -0,0 +1,32 @@
+<a name="Panoramax.components.ui.widgets.GeoSearch"></a>
+
+## Panoramax.components.ui.widgets.GeoSearch ⇐ <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-geosearch  
+
+* [.GeoSearch](#Panoramax.components.ui.widgets.GeoSearch) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
+    * [new GeoSearch()](#new_Panoramax.components.ui.widgets.GeoSearch_new)
+    * [.properties](#Panoramax.components.ui.widgets.GeoSearch+properties) : <code>Object</code>
+
+<a name="new_Panoramax.components.ui.widgets.GeoSearch_new"></a>
+
+### new GeoSearch()
+Ready-to-use geocoder search bar.
+
+**Example**  
+```html
+<pnx-widget-geosearch _parent=${viewer} />
+```
+<a name="Panoramax.components.ui.widgets.GeoSearch+properties"></a>
+
+### geoSearch.properties : <code>Object</code>
+Component properties.
+
+**Kind**: instance property of [<code>GeoSearch</code>](#Panoramax.components.ui.widgets.GeoSearch)  
+**Properties**
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| [geocoder] | <code>string</code> | <code>&quot;nominatim&quot;</code> | The geocoder engine to use (nominatim, ban) |
+

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

@@ -0,0 +1,32 @@
+<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  
+
+* [.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.
+
+**Example**  
+```html
+<pnx-widget-legend _parent=${viewer} />
+```
+<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) |
+

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/Player.md

@@ -0,0 +1,32 @@
+<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 ? |
+

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

@@ -0,0 +1,15 @@
+<a name="Panoramax.components.ui.widgets.Share"></a>
+
+## Panoramax.components.ui.widgets.Share ⇐ <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-share  
+<a name="new_Panoramax.components.ui.widgets.Share_new"></a>
+
+### new Share()
+Share button handles showing/hiding share menu.
+
+**Example**  
+```html
+<pnx-widget-share _parent=${viewer} />
+```

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,311 @@
+<a name="Panoramax.utils.API"></a>
+
+## Panoramax.utils.API
+**Kind**: static class of <code>Panoramax.utils</code>  
+
+* [.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>
+    * _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.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 |
+