@panoramax/web-viewer 4.4.0-develop-746bcb00 → 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}/translations/pt.json +7 -2
  81. package/{src → build}/utils/API.js +33 -33
  82. package/{src → build}/utils/InitParameters.js +11 -9
  83. package/{src → build}/utils/MapStyleComposer.js +39 -37
  84. package/{src → build}/utils/PhotoAdapter.js +1 -0
  85. package/{src → build}/utils/PresetsManager.js +4 -4
  86. package/{src → build}/utils/SemanticsMapProtocol.js +3 -4
  87. package/{src → build}/utils/URLHandler.js +16 -14
  88. package/{src → build}/utils/geocoder.js +5 -5
  89. package/{src → build}/utils/i18n.js +21 -20
  90. package/build/utils/index.js +17 -0
  91. package/build/utils/index_photoviewer.js +14 -0
  92. package/{src → build}/utils/indoor.js +9 -5
  93. package/{src → build}/utils/map.js +15 -11
  94. package/{src → build}/utils/picture.js +22 -17
  95. package/{src → build}/utils/semantics.js +9 -5
  96. package/{src → build}/utils/utils.js +8 -4
  97. package/{src → build}/utils/widgets.js +2 -2
  98. package/build/viewer.html +120 -35
  99. package/build/viewer_indoor.html +90 -8
  100. package/build/widgets.html +410 -1
  101. package/package.json +81 -204
  102. package/.dockerignore +0 -7
  103. package/.gitlab-ci.yml +0 -78
  104. package/CHANGELOG.md +0 -853
  105. package/CODE_OF_CONDUCT.md +0 -134
  106. package/Dockerfile +0 -14
  107. package/build/index.css +0 -36
  108. package/build/index.css.map +0 -1
  109. package/build/index.js.map +0 -1
  110. package/build/photoviewer.css +0 -36
  111. package/build/photoviewer.css.map +0 -1
  112. package/build/photoviewer.js +0 -86
  113. package/build/photoviewer.js.map +0 -1
  114. package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff +0 -0
  115. package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff2 +0 -0
  116. package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff +0 -0
  117. package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff2 +0 -0
  118. package/config/env.js +0 -104
  119. package/config/getHttpsConfig.js +0 -69
  120. package/config/getPackageJson.js +0 -25
  121. package/config/jest/babelTransform.js +0 -29
  122. package/config/jest/cssTransform.js +0 -14
  123. package/config/jest/fileTransform.js +0 -40
  124. package/config/jest/mocks.js +0 -230
  125. package/config/modules.js +0 -134
  126. package/config/paths.js +0 -76
  127. package/config/pnpTs.js +0 -35
  128. package/config/webpack/persistentCache/createEnvironmentHash.js +0 -9
  129. package/config/webpack.config.js +0 -825
  130. package/config/webpackDevServer.config.js +0 -131
  131. package/docs/03_URL_settings.md +0 -218
  132. package/docs/05_Compatibility.md +0 -83
  133. package/docs/09_Develop.md +0 -141
  134. package/docs/90_Releases.md +0 -27
  135. package/docs/images/class_diagram.drawio +0 -144
  136. package/docs/images/class_diagram.jpg +0 -0
  137. package/docs/images/comparative_3drender.jpg +0 -0
  138. package/docs/images/indoor_level.png +0 -0
  139. package/docs/images/screenshot.jpg +0 -0
  140. package/docs/index.md +0 -159
  141. package/docs/reference/components/core/Basic.md +0 -211
  142. package/docs/reference/components/core/CoverageMap.md +0 -220
  143. package/docs/reference/components/core/Editor.md +0 -252
  144. package/docs/reference/components/core/PhotoViewer.md +0 -320
  145. package/docs/reference/components/core/Viewer.md +0 -398
  146. package/docs/reference/components/layout/BottomDrawer.md +0 -35
  147. package/docs/reference/components/layout/CorneredGrid.md +0 -29
  148. package/docs/reference/components/layout/Mini.md +0 -45
  149. package/docs/reference/components/layout/Tabs.md +0 -46
  150. package/docs/reference/components/menus/LocationPrecisionDoc.md +0 -15
  151. package/docs/reference/components/menus/MapBackground.md +0 -32
  152. package/docs/reference/components/menus/MapFilters.md +0 -37
  153. package/docs/reference/components/menus/MapLayers.md +0 -15
  154. package/docs/reference/components/menus/MapLegend.md +0 -32
  155. package/docs/reference/components/menus/MiniPictureLegend.md +0 -15
  156. package/docs/reference/components/menus/PictureLegend.md +0 -45
  157. package/docs/reference/components/menus/PictureMetadata.md +0 -32
  158. package/docs/reference/components/menus/PlayerOptions.md +0 -15
  159. package/docs/reference/components/menus/QualityScoreDoc.md +0 -15
  160. package/docs/reference/components/menus/ReportForm.md +0 -15
  161. package/docs/reference/components/menus/SemanticsDoc.md +0 -15
  162. package/docs/reference/components/menus/SemanticsDownload.md +0 -15
  163. package/docs/reference/components/menus/SemanticsFilters.md +0 -33
  164. package/docs/reference/components/menus/SemanticsList.md +0 -97
  165. package/docs/reference/components/menus/SemanticsMetadata.md +0 -15
  166. package/docs/reference/components/menus/ShareMenu.md +0 -32
  167. package/docs/reference/components/ui/AnnotationsSwitch.md +0 -32
  168. package/docs/reference/components/ui/Button.md +0 -40
  169. package/docs/reference/components/ui/ButtonGroup.md +0 -36
  170. package/docs/reference/components/ui/CopyButton.md +0 -41
  171. package/docs/reference/components/ui/Grade.md +0 -32
  172. package/docs/reference/components/ui/GradeFilter.md +0 -42
  173. package/docs/reference/components/ui/IconSwitch.md +0 -53
  174. package/docs/reference/components/ui/LinkButton.md +0 -45
  175. package/docs/reference/components/ui/ListGroup.md +0 -22
  176. package/docs/reference/components/ui/ListItem.md +0 -39
  177. package/docs/reference/components/ui/Loader.md +0 -56
  178. package/docs/reference/components/ui/Map.md +0 -150
  179. package/docs/reference/components/ui/MapMore.md +0 -150
  180. package/docs/reference/components/ui/Photo.md +0 -495
  181. package/docs/reference/components/ui/Popup.md +0 -56
  182. package/docs/reference/components/ui/ProgressBar.md +0 -32
  183. package/docs/reference/components/ui/QualityScore.md +0 -45
  184. package/docs/reference/components/ui/SearchBar.md +0 -63
  185. package/docs/reference/components/ui/SemanticsEditor.md +0 -113
  186. package/docs/reference/components/ui/SemanticsTable.md +0 -32
  187. package/docs/reference/components/ui/Switch.md +0 -49
  188. package/docs/reference/components/ui/TogglableGroup.md +0 -39
  189. package/docs/reference/components/ui/widgets/CopyCoordinates.md +0 -32
  190. package/docs/reference/components/ui/widgets/GeoSearch.md +0 -36
  191. package/docs/reference/components/ui/widgets/Legend.md +0 -58
  192. package/docs/reference/components/ui/widgets/LevelSelect.md +0 -16
  193. package/docs/reference/components/ui/widgets/MapFiltersButton.md +0 -37
  194. package/docs/reference/components/ui/widgets/MapLayersButton.md +0 -15
  195. package/docs/reference/components/ui/widgets/OSMEditors.md +0 -15
  196. package/docs/reference/components/ui/widgets/PictureLegendActions.md +0 -32
  197. package/docs/reference/components/ui/widgets/Player.md +0 -34
  198. package/docs/reference/components/ui/widgets/SemanticsFiltersButton.md +0 -15
  199. package/docs/reference/components/ui/widgets/Zoom.md +0 -15
  200. package/docs/reference/utils/API.md +0 -389
  201. package/docs/reference/utils/InitParameters.md +0 -68
  202. package/docs/reference/utils/MapStyleComposer.md +0 -408
  203. package/docs/reference/utils/PanoraMapProtocol.md +0 -28
  204. package/docs/reference/utils/PresetsManager.md +0 -43
  205. package/docs/reference/utils/SemanticsMapProtocol.md +0 -43
  206. package/docs/reference/utils/URLHandler.md +0 -114
  207. package/docs/reference.md +0 -99
  208. package/docs/shortcuts.md +0 -11
  209. package/docs/tutorials/aerial_imagery.md +0 -21
  210. package/docs/tutorials/authentication.md +0 -10
  211. package/docs/tutorials/custom_widgets.md +0 -59
  212. package/docs/tutorials/indoor_maps.md +0 -50
  213. package/docs/tutorials/map_style.md +0 -83
  214. package/docs/tutorials/migrate_v4.md +0 -153
  215. package/docs/tutorials/migrate_v5.md +0 -103
  216. package/docs/tutorials/semantics_overlays.md +0 -74
  217. package/docs/tutorials/synced_coverage.md +0 -43
  218. package/mkdocs.yml +0 -131
  219. package/public/editor.html +0 -53
  220. package/public/index.html +0 -70
  221. package/public/map.html +0 -55
  222. package/public/photo.html +0 -43
  223. package/public/servers.js +0 -15
  224. package/public/viewer.html +0 -79
  225. package/public/viewer_indoor.html +0 -48
  226. package/public/widgets.html +0 -366
  227. package/scripts/build.js +0 -217
  228. package/scripts/doc.js +0 -79
  229. package/scripts/start.js +0 -172
  230. package/scripts/test.js +0 -52
  231. package/src/components/core/index.js +0 -12
  232. package/src/components/index.js +0 -13
  233. package/src/components/index_photoviewer.js +0 -8
  234. package/src/components/layout/index.js +0 -9
  235. package/src/components/menus/index.js +0 -22
  236. package/src/components/menus/index_photoviewer.js +0 -13
  237. package/src/components/ui/index.js +0 -29
  238. package/src/components/ui/index_photoviewer.js +0 -23
  239. package/src/components/ui/widgets/index.js +0 -16
  240. package/src/components/ui/widgets/index_photoviewer.js +0 -9
  241. package/src/index.js +0 -8
  242. package/src/index_photoviewer.js +0 -6
  243. package/src/utils/index.js +0 -17
  244. package/src/utils/index_photoviewer.js +0 -16
  245. package/tests/components/core/Basic.test.js +0 -168
  246. package/tests/components/core/BasicMock.js +0 -25
  247. package/tests/components/core/CoverageMap.test.js +0 -20
  248. package/tests/components/core/Editor.test.js +0 -20
  249. package/tests/components/core/PhotoViewer.test.js +0 -57
  250. package/tests/components/core/Viewer.test.js +0 -85
  251. package/tests/components/core/__snapshots__/PhotoViewer.test.js.snap +0 -96
  252. package/tests/components/core/__snapshots__/Viewer.test.js.snap +0 -188
  253. package/tests/components/ui/CopyButton.test.js +0 -52
  254. package/tests/components/ui/Loader.test.js +0 -55
  255. package/tests/components/ui/Map.test.js +0 -145
  256. package/tests/components/ui/Photo.test.js +0 -437
  257. package/tests/components/ui/Popup.test.js +0 -26
  258. package/tests/components/ui/QualityScore.test.js +0 -18
  259. package/tests/components/ui/SearchBar.test.js +0 -110
  260. package/tests/components/ui/__snapshots__/CopyButton.test.js.snap +0 -33
  261. package/tests/components/ui/__snapshots__/Loader.test.js.snap +0 -56
  262. package/tests/components/ui/__snapshots__/Map.test.js.snap +0 -16
  263. package/tests/components/ui/__snapshots__/Photo.test.js.snap +0 -263
  264. package/tests/components/ui/__snapshots__/Popup.test.js.snap +0 -29
  265. package/tests/components/ui/__snapshots__/QualityScore.test.js.snap +0 -11
  266. package/tests/components/ui/__snapshots__/SearchBar.test.js.snap +0 -65
  267. package/tests/data/Map_geocoder_ban.json +0 -36
  268. package/tests/data/Map_geocoder_nominatim.json +0 -41
  269. package/tests/data/Viewer_pictures_1.json +0 -148
  270. package/tests/setupTests.js +0 -5
  271. package/tests/utils/API.test.js +0 -752
  272. package/tests/utils/InitParameters.test.js +0 -599
  273. package/tests/utils/MapStyleComposer.test.js +0 -697
  274. package/tests/utils/PresetsManager.test.js +0 -123
  275. package/tests/utils/URLHandler.test.js +0 -587
  276. package/tests/utils/__snapshots__/API.test.js.snap +0 -40
  277. package/tests/utils/__snapshots__/MapStyleComposer.test.js.snap +0 -767
  278. package/tests/utils/__snapshots__/URLHandler.test.js.snap +0 -21
  279. package/tests/utils/__snapshots__/geocoder.test.js.snap +0 -37
  280. package/tests/utils/__snapshots__/map.test.js.snap +0 -1249
  281. package/tests/utils/__snapshots__/picture.test.js.snap +0 -327
  282. package/tests/utils/__snapshots__/widgets.test.js.snap +0 -19
  283. package/tests/utils/geocoder.test.js +0 -37
  284. package/tests/utils/i18n.test.js +0 -111
  285. package/tests/utils/map.test.js +0 -200
  286. package/tests/utils/picture.test.js +0 -745
  287. package/tests/utils/semantics.test.js +0 -174
  288. package/tests/utils/utils.test.js +0 -358
  289. package/tests/utils/widgets.test.js +0 -31
  290. /package/{src → build}/components/core/Basic.css +0 -0
  291. /package/{src → build}/components/core/CoverageMap.css +0 -0
  292. /package/{src → build}/components/core/Editor.css +0 -0
  293. /package/{src → build}/components/core/PhotoViewer.css +0 -0
  294. /package/{src → build}/components/core/Viewer.css +0 -0
  295. /package/{src → build}/components/ui/ButtonGroup.css +0 -0
  296. /package/{src → build}/components/ui/Map.css +0 -0
  297. /package/{src → build}/components/ui/Photo.css +0 -0
  298. /package/{src → build}/components/ui/ProgressBar.js +0 -0
  299. /package/{src → build}/components/ui/widgets/GeoSearch.css +0 -0
  300. /package/{src → build}/components/ui/widgets/LevelSelect.css +0 -0
  301. /package/{src → build}/components/ui/widgets/Player.css +0 -0
  302. /package/{public → build}/favicon.ico +0 -0
  303. /package/{src → build}/img/arrow_360.svg +0 -0
  304. /package/{src → build}/img/arrow_flat.svg +0 -0
  305. /package/{src → build}/img/bg_aerial.jpg +0 -0
  306. /package/{src → build}/img/bg_streets.jpg +0 -0
  307. /package/{src → build}/img/loader_base.jpg +0 -0
  308. /package/{src → build}/img/logo_dead.svg +0 -0
  309. /package/{src → build}/img/marker.svg +0 -0
  310. /package/{src → build}/img/marker_blue.svg +0 -0
  311. /package/{src → build}/img/osm.svg +0 -0
  312. /package/{src → build}/img/panoramax.svg +0 -0
  313. /package/{src → build}/img/switch_big.svg +0 -0
  314. /package/{src → build}/img/switch_mini.svg +0 -0
  315. /package/{src → build}/img/wd.svg +0 -0
  316. /package/{src → build}/translations/ar.json +0 -0
  317. /package/{src → build}/translations/be.json +0 -0
  318. /package/{src → build}/translations/br.json +0 -0
  319. /package/{src → build}/translations/cy.json +0 -0
  320. /package/{src → build}/translations/da.json +0 -0
  321. /package/{src → build}/translations/de.json +0 -0
  322. /package/{src → build}/translations/en.json +0 -0
  323. /package/{src → build}/translations/eo.json +0 -0
  324. /package/{src → build}/translations/es.json +0 -0
  325. /package/{src → build}/translations/fi.json +0 -0
  326. /package/{src → build}/translations/fr.json +0 -0
  327. /package/{src → build}/translations/hu.json +0 -0
  328. /package/{src → build}/translations/it.json +0 -0
  329. /package/{src → build}/translations/ja.json +0 -0
  330. /package/{src → build}/translations/ko.json +0 -0
  331. /package/{src → build}/translations/nl.json +0 -0
  332. /package/{src → build}/translations/nn.json +0 -0
  333. /package/{src → build}/translations/pl.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,495 +0,0 @@
