Skip to content

Commit ca56f01

Browse files
committed
Some updates in readme.md docs and license
1 parent ecaa355 commit ca56f01

File tree

4 files changed

+46
-16
lines changed

4 files changed

+46
-16
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ If funded by someone else than 3Liz, please add label "sponsored development"
66
* [ ] JavaScript are named according to the following pattern `my_own_feature_X.Y.js` where `X.Y` is the version of LWC used
77
* [ ] Include a `README.md` with a small picture/GIF of the feature
88
* [ ] I agree to the license of this repository : [Mozilla Public License Version 2.0](https://www.mozilla.org/en-US/MPL/2.0/)
9-
* [ ] I have added the docstring, according to the [contributing][https://github.com/3liz/lizmap-javascript-scripts/blob/master/CONTRIBUTING.md] guidelines.
9+
* [ ] I have added the docstring, according to the [contributing](https://github.com/3liz/lizmap-javascript-scripts/blob/master/CONTRIBUTING.md) guidelines.
1010

1111
Funded by

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ be designed for a special need of a project or a customer.
2323
The API on Lizmap Web Client is not guaranteed across versions. So the compatibility with Lizmap Web Client is not
2424
guaranteed as well on this repository. They aren't any tests suite done on these snippets to avoid regression.
2525

26-
Each JavaScript file is naming following the pattern `custom_feature_X.Y.js` where `X.Y` is targeting the LWC version when
26+
Each JavaScript file is named following the pattern `custom_feature_X.Y.js` where `X.Y` is targeting the LWC version when
2727
the script was written.
2828

2929
## Scripts
@@ -34,6 +34,7 @@ the script was written.
3434
* [IGN web services 🇫🇷](library/api/ign_web_services)
3535
* [Google Street View](library/api/google_street_view)
3636
* [Mapillary](library/api/mapillary)
37+
* [Panoramax](library/api/panoramax)
3738
* [GeoFoncier Popup🇫🇷](library/data/geofoncier_wms_getFeatureInfo)
3839

3940
### Data

library/api/panoramax/README.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,24 @@
11
# (FR) Panoramax
22

3-
Ce script permet d'afficher dans votre projet les photos provenant du projet Panoramax (https://panoramax.openstreetmap.fr/ et/ou https://panoramax.ign.fr/) dans Lizmap Web Client. À noter qu'il n'est pas nécessaire que votre projet soit dans une projection spécifique pour que ce script fonctionne. C'est QGIS qui se chargera de la reprojection.
3+
_English below_
4+
5+
Ce script permet d'afficher dans votre projet les photos provenant du projet Panoramax
6+
(https://panoramax.openstreetmap.fr/ et/ou https://panoramax.ign.fr/) dans Lizmap Web Client. À noter qu'il n'est pas
7+
nécessaire que votre projet soit dans une projection spécifique pour que ce script fonctionne. C'est QGIS qui se
8+
chargera de la reprojection.
49

510
![alt text](image-3.png)
611

712
## Pré-requis
813

9-
- Lizmap Web Client >= 3.8
14+
- Lizmap Web Client 3.8
1015

11-
- Pour des raisons de performance et du fait qu'OpenLayers ne permette pas la reprojection de tuiles vectorielles, **la ou les couches de données Panoramax doivent être ajoutées depuis votre projet QGIS**. **Un groupe ou une couche nommée Panoramax doit absolument exister dans votre projet QGIS. Sinon le script générera une erreur**. Vous pouvez changer le nom de votre couche/groupe mais dans ce cas il sera nécessaire de modifier la variable PANORAMAX_QGIS_LAYER_NAME du script pour qu'elle corresponde au nom de votre couche. Vous pouvez également modifier depuis QGIS le style de votre couche de tuiles vectorielles si vous le souhaitez.
16+
- Pour des raisons de performance et du fait qu'OpenLayers ne permette pas la reprojection de tuiles vectorielles,
17+
**la ou les couches de données Panoramax doivent être ajoutées depuis votre projet QGIS**.
18+
**Un groupe ou une couche nommée Panoramax doit absolument exister dans votre projet QGIS. Sinon le script générera
19+
une erreur**. Vous pouvez changer le nom de votre couche/groupe mais dans ce cas il sera nécessaire de modifier
20+
la variable `PANORAMAX_QGIS_LAYER_NAME` du script pour qu'elle corresponde au nom de votre couche. Vous pouvez
21+
également modifier depuis QGIS le style de votre couche de tuiles vectorielles si vous le souhaitez.
1222

1323
![alt text](image.png)
1424
![alt text](image-1.png)
@@ -18,26 +28,35 @@ Ce script permet d'afficher dans votre projet les photos provenant du projet Pan
1828
Pour utiliser le script Panoramax dans votre projet :
1929
1. assurez-vous d'avoir une couche Panoramax présente dans votre projet QGIS
2030
2. copier `panoramax_3.8.js` dans le dossier `media/js` de votre projet
21-
3. le bouton panoramax s'affichera dans Lizmap Web Client
22-
4. En cliquant sur ce bouton, les photos associées aux points de la couche Panoramax seront affichées. Un clic sur un point permet d'afficher la photo correspondante.
31+
3. le bouton Panoramax s'affichera dans Lizmap Web Client
32+
4. En cliquant sur ce bouton, les photos associées aux points de la couche Panoramax seront affichées.
33+
Un clic sur un point permet d'afficher la photo correspondante.
2334

2435
## Personnalisation
2536

26-
Si vous modifiez le nom du groupe ou de la couche Panoramax dans QGIS, vous devrez adapter la variable PANORAMAX_QGIS_LAYER_NAME dans le script pour qu'elle corresponde au nom de la couche dans votre projet.
37+
Si vous modifiez le nom du groupe ou de la couche Panoramax dans QGIS, vous devrez adapter la variable
38+
`PANORAMAX_QGIS_LAYER_NAME` dans le script pour qu'elle corresponde au nom de la couche dans votre projet.
2739

28-
Vous pouvez également personnaliser l'apparence du bouton ou le comportement d'affichage selon vos besoins via des ajustements dans le fichier JavaScript.
40+
Vous pouvez également personnaliser l'apparence du bouton ou le comportement d'affichage selon vos besoins via des
41+
ajustements dans le fichier JavaScript.
2942

3043
# (EN) Panoramax
3144

32-
This script allows you to display photos from the Panoramax project (https://panoramax.openstreetmap.fr/ and/or https://panoramax.ign.fr/) in your Lizmap Web Client project. It is not necessary for your project to have a specific projection for this script to work. QGIS will handle the reprojection.
45+
This script allows you to display photos from the Panoramax project (https://panoramax.openstreetmap.fr/ and/or
46+
https://panoramax.ign.fr/) in your Lizmap Web Client project. It is not necessary for your project to have a specific
47+
projection for this script to work. QGIS will handle the reprojection.
3348

3449
![alt text](image-3.png)
3550

3651
## Requirements
3752

38-
- Lizmap Web Client >= 3.8
53+
- Lizmap Web Client 3.8
3954

40-
- For performance reasons and because OpenLayers does not allow the reprojection of vector tiles, **the Panoramax data layer(s) must be added from your QGIS project**. **A layer or group named Panoramax must exist in your QGIS project. Otherwise, the script will generate an error**. You can change the name of your layer/group, but in that case, you will need to modify the PANORAMAX_QGIS_LAYER_NAME variable in the script to match the name of your layer. You can also modify the vector tiles style in QGIS.
55+
- For performance reasons and because OpenLayers does not allow the reprojection of vector tiles, **the Panoramax data
56+
layer(s) must be added from your QGIS project**. **A layer or group named Panoramax must exist in your QGIS project.
57+
Otherwise, the script will generate an error**. You can change the name of your layer/group, but in that case, you
58+
will need to modify the PANORAMAX_QGIS_LAYER_NAME variable in the script to match the name of your layer. You can
59+
also modify the vector tiles style in QGIS.
4160

4261
![alt text](image.png)
4362
![alt text](image-1.png)
@@ -48,11 +67,14 @@ This script allows you to display photos from the Panoramax project (https://pan
4867
1. copy the panoramax_3.8.js file to the media/js folder of your QGIS project.
4968
2. verify that the Panoramax layer (or group) exists in your QGIS project.
5069
3. open Lizmap Web Client and ensure the version installed is 3.8 or higher.
51-
4. the Panoramax button should now appear in the Lizmap interface, allowing you to view the photos related to the points in the Panoramax layer.
70+
4. the Panoramax button should now appear in the Lizmap interface, allowing you to view the photos related to the points
71+
in the Panoramax layer.
5272

5373

5474
## Customization
5575

56-
If you change the name of the Panoramax group or layer in QGIS, you will need to adjust the PANORAMAX_QGIS_LAYER_NAME variable in the script to match the name of your layer.
76+
If you change the name of the Panoramax group or layer in QGIS, you will need to adjust the `PANORAMAX_QGIS_LAYER_NAME`
77+
variable in the script to match the name of your layer.
5778

58-
You can also customize the appearance of the button or the display behavior according to your needs by making adjustments to the JavaScript file.
79+
You can also customize the appearance of the button or the display behavior according to your needs by making
80+
adjustments to the JavaScript file.
Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
1+
/**
2+
* @license Mozilla Public License Version 2.0
3+
* This script has been developed by the "community"
4+
* There isn't any guarantee that this script will work on another version of Lizmap Web Client.
5+
*
6+
*/
7+
18
lizMap.events.on({
29
mapcreated: function(e) {
310
lizMap.map.restrictedExtent = lizMap.map.maxExtent;
411
}
5-
});
12+
});

0 commit comments

Comments
 (0)