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

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.
Files changed (341) hide show
  1. package/{src → build}/components/core/Basic.js +22 -16
  2. package/{src → build}/components/core/CoverageMap.js +19 -14
  3. package/{src → build}/components/core/Editor.js +16 -16
  4. package/{src → build}/components/core/PhotoViewer.js +30 -29
  5. package/{src → build}/components/core/Viewer.js +21 -20
  6. package/build/components/core/index.js +10 -0
  7. package/build/components/index.js +11 -0
  8. package/build/components/index_photoviewer.js +6 -0
  9. package/{src → build}/components/layout/BottomDrawer.js +4 -4
  10. package/{src → build}/components/layout/CorneredGrid.js +1 -1
  11. package/{src → build}/components/layout/Mini.js +5 -4
  12. package/{src → build}/components/layout/Tabs.js +1 -1
  13. package/build/components/layout/index.js +9 -0
  14. package/{src → build}/components/menus/LocationPrecisionDoc.js +4 -6
  15. package/{src → build}/components/menus/MapBackground.js +4 -6
  16. package/{src → build}/components/menus/MapFilters.js +16 -21
  17. package/{src → build}/components/menus/MapLayers.js +20 -24
  18. package/{src → build}/components/menus/MapLegend.js +3 -4
  19. package/{src → build}/components/menus/MiniPictureLegend.js +3 -4
  20. package/{src → build}/components/menus/PictureLegend.js +10 -15
  21. package/{src → build}/components/menus/PictureMetadata.js +12 -19
  22. package/{src → build}/components/menus/PlayerOptions.js +5 -7
  23. package/{src → build}/components/menus/QualityScoreDoc.js +3 -4
  24. package/{src → build}/components/menus/ReportForm.js +8 -9
  25. package/{src → build}/components/menus/SemanticsDoc.js +3 -4
  26. package/{src → build}/components/menus/SemanticsDownload.js +3 -3
  27. package/{src → build}/components/menus/SemanticsFilters.js +7 -8
  28. package/{src → build}/components/menus/SemanticsList.js +11 -18
  29. package/{src → build}/components/menus/SemanticsMetadata.js +8 -11
  30. package/{src → build}/components/menus/Share.js +6 -7
  31. package/build/components/menus/index.js +22 -0
  32. package/build/components/menus/index_photoviewer.js +11 -0
  33. package/{src → build}/components/styles.js +0 -2
  34. package/{src → build}/components/ui/AnnotationsSwitch.js +6 -8
  35. package/{src → build}/components/ui/Button.js +1 -1
  36. package/{src → build}/components/ui/ButtonGroup.js +2 -1
  37. package/{src → build}/components/ui/CopyButton.js +4 -6
  38. package/{src → build}/components/ui/Grade.js +5 -5
  39. package/{src → build}/components/ui/GradeFilter.js +3 -3
  40. package/{src → build}/components/ui/IconSwitch.js +1 -1
  41. package/{src → build}/components/ui/LinkButton.js +1 -1
  42. package/{src → build}/components/ui/ListGroup.js +3 -3
  43. package/{src → build}/components/ui/ListItem.js +1 -1
  44. package/{src → build}/components/ui/Loader.js +8 -7
  45. package/{src → build}/components/ui/Map.js +38 -26
  46. package/{src → build}/components/ui/MapMore.js +7 -7
  47. package/{src → build}/components/ui/Photo.js +29 -27
  48. package/{src → build}/components/ui/Popup.js +4 -4
  49. package/{src → build}/components/ui/QualityScore.js +4 -4
  50. package/{src → build}/components/ui/SearchBar.js +6 -7
  51. package/{src → build}/components/ui/SemanticsEditor.js +14 -15
  52. package/{src → build}/components/ui/SemanticsTable.js +4 -5
  53. package/{src → build}/components/ui/Switch.js +1 -1
  54. package/{src → build}/components/ui/TogglableGroup.js +4 -4
  55. package/build/components/ui/index.js +29 -0
  56. package/build/components/ui/index_photoviewer.js +21 -0
  57. package/{src → build}/components/ui/widgets/CopyCoordinates.js +5 -5
  58. package/{src → build}/components/ui/widgets/GeoSearch.js +10 -10
  59. package/{src → build}/components/ui/widgets/Legend.js +9 -8
  60. package/{src → build}/components/ui/widgets/LevelSelect.js +9 -7
  61. package/{src → build}/components/ui/widgets/MapFiltersButton.js +5 -5
  62. package/{src → build}/components/ui/widgets/MapLayersButton.js +5 -5
  63. package/{src → build}/components/ui/widgets/OSMEditors.js +8 -8
  64. package/{src → build}/components/ui/widgets/PictureLegendActions.js +4 -4
  65. package/{src → build}/components/ui/widgets/Player.js +6 -7
  66. package/{src → build}/components/ui/widgets/SemanticsFiltersButton.js +6 -7
  67. package/{src → build}/components/ui/widgets/Zoom.js +6 -6
  68. package/build/components/ui/widgets/index.js +16 -0
  69. package/build/components/ui/widgets/index_photoviewer.js +7 -0
  70. package/build/editor.html +94 -10
  71. package/{src → build}/img/arrow_triangle.svg +0 -1
  72. package/{src → build}/img/arrow_turn.svg +0 -1
  73. package/build/index.html +111 -1
  74. package/build/index.js +6 -95
  75. package/build/index_photoviewer.js +4 -0
  76. package/build/map.html +97 -1
  77. package/build/package.json +141 -0
  78. package/build/photo.html +85 -1
  79. package/build/servers.js +3 -4
  80. package/{src → build}/utils/API.js +33 -33
  81. package/{src → build}/utils/InitParameters.js +11 -9
  82. package/{src → build}/utils/MapStyleComposer.js +39 -37
  83. package/{src → build}/utils/PhotoAdapter.js +1 -0
  84. package/{src → build}/utils/PresetsManager.js +4 -4
  85. package/{src → build}/utils/SemanticsMapProtocol.js +3 -4
  86. package/{src → build}/utils/URLHandler.js +16 -14
  87. package/{src → build}/utils/geocoder.js +5 -5
  88. package/{src → build}/utils/i18n.js +21 -20
  89. package/build/utils/index.js +17 -0
  90. package/build/utils/index_photoviewer.js +14 -0
  91. package/{src → build}/utils/indoor.js +9 -5
  92. package/{src → build}/utils/map.js +15 -11
  93. package/{src → build}/utils/picture.js +22 -17
  94. package/{src → build}/utils/semantics.js +9 -5
  95. package/{src → build}/utils/utils.js +8 -4
  96. package/{src → build}/utils/widgets.js +2 -2
  97. package/build/viewer.html +120 -35
  98. package/build/viewer_indoor.html +90 -8
  99. package/build/widgets.html +410 -1
  100. package/package.json +81 -204
  101. package/.dockerignore +0 -7
  102. package/.gitlab-ci.yml +0 -78
  103. package/CHANGELOG.md +0 -853
  104. package/CODE_OF_CONDUCT.md +0 -134
  105. package/Dockerfile +0 -14
  106. package/build/index.css +0 -36
  107. package/build/index.css.map +0 -1
  108. package/build/index.js.map +0 -1
  109. package/build/photoviewer.css +0 -36
  110. package/build/photoviewer.css.map +0 -1
  111. package/build/photoviewer.js +0 -86
  112. package/build/photoviewer.js.map +0 -1
  113. package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff +0 -0
  114. package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff2 +0 -0
  115. package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff +0 -0
  116. package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff2 +0 -0
  117. package/config/env.js +0 -104
  118. package/config/getHttpsConfig.js +0 -69
  119. package/config/getPackageJson.js +0 -25
  120. package/config/jest/babelTransform.js +0 -29
  121. package/config/jest/cssTransform.js +0 -14
  122. package/config/jest/fileTransform.js +0 -40
  123. package/config/jest/mocks.js +0 -230
  124. package/config/modules.js +0 -134
  125. package/config/paths.js +0 -76
  126. package/config/pnpTs.js +0 -35
  127. package/config/webpack/persistentCache/createEnvironmentHash.js +0 -9
  128. package/config/webpack.config.js +0 -825
  129. package/config/webpackDevServer.config.js +0 -131
  130. package/docs/03_URL_settings.md +0 -218
  131. package/docs/05_Compatibility.md +0 -83
  132. package/docs/09_Develop.md +0 -141
  133. package/docs/90_Releases.md +0 -27
  134. package/docs/images/class_diagram.drawio +0 -144
  135. package/docs/images/class_diagram.jpg +0 -0
  136. package/docs/images/comparative_3drender.jpg +0 -0
  137. package/docs/images/indoor_level.png +0 -0
  138. package/docs/images/screenshot.jpg +0 -0
  139. package/docs/index.md +0 -159
  140. package/docs/reference/components/core/Basic.md +0 -211
  141. package/docs/reference/components/core/CoverageMap.md +0 -220
  142. package/docs/reference/components/core/Editor.md +0 -252
  143. package/docs/reference/components/core/PhotoViewer.md +0 -320
  144. package/docs/reference/components/core/Viewer.md +0 -398
  145. package/docs/reference/components/layout/BottomDrawer.md +0 -35
  146. package/docs/reference/components/layout/CorneredGrid.md +0 -29
  147. package/docs/reference/components/layout/Mini.md +0 -45
  148. package/docs/reference/components/layout/Tabs.md +0 -46
  149. package/docs/reference/components/menus/LocationPrecisionDoc.md +0 -15
  150. package/docs/reference/components/menus/MapBackground.md +0 -32
  151. package/docs/reference/components/menus/MapFilters.md +0 -37
  152. package/docs/reference/components/menus/MapLayers.md +0 -15
  153. package/docs/reference/components/menus/MapLegend.md +0 -32
  154. package/docs/reference/components/menus/MiniPictureLegend.md +0 -15
  155. package/docs/reference/components/menus/PictureLegend.md +0 -45
  156. package/docs/reference/components/menus/PictureMetadata.md +0 -32
  157. package/docs/reference/components/menus/PlayerOptions.md +0 -15
  158. package/docs/reference/components/menus/QualityScoreDoc.md +0 -15
  159. package/docs/reference/components/menus/ReportForm.md +0 -15
  160. package/docs/reference/components/menus/SemanticsDoc.md +0 -15
  161. package/docs/reference/components/menus/SemanticsDownload.md +0 -15
  162. package/docs/reference/components/menus/SemanticsFilters.md +0 -33
  163. package/docs/reference/components/menus/SemanticsList.md +0 -97
  164. package/docs/reference/components/menus/SemanticsMetadata.md +0 -15
  165. package/docs/reference/components/menus/ShareMenu.md +0 -32
  166. package/docs/reference/components/ui/AnnotationsSwitch.md +0 -32
  167. package/docs/reference/components/ui/Button.md +0 -40
  168. package/docs/reference/components/ui/ButtonGroup.md +0 -36
  169. package/docs/reference/components/ui/CopyButton.md +0 -41
  170. package/docs/reference/components/ui/Grade.md +0 -32
  171. package/docs/reference/components/ui/GradeFilter.md +0 -42
  172. package/docs/reference/components/ui/IconSwitch.md +0 -53
  173. package/docs/reference/components/ui/LinkButton.md +0 -45
  174. package/docs/reference/components/ui/ListGroup.md +0 -22
  175. package/docs/reference/components/ui/ListItem.md +0 -39
  176. package/docs/reference/components/ui/Loader.md +0 -56
  177. package/docs/reference/components/ui/Map.md +0 -150
  178. package/docs/reference/components/ui/MapMore.md +0 -150
  179. package/docs/reference/components/ui/Photo.md +0 -495
  180. package/docs/reference/components/ui/Popup.md +0 -56
  181. package/docs/reference/components/ui/ProgressBar.md +0 -32
  182. package/docs/reference/components/ui/QualityScore.md +0 -45
  183. package/docs/reference/components/ui/SearchBar.md +0 -63
  184. package/docs/reference/components/ui/SemanticsEditor.md +0 -113
  185. package/docs/reference/components/ui/SemanticsTable.md +0 -32
  186. package/docs/reference/components/ui/Switch.md +0 -49
  187. package/docs/reference/components/ui/TogglableGroup.md +0 -39
  188. package/docs/reference/components/ui/widgets/CopyCoordinates.md +0 -32
  189. package/docs/reference/components/ui/widgets/GeoSearch.md +0 -36
  190. package/docs/reference/components/ui/widgets/Legend.md +0 -58
  191. package/docs/reference/components/ui/widgets/LevelSelect.md +0 -16
  192. package/docs/reference/components/ui/widgets/MapFiltersButton.md +0 -37
  193. package/docs/reference/components/ui/widgets/MapLayersButton.md +0 -15
  194. package/docs/reference/components/ui/widgets/OSMEditors.md +0 -15
  195. package/docs/reference/components/ui/widgets/PictureLegendActions.md +0 -32
  196. package/docs/reference/components/ui/widgets/Player.md +0 -34
  197. package/docs/reference/components/ui/widgets/SemanticsFiltersButton.md +0 -15
  198. package/docs/reference/components/ui/widgets/Zoom.md +0 -15
  199. package/docs/reference/utils/API.md +0 -389
  200. package/docs/reference/utils/InitParameters.md +0 -68
  201. package/docs/reference/utils/MapStyleComposer.md +0 -408
  202. package/docs/reference/utils/PanoraMapProtocol.md +0 -28
  203. package/docs/reference/utils/PresetsManager.md +0 -43
  204. package/docs/reference/utils/SemanticsMapProtocol.md +0 -43
  205. package/docs/reference/utils/URLHandler.md +0 -114
  206. package/docs/reference.md +0 -99
  207. package/docs/shortcuts.md +0 -11
  208. package/docs/tutorials/aerial_imagery.md +0 -21
  209. package/docs/tutorials/authentication.md +0 -10
  210. package/docs/tutorials/custom_widgets.md +0 -59
  211. package/docs/tutorials/indoor_maps.md +0 -50
  212. package/docs/tutorials/map_style.md +0 -83
  213. package/docs/tutorials/migrate_v4.md +0 -153
  214. package/docs/tutorials/migrate_v5.md +0 -103
  215. package/docs/tutorials/semantics_overlays.md +0 -74
  216. package/docs/tutorials/synced_coverage.md +0 -43
  217. package/mkdocs.yml +0 -131
  218. package/public/editor.html +0 -53
  219. package/public/index.html +0 -70
  220. package/public/map.html +0 -55
  221. package/public/photo.html +0 -43
  222. package/public/servers.js +0 -15
  223. package/public/viewer.html +0 -79
  224. package/public/viewer_indoor.html +0 -48
  225. package/public/widgets.html +0 -366
  226. package/scripts/build.js +0 -217
  227. package/scripts/doc.js +0 -79
  228. package/scripts/start.js +0 -172
  229. package/scripts/test.js +0 -52
  230. package/src/components/core/index.js +0 -12
  231. package/src/components/index.js +0 -13
  232. package/src/components/index_photoviewer.js +0 -8
  233. package/src/components/layout/index.js +0 -9
  234. package/src/components/menus/index.js +0 -22
  235. package/src/components/menus/index_photoviewer.js +0 -13
  236. package/src/components/ui/index.js +0 -29
  237. package/src/components/ui/index_photoviewer.js +0 -23
  238. package/src/components/ui/widgets/index.js +0 -16
  239. package/src/components/ui/widgets/index_photoviewer.js +0 -9
  240. package/src/index.js +0 -8
  241. package/src/index_photoviewer.js +0 -6
  242. package/src/utils/index.js +0 -17
  243. package/src/utils/index_photoviewer.js +0 -16
  244. package/tests/components/core/Basic.test.js +0 -168
  245. package/tests/components/core/BasicMock.js +0 -25
  246. package/tests/components/core/CoverageMap.test.js +0 -20
  247. package/tests/components/core/Editor.test.js +0 -20
  248. package/tests/components/core/PhotoViewer.test.js +0 -57
  249. package/tests/components/core/Viewer.test.js +0 -85
  250. package/tests/components/core/__snapshots__/PhotoViewer.test.js.snap +0 -96
  251. package/tests/components/core/__snapshots__/Viewer.test.js.snap +0 -188
  252. package/tests/components/ui/CopyButton.test.js +0 -52
  253. package/tests/components/ui/Loader.test.js +0 -55
  254. package/tests/components/ui/Map.test.js +0 -145
  255. package/tests/components/ui/Photo.test.js +0 -437
  256. package/tests/components/ui/Popup.test.js +0 -26
  257. package/tests/components/ui/QualityScore.test.js +0 -18
  258. package/tests/components/ui/SearchBar.test.js +0 -110
  259. package/tests/components/ui/__snapshots__/CopyButton.test.js.snap +0 -33
  260. package/tests/components/ui/__snapshots__/Loader.test.js.snap +0 -56
  261. package/tests/components/ui/__snapshots__/Map.test.js.snap +0 -16
  262. package/tests/components/ui/__snapshots__/Photo.test.js.snap +0 -263
  263. package/tests/components/ui/__snapshots__/Popup.test.js.snap +0 -29
  264. package/tests/components/ui/__snapshots__/QualityScore.test.js.snap +0 -11
  265. package/tests/components/ui/__snapshots__/SearchBar.test.js.snap +0 -65
  266. package/tests/data/Map_geocoder_ban.json +0 -36
  267. package/tests/data/Map_geocoder_nominatim.json +0 -41
  268. package/tests/data/Viewer_pictures_1.json +0 -148
  269. package/tests/setupTests.js +0 -5
  270. package/tests/utils/API.test.js +0 -752
  271. package/tests/utils/InitParameters.test.js +0 -599
  272. package/tests/utils/MapStyleComposer.test.js +0 -697
  273. package/tests/utils/PresetsManager.test.js +0 -123
  274. package/tests/utils/URLHandler.test.js +0 -587
  275. package/tests/utils/__snapshots__/API.test.js.snap +0 -40
  276. package/tests/utils/__snapshots__/MapStyleComposer.test.js.snap +0 -767
  277. package/tests/utils/__snapshots__/URLHandler.test.js.snap +0 -21
  278. package/tests/utils/__snapshots__/geocoder.test.js.snap +0 -37
  279. package/tests/utils/__snapshots__/map.test.js.snap +0 -1249
  280. package/tests/utils/__snapshots__/picture.test.js.snap +0 -327
  281. package/tests/utils/__snapshots__/widgets.test.js.snap +0 -19
  282. package/tests/utils/geocoder.test.js +0 -37
  283. package/tests/utils/i18n.test.js +0 -111
  284. package/tests/utils/map.test.js +0 -200
  285. package/tests/utils/picture.test.js +0 -745
  286. package/tests/utils/semantics.test.js +0 -174
  287. package/tests/utils/utils.test.js +0 -358
  288. package/tests/utils/widgets.test.js +0 -31
  289. /package/{src → build}/components/core/Basic.css +0 -0
  290. /package/{src → build}/components/core/CoverageMap.css +0 -0
  291. /package/{src → build}/components/core/Editor.css +0 -0
  292. /package/{src → build}/components/core/PhotoViewer.css +0 -0
  293. /package/{src → build}/components/core/Viewer.css +0 -0
  294. /package/{src → build}/components/ui/ButtonGroup.css +0 -0
  295. /package/{src → build}/components/ui/Map.css +0 -0
  296. /package/{src → build}/components/ui/Photo.css +0 -0
  297. /package/{src → build}/components/ui/ProgressBar.js +0 -0
  298. /package/{src → build}/components/ui/widgets/GeoSearch.css +0 -0
  299. /package/{src → build}/components/ui/widgets/LevelSelect.css +0 -0
  300. /package/{src → build}/components/ui/widgets/Player.css +0 -0
  301. /package/{public → build}/favicon.ico +0 -0
  302. /package/{src → build}/img/arrow_360.svg +0 -0
  303. /package/{src → build}/img/arrow_flat.svg +0 -0
  304. /package/{src → build}/img/bg_aerial.jpg +0 -0
  305. /package/{src → build}/img/bg_streets.jpg +0 -0
  306. /package/{src → build}/img/loader_base.jpg +0 -0
  307. /package/{src → build}/img/logo_dead.svg +0 -0
  308. /package/{src → build}/img/marker.svg +0 -0
  309. /package/{src → build}/img/marker_blue.svg +0 -0
  310. /package/{src → build}/img/osm.svg +0 -0
  311. /package/{src → build}/img/panoramax.svg +0 -0
  312. /package/{src → build}/img/switch_big.svg +0 -0
  313. /package/{src → build}/img/switch_mini.svg +0 -0
  314. /package/{src → build}/img/wd.svg +0 -0
  315. /package/{src → build}/translations/ar.json +0 -0
  316. /package/{src → build}/translations/be.json +0 -0
  317. /package/{src → build}/translations/br.json +0 -0
  318. /package/{src → build}/translations/cy.json +0 -0
  319. /package/{src → build}/translations/da.json +0 -0
  320. /package/{src → build}/translations/de.json +0 -0
  321. /package/{src → build}/translations/en.json +0 -0
  322. /package/{src → build}/translations/eo.json +0 -0
  323. /package/{src → build}/translations/es.json +0 -0
  324. /package/{src → build}/translations/fi.json +0 -0
  325. /package/{src → build}/translations/fr.json +0 -0
  326. /package/{src → build}/translations/hu.json +0 -0
  327. /package/{src → build}/translations/it.json +0 -0
  328. /package/{src → build}/translations/ja.json +0 -0
  329. /package/{src → build}/translations/ko.json +0 -0
  330. /package/{src → build}/translations/nl.json +0 -0
  331. /package/{src → build}/translations/nn.json +0 -0
  332. /package/{src → build}/translations/pl.json +0 -0
  333. /package/{src → build}/translations/pt.json +0 -0
  334. /package/{src → build}/translations/pt_BR.json +0 -0
  335. /package/{src → build}/translations/sv.json +0 -0
  336. /package/{src → build}/translations/ti.json +0 -0
  337. /package/{src → build}/translations/tr.json +0 -0
  338. /package/{src → build}/translations/uk.json +0 -0
  339. /package/{src → build}/translations/zh_Hant.json +0 -0
  340. /package/{src → build}/utils/PanoraMapProtocol.js +0 -0
  341. /package/{src → build}/utils/services.js +0 -0