1
- <a name="Panoramax.components.ui.Photo"></a>
2
-
3
- ## Panoramax.components.ui.Photo ⇐ <code>[photo-sphere-viewer.core.Viewer](https://photo-sphere-viewer.js.org/api/classes/Core.Viewer.html)</code>
4
- **Kind**: static class of <code>Panoramax.components.ui</code>
5
- **Extends**: <code>[photo-sphere-viewer.core.Viewer](https://photo-sphere-viewer.js.org/api/classes/Core.Viewer.html)</code>
6
- **Emits**: [<code>picture-loading</code>](#Panoramax.components.ui.Photo+event_picture-loading), [<code>picture-preview-started</code>](#Panoramax.components.ui.Photo+event_picture-preview-started), [<code>picture-preview-stopped</code>](#Panoramax.components.ui.Photo+event_picture-preview-stopped), [<code>view-rotated</code>](#Panoramax.components.ui.Photo+event_view-rotated), [<code>picture-loaded</code>](#Panoramax.components.ui.Photo+event_picture-loaded), [<code>picture-tiles-loaded</code>](#Panoramax.components.ui.Photo+event_picture-tiles-loaded), [<code>transition-duration-changed</code>](#Panoramax.components.ui.Photo+event_transition-duration-changed), [<code>sequence-playing</code>](#Panoramax.components.ui.Photo+event_sequence-playing), [<code>sequence-stopped</code>](#Panoramax.components.ui.Photo+event_sequence-stopped), [<code>pictures-navigation-changed</code>](#Panoramax.components.ui.Photo+event_pictures-navigation-changed), [<code>ready</code>](#Panoramax.components.ui.Photo+event_ready), [<code>annotations-toggled</code>](#Panoramax.components.ui.Photo+event_annotations-toggled), <code>Panoramax.components.ui.Photo#event:annotation-click</code>, [<code>annotation-focused</code>](#Panoramax.components.ui.Photo+event_annotation-focused), [<code>annotations-unfocused</code>](#Panoramax.components.ui.Photo+event_annotations-unfocused)
7
-
8
- * [.Photo](#Panoramax.components.ui.Photo) ⇐ <code>[photo-sphere-viewer.core.Viewer](https://photo-sphere-viewer.js.org/api/classes/Core.Viewer.html)</code>
9
- * [new Photo(parent, container, [options])](#new_Panoramax.components.ui.Photo_new)
10
- * [.getPictureMetadata()](#Panoramax.components.ui.Photo+getPictureMetadata) ⇒ <code>object</code>
11
- * [.getPictureId()](#Panoramax.components.ui.Photo+getPictureId) ⇒ <code>string</code> \| <code>null</code>
12
- * [.goToNextPicture()](#Panoramax.components.ui.Photo+goToNextPicture)
13
- * [.goToPrevPicture()](#Panoramax.components.ui.Photo+goToPrevPicture)
14
- * [.goToPosition(lat, lon)](#Panoramax.components.ui.Photo+goToPosition) ⇒ <code>Promise</code>
15
- * [.getXY()](#Panoramax.components.ui.Photo+getXY) ⇒ <code>object</code>
16
- * [.getXYZ()](#Panoramax.components.ui.Photo+getXYZ) ⇒ <code>object</code>
17
- * [.getPictureOriginalHeading()](#Panoramax.components.ui.Photo+getPictureOriginalHeading) ⇒ <code>number</code>
18
- * [.getPictureRelativeHeading()](#Panoramax.components.ui.Photo+getPictureRelativeHeading) ⇒ <code>number</code>
19
- * [.getRoadAbsoluteHeading()](#Panoramax.components.ui.Photo+getRoadAbsoluteHeading) ⇒ <code>number</code>
20
- * [.clearPictureMetadataCache()](#Panoramax.components.ui.Photo+clearPictureMetadataCache)
21
- * [.setXYZ(x, y, z)](#Panoramax.components.ui.Photo+setXYZ)
22
- * [.setHigherContrast(enable)](#Panoramax.components.ui.Photo+setHigherContrast)
23
- * [.getTransitionDuration()](#Panoramax.components.ui.Photo+getTransitionDuration) ⇒ <code>number</code>
24
- * [.setTransitionDuration(value)](#Panoramax.components.ui.Photo+setTransitionDuration)
25
- * [.showErrorOverlay(e, label, dissmisable)](#Panoramax.components.ui.Photo+showErrorOverlay)
26
- * [.playSequence()](#Panoramax.components.ui.Photo+playSequence)
27
- * [.stopSequence()](#Panoramax.components.ui.Photo+stopSequence)
28
- * [.isSequencePlaying()](#Panoramax.components.ui.Photo+isSequencePlaying) ⇒ <code>boolean</code>
29
- * [.toggleSequencePlaying()](#Panoramax.components.ui.Photo+toggleSequencePlaying)
30
- * [.getPicturesNavigation()](#Panoramax.components.ui.Photo+getPicturesNavigation) ⇒ <code>string</code>
31
- * [.setPicturesNavigation(pn)](#Panoramax.components.ui.Photo+setPicturesNavigation)
32
- * [.areAnnotationsVisible()](#Panoramax.components.ui.Photo+areAnnotationsVisible) ⇒ <code>boolean</code>
33
- * [.getSelectedAnnotations()](#Panoramax.components.ui.Photo+getSelectedAnnotations) ⇒ <code>Array.&lt;string&gt;</code>
34
- * [.toggleAllAnnotations(visible)](#Panoramax.components.ui.Photo+toggleAllAnnotations)
35
- * [.focusOnAnnotation(id, [blockFocus], [skipEvent])](#Panoramax.components.ui.Photo+focusOnAnnotation)
36
- * [.unfocusAnnotation([skipEvent], [skipBlocked])](#Panoramax.components.ui.Photo+unfocusAnnotation)
37
- * [.forceRefresh()](#Panoramax.components.ui.Photo+forceRefresh)
38
- * ["ready"](#Panoramax.components.ui.Photo+event_ready)
39
- * ["picture-loading"](#Panoramax.components.ui.Photo+event_picture-loading)
40
- * ["picture-preview-started"](#Panoramax.components.ui.Photo+event_picture-preview-started)
41
- * ["picture-preview-stopped"](#Panoramax.components.ui.Photo+event_picture-preview-stopped)
42
- * ["view-rotated"](#Panoramax.components.ui.Photo+event_view-rotated)
43
- * ["picture-loaded"](#Panoramax.components.ui.Photo+event_picture-loaded)
44
- * ["picture-tiles-loaded"](#Panoramax.components.ui.Photo+event_picture-tiles-loaded)
45
- * ["transition-duration-changed"](#Panoramax.components.ui.Photo+event_transition-duration-changed)
46
- * ["sequence-playing"](#Panoramax.components.ui.Photo+event_sequence-playing)
47
- * ["sequence-stopped"](#Panoramax.components.ui.Photo+event_sequence-stopped)
48
- * ["pictures-navigation-changed"](#Panoramax.components.ui.Photo+event_pictures-navigation-changed)
49
- * ["annotations-toggled"](#Panoramax.components.ui.Photo+event_annotations-toggled)
50
- * ["annotation-focused"](#Panoramax.components.ui.Photo+event_annotation-focused)
51
- * ["annotations-unfocused"](#Panoramax.components.ui.Photo+event_annotations-unfocused)
52
- * ["annotation-drawn"](#Panoramax.components.ui.Photo+event_annotation-drawn)
53
-
54
- <a name="new_Panoramax.components.ui.Photo_new"></a>
55
-
56
- ### new Photo(parent, container, [options])
57
- Photo is the component showing a single picture.
58
- It uses Photo Sphere Viewer as a basis, and pre-configure dialog with STAC API.
59
-
60
- Note that all functions of [PhotoSphereViewer Viewer class](https://photo-sphere-viewer.js.org/api/classes/core.viewer) are available as well.
61
-
62
-
63
- | Param | Type | Default | Description |
64
- | --- | --- | --- | --- |
65
- | parent | <code>Panoramax.components.core.basic</code> | | The parent view |
66
- | container | <code>Element</code> | | The DOM element to create into |
67
- | [options] | <code>object</code> | | The viewer options. Can be any of [Photo Sphere Viewer options](https://photo-sphere-viewer.js.org/guide/config.html#standard-options) |
68
- | [options.transitionDuration] | <code>number</code> | | The number of milliseconds the transition animation should be. |
69
- | [options.position] | <code>Array.&lt;number&gt;</code> | | Initial geographical coordinates (as [latitude, longitude]) to find picture nearby. Only used if no picture ID is set. |
70
- | [options.shouldGoFast] | <code>function</code> | | Function returning a boolean to indicate if we may skip loading HD images. |
71
- | [options.picturesNavigation] | <code>string</code> | <code>&quot;any&quot;</code> | The allowed pictures navigation ("any": no restriction, "seq": only pictures in same sequence, "pic": only selected picture) |
72
- | [options.displayAnnotations] | <code>boolean</code> | <code>false</code> | Should pictures annotations show up automatically if they are present ? Set to true to enable. |
73
-
74
- **Example**
75
- ```js
76
- const psv = new Panoramax.components.ui.Photo(viewer, psvNode, {transitionDuration: 500})
77
- ```
78
- <a name="Panoramax.components.ui.Photo+getPictureMetadata"></a>
79
-
80
- ### photo.getPictureMetadata() ⇒ <code>object</code>
81
- Access currently shown picture metadata
82
-
83
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
84
- **Returns**: <code>object</code> - Picture metadata
85
- <a name="Panoramax.components.ui.Photo+getPictureId"></a>
86
-
87
- ### photo.getPictureId() ⇒ <code>string</code> \| <code>null</code>
88
- Get current picture ID, or loading picture ID if any.
89
-
90
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
91
- **Returns**: <code>string</code> \| <code>null</code> - Picture ID (current or loading), or null if none is selected.
92
- <a name="Panoramax.components.ui.Photo+goToNextPicture"></a>
93
-
94
- ### photo.goToNextPicture()
95
- Displays next picture in current sequence (if any)
96
-
97
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
98
- **Throws**:
99
-
100
- - <code>Error</code> If no picture is selected, or no next picture available
101
-
102
- <a name="Panoramax.components.ui.Photo+goToPrevPicture"></a>
103
-
104
- ### photo.goToPrevPicture()
105
- Displays previous picture in current sequence (if any)
106
-
107
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
108
- **Throws**:
109
-
110
- - <code>Error</code> If no picture is selected, or no previous picture available
111
-
112
- <a name="Panoramax.components.ui.Photo+goToPosition"></a>
113
-
114
- ### photo.goToPosition(lat, lon) ⇒ <code>Promise</code>
115
- Displays in viewer a picture near to given coordinates
116
-
117
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
118
- **Fulfil**: <code>string</code> Picture ID if picture found
119
- **Reject**: <code>Error</code> If no picture found
120
-
121
- | Param | Type | Description |
122
- | --- | --- | --- |
123
- | lat | <code>number</code> | Latitude (WGS84) |
124
- | lon | <code>number</code> | Longitude (WGS84) |
125
-
126
- <a name="Panoramax.components.ui.Photo+getXY"></a>
127
-
128
- ### photo.getXY() ⇒ <code>object</code>
129
- Get 2D position of sphere currently shown to user
130
-
131
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
132
- **Returns**: <code>object</code> - Position in format { x: heading in degrees (0° = North, 90° = East, 180° = South, 270° = West), y: top/bottom position in degrees (-90° = bottom, 0° = front, 90° = top) }
133
- <a name="Panoramax.components.ui.Photo+getXYZ"></a>
134
-
135
- ### photo.getXYZ() ⇒ <code>object</code>
136
- Get 3D position of sphere currently shown to user
137
-
138
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
139
- **Returns**: <code>object</code> - Position in format { x: heading in degrees (0° = North, 90° = East, 180° = South, 270° = West), y: top/bottom position in degrees (-90° = bottom, 0° = front, 90° = top), z: zoom (0 = wide, 100 = zoomed in) }
140
- <a name="Panoramax.components.ui.Photo+getPictureOriginalHeading"></a>
141
-
142
- ### photo.getPictureOriginalHeading() ⇒ <code>number</code>
143
- Get capture orientation of current picture, based on its GPS.
144
-
145
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
146
- **Returns**: <code>number</code> - Picture original heading in degrees (0 to 360°)
147
- <a name="Panoramax.components.ui.Photo+getPictureRelativeHeading"></a>
148
-
149
- ### photo.getPictureRelativeHeading() ⇒ <code>number</code>
150
- Computes the relative heading of currently selected picture.
151
- This gives the angle of capture compared to sequence path (vehicle movement).
152
-
153
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
154
- **Returns**: <code>number</code> - Relative heading in degrees (-180 to 180)
155
- <a name="Panoramax.components.ui.Photo+getRoadAbsoluteHeading"></a>
156
-
157
- ### photo.getRoadAbsoluteHeading() ⇒ <code>number</code>
158
- Computes the absolute heading of the road (ie sequence around selected picutre).
159
-
160
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
161
- **Returns**: <code>number</code> - Absolute heading in degrees (0 to 360)
162
- <a name="Panoramax.components.ui.Photo+clearPictureMetadataCache"></a>
163
-
164
- ### photo.clearPictureMetadataCache()
165
- Clears the Photo Sphere Viewer metadata cache.
166
- It is useful when current picture or sequence has changed server-side after first load.
167
-
168
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
169
- <a name="Panoramax.components.ui.Photo+setXYZ"></a>
170
-
171
- ### photo.setXYZ(x, y, z)
172
- Change the shown position in picture
173
-
174
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
175
-
176
- | Param | Type | Description |
177
- | --- | --- | --- |
178
- | x | <code>number</code> | X position (in degrees) |
179
- | y | <code>number</code> | Y position (in degrees) |
180
- | z | <code>number</code> | Z position (0-100) |
181
-
182
- <a name="Panoramax.components.ui.Photo+setHigherContrast"></a>
183
-
184
- ### photo.setHigherContrast(enable)
185
- Enable or disable higher contrast on picture
186
-
187
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
188
-
189
- | Param | Type | Description |
190
- | --- | --- | --- |
191
- | enable | <code>boolean</code> | True to enable higher contrast |
192
-
193
- <a name="Panoramax.components.ui.Photo+getTransitionDuration"></a>
194
-
195
- ### photo.getTransitionDuration() ⇒ <code>number</code>
196
- Get the duration of stay on a picture during a sequence play.
197
-
198
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
199
- **Returns**: <code>number</code> - The duration (in milliseconds)
200
- <a name="Panoramax.components.ui.Photo+setTransitionDuration"></a>
201
-
202
- ### photo.setTransitionDuration(value)
203
- Changes the duration of stay on a picture during a sequence play.
204
-
205
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
206
-
207
- | Param | Type | Description |
208
- | --- | --- | --- |
209
- | value | <code>number</code> | The new duration (in milliseconds, between 100 and 3000) |
210
-
211
- <a name="Panoramax.components.ui.Photo+showErrorOverlay"></a>
212
-
213
- ### photo.showErrorOverlay(e, label, dissmisable)
214
- Display an error message to user on screen
215
-
216
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
217
-
218
- | Param | Type | Description |
219
- | --- | --- | --- |
220
- | e | <code>object</code> | The initial error |
221
- | label | <code>str</code> | The main error label to display |
222
- | dissmisable | <code>boolean</code> | Is error dissmisable |
223
-
224
- <a name="Panoramax.components.ui.Photo+playSequence"></a>
225
-
226
- ### photo.playSequence()
227
- Goes continuously to next picture in sequence as long as possible
228
-
229
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
230
- <a name="Panoramax.components.ui.Photo+stopSequence"></a>
231
-
232
- ### photo.stopSequence()
233
- Stops playing current sequence
234
-
235
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
236
- <a name="Panoramax.components.ui.Photo+isSequencePlaying"></a>
237
-
238
- ### photo.isSequencePlaying() ⇒ <code>boolean</code>
239
- Is there any sequence being played right now ?
240
-
241
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
242
- **Returns**: <code>boolean</code> - True if sequence is playing
243
- <a name="Panoramax.components.ui.Photo+toggleSequencePlaying"></a>
244
-
245
- ### photo.toggleSequencePlaying()
246
- Starts/stops the reading of pictures in a sequence
247
-
248
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
249
- <a name="Panoramax.components.ui.Photo+getPicturesNavigation"></a>
250
-
251
- ### photo.getPicturesNavigation() ⇒ <code>string</code>
252
- Get current pictures navigation mode.
253
-
254
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
255
- **Returns**: <code>string</code> - The picture navigation mode ("any": no restriction, "seq": only pictures in same sequence, "pic": only selected picture)
256
- <a name="Panoramax.components.ui.Photo+setPicturesNavigation"></a>
257
-
258
- ### photo.setPicturesNavigation(pn)
259
- Switch the allowed navigation between pictures.
260
-
261
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
262
-
263
- | Param | Type | Description |
264
- | --- | --- | --- |
265
- | pn | <code>string</code> | The picture navigation mode ("any": no restriction, "seq": only pictures in same sequence, "pic": only selected picture) |
266
-
267
- <a name="Panoramax.components.ui.Photo+areAnnotationsVisible"></a>
268
-
269
- ### photo.areAnnotationsVisible() ⇒ <code>boolean</code>
270
- Are there any picture annotations shown ?
271
-
272
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
273
- **Returns**: <code>boolean</code> - True if annotations are visible
274
- <a name="Panoramax.components.ui.Photo+getSelectedAnnotations"></a>
275
-
276
- ### photo.getSelectedAnnotations() ⇒ <code>Array.&lt;string&gt;</code>
277
- Get all selected annotations
278
-
279
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
280
- **Returns**: <code>Array.&lt;string&gt;</code> - List of selected annotations IDs
281
- <a name="Panoramax.components.ui.Photo+toggleAllAnnotations"></a>
282
-
283
- ### photo.toggleAllAnnotations(visible)
284
- Toggle visibility of picture annotations
285
-
286
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
287
-
288
- | Param | Type | Description |
289
- | --- | --- | --- |
290
- | visible | <code>boolean</code> | True to make visible, false to hide |
291
-
292
- <a name="Panoramax.components.ui.Photo+focusOnAnnotation"></a>
293
-
294
- ### photo.focusOnAnnotation(id, [blockFocus], [skipEvent])
295
- Make view centered and zoomed on given annotation.
296
-
297
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
298
-
299
- | Param | Type | Default | Description |
300
- | --- | --- | --- | --- |
301
- | id | <code>string</code> | | The annotation UUID |
302
- | [blockFocus] | <code>boolean</code> | <code>false</code> | Set to true to disable user unselect |
303
- | [skipEvent] | <code>boolean</code> | <code>false</code> | Set to true to avoid launching annotation-focused event |
304
-
305
- <a name="Panoramax.components.ui.Photo+unfocusAnnotation"></a>
306
-
307
- ### photo.unfocusAnnotation([skipEvent], [skipBlocked])
308
- Remove focus styling on annotations.
309
-
310
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
311
-
312
- | Param | Type | Default | Description |
313
- | --- | --- | --- | --- |
314
- | [skipEvent] | <code>boolean</code> | <code>false</code> | Set to true to avoid launching annotations-unfocused event |
315
- | [skipBlocked] | <code>boolean</code> | <code>false</code> | Set to true to not unfocus blocked annotations |
316
-
317
- <a name="Panoramax.components.ui.Photo+forceRefresh"></a>
318
-
319
- ### photo.forceRefresh()
320
- Force reload of texture and tiles.
321
-
322
- **Kind**: instance method of [<code>Photo</code>](#Panoramax.components.ui.Photo)
323
- <a name="Panoramax.components.ui.Photo+event_ready"></a>
324
-
325
- ### "ready"
326
- Triggered once when the panorama image has been loaded and the viewer is ready to perform the first render.
327
-
328
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
329
- **See**: [Photo Sphere Viewer documentation](https://photo-sphere-viewer.js.org/guide/events.html#ready)
330
- <a name="Panoramax.components.ui.Photo+event_picture-loading"></a>
331
-
332
- ### "picture-loading"
333
- Event for picture starting to load
334
-
335
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
336
- **Properties**
337
-
338
- | Name | Type | Description |
339
- | --- | --- | --- |
340
- | detail.picId | <code>string</code> | The picture unique identifier |
341
- | detail.lon | <code>number</code> | Longitude (WGS84) |
342
- | detail.lat | <code>number</code> | Latitude (WGS84) |
343
- | detail.x | <code>number</code> | New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West) |
344
- | detail.y | <code>number</code> | New y position (in degrees) |
345
- | detail.z | <code>number</code> | New z position (0-100) |
346
- | detail.first | <code>boolean</code> | True if first picture loaded |
347
-
348
- <a name="Panoramax.components.ui.Photo+event_picture-preview-started"></a>
349
-
350
- ### "picture-preview-started"
351
- Event for picture preview
352
-
353
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
354
- **Properties**
355
-
356
- | Name | Type | Description |
357
- | --- | --- | --- |
358
- | detail.picId | <code>string</code> | The picture ID |
359
- | detail.coordinates | <code>Array.&lt;number&gt;</code> | [x,y] coordinates |
360
- | detail.direction | <code>number</code> | The theoretical picture orientation |
361
-
362
- <a name="Panoramax.components.ui.Photo+event_picture-preview-stopped"></a>
363
-
364
- ### "picture-preview-stopped"
365
- Event for end of picture preview
366
-
367
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
368
- **Properties**
369
-
370
- | Name | Type | Description |
371
- | --- | --- | --- |
372
- | detail.picId | <code>string</code> | The picture ID |
373
-
374
- <a name="Panoramax.components.ui.Photo+event_view-rotated"></a>
375
-
376
- ### "view-rotated"
377
- Event for viewer rotation
378
-
379
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
380
- **Properties**
381
-
382
- | Name | Type | Description |
383
- | --- | --- | --- |
384
- | detail.x | <code>number</code> | New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West) |
385
- | detail.y | <code>number</code> | New y position (in degrees) |
386
- | detail.z | <code>number</code> | New Z position (between 0 and 100) |
387
-
388
- <a name="Panoramax.components.ui.Photo+event_picture-loaded"></a>
389
-
390
- ### "picture-loaded"
391
- Event for picture load (low-resolution image is loaded)
392
-
393
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
394
- **Properties**
395
-
396
- | Name | Type | Description |
397
- | --- | --- | --- |
398
- | detail.picId | <code>string</code> | The picture unique identifier |
399
- | detail.lon | <code>number</code> | Longitude (WGS84) |
400
- | detail.lat | <code>number</code> | Latitude (WGS84) |
401
- | detail.x | <code>number</code> | New x position (in degrees, 0-360), corresponds to heading (0° = North, 90° = East, 180° = South, 270° = West) |
402
- | detail.y | <code>number</code> | New y position (in degrees) |
403
- | detail.z | <code>number</code> | New z position (0-100) |
404
- | detail.first | <code>boolean</code> | True if first picture loaded |
405
-
406
- <a name="Panoramax.components.ui.Photo+event_picture-tiles-loaded"></a>
407
-
408
- ### "picture-tiles-loaded"
409
- Event launched when all visible tiles of a picture are loaded
410
-
411
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
412
- **Properties**
413
-
414
- | Name | Type | Description |
415
- | --- | --- | --- |
416
- | detail.picId | <code>string</code> | The picture unique identifier |
417
-
418
- <a name="Panoramax.components.ui.Photo+event_transition-duration-changed"></a>
419
-
420
- ### "transition-duration-changed"
421
- Event for transition duration change
422
-
423
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
424
- **Properties**
425
-
426
- | Name | Type | Description |
427
- | --- | --- | --- |
428
- | detail.duration | <code>string</code> | New duration (in milliseconds) |
429
-
430
- <a name="Panoramax.components.ui.Photo+event_sequence-playing"></a>
431
-
432
- ### "sequence-playing"
433
- Event for sequence starting to play
434
-
435
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
436
- <a name="Panoramax.components.ui.Photo+event_sequence-stopped"></a>
437
-
438
- ### "sequence-stopped"
439
- Event for sequence stopped playing
440
-
441
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
442
- <a name="Panoramax.components.ui.Photo+event_pictures-navigation-changed"></a>
443
-
444
- ### "pictures-navigation-changed"
445
- Event for pictures navigation mode change
446
-
447
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
448
- **Properties**
449
-
450
- | Name | Type | Description |
451
- | --- | --- | --- |
452
- | detail.value | <code>string</code> | New mode (any, pic, seq) |
453
-
454
- <a name="Panoramax.components.ui.Photo+event_annotations-toggled"></a>
455
-
456
- ### "annotations-toggled"
457
- Event for pictures annotation visibility change
458
-
459
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
460
- **Properties**
461
-
462
- | Name | Type | Description |
463
- | --- | --- | --- |
464
- | detail.visible | <code>boolean</code> | True if they are visible |
465
-
466
- <a name="Panoramax.components.ui.Photo+event_annotation-focused"></a>
467
-
468
- ### "annotation-focused"
469
- Event launched on annotation focus
470
-
471
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
472
- **Properties**
473
-
474
- | Name | Type | Description |
475
- | --- | --- | --- |
476
- | detail.annotationId | <code>string</code> | The annotation UUID |
477
-
478
- <a name="Panoramax.components.ui.Photo+event_annotations-unfocused"></a>
479
-
480
- ### "annotations-unfocused"
481
- Event for pictures annotation unfocus
482
-
483
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
484
- <a name="Panoramax.components.ui.Photo+event_annotation-drawn"></a>
485
-
486
- ### "annotation-drawn"
487
- Event for annotation drawn
488
-
489
- **Kind**: event emitted by [<code>Photo</code>](#Panoramax.components.ui.Photo)
490
- **Properties**
491
-
492
- | Name | Type | Description |
493
- | --- | --- | --- |
494
- | detail.shape | <code>string</code> | The annotation geometry, or null if latest draw is invalid |
495
-
@@ -1,56 +0,0 @@
1
- <a name="Panoramax.components.ui.Popup"></a>
2
-
3
- ## Panoramax.components.ui.Popup ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.ui</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Emits**: [<code>open</code>](#Panoramax.components.ui.Popup+event_open), [<code>close</code>](#Panoramax.components.ui.Popup+event_close)
7
- **Element**: pnx-popup
8
-
9
- * [.Popup](#Panoramax.components.ui.Popup) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
10
- * [new Popup()](#new_Panoramax.components.ui.Popup_new)
11
- * [.properties](#Panoramax.components.ui.Popup+properties) : <code>Object</code>
12
- * [.close()](#Panoramax.components.ui.Popup+close)
13
- * ["open"](#Panoramax.components.ui.Popup+event_open)
14
- * ["close"](#Panoramax.components.ui.Popup+event_close)
15
-
16
- <a name="new_Panoramax.components.ui.Popup_new"></a>
17
-
18
- ### new Popup()
19
- Popup Element displays a full overlay container.
20
-
21
- **Example**
22
- ```html
23
- <pnx-popup @close=${() => alert("closed")}>
24
- <h3>Popup content</h3>
25
- </pnx-popup>
26
- ```
27
- <a name="Panoramax.components.ui.Popup+properties"></a>
28
-
29
- ### popup.properties : <code>Object</code>
30
- Component properties.
31
-
32
- **Kind**: instance property of [<code>Popup</code>](#Panoramax.components.ui.Popup)
33
- **Properties**
34
-
35
- | Name | Type | Default | Description |
36
- | --- | --- | --- | --- |
37
- | [visible] | <code>boolean</code> | <code>true</code> | Is the popup visible to user ? |
38
-
39
- <a name="Panoramax.components.ui.Popup+close"></a>
40
-
41
- ### popup.close()
42
- Close popup
43
-
44
- **Kind**: instance method of [<code>Popup</code>](#Panoramax.components.ui.Popup)
45
- <a name="Panoramax.components.ui.Popup+event_open"></a>
46
-
47
- ### "open"
48
- Event for popup opening
49
-
50
- **Kind**: event emitted by [<code>Popup</code>](#Panoramax.components.ui.Popup)
51
- <a name="Panoramax.components.ui.Popup+event_close"></a>
52
-
53
- ### "close"
54
- Event for popup closing
55
-
56
- **Kind**: event emitted by [<code>Popup</code>](#Panoramax.components.ui.Popup)
@@ -1,32 +0,0 @@
1
- <a name="Panoramax.components.ui.ProgressBar"></a>
2
-
3
- ## Panoramax.components.ui.ProgressBar ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.ui</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Element**: pnx-progress-bar
7
-
8
- * [.ProgressBar](#Panoramax.components.ui.ProgressBar) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
9
- * [new ProgressBar()](#new_Panoramax.components.ui.ProgressBar_new)
10
- * [.properties](#Panoramax.components.ui.ProgressBar+properties) : <code>Object</code>
11
-
12
- <a name="new_Panoramax.components.ui.ProgressBar_new"></a>
13
-
14
- ### new ProgressBar()
15
- Progress bar with nice styling.
16
-
17
- **Example**
18
- ```html
19
- <pnx-loader value="42" ._t=${viewer._t} />
20
- ```
21
- <a name="Panoramax.components.ui.ProgressBar+properties"></a>
22
-
23
- ### progressBar.properties : <code>Object</code>
24
- Component properties.
25
-
26
- **Kind**: instance property of [<code>ProgressBar</code>](#Panoramax.components.ui.ProgressBar)
27
- **Properties**
28
-
29
- | Name | Type | Description |
30
- | --- | --- | --- |
31
- | [value] | <code>number</code> | Progress bar percentage (0-100) or empty for indeterminate state |
32
-
@@ -1,45 +0,0 @@
1
- <a name="Panoramax.components.ui.QualityScore"></a>
2
-
3
- ## Panoramax.components.ui.QualityScore ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
4
- **Kind**: static class of <code>Panoramax.components.ui</code>
5
- **Extends**: <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
6
- **Emits**: [<code>change</code>](#Panoramax.components.ui.QualityScore+event_change)
7
- **Element**: pnx-quality-score
8
-
9
- * [.QualityScore](#Panoramax.components.ui.QualityScore) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
10
- * [new QualityScore()](#new_Panoramax.components.ui.QualityScore_new)
11
- * [.properties](#Panoramax.components.ui.QualityScore+properties) : <code>Object</code>
12
- * ["change"](#Panoramax.components.ui.QualityScore+event_change)
13
-
14
- <a name="new_Panoramax.components.ui.QualityScore_new"></a>
15
-
16
- ### new QualityScore()
17
- Quality Score element displays the picture quality grade.
18
-
19
- **Example**
20
- ```html
21
- <!-- Read-only -->
22
- <pnx-quality-score grade="5" ._t=${viewer._t} />
23
-
24
- <!-- Input -->
25
- <pnx-quality-score grade="5" input="pnx-qs-input" @change=${() => alert('changed')} ._t=${viewer._t} />
26
- ```
27
- <a name="Panoramax.components.ui.QualityScore+properties"></a>
28
-
29
- ### qualityScore.properties : <code>Object</code>
30
- Component properties.
31
-
32
- **Kind**: instance property of [<code>QualityScore</code>](#Panoramax.components.ui.QualityScore)
33
- **Properties**
34
-
35
- | Name | Type | Default | Description |
36
- | --- | --- | --- | --- |
37
- | [grade] | <code>number</code> \| <code>string</code> | <code>0</code> | The grade (5=A, 1=E, 0=none selected), or a list of grades |
38
- | [input] | <code>string</code> | <code>false</code> | If set, score is an input and value is used as ID prefix |
39
-
40
- <a name="Panoramax.components.ui.QualityScore+event_change"></a>
41
-
42
- ### "change"
43
- Event for grade change
44
-
45
- **Kind**: event emitted by [<code>QualityScore</code>](#Panoramax.components.ui.QualityScore)