@panoramax/web-viewer 3.2.2-develop-ebca3b31 → 3.2.2-develop-d9aeae60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/docs/02_Usage.md CHANGED
@@ -291,6 +291,12 @@ Note that all functions of [MapLibre GL JS class Map][16] are also available.
291
291
 
292
292
  Destroy any form of life in this component
293
293
 
294
+ ### waitForEnoughMapLoaded
295
+
296
+ Helper to know when enough map background and Panoramax tiles are loaded for a proper display.
297
+
298
+ Returns **[Promise][19]** Resolves when enough is loaded
299
+
294
300
  ### reloadVectorTiles
295
301
 
296
302
  Force refresh of vector tiles data
@@ -360,16 +366,16 @@ This is useful after a map theme change.
360
366
  Photo is the component showing a single picture.
361
367
  It uses Photo Sphere Viewer as a basis, and pre-configure dialog with STAC API.
362
368
 
363
- Note that all functions of [PhotoSphereViewer Viewer class][19] are available as well.
369
+ Note that all functions of [PhotoSphereViewer Viewer class][20] are available as well.
364
370
 
365
371
  ### Parameters
366
372
 
367
373
  * `parent` **[CoreView][1]** The parent view
368
374
  * `container` **[Element][8]** The DOM element to create into
369
- * `options` **[object][10]?** The viewer options. Can be any of [Photo Sphere Viewer options][20] (optional, default `{}`)
375
+ * `options` **[object][10]?** The viewer options. Can be any of [Photo Sphere Viewer options][21] (optional, default `{}`)
370
376
 
371
377
  * `options.transitionDuration` **[number][15]?** The number of milliseconds the transition animation should be.
372
- * `options.shouldGoFast` **[function][21]?** Function returning a boolean to indicate if we may skip loading HD images.
378
+ * `options.shouldGoFast` **[function][22]?** Function returning a boolean to indicate if we may skip loading HD images.
373
379
 
374
380
  ### getPictureMetadata
375
381
 
@@ -394,7 +400,7 @@ Displays in viewer a picture near to given coordinates
394
400
  * `lat` **[number][15]** Latitude (WGS84)
395
401
  * `lon` **[number][15]** Longitude (WGS84)
396
402
 
397
- Returns **[Promise][22]** Resolves on picture ID if picture found, otherwise rejects
403
+ Returns **[Promise][19]** Resolves on picture ID if picture found, otherwise rejects
398
404
 
399
405
  ### getXY
400
406
 
@@ -676,7 +682,7 @@ Enable or disable JOSM live editing using [Remote][24]
676
682
 
677
683
  * `enabled` **[boolean][14]** Set to true to enable JOSM live
678
684
 
679
- Returns **[Promise][22]** Resolves on JOSM live being enabled or disabled
685
+ Returns **[Promise][19]** Resolves on JOSM live being enabled or disabled
680
686
 
681
687
  ### setFocus
682
688
 
@@ -812,13 +818,13 @@ Type: [object][10]
812
818
 
813
819
  [18]: https://maplibre.org/maplibre-style-spec/sources/#raster
814
820
 
815
- [19]: https://photo-sphere-viewer.js.org/api/classes/core.viewer
821
+ [19]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
816
822
 
817
- [20]: https://photo-sphere-viewer.js.org/guide/config.html#standard-options
823
+ [20]: https://photo-sphere-viewer.js.org/api/classes/core.viewer
818
824
 
819
- [21]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
825
+ [21]: https://photo-sphere-viewer.js.org/guide/config.html#standard-options
820
826
 
821
- [22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
827
+ [22]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
822
828
 
823
829
  [23]: #CoreView
824
830
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@panoramax/web-viewer",
3
- "version": "3.2.2-develop-ebca3b31",
3
+ "version": "3.2.2-develop-d9aeae60",
4
4
  "description": "Panoramax web viewer for geolocated pictures",
5
5
  "main": "build/index.js",
6
6
  "author": "Panoramax team",