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

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,144 +0,0 @@
1
- <mxfile host="app.diagrams.net" agent="Mozilla/5.0 (X11; Linux x86_64; rv:136.0) Gecko/20100101 Firefox/136.0" version="26.1.1">
2
- <diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">
3
- <mxGraphModel dx="983" dy="448" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
4
- <root>
5
- <mxCell id="WIyWlLk6GJQsqaUBKTNV-0" />
6
- <mxCell id="WIyWlLk6GJQsqaUBKTNV-1" parent="WIyWlLk6GJQsqaUBKTNV-0" />
7
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-1" value="Basic" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
8
- <mxGeometry x="20" y="40" width="160" height="34" as="geometry" />
9
- </mxCell>
10
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-3" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-1" vertex="1">
11
- <mxGeometry y="26" width="160" height="8" as="geometry" />
12
- </mxCell>
13
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-9" value="PhotoViewer" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
14
- <mxGeometry x="20" y="148" width="160" height="34" as="geometry" />
15
- </mxCell>
16
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-10" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-9" vertex="1">
17
- <mxGeometry y="26" width="160" height="8" as="geometry" />
18
- </mxCell>
19
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-11" value="CoverageMap" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
20
- <mxGeometry x="200" y="148" width="160" height="34" as="geometry" />
21
- </mxCell>
22
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-12" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-11" vertex="1">
23
- <mxGeometry y="26" width="160" height="8" as="geometry" />
24
- </mxCell>
25
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-13" value="Editor" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
26
- <mxGeometry x="380" y="148" width="160" height="34" as="geometry" />
27
- </mxCell>
28
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-14" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-13" vertex="1">
29
- <mxGeometry y="26" width="160" height="8" as="geometry" />
30
- </mxCell>
31
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-15" value="Extends" style="endArrow=block;endSize=16;endFill=0;html=1;rounded=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-9" target="-sBJLWWXFzCuZ66xZKHM-1" edge="1">
32
- <mxGeometry width="160" relative="1" as="geometry">
33
- <mxPoint x="310" y="260" as="sourcePoint" />
34
- <mxPoint x="470" y="260" as="targetPoint" />
35
- </mxGeometry>
36
- </mxCell>
37
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-17" value="" style="endArrow=none;html=1;rounded=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" edge="1">
38
- <mxGeometry width="50" height="50" relative="1" as="geometry">
39
- <mxPoint x="100" y="128" as="sourcePoint" />
40
- <mxPoint x="460" y="128" as="targetPoint" />
41
- </mxGeometry>
42
- </mxCell>
43
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-19" value="" style="endArrow=none;html=1;rounded=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-11" edge="1">
44
- <mxGeometry width="50" height="50" relative="1" as="geometry">
45
- <mxPoint x="370" y="290" as="sourcePoint" />
46
- <mxPoint x="280" y="130" as="targetPoint" />
47
- </mxGeometry>
48
- </mxCell>
49
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-20" value="" style="endArrow=none;html=1;rounded=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-13" edge="1">
50
- <mxGeometry width="50" height="50" relative="1" as="geometry">
51
- <mxPoint x="290" y="170" as="sourcePoint" />
52
- <mxPoint x="460" y="130" as="targetPoint" />
53
- </mxGeometry>
54
- </mxCell>
55
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-22" value="components.core" style="swimlane;whiteSpace=wrap;html=1;startSize=23;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
56
- <mxGeometry x="10" y="10" width="540" height="240" as="geometry" />
57
- </mxCell>
58
- <mxCell id="l_DTcpemKbOkDnIudQOG-0" value="Viewer" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" vertex="1" parent="-sBJLWWXFzCuZ66xZKHM-22">
59
- <mxGeometry x="60" y="200" width="160" height="34" as="geometry" />
60
- </mxCell>
61
- <mxCell id="l_DTcpemKbOkDnIudQOG-1" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" vertex="1" parent="l_DTcpemKbOkDnIudQOG-0">
62
- <mxGeometry y="26" width="160" height="8" as="geometry" />
63
- </mxCell>
64
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-23" value="components.ui" style="swimlane;whiteSpace=wrap;html=1;" parent="WIyWlLk6GJQsqaUBKTNV-1" vertex="1">
65
- <mxGeometry x="10" y="271" width="540" height="90" as="geometry" />
66
- </mxCell>
67
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-26" value="Photo" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="-sBJLWWXFzCuZ66xZKHM-23" vertex="1">
68
- <mxGeometry x="10" y="40" width="160" height="34" as="geometry" />
69
- </mxCell>
70
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-27" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-26" vertex="1">
71
- <mxGeometry y="26" width="160" height="8" as="geometry" />
72
- </mxCell>
73
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-28" value="Loader" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="-sBJLWWXFzCuZ66xZKHM-23" vertex="1">
74
- <mxGeometry x="370" y="40" width="160" height="34" as="geometry" />
75
- </mxCell>
76
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-29" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-28" vertex="1">
77
- <mxGeometry y="26" width="160" height="8" as="geometry" />
78
- </mxCell>
79
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-24" value="Map" style="swimlane;fontStyle=1;align=center;verticalAlign=top;childLayout=stackLayout;horizontal=1;startSize=26;horizontalStack=0;resizeParent=1;resizeParentMax=0;resizeLast=0;collapsible=1;marginBottom=0;whiteSpace=wrap;html=1;" parent="-sBJLWWXFzCuZ66xZKHM-23" vertex="1">
80
- <mxGeometry x="190" y="40" width="160" height="34" as="geometry" />
81
- </mxCell>
82
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-25" value="" style="line;strokeWidth=1;fillColor=none;align=left;verticalAlign=middle;spacingTop=-1;spacingLeft=3;spacingRight=3;rotatable=0;labelPosition=right;points=[];portConstraint=eastwest;strokeColor=inherit;" parent="-sBJLWWXFzCuZ66xZKHM-24" vertex="1">
83
- <mxGeometry y="26" width="160" height="8" as="geometry" />
84
- </mxCell>
85
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-30" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0;entryY=0;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="l_DTcpemKbOkDnIudQOG-0" target="-sBJLWWXFzCuZ66xZKHM-24" edge="1">
86
- <mxGeometry x="0.3561" y="-10" width="160" relative="1" as="geometry">
87
- <mxPoint x="370" y="300" as="sourcePoint" />
88
- <mxPoint x="234" y="272" as="targetPoint" />
89
- <mxPoint as="offset" />
90
- </mxGeometry>
91
- </mxCell>
92
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-31" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;entryX=0.123;entryY=0.023;entryDx=0;entryDy=0;entryPerimeter=0;exitX=0.114;exitY=0.919;exitDx=0;exitDy=0;exitPerimeter=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-10" target="-sBJLWWXFzCuZ66xZKHM-26" edge="1">
93
- <mxGeometry x="0.4701" width="160" relative="1" as="geometry">
94
- <mxPoint x="40" y="200" as="sourcePoint" />
95
- <mxPoint x="530" y="300" as="targetPoint" />
96
- <mxPoint as="offset" />
97
- </mxGeometry>
98
- </mxCell>
99
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-32" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;exitX=1;exitY=0.25;exitDx=0;exitDy=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-1" target="-sBJLWWXFzCuZ66xZKHM-28" edge="1">
100
- <mxGeometry x="0.3304" width="160" relative="1" as="geometry">
101
- <mxPoint x="111" y="204" as="sourcePoint" />
102
- <mxPoint x="290" y="280" as="targetPoint" />
103
- <Array as="points">
104
- <mxPoint x="580" y="49" />
105
- <mxPoint x="580" y="287" />
106
- </Array>
107
- <mxPoint as="offset" />
108
- </mxGeometry>
109
- </mxCell>
110
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-38" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=1;entryY=0;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-13" target="-sBJLWWXFzCuZ66xZKHM-24" edge="1">
111
- <mxGeometry x="0.4416" y="4" width="160" relative="1" as="geometry">
112
- <mxPoint x="320" y="390" as="sourcePoint" />
113
- <mxPoint x="480" y="390" as="targetPoint" />
114
- <mxPoint as="offset" />
115
- </mxGeometry>
116
- </mxCell>
117
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-39" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;exitX=1;exitY=1;exitDx=0;exitDy=0;entryX=0.75;entryY=0;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-11" target="-sBJLWWXFzCuZ66xZKHM-24" edge="1">
118
- <mxGeometry x="0.2678" y="6" width="160" relative="1" as="geometry">
119
- <mxPoint x="210" y="360" as="sourcePoint" />
120
- <mxPoint x="240" y="270" as="targetPoint" />
121
- <mxPoint as="offset" />
122
- </mxGeometry>
123
- </mxCell>
124
- <mxCell id="-sBJLWWXFzCuZ66xZKHM-41" value="Use" style="endArrow=open;endSize=12;dashed=1;html=1;rounded=0;exitX=0.25;exitY=1;exitDx=0;exitDy=0;entryX=0.75;entryY=0;entryDx=0;entryDy=0;" parent="WIyWlLk6GJQsqaUBKTNV-1" source="-sBJLWWXFzCuZ66xZKHM-13" target="-sBJLWWXFzCuZ66xZKHM-26" edge="1">
125
- <mxGeometry width="160" relative="1" as="geometry">
126
- <mxPoint x="150" y="370" as="sourcePoint" />
127
- <mxPoint x="310" y="370" as="targetPoint" />
128
- <Array as="points">
129
- <mxPoint x="350" y="260" />
130
- <mxPoint x="190" y="280" />
131
- </Array>
132
- </mxGeometry>
133
- </mxCell>
134
- <mxCell id="l_DTcpemKbOkDnIudQOG-4" value="Extends" style="endArrow=block;endSize=16;endFill=0;html=1;rounded=0;exitX=0.441;exitY=0.022;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="WIyWlLk6GJQsqaUBKTNV-1" source="l_DTcpemKbOkDnIudQOG-0">
135
- <mxGeometry x="-0.2397" y="-30" width="160" relative="1" as="geometry">
136
- <mxPoint x="110" y="158" as="sourcePoint" />
137
- <mxPoint x="140" y="182" as="targetPoint" />
138
- <mxPoint as="offset" />
139
- </mxGeometry>
140
- </mxCell>
141
- </root>
142
- </mxGraphModel>
143
- </diagram>
144
- </mxfile>
Binary file
Binary file
Binary file
package/docs/index.md DELETED
@@ -1,159 +0,0 @@
1
- # Web viewer documentation
2
-
3
- Welcome to Panoramax __Web Viewer__ documentation ! It will help you through all phases of setup, run and develop on Panoramax JS pictures viewer.
4
-
5
- ![Web viewer screenshots](./images/screenshot.jpg)
6
-
7
- !!! note
8
-
9
- If at some point you're lost or need help, you can contact us through [issues](https://gitlab.com/panoramax/clients/web-viewer/-/issues) or by [email](mailto:panoramax@panoramax.fr).
10
-
11
- ## Install
12
-
13
- Many options are available for installing the viewer.
14
-
15
- === ":simple-npm: NPM"
16
-
17
- Panoramax viewer is available on NPM as [@panoramax/web-viewer](https://www.npmjs.com/package/@panoramax/web-viewer) package.
18
-
19
- ```bash
20
- npm install @panoramax/web-viewer
21
- ```
22
-
23
- If you want the latest version (corresponding to the `develop` git branch), you can use the `develop` NPM dist-tag:
24
-
25
- ```bash
26
- npm install @panoramax/web-viewer@develop
27
- ```
28
-
29
- === ":material-web: Hosted"
30
-
31
- You can rely on various providers offering hosted NPM packages, for example JSDelivr.
32
-
33
- ```html
34
- <!-- You may use another version than 4.1.0, just change the release in URL -->
35
- <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/@panoramax/web-viewer@4.1.0/build/index.css" />
36
- <script src="https://cdn.jsdelivr.net/npm/@panoramax/web-viewer@4.1.0/build/index.js"></script>
37
- ```
38
-
39
- === ":material-code-tags: Source code"
40
-
41
- You can install and use Panoramax web client based on code provided in this repository.
42
-
43
- This library relies on any recent __Node.js__ version, which should be installed on your computer. Then, you can build the library using these commands:
44
-
45
- ```bash
46
- git clone https://gitlab.com/panoramax/clients/web-viewer.git
47
- cd web-viewer/
48
- npm install
49
- npm build
50
- ```
51
-
52
-
53
- ## Basic usage
54
-
55
- First, you need to import Panoramax code:
56
-
57
- === ":fontawesome-brands-js: Old-school JS"
58
-
59
- Make sure to have both JS and CSS code available in your HTML `head` part:
60
-
61
- ```html
62
- <!-- Change the actual path depending of where you installed the library -->
63
- <link rel="stylesheet" type="text/css" href="web-viewer/build/index.css" />
64
- <script src="web-viewer/build/index.js"></script>
65
-
66
- <!-- You can use the lightweight version with only PhotoViewer as well -->
67
- <link rel="stylesheet" type="text/css" href="web-viewer/build/photoviewer.css" />
68
- <script src="web-viewer/build/photoviewer.js"></script>
69
- ```
70
-
71
- === ":fontawesome-brands-node-js: New-style JS"
72
-
73
- Make sure to import both JS and CSS in your code:
74
-
75
- ```js
76
- import Panoramax from '@panoramax/web-viewer';
77
- import '@panoramax/web-viewer/build/index.css';
78
- ```
79
-
80
- If you prefer the lightweight version, only containing PhotoViewer component:
81
-
82
- ```js
83
- import Panoramax from '@panoramax/web-viewer/build/photoviewer';
84
- import '@panoramax/web-viewer/build/photoviewer.css';
85
- ```
86
-
87
- Once ready, you can create for example a viewer. We use web components to do so, you can create it in HTML or in other web components:
88
-
89
- ```html
90
- <pnx-viewer
91
- endpoint="https://api.panoramax.xyz/api"
92
- />
93
- ```
94
-
95
- [Many options are available to configure it finely](./reference/components/core/Viewer.md).
96
-
97
- You may also add some CSS to make sure your component has proper dimensions:
98
-
99
- ```css
100
- pnx-viewer {
101
- width: 300px;
102
- height: 250px;
103
- }
104
- ```
105
-
106
- Beyond classic viewer, other widgets are available and [can be tested online](https://viewer.geovisio.fr/).
107
-
108
- __Coverage map__
109
-
110
- A simple map for showing Panoramax data availability.
111
-
112
- ```html
113
- <pnx-coverage-map
114
- endpoint="https://api.panoramax.xyz/api"
115
- />
116
- ```
117
-
118
- [Many options are available as well](./reference/components/core/CoverageMap.md).
119
-
120
- __Photo Viewer__
121
-
122
- A photo-only viewer, showing one picture at a time, and offering navigation through sequence and nearby pictures.
123
-
124
- ```html
125
- <pnx-photo-viewer
126
- endpoint="https://api.panoramax.xyz/api"
127
- sequence="id-to-an-existing-sequence"
128
- picture="id-to-a-picture-in-this-sequence"
129
- />
130
- ```
131
-
132
- If you'd like a photo viewer that looks like an iframe embed (with only a small legend widget), you may use this code:
133
-
134
- ```html
135
- <pnx-photo-viewer
136
- endpoint="https://api.panoramax.xyz/api"
137
- sequence="id-to-an-existing-sequence"
138
- picture="id-to-a-picture-in-this-sequence"
139
- widgets="false"
140
- >
141
- <pnx-widget-legend light slot="bottom-right"></pnx-widget-legend>
142
- </pnx-photo-viewer>
143
- ```
144
-
145
- [Many options are available as well](./reference/components/core/PhotoViewer.md).
146
-
147
- __Editor__
148
-
149
- A map and photo viewer, focused on a single sequence, for previewing edits made to it.
150
-
151
- ```html
152
- <pnx-editor
153
- endpoint="https://panoramax.openstreetmap.fr/api"
154
- sequence="id-to-an-existing-sequence"
155
- picture="id-to-a-picture-in-this-sequence"
156
- />
157
- ```
158
-
159
- [Many options are available as well](./reference/components/core/Editor.md).
@@ -1,211 +0,0 @@
1
- <a name="Panoramax.components.core.Basic"></a>
2
-
3
- ## Panoramax.components.core.Basic ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.core</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Emits**: [<code>select</code>](#Panoramax.components.core.Basic+event_select), [<code>ready</code>](#Panoramax.components.core.Basic+event_ready), [<code>broken</code>](#Panoramax.components.core.Basic+event_broken), [<code>menu-opened</code>](#Panoramax.components.core.Basic+event_menu-opened)
7
- **Properties**
8
-
9
- | Name | Type | Description |
10
- | --- | --- | --- |
11
- | loader | [<code>Loader</code>](../ui/Loader.md/#Panoramax.components.ui.Loader) | The loader screen |
12
- | api | [<code>API</code>](../../utils/API.md/#Panoramax.utils.API) | The API manager |
13
-
14
-
15
- * [.Basic](#Panoramax.components.core.Basic) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
16
- * [new Basic()](#new_Panoramax.components.core.Basic_new)
17
- * [.properties](#Panoramax.components.core.Basic+properties) : <code>Object</code>
18
- * [.onceReady()](#Panoramax.components.core.Basic+onceReady) ⇒ <code>Promise</code>
19
- * [.onceAPIReady()](#Panoramax.components.core.Basic+onceAPIReady) ⇒ <code>Promise</code>
20
- * [.getClassName()](#Panoramax.components.core.Basic+getClassName) ⇒ <code>string</code>
21
- * [.select([seqId], [picId], [force])](#Panoramax.components.core.Basic+select)
22
- * [.isWidthSmall()](#Panoramax.components.core.Basic+isWidthSmall) ⇒ <code>boolean</code>
23
- * [.isWidthMedium()](#Panoramax.components.core.Basic+isWidthMedium) ⇒ <code>boolean</code>
24
- * [.isHeightSmall()](#Panoramax.components.core.Basic+isHeightSmall) ⇒ <code>boolean</code>
25
- * [.getSubComponentsNames()](#Panoramax.components.core.Basic+getSubComponentsNames) ⇒ <code>Array.&lt;string&gt;</code>
26
- * [.addEventListener(type, listener, [options])](#Panoramax.components.core.Basic+addEventListener)
27
- * [.onceAPIReady()](#Panoramax.components.core.Basic+onceAPIReady) ⇒ <code>Promise</code>
28
- * ["menu-opened"](#Panoramax.components.core.Basic+event_menu-opened)
29
- * ["select"](#Panoramax.components.core.Basic+event_select)
30
- * ["ready"](#Panoramax.components.core.Basic+event_ready)
31
- * ["broken"](#Panoramax.components.core.Basic+event_broken)
32
-
33
- <a name="new_Panoramax.components.core.Basic_new"></a>
34
-
35
- ### new Basic()
36
- Basic core component is a basic container for common functions through all core components.
37
- It is not intended to be used directly, it's only to be extended by other core components.
38
-
39
- <a name="Panoramax.components.core.Basic+properties"></a>
40
-
41
- ### basic.properties : <code>Object</code>
42
- Component properties.
43
-
44
- **Kind**: instance mixin of [<code>Basic</code>](#Panoramax.components.core.Basic)
45
- **Properties**
46
-
47
- | Name | Type | Description |
48
- | --- | --- | --- |
49
- | 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)) |
50
- | [picture] | <code>string</code> | The picture ID to display |
51
- | [sequence] | <code>string</code> | The sequence ID of the picture displayed |
52
- | [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)) |
53
- | [lang] | <code>string</code> | To override language used for labels. Defaults to using user's preferred languages. |
54
-
55
- <a name="Panoramax.components.core.Basic+onceReady"></a>
56
-
57
- ### basic.onceReady() ⇒ <code>Promise</code>
58
- Waits for component to have its first loading done.
59
-
60
- Each inheriting class must override this method.
61
-
62
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
63
- **Fulfil**: <code>null</code> When initialization is complete.
64
- **Reject**: <code>string</code> Error message
65
- <a name="Panoramax.components.core.Basic+onceAPIReady"></a>
66
-
67
- ### basic.onceAPIReady() ⇒ <code>Promise</code>
68
- Waits for initial API setup.
69
-
70
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
71
- **Fulfil**: <code>null</code> When API is ready.
72
- **Reject**: <code>string</code> Error message
73
- <a name="Panoramax.components.core.Basic+getClassName"></a>
74
-
75
- ### basic.getClassName() ⇒ <code>string</code>
76
- This allows to retrieve an always correct class name.
77
- This is crap, but avoids issues with Webpack & so on.
78
-
79
- Each inheriting class must override this method.
80
-
81
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
82
- **Returns**: <code>string</code> - The class name (for example "Basic")
83
- <a name="Panoramax.components.core.Basic+select"></a>
84
-
85
- ### basic.select([seqId], [picId], [force])
86
- Change the currently picture and/or sequence.
87
- Calling the method without parameters unselects.
88
-
89
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
90
-
91
- | Param | Type | Default | Description |
92
- | --- | --- | --- | --- |
93
- | [seqId] | <code>string</code> | <code>null</code> | The sequence UUID |
94
- | [picId] | <code>string</code> | <code>null</code> | The picture UUID |
95
- | [force] | <code>boolean</code> | <code>false</code> | Force select even if already selected |
96
-
97
- <a name="Panoramax.components.core.Basic+isWidthSmall"></a>
98
-
99
- ### basic.isWidthSmall() ⇒ <code>boolean</code>
100
- Is the view running in a small container (small embed or smartphone)
101
-
102
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
103
- **Returns**: <code>boolean</code> - True if container is small
104
- <a name="Panoramax.components.core.Basic+isWidthMedium"></a>
105
-
106
- ### basic.isWidthMedium() ⇒ <code>boolean</code>
107
- Is the view running in a medium container (576-768px)
108
-
109
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
110
- **Returns**: <code>boolean</code> - True if container is medium
111
- <a name="Panoramax.components.core.Basic+isHeightSmall"></a>
112
-
113
- ### basic.isHeightSmall() ⇒ <code>boolean</code>
114
- Is the view running in a small-height container (small embed or smartphone)
115
-
116
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
117
- **Returns**: <code>boolean</code> - True if container height is small
118
- <a name="Panoramax.components.core.Basic+getSubComponentsNames"></a>
119
-
120
- ### basic.getSubComponentsNames() ⇒ <code>Array.&lt;string&gt;</code>
121
- List names of sub-components (like loader, api, map, psv) available in this component.
122
-
123
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
124
- **Returns**: <code>Array.&lt;string&gt;</code> - Sub-components names.
125
- <a name="Panoramax.components.core.Basic+addEventListener"></a>
126
-
127
- ### basic.addEventListener(type, listener, [options])
128
- Listen to events from this components or one of its sub-components.
129
-
130
- For example, you can listen to `map` events using prefix `map:`.
131
-
132
- ```js
133
- me.addEventListener("map:move", doSomething);
134
- ```
135
-
136
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
137
-
138
- | Param | Type | Description |
139
- | --- | --- | --- |
140
- | type | <code>string</code> | The event type to listen for |
141
- | listener | <code>function</code> | The event handler |
142
- | [options] | <code>object</code> | [Any original addEventListener available options](https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener#options) |
143
-
144
- <a name="Panoramax.components.core.Basic+onceAPIReady"></a>
145
-
146
- ### basic.onceAPIReady() ⇒ <code>Promise</code>
147
- Waits for initial API setup.
148
-
149
- **Kind**: instance method of [<code>Basic</code>](#Panoramax.components.core.Basic)
150
- **Fulfil**: <code>null</code> When API is ready.
151
- **Reject**: <code>string</code> Error message
152
- <a name="Panoramax.components.core.Basic+event_menu-opened"></a>
153
-
154
- ### "menu-opened"
155
- Event for overlaying menu opening
156
-
157
- **Kind**: event emitted by [<code>Basic</code>](#Panoramax.components.core.Basic)
158
- **Properties**
159
-
160
- | Name | Type | Description |
161
- | --- | --- | --- |
162
- | detail.menu | <code>Element</code> | The opened menu |
163
-
164
- <a name="Panoramax.components.core.Basic+event_select"></a>
165
-
166
- ### "select"
167
- Event for sequence/picture selection
168
-
169
- **Kind**: event emitted by [<code>Basic</code>](#Panoramax.components.core.Basic)
170
- **Properties**
171
-
172
- | Name | Type | Description |
173
- | --- | --- | --- |
174
- | detail.seqId | <code>string</code> | The selected sequence ID |
175
- | detail.picId | <code>string</code> | The selected picture ID (or null if not a precise picture clicked) |
176
- | [detail.prevSeqId] | <code>string</code> | The previously selected sequence ID (or null if none) |
177
- | [detail.prevPicId] | <code>string</code> | The previously selected picture ID (or null if none) |
178
-
179
- <a name="Panoramax.components.core.Basic+event_ready"></a>
180
-
181
- ### "ready"
182
- Event when component is ready to use.
183
- This happens when loader screen disappear, with picture and map loaded.
184
-
185
- To follow more precisely loading steps, you can also watch for sub-components `ready` events.
186
- ```js
187
- // Watch API-readiness
188
- viewer.addEventListener("api:ready", ...); // From parent
189
- viewer.api.addEventListener("ready", ...); // Or on sub-component
190
- ```
191
-
192
- **Kind**: event emitted by [<code>Basic</code>](#Panoramax.components.core.Basic)
193
- <a name="Panoramax.components.core.Basic+event_broken"></a>
194
-
195
- ### "broken"
196
- Event for viewer failing to initially load.
197
-
198
- To follow more precisely loading failures, you can also watch for sub-components `broken` events.
199
- ```js
200
- // Watch API breaks
201
- viewer.addEventListener("api:broken", ...); // From parent
202
- viewer.api.addEventListener("broken", ...); // Or on sub-component
203
- ```
204
-
205
- **Kind**: event emitted by [<code>Basic</code>](#Panoramax.components.core.Basic)
206
- **Properties**
207
-
208
- | Name | Type | Description |
209
- | --- | --- | --- |
210
- | detail.error | <code>string</code> | The user-friendly error message to display |
211
-