@@ -1,398 +0,0 @@
1
- <a name="Panoramax.components.core.Viewer"></a>
2
-
3
- ## Panoramax.components.core.Viewer ⇐ [<code>PhotoViewer</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer)
4
- **Kind**: static class of <code>Panoramax.components.core</code>
5
- **Extends**: [<code>PhotoViewer</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer)
6
- **Emits**: [<code>select</code>](Basic.md/#Panoramax.components.core.Basic+event_select), [<code>ready</code>](Basic.md/#Panoramax.components.core.Basic+event_ready), [<code>broken</code>](Basic.md/#Panoramax.components.core.Basic+event_broken), [<code>focus-changed</code>](#Panoramax.components.core.Viewer+event_focus-changed)
7
- **Element**: pnx-viewer
8
- **Slot**: `top-left` The top-left corner
9
- **Slot**: `top` The top middle corner
10
- **Slot**: `top-right` The top-right corner
11
- **Slot**: `bottom-left` The bottom-left corner
12
- **Slot**: `bottom` The bottom middle corner
13
- **Slot**: `bottom-right` The bottom-right corner
14
- **Slot**: `editors` External links to map editors, or any tool that may be helpful. Defaults to OSM tools (iD & JOSM).
15
- **Properties**
16
-
17
- | Name | Type | Description |
18
- | --- | --- | --- |
19
- | loader | [<code>Loader</code>](../ui/Loader.md/#Panoramax.components.ui.Loader) | The loader screen |
20
- | api | [<code>API</code>](../../utils/API.md/#Panoramax.utils.API) | The API manager (local instance) |
21
- | apiMC | [<code>API</code>](../../utils/API.md/#Panoramax.utils.API) | The API manager for metacatalog |
22
- | map | [<code>MapMore</code>](../ui/MapMore.md/#Panoramax.components.ui.MapMore) | The MapLibre GL map itself |
23
- | mapStyleComposer | [<code>MapStyleComposer</code>](../../utils/MapStyleComposer.md/#Panoramax.utils.MapStyleComposer) | The map style helper |
24
- | psv | [<code>Photo</code>](../ui/Photo.md/#Panoramax.components.ui.Photo) | The Photo Sphere Viewer component itself |
25
- | grid | [<code>CorneredGrid</code>](../layout/CorneredGrid.md/#Panoramax.components.layout.CorneredGrid) | The grid layout manager |
26
- | mini | [<code>Mini</code>](../layout/Mini.md/#Panoramax.components.layout.Mini) | The reduced/collapsed map/photo component |
27
- | popup | [<code>Popup</code>](../ui/Popup.md/#Panoramax.components.ui.Popup) | The popup container |
28
- | urlHandler | [<code>URLHandler</code>](../../utils/URLHandler.md/#Panoramax.utils.URLHandler) | The URL query parameters manager |
29
- | presetsManager | [<code>PresetsManager</code>](../../utils/PresetsManager.md/#Panoramax.utils.PresetsManager) | The semantics presets manager |
30
-
31
-
32
- * [.Viewer](#Panoramax.components.core.Viewer) ⇐ [<code>PhotoViewer</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer)
33
- * [new Viewer()](#new_Panoramax.components.core.Viewer_new)
34
- * [.properties](#Panoramax.components.core.Viewer+properties) : <code>Object</code>
35
- * [.onceReady()](#Panoramax.components.core.Viewer+onceReady) ⇒ <code>Promise</code>
36
- * [.onceAllAPIsReady()](#Panoramax.components.core.Viewer+onceAllAPIsReady) ⇒ <code>Promise</code>
37
- * [.onceMapReady()](#Panoramax.components.core.Viewer+onceMapReady) ⇒ <code>Promise</code>
38
- * [.hasTwoAPIs()](#Panoramax.components.core.Viewer+hasTwoAPIs) ⇒ <code>boolean</code>
39
- * [.getAPI()](#Panoramax.components.core.Viewer+getAPI) ⇒ <code>API</code>
40
- * [.moveCenter()](#Panoramax.components.core.Viewer+moveCenter)
41
- * [.isMapWide()](#Panoramax.components.core.Viewer+isMapWide) ⇒ <code>boolean</code>
42
- * [.oncePSVReady()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+oncePSVReady) ⇒ <code>Promise</code>
43
- * [.onceFirstPicLoaded()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+onceFirstPicLoaded) ⇒ <code>Promise</code>
44
- * [.setPopup(visible, [content])](#Panoramax.components.core.PhotoViewer+setPopup)
45
- * [.moveLeft()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+moveLeft)
46
- * [.moveRight()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+moveRight)
47
- * [.moveUp()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+moveUp)
48
- * [.moveDown()](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+moveDown)
49
- * [.addEventListener(type, listener, [options])](#Panoramax.components.core.PhotoViewer+addEventListener)
50
- * [.onceAPIReady()](Basic.md/#Panoramax.components.core.Basic+onceAPIReady) ⇒ <code>Promise</code>
51
- * [.getClassName()](Basic.md/#Panoramax.components.core.Basic+getClassName) ⇒ <code>string</code>
52
- * [.select([seqId], [picId], [force])](#Panoramax.components.core.Basic+select)
53
- * [.isWidthSmall()](Basic.md/#Panoramax.components.core.Basic+isWidthSmall) ⇒ <code>boolean</code>
54
- * [.isWidthMedium()](Basic.md/#Panoramax.components.core.Basic+isWidthMedium) ⇒ <code>boolean</code>
55
- * [.isHeightSmall()](Basic.md/#Panoramax.components.core.Basic+isHeightSmall) ⇒ <code>boolean</code>
56
- * [.getSubComponentsNames()](Basic.md/#Panoramax.components.core.Basic+getSubComponentsNames) ⇒ <code>Array.&lt;string&gt;</code>
57
- * ["focus-changed"](#Panoramax.components.core.Viewer+event_focus-changed)
58
- * ["menu-opened"](Basic.md/#Panoramax.components.core.Basic+event_menu-opened)
59
- * ["select"](Basic.md/#Panoramax.components.core.Basic+event_select)
60
- * ["ready"](Basic.md/#Panoramax.components.core.Basic+event_ready)
61
- * ["broken"](Basic.md/#Panoramax.components.core.Basic+event_broken)
62
-
63
- <a name="new_Panoramax.components.core.Viewer_new"></a>
64
-
65
- ### new Viewer()
66
- Viewer is the main component of Panoramax JS library, showing pictures and map.
67
-
68
- This component has a [CorneredGrid](../layout/CorneredGrid.md/#Panoramax.components.layout.CorneredGrid) layout, you can use directly any slot element to pass custom widgets.
69
-
70
- If you need a viewer without map, checkout [Photo Viewer component](PhotoViewer.md/#Panoramax.components.core.PhotoViewer).
71
-
72
- Make sure to set width/height through CSS for proper display.
73
-
74
- **Example**
75
- ```html
76
- <!-- Basic example (embeds metacatalog) -->
77
- <pnx-viewer
78
- endpoint="https://panoramax.openstreetmap.fr/"
79
- style="width: 300px; height: 250px"
80
- />
81
-
82
- <!-- Basic example (without metacatalog) -->
83
- <pnx-viewer
84
- endpoint="https://panoramax.openstreetmap.fr/"
85
- metacatalog="false"
86
- style="width: 300px; height: 250px"
87
- />
88
-
89
- <!-- With slotted widgets -->
90
- <pnx-viewer
91
- endpoint="https://panoramax.openstreetmap.fr/"
92
- style="width: 300px; height: 250px"
93
- >
94
- <p slot="top-right">My custom text</p>
95
- <p slot="editors"><a href="https://my.own.tool/">Edit in my own tool</a></p>
96
- </pnx-viewer>
97
-
98
- <!-- With only your custom widgets -->
99
- <pnx-viewer
100
- endpoint="https://panoramax.openstreetmap.fr/"
101
- style="width: 300px; height: 250px"
102
- widgets="false"
103
- >
104
- <p slot="top-right">My custom text</p>
105
- </pnx-viewer>
106
-
107
- <!-- With map options -->
108
- <pnx-viewer
109
- endpoint="https://panoramax.openstreetmap.fr/"
110
- style="width: 300px; height: 250px"
111
- map-options="{'maxZoom': 15, 'background': 'aerial', 'raster': '...'}"
112
- />
113
- ```
114
- <a name="Panoramax.components.core.Viewer+properties"></a>
115
-
116
- ### viewer.properties : <code>Object</code>
117
- Component properties. All of [Basic properties](Basic.md/#Panoramax.components.core.Basic+properties) are available as well.
118
-
119
- **Kind**: instance property of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
120
- **Mixes**: [<code>properties</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+properties)
121
- **Overrides**: [<code>properties</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+properties)
122
- **Properties**
123
-
124
- | Name | Type | Default | Description |
125
- | --- | --- | --- | --- |
126
- | endpoint | <code>string</code> | | URL to API to use (must be a [STAC API](https://github.com/radiantearth/stac-api-spec/blob/main/overview.md)) |
127
- | [map-options] | <code>object</code> | | An object with [any map option available in Map or MapMore class](../ui/MapMore.md/#Panoramax.components.ui.MapMore).<br />Example: `map-options="{'background': 'aerial', 'theme': 'age'}"` |
128
- | [psv-options] | <code>object</code> | | [Any option to pass to Photo component](../ui/Photo.md/#Panoramax.components.ui.Photo) as an object.<br />Example: `psv-options="{'transitionDuration': 500, 'picturesNavigation': 'pic'}"` |
129
- | [url-parameters] | <code>string</code> | <code>true</code> | Should the component add and update URL query parameters to save viewer state ? |
130
- | [keyboard-shortcuts] | <code>string</code> | <code>true</code> | Should keyboard shortcuts be enabled ? Set to "false" to fully disable any keyboard shortcuts. |
131
- | [focus] | <code>string</code> | <code>&quot;pic&quot;</code> | The component showing up as main component (pic, map) |
132
- | [geocoder] | <code>string</code> | <code>&quot;nominatim&quot;</code> | The geocoder engine to use (nominatim, ban, or URL to a standard [GeocodeJSON-compliant](https://github.com/geocoders/geocodejson-spec/blob/master/draft/README.md) API) |
133
- | [widgets] | <code>string</code> | <code>true</code> | Use default set of widgets ? Set to false to avoid any widget to show up, and use slots to populate as you like. |
134
- | [picture] | <code>string</code> | | The picture ID to display |
135
- | [sequence] | <code>string</code> | | The sequence ID of the picture displayed |
136
- | [fetch-options] | <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)) |
137
- | [map-style] | <code>string</code> \| <code>object</code> | | The map's MapLibre style. This can be an a JSON object conforming to the schema described in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/), or a URL string pointing to one. Defaults to OSM vector tiles. |
138
- | [lang] | <code>string</code> | | To override language used for labels. Defaults to using user's preferred languages. |
139
- | [skip-tags-menu-opening] | <code>string</code> | <code>false</code> | Should the "Tags" menu automatically open when you toggle Annotations switch ? Set true to avoid auto-opening. |
140
- | [share-base-url] | <code>string</code> | | Override the default base URL (current page) for the Share widget. Useful to lead to a public page when viewer is used in a closed tool. |
141
- | [metacatalog] | <code>string</code> | | The URL to access Panoramax federated catalog. Defaults to "https://explore.panoramax.fr". Set to "false" to not display pictures from federated catalog on map. |
142
- | [endpoint-to-use] | <code>string</code> | | Selects the default Panoramax endpoint to use. Either "default" (specific endpoint), "metacatalog" (if defined), any user UUID (available on default endpoint), or user UUID prefixed with "metacatalog_" for a metacatalog user. |
143
-
144
- <a name="Panoramax.components.core.Viewer+onceReady"></a>
145
-
146
- ### viewer.onceReady() ⇒ <code>Promise</code>
147
- Waits for Viewer to be completely ready (map & PSV loaded, first picture also if one is wanted)
148
-
149
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
150
- **Overrides**: [<code>onceReady</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+onceReady)
151
- **Returns**: <code>Promise</code> - When viewer is ready
152
- <a name="Panoramax.components.core.Viewer+onceAllAPIsReady"></a>
153
-
154
- ### viewer.onceAllAPIsReady() ⇒ <code>Promise</code>
155
- Waits for all APIs setup.
156
- This is useful for two-APIs setup.
157
-
158
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
159
- **Fulfil**: <code>null</code> When two APIs are ready.
160
- **Reject**: <code>string</code> Error message
161
- <a name="Panoramax.components.core.Viewer+onceMapReady"></a>
162
-
163
- ### viewer.onceMapReady() ⇒ <code>Promise</code>
164
- Waiting for map to be available.
165
-
166
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
167
- **Returns**: <code>Promise</code> - When map is ready to use
168
- <a name="Panoramax.components.core.Viewer+hasTwoAPIs"></a>
169
-
170
- ### viewer.hasTwoAPIs() ⇒ <code>boolean</code>
171
- Is the viewer using both metacatalog and local API ?
172
-
173
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
174
- **Returns**: <code>boolean</code> - True if using two APIs
175
- <a name="Panoramax.components.core.Viewer+getAPI"></a>
176
-
177
- ### viewer.getAPI() ⇒ <code>API</code>
178
- Returns the API manager, from current Panoramax endpoint.
179
-
180
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
181
- **Returns**: <code>API</code> - The API manager
182
- <a name="Panoramax.components.core.Viewer+moveCenter"></a>
183
-
184
- ### viewer.moveCenter()
185
- Move the view of main component to its center.
186
- For map, center view on selected picture.
187
- For picture, center view on image center.
188
-
189
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
190
- **Overrides**: [<code>moveCenter</code>](PhotoViewer.md/#Panoramax.components.core.PhotoViewer+moveCenter)
191
- <a name="Panoramax.components.core.Viewer+isMapWide"></a>
192
-
193
- ### viewer.isMapWide() ⇒ <code>boolean</code>
194
- Is the map shown as main element instead of viewer (wide map mode) ?
195
-
196
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
197
- **Returns**: <code>boolean</code> - True if map is wider than viewer
198
- <a name="Panoramax.components.core.PhotoViewer+oncePSVReady"></a>
199
-
200
- ### viewer.oncePSVReady() ⇒ <code>Promise</code>
201
- Waiting for Photo Sphere Viewer to be available.
202
-
203
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
204
- **Returns**: <code>Promise</code> - When PSV is ready to use
205
- <a name="Panoramax.components.core.PhotoViewer+onceFirstPicLoaded"></a>
206
-
207
- ### viewer.onceFirstPicLoaded() ⇒ <code>Promise</code>
208
- Waits for first picture to display on PSV.
209
-
210
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
211
- **Fulfil**: <code>undefined</code> When picture is shown
212
- <a name="Panoramax.components.core.PhotoViewer+setPopup"></a>
213
-
214
- ### viewer.setPopup(visible, [content])
215
- Change full-page popup visibility and content
216
-
217
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
218
-
219
- | Param | Type | Default | Description |
220
- | --- | --- | --- | --- |
221
- | visible | <code>boolean</code> | | True to make it appear |
222
- | [content] | <code>string</code> \| <code>Array.&lt;Element&gt;</code> | <code>null</code> | The new popup content |
223
-
224
- <a name="Panoramax.components.core.PhotoViewer+moveLeft"></a>
225
-
226
- ### viewer.moveLeft()
227
- Moves the view of main component slightly to the left.
228
-
229
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
230
- <a name="Panoramax.components.core.PhotoViewer+moveRight"></a>
231
-
232
- ### viewer.moveRight()
233
- Moves the view of main component slightly to the right.
234
-
235
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
236
- <a name="Panoramax.components.core.PhotoViewer+moveUp"></a>
237
-
238
- ### viewer.moveUp()
239
- Moves the view of main component slightly to the top.
240
-
241
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
242
- <a name="Panoramax.components.core.PhotoViewer+moveDown"></a>
243
-
244
- ### viewer.moveDown()
245
- Moves the view of main component slightly to the bottom.
246
-
247
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
248
- <a name="Panoramax.components.core.PhotoViewer+addEventListener"></a>
249
-
250
- ### viewer.addEventListener(type, listener, [options])
251
- Listen to events from this components or one of its sub-components.
252
-
253
- For example, you can listen to `psv` events using prefix `psv:`.
254
-
255
- ```js
256
- me.addEventListener("psv:picture-loading", doSomething);
257
- ```
258
-
259
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
260
-
261
- | Param | Type | Description |
262
- | --- | --- | --- |
263
- | type | <code>string</code> | The event type to listen for |
264
- | listener | <code>function</code> | The event handler |
265
- | [options] | <code>object</code> | [Any original addEventListener available options](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#options) |
266
-
267
- <a name="Panoramax.components.core.Basic+onceAPIReady"></a>
268
-
269
- ### viewer.onceAPIReady() ⇒ <code>Promise</code>
270
- Waits for initial API setup.
271
-
272
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
273
- **Fulfil**: <code>null</code> When API is ready.
274
- **Reject**: <code>string</code> Error message
275
- <a name="Panoramax.components.core.Basic+getClassName"></a>
276
-
277
- ### viewer.getClassName() ⇒ <code>string</code>
278
- This allows to retrieve an always correct class name.
279
- This is crap, but avoids issues with Webpack & so on.
280
-
281
- Each inheriting class must override this method.
282
-
283
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
284
- **Returns**: <code>string</code> - The class name (for example "Basic")
285
- <a name="Panoramax.components.core.Basic+select"></a>
286
-
287
- ### viewer.select([seqId], [picId], [force])
288
- Change the currently picture and/or sequence.
289
- Calling the method without parameters unselects.
290
-
291
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
292
-
293
- | Param | Type | Default | Description |
294
- | --- | --- | --- | --- |
295
- | [seqId] | <code>string</code> | <code>null</code> | The sequence UUID |
296
- | [picId] | <code>string</code> | <code>null</code> | The picture UUID |
297
- | [force] | <code>boolean</code> | <code>false</code> | Force select even if already selected |
298
-
299
- <a name="Panoramax.components.core.Basic+isWidthSmall"></a>
300
-
301
- ### viewer.isWidthSmall() ⇒ <code>boolean</code>
302
- Is the view running in a small container (small embed or smartphone)
303
-
304
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
305
- **Returns**: <code>boolean</code> - True if container is small
306
- <a name="Panoramax.components.core.Basic+isWidthMedium"></a>
307
-
308
- ### viewer.isWidthMedium() ⇒ <code>boolean</code>
309
- Is the view running in a medium container (576-768px)
310
-
311
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
312
- **Returns**: <code>boolean</code> - True if container is medium
313
- <a name="Panoramax.components.core.Basic+isHeightSmall"></a>
314
-
315
- ### viewer.isHeightSmall() ⇒ <code>boolean</code>
316
- Is the view running in a small-height container (small embed or smartphone)
317
-
318
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
319
- **Returns**: <code>boolean</code> - True if container height is small
320
- <a name="Panoramax.components.core.Basic+getSubComponentsNames"></a>
321
-
322
- ### viewer.getSubComponentsNames() ⇒ <code>Array.&lt;string&gt;</code>
323
- List names of sub-components (like loader, api, map, psv) available in this component.
324
-
325
- **Kind**: instance method of [<code>Viewer</code>](#Panoramax.components.core.Viewer)
326
- **Returns**: <code>Array.&lt;string&gt;</code> - Sub-components names.
327
- <a name="Panoramax.components.core.Viewer+event_focus-changed"></a>
328
-
329
- ### "focus-changed"
330
- Event for focus change (either map or picture is shown wide)
331
-
332
- **Kind**: event emitted by [<code>Viewer</code>](#Panoramax.components.core.Viewer)
333
- **Properties**
334
-
335
- | Name | Type | Description |
336
- | --- | --- | --- |
337
- | detail.focus | <code>string</code> | Component now focused on (map, pic) |
338
-
339
- <a name="Panoramax.components.core.Basic+event_menu-opened"></a>
340
-
341
- ### "menu-opened"
342
- Event for overlaying menu opening
343
-
344
- **Kind**: event emitted by [<code>Viewer</code>](#Panoramax.components.core.Viewer)
345
- **Properties**
346
-
347
- | Name | Type | Description |
348
- | --- | --- | --- |
349
- | detail.menu | <code>Element</code> | The opened menu |
350
-
351
- <a name="Panoramax.components.core.Basic+event_select"></a>
352
-
353
- ### "select"
354
- Event for sequence/picture selection
355
-
356
- **Kind**: event emitted by [<code>Viewer</code>](#Panoramax.components.core.Viewer)
357
- **Properties**
358
-
359
- | Name | Type | Description |
360
- | --- | --- | --- |
361
- | detail.seqId | <code>string</code> | The selected sequence ID |
362
- | detail.picId | <code>string</code> | The selected picture ID (or null if not a precise picture clicked) |
363
- | [detail.prevSeqId] | <code>string</code> | The previously selected sequence ID (or null if none) |
364
- | [detail.prevPicId] | <code>string</code> | The previously selected picture ID (or null if none) |
365
-
366
- <a name="Panoramax.components.core.Basic+event_ready"></a>
367
-
368
- ### "ready"
369
- Event when component is ready to use.
370
- This happens when loader screen disappear, with picture and map loaded.
371
-
372
- To follow more precisely loading steps, you can also watch for sub-components `ready` events.
373
- ```js
374
- // Watch API-readiness
375
- viewer.addEventListener("api:ready", ...); // From parent
376
- viewer.api.addEventListener("ready", ...); // Or on sub-component
377
- ```
378
-
379
- **Kind**: event emitted by [<code>Viewer</code>](#Panoramax.components.core.Viewer)
380
- <a name="Panoramax.components.core.Basic+event_broken"></a>
381
-
382
- ### "broken"
383
- Event for viewer failing to initially load.
384
-
385
- To follow more precisely loading failures, you can also watch for sub-components `broken` events.
386
- ```js
387
- // Watch API breaks
388
- viewer.addEventListener("api:broken", ...); // From parent
389
- viewer.api.addEventListener("broken", ...); // Or on sub-component
390
- ```
391
-
392
- **Kind**: event emitted by [<code>Viewer</code>](#Panoramax.components.core.Viewer)
393
- **Properties**
394
-
395
- | Name | Type | Description |
396
- | --- | --- | --- |
397
- | detail.error | <code>string</code> | The user-friendly error message to display |
398
-
@@ -1,35 +0,0 @@
1
- <a name="Panoramax.components.layout.BottomDrawer"></a>
2
-
3
- ## Panoramax.components.layout.BottomDrawer ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.layout</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-bottom-drawer
7
- **Slot**: `default` The drawer content
8
-
9
- * [.BottomDrawer](#Panoramax.components.layout.BottomDrawer) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
10
- * [new BottomDrawer()](#new_Panoramax.components.layout.BottomDrawer_new)
11
- * [.properties](#Panoramax.components.layout.BottomDrawer+properties) : <code>Object</code>
12
-
13
- <a name="new_Panoramax.components.layout.BottomDrawer_new"></a>
14
-
15
- ### new BottomDrawer()
16
- BottomDrawer layout offers a mobile-like drawer menu, coming from bottom of the screen.
17
-
18
- **Example**
19
- ```html
20
- <pnx-bottom-drawer openness="opened">
21
- <p>My drawer content</p>
22
- </pnx-bottom-drawer>
23
- ```
24
- <a name="Panoramax.components.layout.BottomDrawer+properties"></a>
25
-
26
- ### bottomDrawer.properties : <code>Object</code>
27
- Component properties.
28
-
29
- **Kind**: instance property of [<code>BottomDrawer</code>](#Panoramax.components.layout.BottomDrawer)
30
- **Properties**
31
-
32
- | Name | Type | Default | Description |
33
- | --- | --- | --- | --- |
34
- | [openness] | <code>string</code> | <code>&quot;half-opened&quot;</code> | How much the drawer should be opened (closed, half-opened, opened) |
35
-
@@ -1,29 +0,0 @@
1
- <a name="Panoramax.components.layout.CorneredGrid"></a>
2
-
3
- ## Panoramax.components.layout.CorneredGrid ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.layout</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-cornered-grid
7
- **Slot**: `bg` The full size background component
8
- **Slot**: `top-left` The top-left corner
9
- **Slot**: `top` The top middle corner
10
- **Slot**: `top-right` The top-right corner
11
- **Slot**: `bottom-left` The bottom-left corner
12
- **Slot**: `bottom` The bottom middle corner
13
- **Slot**: `bottom-right` The bottom-right corner
14
- <a name="new_Panoramax.components.layout.CorneredGrid_new"></a>
15
-
16
- ### new CorneredGrid()
17
- CorneredGrid layout offers a convenient way to display overlay widgets on top of a background component.
18
- This is useful for showing buttons in corners over a map or picture display.
19
- Grid layout is organised through many slots (background and corners) : two rows (top, bottom) and three columns (right, middle, left).
20
-
21
- **Example**
22
- ```html
23
- <pnx-cornered-grid>
24
- <pnx-map slot="bg" />
25
- <pnx-button slot="top-left" />
26
- <pnx-button slot="top-left" />
27
- <pnx-legend slot="bottom" />
28
- </pnx-cornered-grid>
29
- ```
@@ -1,45 +0,0 @@
1
- <a name="Panoramax.components.layout.Mini"></a>
2
-
3
- ## Panoramax.components.layout.Mini ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.layout</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Emits**: [<code>expand</code>](#Panoramax.components.layout.Mini+event_expand)
7
- **Element**: pnx-mini
8
- **Slot**: `default` The component to display.
9
-
10
- * [.Mini](#Panoramax.components.layout.Mini) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
11
- * [new Mini()](#new_Panoramax.components.layout.Mini_new)
12
- * [.properties](#Panoramax.components.layout.Mini+properties) : <code>Object</code>
13
- * ["expand"](#Panoramax.components.layout.Mini+event_expand)
14
-
15
- <a name="new_Panoramax.components.layout.Mini_new"></a>
16
-
17
- ### new Mini()
18
- Mini layout allows to show a reduced or collapsed component in a corner of a main component.
19
- For example, show a reduced map on top of a photo display.
20
-
21
- **Example**
22
- ```html
23
- <pnx-mini icon=${fa(faMap)} ._parent=${viewer}>
24
- <pnx-map />
25
- </pnx-mini>
26
- ```
27
- <a name="Panoramax.components.layout.Mini+properties"></a>
28
-
29
- ### mini.properties : <code>Object</code>
30
- Component properties.
31
-
32
- **Kind**: instance property of [<code>Mini</code>](#Panoramax.components.layout.Mini)
33
- **Properties**
34
-
35
- | Name | Type | Default | Description |
36
- | --- | --- | --- | --- |
37
- | [icon] | <code>string</code> | | The icon to use in collapsed button. |
38
- | [collapsed] | <code>boolean</code> | <code>false</code> | Collapsed displays only a simple button. |
39
-
40
- <a name="Panoramax.components.layout.Mini+event_expand"></a>
41
-
42
- ### "expand"
43
- Event when user ask for component expand
44
-
45
- **Kind**: event emitted by [<code>Mini</code>](#Panoramax.components.layout.Mini)
@@ -1,46 +0,0 @@
1
- <a name="Panoramax.components.layout.Tabs"></a>
2
-
3
- ## Panoramax.components.layout.Tabs ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.layout</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-tabs
7
- **Slot**: `title` A single tab name
8
- **Slot**: `content` A single tab content
9
-
10
- * [.Tabs](#Panoramax.components.layout.Tabs) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
11
- * [new Tabs()](#new_Panoramax.components.layout.Tabs_new)
12
- * [.properties](#Panoramax.components.layout.Tabs+properties) : <code>Object</code>
13
-
14
- <a name="new_Panoramax.components.layout.Tabs_new"></a>
15
-
16
- ### new Tabs()
17
- Tabs offers a nice paged content rendering based on tabs buttons.
18
- The list of tab names are passed through `title` slots, and content using `content` slots.
19
- Note that tab names and contents should respect a coherent order.
20
-
21
- **Example**
22
- ```html
23
- <pnx-tabs>
24
- <h4 slot="title">Tab 1</h4>
25
- <div slot="content">Tab 1 content</div>
26
-
27
- <h4 slot="title">Tab 2</h4>
28
- <div slot="content">Tab 2 content</div>
29
-
30
- <h4 slot="title">Tab 3</h4>
31
- <div slot="content">Tab 3 content</div>
32
- </pnx-tabs>
33
- ```
34
- <a name="Panoramax.components.layout.Tabs+properties"></a>
35
-
36
- ### tabs.properties : <code>Object</code>
37
- Component properties.
38
-
39
- **Kind**: instance property of [<code>Tabs</code>](#Panoramax.components.layout.Tabs)
40
- **Properties**
41
-
42
- | Name | Type | Default | Description |
43
- | --- | --- | --- | --- |
44
- | [activeTabIndex] | <code>string</code> | <code>0</code> | The selected tab index |
45
- | [hideNav] | <code>boolean</code> | <code>false</code> | Hide nav |
46
-
@@ -1,15 +0,0 @@
1
- <a name="Panoramax.components.menus.LocationPrecisionDoc"></a>
2
-
3
- ## Panoramax.components.menus.LocationPrecisionDoc ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.menus</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-location-precision-doc
7
- <a name="new_Panoramax.components.menus.LocationPrecisionDoc_new"></a>
8
-
9
- ### new LocationPrecisionDoc()
10
- Location Precision Doc displays a synthetic summary of how Location Precision filter and map theme works.
11
-
12
- **Example**
13
- ```html
14
- <pnx-location-precision-doc ._t=${viewer._t} />
15
- ```
@@ -1,32 +0,0 @@
1
- <a name="Panoramax.components.menus.MapBackground"></a>
2
-
3
- ## Panoramax.components.menus.MapBackground ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.menus</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-map-background
7
-
8
- * [.MapBackground](#Panoramax.components.menus.MapBackground) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
9
- * [new MapBackground()](#new_Panoramax.components.menus.MapBackground_new)
10
- * [.properties](#Panoramax.components.menus.MapBackground+properties) : <code>Object</code>
11
-
12
- <a name="new_Panoramax.components.menus.MapBackground_new"></a>
13
-
14
- ### new MapBackground()
15
- Map Background menu allows user to select background.
16
-
17
- **Example**
18
- ```html
19
- <pnx-map-background size="sm" _parent=${viewer} />
20
- ```
21
- <a name="Panoramax.components.menus.MapBackground+properties"></a>
22
-
23
- ### mapBackground.properties : <code>Object</code>
24
- Component properties.
25
-
26
- **Kind**: instance property of [<code>MapBackground</code>](#Panoramax.components.menus.MapBackground)
27
- **Properties**
28
-
29
- | Name | Type | Default | Description |
30
- | --- | --- | --- | --- |
31
- | [size] | <code>string</code> | <code>&quot;md&quot;</code> | The size of the button (sm, md) |
32
-
@@ -1,37 +0,0 @@
1
- <a name="Panoramax.components.menus.MapFilters"></a>
2
-
3
- ## Panoramax.components.menus.MapFilters ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.menus</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-map-filters-menu
7
-
8
- * [.MapFilters](#Panoramax.components.menus.MapFilters) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
9
- * [new MapFilters()](#new_Panoramax.components.menus.MapFilters_new)
10
- * [.properties](#Panoramax.components.menus.MapFilters+properties) : <code>Object</code>
11
-
12
- <a name="new_Panoramax.components.menus.MapFilters_new"></a>
13
-
14
- ### new MapFilters()
15
- Map Filters menu allows user to select map data they want displayed.
16
-
17
- **Example**
18
- ```html
19
- <pnx-map-filters-menu user-search="" _parent=${viewer} />
20
- ```
21
- <a name="Panoramax.components.menus.MapFilters+properties"></a>
22
-
23
- ### mapFilters.properties : <code>Object</code>
24
- Component properties.
25
-
26
- **Kind**: instance property of [<code>MapFilters</code>](#Panoramax.components.menus.MapFilters)
27
- **Properties**
28
-
29
- | Name | Type | Default | Description |
30
- | --- | --- | --- | --- |
31
- | [user-search] | <code>boolean</code> | <code>false</code> | Should user search filter show up ? |
32
- | [quality-score] | <code>boolean</code> | <code>false</code> | Should quality score filter show up ? |
33
- | [no-date] | <code>boolean</code> | <code>false</code> | Should date filters be hidden ? |
34
- | [no-picture-type] | <code>boolean</code> | <code>false</code> | Should picture type filter be hidden ? |
35
- | [no-gps] | <code>boolean</code> | <code>false</code> | Should GPS precision filter be hidden ? |
36
- | [no-source] | <code>boolean</code> | <code>false</code> | Should pictures source (world, instance) filter be hidden ? |
37
-