@panoramax/web-viewer 4.4.0-develop-3839b5a4 → 4.4.0-develop-f91f6758
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/{src → build}/components/core/Basic.js +22 -16
- package/{src → build}/components/core/CoverageMap.js +19 -14
- package/{src → build}/components/core/Editor.js +16 -16
- package/{src → build}/components/core/PhotoViewer.js +30 -29
- package/{src → build}/components/core/Viewer.js +21 -20
- package/build/components/core/index.js +10 -0
- package/build/components/index.js +11 -0
- package/build/components/index_photoviewer.js +6 -0
- package/{src → build}/components/layout/BottomDrawer.js +4 -4
- package/{src → build}/components/layout/CorneredGrid.js +1 -1
- package/{src → build}/components/layout/Mini.js +5 -4
- package/{src → build}/components/layout/Tabs.js +1 -1
- package/build/components/layout/index.js +9 -0
- package/{src → build}/components/menus/LocationPrecisionDoc.js +4 -6
- package/{src → build}/components/menus/MapBackground.js +4 -6
- package/{src → build}/components/menus/MapFilters.js +16 -21
- package/{src → build}/components/menus/MapLayers.js +20 -24
- package/{src → build}/components/menus/MapLegend.js +3 -4
- package/{src → build}/components/menus/MiniPictureLegend.js +3 -4
- package/{src → build}/components/menus/PictureLegend.js +10 -15
- package/{src → build}/components/menus/PictureMetadata.js +12 -19
- package/{src → build}/components/menus/PlayerOptions.js +5 -7
- package/{src → build}/components/menus/QualityScoreDoc.js +3 -4
- package/{src → build}/components/menus/ReportForm.js +8 -9
- package/{src → build}/components/menus/SemanticsDoc.js +3 -4
- package/{src → build}/components/menus/SemanticsDownload.js +3 -3
- package/{src → build}/components/menus/SemanticsFilters.js +7 -8
- package/{src → build}/components/menus/SemanticsList.js +11 -18
- package/{src → build}/components/menus/SemanticsMetadata.js +8 -11
- package/{src → build}/components/menus/Share.js +6 -7
- package/build/components/menus/index.js +22 -0
- package/build/components/menus/index_photoviewer.js +11 -0
- package/{src → build}/components/styles.js +0 -2
- package/{src → build}/components/ui/AnnotationsSwitch.js +6 -8
- package/{src → build}/components/ui/Button.js +1 -1
- package/{src → build}/components/ui/ButtonGroup.js +2 -1
- package/{src → build}/components/ui/CopyButton.js +4 -6
- package/{src → build}/components/ui/Grade.js +5 -5
- package/{src → build}/components/ui/GradeFilter.js +3 -3
- package/{src → build}/components/ui/IconSwitch.js +1 -1
- package/{src → build}/components/ui/LinkButton.js +1 -1
- package/{src → build}/components/ui/ListGroup.js +3 -3
- package/{src → build}/components/ui/ListItem.js +1 -1
- package/{src → build}/components/ui/Loader.js +8 -7
- package/{src → build}/components/ui/Map.js +38 -26
- package/{src → build}/components/ui/MapMore.js +7 -7
- package/{src → build}/components/ui/Photo.js +29 -27
- package/{src → build}/components/ui/Popup.js +4 -4
- package/{src → build}/components/ui/QualityScore.js +4 -4
- package/{src → build}/components/ui/SearchBar.js +6 -7
- package/{src → build}/components/ui/SemanticsEditor.js +14 -15
- package/{src → build}/components/ui/SemanticsTable.js +4 -5
- package/{src → build}/components/ui/Switch.js +1 -1
- package/{src → build}/components/ui/TogglableGroup.js +4 -4
- package/build/components/ui/index.js +29 -0
- package/build/components/ui/index_photoviewer.js +21 -0
- package/{src → build}/components/ui/widgets/CopyCoordinates.js +5 -5
- package/{src → build}/components/ui/widgets/GeoSearch.js +10 -10
- package/{src → build}/components/ui/widgets/Legend.js +9 -8
- package/{src → build}/components/ui/widgets/LevelSelect.js +9 -7
- package/{src → build}/components/ui/widgets/MapFiltersButton.js +5 -5
- package/{src → build}/components/ui/widgets/MapLayersButton.js +5 -5
- package/{src → build}/components/ui/widgets/OSMEditors.js +8 -8
- package/{src → build}/components/ui/widgets/PictureLegendActions.js +4 -4
- package/{src → build}/components/ui/widgets/Player.js +6 -7
- package/{src → build}/components/ui/widgets/SemanticsFiltersButton.js +6 -7
- package/{src → build}/components/ui/widgets/Zoom.js +6 -6
- package/build/components/ui/widgets/index.js +16 -0
- package/build/components/ui/widgets/index_photoviewer.js +7 -0
- package/build/editor.html +94 -10
- package/{src → build}/img/arrow_triangle.svg +0 -1
- package/{src → build}/img/arrow_turn.svg +0 -1
- package/build/index.html +111 -1
- package/build/index.js +6 -95
- package/build/index_photoviewer.js +4 -0
- package/build/map.html +97 -1
- package/build/package.json +141 -0
- package/build/photo.html +85 -1
- package/build/servers.js +3 -4
- package/{src → build}/utils/API.js +33 -33
- package/{src → build}/utils/InitParameters.js +11 -9
- package/{src → build}/utils/MapStyleComposer.js +39 -37
- package/{src → build}/utils/PhotoAdapter.js +1 -0
- package/{src → build}/utils/PresetsManager.js +4 -4
- package/{src → build}/utils/SemanticsMapProtocol.js +3 -4
- package/{src → build}/utils/URLHandler.js +16 -14
- package/{src → build}/utils/geocoder.js +5 -5
- package/{src → build}/utils/i18n.js +21 -20
- package/build/utils/index.js +17 -0
- package/build/utils/index_photoviewer.js +14 -0
- package/{src → build}/utils/indoor.js +9 -5
- package/{src → build}/utils/map.js +15 -11
- package/{src → build}/utils/picture.js +22 -17
- package/{src → build}/utils/semantics.js +9 -5
- package/{src → build}/utils/utils.js +8 -4
- package/{src → build}/utils/widgets.js +2 -2
- package/build/viewer.html +120 -35
- package/build/viewer_indoor.html +90 -8
- package/build/widgets.html +410 -1
- package/package.json +81 -204
- package/.dockerignore +0 -7
- package/.gitlab-ci.yml +0 -78
- package/CHANGELOG.md +0 -853
- package/CODE_OF_CONDUCT.md +0 -134
- package/Dockerfile +0 -14
- package/build/index.css +0 -36
- package/build/index.css.map +0 -1
- package/build/index.js.map +0 -1
- package/build/photoviewer.css +0 -36
- package/build/photoviewer.css.map +0 -1
- package/build/photoviewer.js +0 -86
- package/build/photoviewer.js.map +0 -1
- package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff +0 -0
- package/build/static/media/atkinson-hyperlegible-next-latin-400-normal..woff2 +0 -0
- package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff +0 -0
- package/build/static/media/atkinson-hyperlegible-next-latin-ext-400-normal..woff2 +0 -0
- package/config/env.js +0 -104
- package/config/getHttpsConfig.js +0 -69
- package/config/getPackageJson.js +0 -25
- package/config/jest/babelTransform.js +0 -29
- package/config/jest/cssTransform.js +0 -14
- package/config/jest/fileTransform.js +0 -40
- package/config/jest/mocks.js +0 -230
- package/config/modules.js +0 -134
- package/config/paths.js +0 -76
- package/config/pnpTs.js +0 -35
- package/config/webpack/persistentCache/createEnvironmentHash.js +0 -9
- package/config/webpack.config.js +0 -825
- package/config/webpackDevServer.config.js +0 -131
- package/docs/03_URL_settings.md +0 -218
- package/docs/05_Compatibility.md +0 -83
- package/docs/09_Develop.md +0 -141
- package/docs/90_Releases.md +0 -27
- package/docs/images/class_diagram.drawio +0 -144
- package/docs/images/class_diagram.jpg +0 -0
- package/docs/images/comparative_3drender.jpg +0 -0
- package/docs/images/indoor_level.png +0 -0
- package/docs/images/screenshot.jpg +0 -0
- package/docs/index.md +0 -159
- package/docs/reference/components/core/Basic.md +0 -211
- package/docs/reference/components/core/CoverageMap.md +0 -220
- package/docs/reference/components/core/Editor.md +0 -252
- package/docs/reference/components/core/PhotoViewer.md +0 -320
- package/docs/reference/components/core/Viewer.md +0 -398
- package/docs/reference/components/layout/BottomDrawer.md +0 -35
- package/docs/reference/components/layout/CorneredGrid.md +0 -29
- package/docs/reference/components/layout/Mini.md +0 -45
- package/docs/reference/components/layout/Tabs.md +0 -46
- package/docs/reference/components/menus/LocationPrecisionDoc.md +0 -15
- package/docs/reference/components/menus/MapBackground.md +0 -32
- package/docs/reference/components/menus/MapFilters.md +0 -37
- package/docs/reference/components/menus/MapLayers.md +0 -15
- package/docs/reference/components/menus/MapLegend.md +0 -32
- package/docs/reference/components/menus/MiniPictureLegend.md +0 -15
- package/docs/reference/components/menus/PictureLegend.md +0 -45
- package/docs/reference/components/menus/PictureMetadata.md +0 -32
- package/docs/reference/components/menus/PlayerOptions.md +0 -15
- package/docs/reference/components/menus/QualityScoreDoc.md +0 -15
- package/docs/reference/components/menus/ReportForm.md +0 -15
- package/docs/reference/components/menus/SemanticsDoc.md +0 -15
- package/docs/reference/components/menus/SemanticsDownload.md +0 -15
- package/docs/reference/components/menus/SemanticsFilters.md +0 -33
- package/docs/reference/components/menus/SemanticsList.md +0 -97
- package/docs/reference/components/menus/SemanticsMetadata.md +0 -15
- package/docs/reference/components/menus/ShareMenu.md +0 -32
- package/docs/reference/components/ui/AnnotationsSwitch.md +0 -32
- package/docs/reference/components/ui/Button.md +0 -40
- package/docs/reference/components/ui/ButtonGroup.md +0 -36
- package/docs/reference/components/ui/CopyButton.md +0 -41
- package/docs/reference/components/ui/Grade.md +0 -32
- package/docs/reference/components/ui/GradeFilter.md +0 -42
- package/docs/reference/components/ui/IconSwitch.md +0 -53
- package/docs/reference/components/ui/LinkButton.md +0 -45
- package/docs/reference/components/ui/ListGroup.md +0 -22
- package/docs/reference/components/ui/ListItem.md +0 -39
- package/docs/reference/components/ui/Loader.md +0 -56
- package/docs/reference/components/ui/Map.md +0 -150
- package/docs/reference/components/ui/MapMore.md +0 -150
- package/docs/reference/components/ui/Photo.md +0 -495
- package/docs/reference/components/ui/Popup.md +0 -56
- package/docs/reference/components/ui/ProgressBar.md +0 -32
- package/docs/reference/components/ui/QualityScore.md +0 -45
- package/docs/reference/components/ui/SearchBar.md +0 -63
- package/docs/reference/components/ui/SemanticsEditor.md +0 -113
- package/docs/reference/components/ui/SemanticsTable.md +0 -32
- package/docs/reference/components/ui/Switch.md +0 -49
- package/docs/reference/components/ui/TogglableGroup.md +0 -39
- package/docs/reference/components/ui/widgets/CopyCoordinates.md +0 -32
- package/docs/reference/components/ui/widgets/GeoSearch.md +0 -36
- package/docs/reference/components/ui/widgets/Legend.md +0 -58
- package/docs/reference/components/ui/widgets/LevelSelect.md +0 -16
- package/docs/reference/components/ui/widgets/MapFiltersButton.md +0 -37
- package/docs/reference/components/ui/widgets/MapLayersButton.md +0 -15
- package/docs/reference/components/ui/widgets/OSMEditors.md +0 -15
- package/docs/reference/components/ui/widgets/PictureLegendActions.md +0 -32
- package/docs/reference/components/ui/widgets/Player.md +0 -34
- package/docs/reference/components/ui/widgets/SemanticsFiltersButton.md +0 -15
- package/docs/reference/components/ui/widgets/Zoom.md +0 -15
- package/docs/reference/utils/API.md +0 -389
- package/docs/reference/utils/InitParameters.md +0 -68
- package/docs/reference/utils/MapStyleComposer.md +0 -408
- package/docs/reference/utils/PanoraMapProtocol.md +0 -28
- package/docs/reference/utils/PresetsManager.md +0 -43
- package/docs/reference/utils/SemanticsMapProtocol.md +0 -43
- package/docs/reference/utils/URLHandler.md +0 -114
- package/docs/reference.md +0 -99
- package/docs/shortcuts.md +0 -11
- package/docs/tutorials/aerial_imagery.md +0 -21
- package/docs/tutorials/authentication.md +0 -10
- package/docs/tutorials/custom_widgets.md +0 -59
- package/docs/tutorials/indoor_maps.md +0 -50
- package/docs/tutorials/map_style.md +0 -83
- package/docs/tutorials/migrate_v4.md +0 -153
- package/docs/tutorials/migrate_v5.md +0 -103
- package/docs/tutorials/semantics_overlays.md +0 -74
- package/docs/tutorials/synced_coverage.md +0 -43
- package/mkdocs.yml +0 -131
- package/public/editor.html +0 -53
- package/public/index.html +0 -70
- package/public/map.html +0 -55
- package/public/photo.html +0 -43
- package/public/servers.js +0 -15
- package/public/viewer.html +0 -79
- package/public/viewer_indoor.html +0 -48
- package/public/widgets.html +0 -366
- package/scripts/build.js +0 -217
- package/scripts/doc.js +0 -79
- package/scripts/start.js +0 -172
- package/scripts/test.js +0 -52
- package/src/components/core/index.js +0 -12
- package/src/components/index.js +0 -13
- package/src/components/index_photoviewer.js +0 -8
- package/src/components/layout/index.js +0 -9
- package/src/components/menus/index.js +0 -22
- package/src/components/menus/index_photoviewer.js +0 -13
- package/src/components/ui/index.js +0 -29
- package/src/components/ui/index_photoviewer.js +0 -23
- package/src/components/ui/widgets/index.js +0 -16
- package/src/components/ui/widgets/index_photoviewer.js +0 -9
- package/src/index.js +0 -8
- package/src/index_photoviewer.js +0 -6
- package/src/utils/index.js +0 -17
- package/src/utils/index_photoviewer.js +0 -16
- package/tests/components/core/Basic.test.js +0 -168
- package/tests/components/core/BasicMock.js +0 -25
- package/tests/components/core/CoverageMap.test.js +0 -20
- package/tests/components/core/Editor.test.js +0 -20
- package/tests/components/core/PhotoViewer.test.js +0 -57
- package/tests/components/core/Viewer.test.js +0 -85
- package/tests/components/core/__snapshots__/PhotoViewer.test.js.snap +0 -96
- package/tests/components/core/__snapshots__/Viewer.test.js.snap +0 -188
- package/tests/components/ui/CopyButton.test.js +0 -52
- package/tests/components/ui/Loader.test.js +0 -55
- package/tests/components/ui/Map.test.js +0 -145
- package/tests/components/ui/Photo.test.js +0 -437
- package/tests/components/ui/Popup.test.js +0 -26
- package/tests/components/ui/QualityScore.test.js +0 -18
- package/tests/components/ui/SearchBar.test.js +0 -110
- package/tests/components/ui/__snapshots__/CopyButton.test.js.snap +0 -33
- package/tests/components/ui/__snapshots__/Loader.test.js.snap +0 -56
- package/tests/components/ui/__snapshots__/Map.test.js.snap +0 -16
- package/tests/components/ui/__snapshots__/Photo.test.js.snap +0 -263
- package/tests/components/ui/__snapshots__/Popup.test.js.snap +0 -29
- package/tests/components/ui/__snapshots__/QualityScore.test.js.snap +0 -11
- package/tests/components/ui/__snapshots__/SearchBar.test.js.snap +0 -65
- package/tests/data/Map_geocoder_ban.json +0 -36
- package/tests/data/Map_geocoder_nominatim.json +0 -41
- package/tests/data/Viewer_pictures_1.json +0 -148
- package/tests/setupTests.js +0 -5
- package/tests/utils/API.test.js +0 -752
- package/tests/utils/InitParameters.test.js +0 -599
- package/tests/utils/MapStyleComposer.test.js +0 -697
- package/tests/utils/PresetsManager.test.js +0 -123
- package/tests/utils/URLHandler.test.js +0 -587
- package/tests/utils/__snapshots__/API.test.js.snap +0 -40
- package/tests/utils/__snapshots__/MapStyleComposer.test.js.snap +0 -767
- package/tests/utils/__snapshots__/URLHandler.test.js.snap +0 -21
- package/tests/utils/__snapshots__/geocoder.test.js.snap +0 -37
- package/tests/utils/__snapshots__/map.test.js.snap +0 -1249
- package/tests/utils/__snapshots__/picture.test.js.snap +0 -327
- package/tests/utils/__snapshots__/widgets.test.js.snap +0 -19
- package/tests/utils/geocoder.test.js +0 -37
- package/tests/utils/i18n.test.js +0 -111
- package/tests/utils/map.test.js +0 -200
- package/tests/utils/picture.test.js +0 -745
- package/tests/utils/semantics.test.js +0 -174
- package/tests/utils/utils.test.js +0 -358
- package/tests/utils/widgets.test.js +0 -31
- /package/{src → build}/components/core/Basic.css +0 -0
- /package/{src → build}/components/core/CoverageMap.css +0 -0
- /package/{src → build}/components/core/Editor.css +0 -0
- /package/{src → build}/components/core/PhotoViewer.css +0 -0
- /package/{src → build}/components/core/Viewer.css +0 -0
- /package/{src → build}/components/ui/ButtonGroup.css +0 -0
- /package/{src → build}/components/ui/Map.css +0 -0
- /package/{src → build}/components/ui/Photo.css +0 -0
- /package/{src → build}/components/ui/ProgressBar.js +0 -0
- /package/{src → build}/components/ui/widgets/GeoSearch.css +0 -0
- /package/{src → build}/components/ui/widgets/LevelSelect.css +0 -0
- /package/{src → build}/components/ui/widgets/Player.css +0 -0
- /package/{public → build}/favicon.ico +0 -0
- /package/{src → build}/img/arrow_360.svg +0 -0
- /package/{src → build}/img/arrow_flat.svg +0 -0
- /package/{src → build}/img/bg_aerial.jpg +0 -0
- /package/{src → build}/img/bg_streets.jpg +0 -0
- /package/{src → build}/img/loader_base.jpg +0 -0
- /package/{src → build}/img/logo_dead.svg +0 -0
- /package/{src → build}/img/marker.svg +0 -0
- /package/{src → build}/img/marker_blue.svg +0 -0
- /package/{src → build}/img/osm.svg +0 -0
- /package/{src → build}/img/panoramax.svg +0 -0
- /package/{src → build}/img/switch_big.svg +0 -0
- /package/{src → build}/img/switch_mini.svg +0 -0
- /package/{src → build}/img/wd.svg +0 -0
- /package/{src → build}/translations/ar.json +0 -0
- /package/{src → build}/translations/be.json +0 -0
- /package/{src → build}/translations/br.json +0 -0
- /package/{src → build}/translations/cy.json +0 -0
- /package/{src → build}/translations/da.json +0 -0
- /package/{src → build}/translations/de.json +0 -0
- /package/{src → build}/translations/en.json +0 -0
- /package/{src → build}/translations/eo.json +0 -0
- /package/{src → build}/translations/es.json +0 -0
- /package/{src → build}/translations/fi.json +0 -0
- /package/{src → build}/translations/fr.json +0 -0
- /package/{src → build}/translations/hu.json +0 -0
- /package/{src → build}/translations/it.json +0 -0
- /package/{src → build}/translations/ja.json +0 -0
- /package/{src → build}/translations/ko.json +0 -0
- /package/{src → build}/translations/nl.json +0 -0
- /package/{src → build}/translations/nn.json +0 -0
- /package/{src → build}/translations/pl.json +0 -0
- /package/{src → build}/translations/pt.json +0 -0
- /package/{src → build}/translations/pt_BR.json +0 -0
- /package/{src → build}/translations/sv.json +0 -0
- /package/{src → build}/translations/ti.json +0 -0
- /package/{src → build}/translations/tr.json +0 -0
- /package/{src → build}/translations/uk.json +0 -0
- /package/{src → build}/translations/zh_Hant.json +0 -0
- /package/{src → build}/utils/PanoraMapProtocol.js +0 -0
- /package/{src → build}/utils/services.js +0 -0
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.IconSwitch"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.IconSwitch ⇐ <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.IconSwitch+event_change)
|
|
7
|
-
**Element**: pnx-icon-switch
|
|
8
|
-
**Change=${dosomething}**: >
|
|
9
|
-
<img src="left.svg" slot="icon-left" />
|
|
10
|
-
<span slot="label-left">Left</span>
|
|
11
|
-
<img src="right.svg" slot="icon-right" />
|
|
12
|
-
<span slot="label-right">Right</span>
|
|
13
|
-
</pnx-icon-switch>
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
* [.IconSwitch](#Panoramax.components.ui.IconSwitch) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
|
|
17
|
-
* [new IconSwitch()](#new_Panoramax.components.ui.IconSwitch_new)
|
|
18
|
-
* [.properties](#Panoramax.components.ui.IconSwitch+properties) : <code>Object</code>
|
|
19
|
-
* ["change"](#Panoramax.components.ui.IconSwitch+event_change)
|
|
20
|
-
|
|
21
|
-
<a name="new_Panoramax.components.ui.IconSwitch_new"></a>
|
|
22
|
-
|
|
23
|
-
### new IconSwitch()
|
|
24
|
-
Icon Switch button, based on a native checkbox.
|
|
25
|
-
Checked state corresponds to "right" option selected, unchecked to "left".
|
|
26
|
-
|
|
27
|
-
**Example**
|
|
28
|
-
```html
|
|
29
|
-
<pnx-icon-switch
|
|
30
|
-
checked="true"
|
|
31
|
-
name="my-switch"
|
|
32
|
-
|
|
33
|
-
<a name="Panoramax.components.ui.IconSwitch+properties"></a>
|
|
34
|
-
|
|
35
|
-
### iconSwitch.properties : <code>Object</code>
|
|
36
|
-
Component properties.
|
|
37
|
-
|
|
38
|
-
**Kind**: instance property of [<code>IconSwitch</code>](#Panoramax.components.ui.IconSwitch)
|
|
39
|
-
**Properties**
|
|
40
|
-
|
|
41
|
-
| Name | Type | Description |
|
|
42
|
-
| --- | --- | --- |
|
|
43
|
-
| checked | <code>boolean</code> | True if checked |
|
|
44
|
-
| disabled | <code>boolean</code> | Inactive if true |
|
|
45
|
-
| value | <code>boolean</code> | The current switch value |
|
|
46
|
-
| name | <code>string</code> | The switch name (also serves as ID) |
|
|
47
|
-
|
|
48
|
-
<a name="Panoramax.components.ui.IconSwitch+event_change"></a>
|
|
49
|
-
|
|
50
|
-
### "change"
|
|
51
|
-
Event for switch status change
|
|
52
|
-
|
|
53
|
-
**Kind**: event emitted by [<code>IconSwitch</code>](#Panoramax.components.ui.IconSwitch)
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.LinkButton"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.LinkButton ⇐ <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-link-button
|
|
7
|
-
|
|
8
|
-
* [.LinkButton](#Panoramax.components.ui.LinkButton) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
|
|
9
|
-
* [new LinkButton()](#new_Panoramax.components.ui.LinkButton_new)
|
|
10
|
-
* [.properties](#Panoramax.components.ui.LinkButton+properties) : <code>Object</code>
|
|
11
|
-
|
|
12
|
-
<a name="new_Panoramax.components.ui.LinkButton_new"></a>
|
|
13
|
-
|
|
14
|
-
### new LinkButton()
|
|
15
|
-
Link Button element displays a HTML `<a>` anchor with a button style.
|
|
16
|
-
|
|
17
|
-
**Example**
|
|
18
|
-
```html
|
|
19
|
-
<pnx-link-button
|
|
20
|
-
title="Redirect to other website"
|
|
21
|
-
kind="outline"
|
|
22
|
-
href="https://panoramax.fr"
|
|
23
|
-
target="_blank"
|
|
24
|
-
>
|
|
25
|
-
Click to go on Panoramax
|
|
26
|
-
</pnx-link-button>
|
|
27
|
-
```
|
|
28
|
-
<a name="Panoramax.components.ui.LinkButton+properties"></a>
|
|
29
|
-
|
|
30
|
-
### linkButton.properties : <code>Object</code>
|
|
31
|
-
Component properties.
|
|
32
|
-
|
|
33
|
-
**Kind**: instance property of [<code>LinkButton</code>](#Panoramax.components.ui.LinkButton)
|
|
34
|
-
**Properties**
|
|
35
|
-
|
|
36
|
-
| Name | Type | Default | Description |
|
|
37
|
-
| --- | --- | --- | --- |
|
|
38
|
-
| [href] | <code>string</code> | | The URL the button should navigate to when clicked |
|
|
39
|
-
| [target] | <code>string</code> | | Specifies where to open the linked document (e.g., '_blank') |
|
|
40
|
-
| [title] | <code>string</code> | | Tooltip text displayed when hovering over the button |
|
|
41
|
-
| [download] | <code>string</code> | | Indicates if the linked resource should be downloaded |
|
|
42
|
-
| [class] | <code>string</code> | | Custom CSS class for additional styling |
|
|
43
|
-
| [kind] | <code>string</code> | <code>"full"</code> | The style variation of the button (full, fullwarn, fullsuccess, outline, flat, superflat) |
|
|
44
|
-
| [size] | <code>string</code> | <code>"md"</code> | The size of the button (sm, md, l, xl, xxl) |
|
|
45
|
-
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.ListGroup"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.ListGroup ⇐ <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-list-group
|
|
7
|
-
**Slot**: `default` Any element you want to add in list.
|
|
8
|
-
<a name="new_Panoramax.components.ui.ListGroup_new"></a>
|
|
9
|
-
|
|
10
|
-
### new ListGroup()
|
|
11
|
-
List Group element displays a menu having a list of rapid actions (links, buttons).
|
|
12
|
-
|
|
13
|
-
Note that you may only want to use basic HTML elements (`a`, `button`) instead of Panoramax ones.
|
|
14
|
-
The list group overrides style, so using `pnx-*` component may conflict on styling.
|
|
15
|
-
|
|
16
|
-
**Example**
|
|
17
|
-
```html
|
|
18
|
-
<pnx-list-group>
|
|
19
|
-
<a href="https://web.site/">First link</a>
|
|
20
|
-
<button>Second button</button>
|
|
21
|
-
</pnx-list-group>
|
|
22
|
-
```
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.ListItem"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.ListItem ⇐ <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-list-item
|
|
7
|
-
**Slot**: `icon` The left icon (symbol for this item)
|
|
8
|
-
**Slot**: `action` The right icon (symbol for an interactive action)
|
|
9
|
-
|
|
10
|
-
* [.ListItem](#Panoramax.components.ui.ListItem) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
|
|
11
|
-
* [new ListItem()](#new_Panoramax.components.ui.ListItem_new)
|
|
12
|
-
* [.properties](#Panoramax.components.ui.ListItem+properties) : <code>Object</code>
|
|
13
|
-
|
|
14
|
-
<a name="new_Panoramax.components.ui.ListItem_new"></a>
|
|
15
|
-
|
|
16
|
-
### new ListItem()
|
|
17
|
-
ListItem is a list entry, in a Material Design fashion.
|
|
18
|
-
|
|
19
|
-
**Example**
|
|
20
|
-
```html
|
|
21
|
-
<pnx-list-item title="My feature" subtitle="It is very cool">
|
|
22
|
-
<img src="..." slot="icon" />
|
|
23
|
-
<img src="..." slot="action" />
|
|
24
|
-
</pnx-list-item>
|
|
25
|
-
```
|
|
26
|
-
<a name="Panoramax.components.ui.ListItem+properties"></a>
|
|
27
|
-
|
|
28
|
-
### listItem.properties : <code>Object</code>
|
|
29
|
-
Component properties.
|
|
30
|
-
|
|
31
|
-
**Kind**: instance property of [<code>ListItem</code>](#Panoramax.components.ui.ListItem)
|
|
32
|
-
**Properties**
|
|
33
|
-
|
|
34
|
-
| Name | Type | Description |
|
|
35
|
-
| --- | --- | --- |
|
|
36
|
-
| title | <code>string</code> | The item title |
|
|
37
|
-
| [subtitle] | <code>string</code> | The item subtitle |
|
|
38
|
-
| [tooltip] | <code>string</code> | A display-on-hover label |
|
|
39
|
-
|
|
@@ -1,56 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.Loader"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.Loader ⇐ <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-loader
|
|
7
|
-
|
|
8
|
-
* [.Loader](#Panoramax.components.ui.Loader) ⇐ <code>[lit.LitElement](https://lit.dev/docs/api/LitElement/)</code>
|
|
9
|
-
* [new Loader()](#new_Panoramax.components.ui.Loader_new)
|
|
10
|
-
* [.properties](#Panoramax.components.ui.Loader+properties) : <code>Object</code>
|
|
11
|
-
* [.isVisible()](#Panoramax.components.ui.Loader+isVisible) ⇒ <code>boolean</code>
|
|
12
|
-
* [.dismiss([err], [errMeaningful], [next])](#Panoramax.components.ui.Loader+dismiss)
|
|
13
|
-
|
|
14
|
-
<a name="new_Panoramax.components.ui.Loader_new"></a>
|
|
15
|
-
|
|
16
|
-
### new Loader()
|
|
17
|
-
Loader component display a full page covering for user waiting.
|
|
18
|
-
|
|
19
|
-
**Example**
|
|
20
|
-
```html
|
|
21
|
-
<pnx-loader ._parent=${this.viewer} />
|
|
22
|
-
```
|
|
23
|
-
<a name="Panoramax.components.ui.Loader+properties"></a>
|
|
24
|
-
|
|
25
|
-
### loader.properties : <code>Object</code>
|
|
26
|
-
Component properties.
|
|
27
|
-
|
|
28
|
-
**Kind**: instance property of [<code>Loader</code>](#Panoramax.components.ui.Loader)
|
|
29
|
-
**Properties**
|
|
30
|
-
|
|
31
|
-
| Name | Type | Default | Description |
|
|
32
|
-
| --- | --- | --- | --- |
|
|
33
|
-
| [visible] | <code>boolean</code> | <code>true</code> | Is the loader visible to user ? |
|
|
34
|
-
| [no-label] | <code>boolean</code> | <code>false</code> | Set to true to avoid loading label display |
|
|
35
|
-
| [value] | <code>number</code> | | Progress bar percentage (0-100) |
|
|
36
|
-
|
|
37
|
-
<a name="Panoramax.components.ui.Loader+isVisible"></a>
|
|
38
|
-
|
|
39
|
-
### loader.isVisible() ⇒ <code>boolean</code>
|
|
40
|
-
Is the loader currently visible ?
|
|
41
|
-
|
|
42
|
-
**Kind**: instance method of [<code>Loader</code>](#Panoramax.components.ui.Loader)
|
|
43
|
-
**Returns**: <code>boolean</code> - True if visible
|
|
44
|
-
<a name="Panoramax.components.ui.Loader+dismiss"></a>
|
|
45
|
-
|
|
46
|
-
### loader.dismiss([err], [errMeaningful], [next])
|
|
47
|
-
Dismiss loader, or show error
|
|
48
|
-
|
|
49
|
-
**Kind**: instance method of [<code>Loader</code>](#Panoramax.components.ui.Loader)
|
|
50
|
-
|
|
51
|
-
| Param | Type | Default | Description |
|
|
52
|
-
| --- | --- | --- | --- |
|
|
53
|
-
| [err] | <code>object</code> | <code></code> | Optional error object to show in browser console |
|
|
54
|
-
| [errMeaningful] | <code>str</code> | <code></code> | Optional error message to show to user |
|
|
55
|
-
| [next] | <code>fct</code> | <code></code> | Optional function to run after loader dismiss |
|
|
56
|
-
|
|
@@ -1,150 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.Map"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.Map ⇐ <code>[maplibregl.Map](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/)</code>
|
|
4
|
-
**Kind**: static class of <code>Panoramax.components.ui</code>
|
|
5
|
-
**Extends**: <code>[maplibregl.Map](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/)</code>
|
|
6
|
-
**Emits**: [<code>sequence-hover</code>](#Panoramax.components.ui.Map+event_sequence-hover), [<code>sequence-click</code>](#Panoramax.components.ui.Map+event_sequence-click), [<code>picture-click</code>](#Panoramax.components.ui.Map+event_picture-click), [<code>ready</code>](#Panoramax.components.ui.Map+event_ready)
|
|
7
|
-
|
|
8
|
-
* [.Map](#Panoramax.components.ui.Map) ⇐ <code>[maplibregl.Map](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/)</code>
|
|
9
|
-
* [new Map(parent, container, [options])](#new_Panoramax.components.ui.Map_new)
|
|
10
|
-
* [.destroy()](#Panoramax.components.ui.Map+destroy)
|
|
11
|
-
* [.waitForEnoughMapLoaded()](#Panoramax.components.ui.Map+waitForEnoughMapLoaded) ⇒ <code>Promise</code>
|
|
12
|
-
* [.reloadVectorTiles()](#Panoramax.components.ui.Map+reloadVectorTiles)
|
|
13
|
-
* [.displayPictureMarker(lon, lat, heading, [skipCenter], [picId])](#Panoramax.components.ui.Map+displayPictureMarker)
|
|
14
|
-
* [.addEventListener(type, listener)](#Panoramax.components.ui.Map+addEventListener)
|
|
15
|
-
* ["ready"](#Panoramax.components.ui.Map+event_ready)
|
|
16
|
-
* ["sequence-hover"](#Panoramax.components.ui.Map+event_sequence-hover)
|
|
17
|
-
* ["sequence-click"](#Panoramax.components.ui.Map+event_sequence-click)
|
|
18
|
-
* ["picture-click"](#Panoramax.components.ui.Map+event_picture-click)
|
|
19
|
-
|
|
20
|
-
<a name="new_Panoramax.components.ui.Map_new"></a>
|
|
21
|
-
|
|
22
|
-
### new Map(parent, container, [options])
|
|
23
|
-
Map is the component showing pictures and sequences geolocation.
|
|
24
|
-
|
|
25
|
-
Note that all functions of [MapLibre GL JS class Map](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/) are also available.
|
|
26
|
-
|
|
27
|
-
A more complete version of Map (with filters & themes) is available through [MapMore class](MapMore.md/#Panoramax.components.ui.MapMore)
|
|
28
|
-
|
|
29
|
-
ℹ️ Many style management is done in [MapStyleComposer](../../utils/MapStyleComposer.md/#Panoramax.utils.MapStyleComposer), which is available as a property of parent component.
|
|
30
|
-
|
|
31
|
-
⚠️ This class doesn't inherit from [EventTarget](https://developer.mozilla.org/fr/docs/Web/API/EventTarget), so it doesn't have `addEventListener` and `dispatchEvent` functions.
|
|
32
|
-
It uses instead [`on`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#on) and `fire` functions from MapLibre Map class.
|
|
33
|
-
`fire` function doesn't take directly [`Event`](https://developer.mozilla.org/fr/docs/Web/API/Event) objects, but a string and object data.
|
|
34
|
-
A shorthand `addEventListener` function is added for simpler usage.
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
| Param | Type | Default | Description |
|
|
38
|
-
| --- | --- | --- | --- |
|
|
39
|
-
| parent | [<code>Basic</code>](../core/Basic.md/#Panoramax.components.core.Basic) | | The parent view |
|
|
40
|
-
| container | <code>Element</code> | | The DOM element to create into |
|
|
41
|
-
| [options] | <code>object</code> | | The map options (any of [MapLibre GL settings](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/MapOptions/) or any supplementary option defined here) |
|
|
42
|
-
| [options.raster] | <code>object</code> | | The MapLibre raster source for aerial background. This must be a JSON object following [MapLibre raster source definition](https://maplibre.org/maplibre-style-spec/sources/#raster). |
|
|
43
|
-
| [options.basemaps] | <code>object</code> | | List of complementary basemaps, as { id: {MapLibre Style JSON or URL} }. Note that special IDs streets and aerial are reserved for default backgrounds. |
|
|
44
|
-
| [options.background] | <code>string</code> | <code>"streets"</code> | Choose default map background to display (streets or aerial, if raster aerial background available). Defaults to street. |
|
|
45
|
-
| [options.attributionControl.customAttribution] | <code>string</code> | | To override default map attribution. |
|
|
46
|
-
| [options.picMarkerDraggable] | <code>boolean</code> | | To make the picture marker draggable, default to false. |
|
|
47
|
-
| [options.indoor] | <code>object</code> | | The indoor= MapLibre plugin options. This must be a JSON object following [IndoorEqual parameters](https://indoorequal.com/doc/maplibre-gl-indoorequal/api#parameters). Note that this is only available if [maplibre-gl-indoorequal](https://indoorequal.com/doc/maplibre-gl-indoorequal) plugin is loaded in your web page. |
|
|
48
|
-
| [options.indoor.level] | <code>string</code> | | (only if indoor= plugin is enabled) The initial indoor level to display. Defaults to ground or disabled depending on indoor map availability. Do not use if visible=false. |
|
|
49
|
-
| [options.indoor.visible] | <code>boolean</code> | <code>true</code> | (only if indoor= plugin is enabled) The initial indoor visibility. Set to false to avoid data loading before user explicitly enables indoor through widgets. If set to false, you may not set any level option in component. |
|
|
50
|
-
|
|
51
|
-
**Example**
|
|
52
|
-
```js
|
|
53
|
-
const map = new Panoramax.components.ui.Map(viewer, mapNode, {center: {lat: 48.7, lng: -1.7}});
|
|
54
|
-
```
|
|
55
|
-
<a name="Panoramax.components.ui.Map+destroy"></a>
|
|
56
|
-
|
|
57
|
-
### map.destroy()
|
|
58
|
-
Destroy any form of life in this component
|
|
59
|
-
|
|
60
|
-
**Kind**: instance method of [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
61
|
-
<a name="Panoramax.components.ui.Map+waitForEnoughMapLoaded"></a>
|
|
62
|
-
|
|
63
|
-
### map.waitForEnoughMapLoaded() ⇒ <code>Promise</code>
|
|
64
|
-
Helper to know when enough map background and Panoramax tiles are loaded for a proper display.
|
|
65
|
-
|
|
66
|
-
**Kind**: instance method of [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
67
|
-
**Returns**: <code>Promise</code> - Resolves when enough is loaded
|
|
68
|
-
<a name="Panoramax.components.ui.Map+reloadVectorTiles"></a>
|
|
69
|
-
|
|
70
|
-
### map.reloadVectorTiles()
|
|
71
|
-
Force refresh of vector tiles data
|
|
72
|
-
|
|
73
|
-
**Kind**: instance method of [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
74
|
-
<a name="Panoramax.components.ui.Map+displayPictureMarker"></a>
|
|
75
|
-
|
|
76
|
-
### map.displayPictureMarker(lon, lat, heading, [skipCenter], [picId])
|
|
77
|
-
Shows on map a picture position and heading.
|
|
78
|
-
|
|
79
|
-
If no longitude & latitude are set, marker is removed from map.
|
|
80
|
-
|
|
81
|
-
**Kind**: instance method of [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
82
|
-
|
|
83
|
-
| Param | Type | Default | Description |
|
|
84
|
-
| --- | --- | --- | --- |
|
|
85
|
-
| lon | <code>number</code> | | The longitude |
|
|
86
|
-
| lat | <code>number</code> | | The latitude |
|
|
87
|
-
| heading | <code>number</code> | | The heading |
|
|
88
|
-
| [skipCenter] | <code>boolean</code> | <code>false</code> | Set to true to avoid map centering on marker |
|
|
89
|
-
| [picId] | <code>string</code> | <code>null</code> | The picture Id |
|
|
90
|
-
|
|
91
|
-
<a name="Panoramax.components.ui.Map+addEventListener"></a>
|
|
92
|
-
|
|
93
|
-
### map.addEventListener(type, listener)
|
|
94
|
-
Listen to map events.
|
|
95
|
-
This is a binder to [`on`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#on) and [`once`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#once) MapLibre GL functions.
|
|
96
|
-
|
|
97
|
-
**Kind**: instance method of [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
98
|
-
|
|
99
|
-
| Param | Type | Default | Description |
|
|
100
|
-
| --- | --- | --- | --- |
|
|
101
|
-
| type | <code>string</code> | | The event type to listen for |
|
|
102
|
-
| listener | <code>function</code> | | The event handler |
|
|
103
|
-
| [options.once] | <code>boolean</code> | <code>false</code> | Set to true to only listen to first event. |
|
|
104
|
-
|
|
105
|
-
<a name="Panoramax.components.ui.Map+event_ready"></a>
|
|
106
|
-
|
|
107
|
-
### "ready"
|
|
108
|
-
Event when map is ready to display.
|
|
109
|
-
This includes Maplibre initial load, enough map data display and styling.
|
|
110
|
-
|
|
111
|
-
**Kind**: event emitted by [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
112
|
-
<a name="Panoramax.components.ui.Map+event_sequence-hover"></a>
|
|
113
|
-
|
|
114
|
-
### "sequence-hover"
|
|
115
|
-
Event when a sequence on map is hovered (not selected)
|
|
116
|
-
|
|
117
|
-
**Kind**: event emitted by [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
118
|
-
**Properties**
|
|
119
|
-
|
|
120
|
-
| Name | Type | Description |
|
|
121
|
-
| --- | --- | --- |
|
|
122
|
-
| seqId | <code>string</code> | The hovered sequence ID |
|
|
123
|
-
|
|
124
|
-
<a name="Panoramax.components.ui.Map+event_sequence-click"></a>
|
|
125
|
-
|
|
126
|
-
### "sequence-click"
|
|
127
|
-
Event when a sequence on map is clicked
|
|
128
|
-
|
|
129
|
-
**Kind**: event emitted by [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
130
|
-
**Properties**
|
|
131
|
-
|
|
132
|
-
| Name | Type | Description |
|
|
133
|
-
| --- | --- | --- |
|
|
134
|
-
| seqId | <code>string</code> | The clicked sequence ID |
|
|
135
|
-
| coordinates | <code>maplibregl.LngLat</code> | The coordinates of user click |
|
|
136
|
-
|
|
137
|
-
<a name="Panoramax.components.ui.Map+event_picture-click"></a>
|
|
138
|
-
|
|
139
|
-
### "picture-click"
|
|
140
|
-
Event when a picture on map is clicked
|
|
141
|
-
|
|
142
|
-
**Kind**: event emitted by [<code>Map</code>](#Panoramax.components.ui.Map)
|
|
143
|
-
**Properties**
|
|
144
|
-
|
|
145
|
-
| Name | Type | Description |
|
|
146
|
-
| --- | --- | --- |
|
|
147
|
-
| picId | <code>string</code> | The clicked picture ID |
|
|
148
|
-
| seqId | <code>string</code> | The clicked picture's sequence ID |
|
|
149
|
-
| feature | <code>object</code> | The GeoJSON feature of the picture |
|
|
150
|
-
|
|
@@ -1,150 +0,0 @@
|
|
|
1
|
-
<a name="Panoramax.components.ui.MapMore"></a>
|
|
2
|
-
|
|
3
|
-
## Panoramax.components.ui.MapMore ⇐ [<code>Map</code>](Map.md/#Panoramax.components.ui.Map)
|
|
4
|
-
**Kind**: static class of <code>Panoramax.components.ui</code>
|
|
5
|
-
**Extends**: [<code>Map</code>](Map.md/#Panoramax.components.ui.Map)
|
|
6
|
-
**Emits**: [<code>sequence-hover</code>](Map.md/#Panoramax.components.ui.Map+event_sequence-hover), [<code>sequence-click</code>](Map.md/#Panoramax.components.ui.Map+event_sequence-click), [<code>picture-click</code>](Map.md/#Panoramax.components.ui.Map+event_picture-click)
|
|
7
|
-
|
|
8
|
-
* [.MapMore](#Panoramax.components.ui.MapMore) ⇐ [<code>Map</code>](Map.md/#Panoramax.components.ui.Map)
|
|
9
|
-
* [new MapMore(parent, container, [options])](#new_Panoramax.components.ui.MapMore_new)
|
|
10
|
-
* [.destroy()](Map.md/#Panoramax.components.ui.Map+destroy)
|
|
11
|
-
* [.waitForEnoughMapLoaded()](Map.md/#Panoramax.components.ui.Map+waitForEnoughMapLoaded) ⇒ <code>Promise</code>
|
|
12
|
-
* [.reloadVectorTiles()](Map.md/#Panoramax.components.ui.Map+reloadVectorTiles)
|
|
13
|
-
* [.displayPictureMarker(lon, lat, heading, [skipCenter], [picId])](#Panoramax.components.ui.Map+displayPictureMarker)
|
|
14
|
-
* [.addEventListener(type, listener)](Map.md/#Panoramax.components.ui.Map+addEventListener)
|
|
15
|
-
* ["ready"](Map.md/#Panoramax.components.ui.Map+event_ready)
|
|
16
|
-
* ["sequence-hover"](Map.md/#Panoramax.components.ui.Map+event_sequence-hover)
|
|
17
|
-
* ["sequence-click"](Map.md/#Panoramax.components.ui.Map+event_sequence-click)
|
|
18
|
-
* ["picture-click"](Map.md/#Panoramax.components.ui.Map+event_picture-click)
|
|
19
|
-
|
|
20
|
-
<a name="new_Panoramax.components.ui.MapMore_new"></a>
|
|
21
|
-
|
|
22
|
-
### new MapMore(parent, container, [options])
|
|
23
|
-
MapMore is a more complete version of [Map UI component](Map.md/#Panoramax.components.ui.Map).
|
|
24
|
-
|
|
25
|
-
It offers advanced features filters and semantic overlays.
|
|
26
|
-
|
|
27
|
-
Note that all functions of [MapLibre GL JS class Map](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/) are also available.
|
|
28
|
-
|
|
29
|
-
ℹ️ Many style management is done in [MapStyleComposer](../../utils/MapStyleComposer.md/#Panoramax.utils.MapStyleComposer), which is available as a property of parent component.
|
|
30
|
-
|
|
31
|
-
⚠️ This class doesn't inherit from [EventTarget](https://developer.mozilla.org/fr/docs/Web/API/EventTarget), so it doesn't have `addEventListener` and `dispatchEvent` functions.
|
|
32
|
-
It uses instead [`on`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#on) and `fire` functions from MapLibre Map class.
|
|
33
|
-
`fire` function doesn't take directly [`Event`](https://developer.mozilla.org/fr/docs/Web/API/Event) objects, but a string and object data.
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
| Param | Type | Default | Description |
|
|
37
|
-
| --- | --- | --- | --- |
|
|
38
|
-
| parent | [<code>Basic</code>](../core/Basic.md/#Panoramax.components.core.Basic) | | The parent view |
|
|
39
|
-
| container | <code>Element</code> | | The DOM element to create into |
|
|
40
|
-
| [options] | <code>object</code> | | The map options (any of [MapLibre GL settings](https://maplibre.org/maplibre-gl-js/docs/API/type-aliases/MapOptions/) or any supplementary option defined here) |
|
|
41
|
-
| [options.raster] | <code>object</code> | | The MapLibre raster source for aerial background. This must be a JSON object following [MapLibre raster source definition](https://maplibre.org/maplibre-style-spec/sources/#raster). |
|
|
42
|
-
| [options.basemaps] | <code>object</code> | | List of complementary basemaps, as { id: {MapLibre Style JSON or URL} }. Note that special IDs streets and aerial are reserved for default backgrounds. |
|
|
43
|
-
| [options.background] | <code>string</code> | <code>"streets"</code> | Choose default map background to display (streets or aerial, if raster aerial background available). Defaults to streets. |
|
|
44
|
-
| [options.attributionControl.customAttribution] | <code>string</code> | | To override default map attribution. |
|
|
45
|
-
| [options.picMarkerDraggable] | <code>boolean</code> | | To make the picture marker draggable, default to false. |
|
|
46
|
-
| [options.indoor] | <code>object</code> | | The indoor= MapLibre plugin options. This must be a JSON object following [IndoorEqual parameters](https://indoorequal.com/doc/maplibre-gl-indoorequal/api#parameters). Note that this is only available if [maplibre-gl-indoorequal](https://indoorequal.com/doc/maplibre-gl-indoorequal) plugin is loaded in your web page. |
|
|
47
|
-
| [options.indoor.level] | <code>string</code> | | (only if indoor= plugin is enabled) The initial indoor level to display. Defaults to ground or disabled depending on indoor map availability. |
|
|
48
|
-
| [options.indoor.visible] | <code>boolean</code> | <code>true</code> | (only if indoor= plugin is enabled) The initial indoor visibility. Set to false to avoid data loading before user explicitly enables indoor through widgets. If set to false, you may not set any level option in component. |
|
|
49
|
-
| [options.theme] | <code>string</code> | <code>"default"</code> | The map theme (default, age, score, type) |
|
|
50
|
-
|
|
51
|
-
**Example**
|
|
52
|
-
```js
|
|
53
|
-
const map = new Panoramax.components.ui.MapMore(viewer, mapNode, {center: {lat: 48.7, lng: -1.7}});
|
|
54
|
-
```
|
|
55
|
-
<a name="Panoramax.components.ui.Map+destroy"></a>
|
|
56
|
-
|
|
57
|
-
### mapMore.destroy()
|
|
58
|
-
Destroy any form of life in this component
|
|
59
|
-
|
|
60
|
-
**Kind**: instance method of [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
61
|
-
<a name="Panoramax.components.ui.Map+waitForEnoughMapLoaded"></a>
|
|
62
|
-
|
|
63
|
-
### mapMore.waitForEnoughMapLoaded() ⇒ <code>Promise</code>
|
|
64
|
-
Helper to know when enough map background and Panoramax tiles are loaded for a proper display.
|
|
65
|
-
|
|
66
|
-
**Kind**: instance method of [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
67
|
-
**Returns**: <code>Promise</code> - Resolves when enough is loaded
|
|
68
|
-
<a name="Panoramax.components.ui.Map+reloadVectorTiles"></a>
|
|
69
|
-
|
|
70
|
-
### mapMore.reloadVectorTiles()
|
|
71
|
-
Force refresh of vector tiles data
|
|
72
|
-
|
|
73
|
-
**Kind**: instance method of [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
74
|
-
<a name="Panoramax.components.ui.Map+displayPictureMarker"></a>
|
|
75
|
-
|
|
76
|
-
### mapMore.displayPictureMarker(lon, lat, heading, [skipCenter], [picId])
|
|
77
|
-
Shows on map a picture position and heading.
|
|
78
|
-
|
|
79
|
-
If no longitude & latitude are set, marker is removed from map.
|
|
80
|
-
|
|
81
|
-
**Kind**: instance method of [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
82
|
-
|
|
83
|
-
| Param | Type | Default | Description |
|
|
84
|
-
| --- | --- | --- | --- |
|
|
85
|
-
| lon | <code>number</code> | | The longitude |
|
|
86
|
-
| lat | <code>number</code> | | The latitude |
|
|
87
|
-
| heading | <code>number</code> | | The heading |
|
|
88
|
-
| [skipCenter] | <code>boolean</code> | <code>false</code> | Set to true to avoid map centering on marker |
|
|
89
|
-
| [picId] | <code>string</code> | <code>null</code> | The picture Id |
|
|
90
|
-
|
|
91
|
-
<a name="Panoramax.components.ui.Map+addEventListener"></a>
|
|
92
|
-
|
|
93
|
-
### mapMore.addEventListener(type, listener)
|
|
94
|
-
Listen to map events.
|
|
95
|
-
This is a binder to [`on`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#on) and [`once`](https://maplibre.org/maplibre-gl-js/docs/API/classes/Map/#once) MapLibre GL functions.
|
|
96
|
-
|
|
97
|
-
**Kind**: instance method of [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
98
|
-
|
|
99
|
-
| Param | Type | Default | Description |
|
|
100
|
-
| --- | --- | --- | --- |
|
|
101
|
-
| type | <code>string</code> | | The event type to listen for |
|
|
102
|
-
| listener | <code>function</code> | | The event handler |
|
|
103
|
-
| [options.once] | <code>boolean</code> | <code>false</code> | Set to true to only listen to first event. |
|
|
104
|
-
|
|
105
|
-
<a name="Panoramax.components.ui.Map+event_ready"></a>
|
|
106
|
-
|
|
107
|
-
### "ready"
|
|
108
|
-
Event when map is ready to display.
|
|
109
|
-
This includes Maplibre initial load, enough map data display and styling.
|
|
110
|
-
|
|
111
|
-
**Kind**: event emitted by [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
112
|
-
<a name="Panoramax.components.ui.Map+event_sequence-hover"></a>
|
|
113
|
-
|
|
114
|
-
### "sequence-hover"
|
|
115
|
-
Event when a sequence on map is hovered (not selected)
|
|
116
|
-
|
|
117
|
-
**Kind**: event emitted by [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
118
|
-
**Properties**
|
|
119
|
-
|
|
120
|
-
| Name | Type | Description |
|
|
121
|
-
| --- | --- | --- |
|
|
122
|
-
| seqId | <code>string</code> | The hovered sequence ID |
|
|
123
|
-
|
|
124
|
-
<a name="Panoramax.components.ui.Map+event_sequence-click"></a>
|
|
125
|
-
|
|
126
|
-
### "sequence-click"
|
|
127
|
-
Event when a sequence on map is clicked
|
|
128
|
-
|
|
129
|
-
**Kind**: event emitted by [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
130
|
-
**Properties**
|
|
131
|
-
|
|
132
|
-
| Name | Type | Description |
|
|
133
|
-
| --- | --- | --- |
|
|
134
|
-
| seqId | <code>string</code> | The clicked sequence ID |
|
|
135
|
-
| coordinates | <code>maplibregl.LngLat</code> | The coordinates of user click |
|
|
136
|
-
|
|
137
|
-
<a name="Panoramax.components.ui.Map+event_picture-click"></a>
|
|
138
|
-
|
|
139
|
-
### "picture-click"
|
|
140
|
-
Event when a picture on map is clicked
|
|
141
|
-
|
|
142
|
-
**Kind**: event emitted by [<code>MapMore</code>](#Panoramax.components.ui.MapMore)
|
|
143
|
-
**Properties**
|
|
144
|
-
|
|
145
|
-
| Name | Type | Description |
|
|
146
|
-
| --- | --- | --- |
|
|
147
|
-
| picId | <code>string</code> | The clicked picture ID |
|
|
148
|
-
| seqId | <code>string</code> | The clicked picture's sequence ID |
|
|
149
|
-
| feature | <code>object</code> | The GeoJSON feature of the picture |
|
|
150
|
-
|