Skip to content

Commit

Permalink
update package : date + gp ext versions
Browse files Browse the repository at this point in the history
  • Loading branch information
@elias75015
elias75015 committed Jun 7, 2023
1 parent 2083bf8 commit 7fab093
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 218 deletions.
215 changes: 0 additions & 215 deletions DRAFT_CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,127 +148,16 @@ new ol.layer.Tile({
## Summary
Retrait total de l'utilisation du service d'autoconfiguration et utilisation de fichiers de configuration json générés quotidiennement à partir des getCapabilities des services du Geoportail.
L'ensemble des services de calcul appelés via la bibliothèque d'accès sont désormais appelés avec la clé "calcul" par défaut dans la bibliothèque d'accès. Le paramètre "apiKey" n'est donc plus nécessaire pour appeler les services de géocodage, d'itinéraire, d'isochrone, d'altimétrie et d'autocomplétion, que ce soit directement depuis la bibli
othèque d'accès ou via les widgets des extensions Géoportail.

L'autoconfiguration n'est plus appelée par les API. Pour la remplacer, nous générons quotidiennement, à partir des getCapabilities des services WMS et WMTS, des fichiers de configuration en JSON appelables par les API JavaScript Géoportail. Il y a un fichier par clé générique. L'avantage de ce nouveau processus (en plus de s'adapter au futur arrêt du service d'autoconfiguration) est que les fichiers de configuration JSON sont directement au format attendu par les API : il n'y a plus besoin de les parser pour en extraire les informations utiles puis pour les introduire dans une structure adéquate.
Par exemple, en renseignant "cartes" au paramètre apiKey, c'est le fichier cartesConfig.json qui sera chargé et directement utilisé par les API.
A noter que le multiKeys est toujours géré, c'est à dire qu'il est possible de renseigner plusieurs clés dans le paramètre apiKey.
Il est également possible de générer son propre fichier de configuration à partir d'une ou plusieurs clés. L'utilitaire est temporairement disponible ici : https://geoportal-configuration.onrender.com. Le paramètre permettant ensuite de charger sa configuration personnelle à partir du fichier local généré s'appelle désormais **customConfigFile**, auquel on associera le chemin vers le fichier de configuration json à charger.

## Changelog
* [Added]
* [Changed]
- mise à jour de la bibliothèque d'accès aux services Geoportail en version 3.3.0 (#364)
- **BC** : paramètre "customConfigFile" pour appeler un fichier de configuration local (#364)
##### Avant :
```html
<script src="chemin/vers/GpPluginLeaflet.js" data-url="chemin/vers/mon/autoconf/AutoConf.js"></script>
```
OU
```javascript
Gp.Services.getConfig({
serverUrl : "chemin/vers/mon/autoconf/AutoConf.js",
timeOut : 20000,
onSuccess : createMap
});
```
##### Maintenant :
```html
<script src="chemin/vers/GpPluginLeaflet.js" data-url="chemin/vers/ma/config/customConfig.json"></script>
```
OU
```javascript
Gp.Services.getConfig({
customConfigFile: "chemin/vers/ma/config/customConfig.json",
timeOut: 20000,
onSuccess: createMap
});
```
* [Deprecated]
* [Removed]
- **BC** : les originators ne sont plus renvoyés dans la configuration. Il faut les ajouter manuellement aux couches.
```javascript
var layer = L.geoportalLayer.WMTS({
layer: "ORTHOIMAGERY.ORTHOPHOTOS"
},
{
originators: [{
name: "Nom raccourci originator",
constraints: [{
minScaleDenominator: 20000,
maxScaleDenominator: 1000000,
bbox: {
left: -10,
top: 50,
right: 10,
bottom: 40
}
},
{
bbox: {
left: 120,
top: 50,
right: 150,
bottom: 35
}
}
]
},
{
url: "http://www.url-vers-le-site-du-producteur.fr",
constraints: [{
minScaleDenominator: 20000,
maxScaleDenominator: 40000
}]
},
{
logo: "https://lien-vers-le-logo.png"
},
{
attribution: "Titre complet originator",
constraints: [{
minScaleDenominator: 100000,
maxScaleDenominator: 800000
}]
}]
});
```
- **BC** : Les metadatas sont utilisées dans les API par le contrôle gestionnaire de couches (LayerSwitcher). Celui-ci va lire les metadatas des couches ajoutées à la carte et les afficher dans l'encart d'information dédié du LayerSwitcher. **Pour les couches WMTS uniquement**, désormais, pour que les metadatas apparaissent dans l'onglet "informations" du LayerSwitcher, il faudra les renseigner manuellement à la configuration de la couche Géoportail lors de son ajout à la carte.

```javascript
var maCoucheGeoportail = L.geoportalLayer.WMTS({
layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
}, {
metadata: [
{
format: "xml",
url: "lien/Vers/Une/MetaDonnee.xml"
}
]
});
```

* [Fixed]
* [Security]
Expand All @@ -284,120 +173,16 @@ var maCoucheGeoportail = L.geoportalLayer.WMTS({
## Summary
Retrait total de l'utilisation du service d'autoconfiguration et utilisation de fichiers de configuration json générés quotidiennement à partir des getCapabilities des services du Geoportail.

L'ensemble des services de calcul appelés via la bibliothèque d'accès sont désormais appelés avec la clé "calcul" par défaut dans la bibliothèque d'accès. Le paramètre "apiKey" n'est donc plus nécessaire pour appeler les services de géocodage, d'itinéraire, d'isochrone, d'altimétrie et d'autocomplétion, que ce soit directement depuis la bibliothèque d'accès ou via les widgets des extensions Géoportail.
L'autoconfiguration n'est plus appelée par les API. Pour la remplacer, nous générons quotidiennement, à partir des getCapabilities des services WMS et WMTS, des fichiers de configuration en JSON appelables par les API JavaScript Géoportail. Il y a un fichier par clé générique. L'avantage de ce nouveau processus (en plus de s'adapter au futur arrêt du service d'autoconfiguration) est que les fichiers de configuration JSON sont directement au format attendu par les API : il n'y a plus besoin de les parser pour en extraire les informations utiles puis pour les introduire dans une structure adéquate.
Par exemple, en renseignant "cartes" au paramètre apiKey, c'est le fichier cartesConfig.json qui sera chargé et directement utilisé par les API.

A noter que le multiKeys est toujours géré, c'est à dire qu'il est possible de renseigner plusieurs clés dans le paramètre apiKey.

Il est également possible de générer son propre fichier de configuration à partir d'une ou plusieurs clés. L'utilitaire est temporairement disponible ici : https://geoportal-configuration.onrender.com. Le paramètre permettant ensuite de charger sa configuration personnelle à partir du fichier local généré s'appelle désormais **customConfigFile**, auquel on associera le chemin vers le fichier de configuration json à charger.

## Changelog
* [Added]
* [Changed]
- mise à jour de la bibliothèque d'accès aux services Geoportail en version 3.3.0 (#364)
- **BC** : paramètre "customConfigFile" pour appeler un fichier de configuration local (#364)
##### Avant :
```html
<script src="chemin/vers/GpPluginItowns.js" data-url="chemin/vers/mon/autoconf/AutoConf.js"></script>
```
OU
```javascript
Gp.Services.getConfig({
serverUrl : "chemin/vers/mon/autoconf/AutoConf.js",
timeOut : 20000,
onSuccess : createMap
});
```
##### Maintenant :
```html
<script src="chemin/vers/GpPluginItowns.js" data-url="chemin/vers/ma/config/customConfig.json"></script>
```
OU
```javascript
Gp.Services.getConfig({
customConfigFile: "chemin/vers/ma/config/customConfig.json",
timeOut: 20000,
onSuccess: createMap
});
```
* [Deprecated]
* [Removed]
- **BC** : les originators ne sont plus renvoyés dans la configuration. Il faut les ajouter manuellement aux couches.
```javascript
// Couche WMTS Geoportail
globeView.addLayer(new Gp.itownsExtended.layer.GeoportalWMTS({
layer: "ORTHOIMAGERY.ORTHOPHOTOS",
itownsParams: {
source: {
attribution: [{
"name": "Nom raccourci originator",
"url": "http://www.url-vers-le-site-du-producteur.fr",
"constraints": [{
"crs": "EPSG:4326",
"bbox": {
"left": -180,
"right": 180,
"top": 90,
"bottom": -90
},
"minScaleDenominator": 2,
"maxScaleDenominator": 800000
}]
},
{
"name": "Nom raccourci originator 2",
"url": "http://www.url-vers-le-site-du-producteur2.fr",
"constraints": [{
"crs": "EPSG:4326",
"bbox": {
"left": 1.5,
"right": 3,
"top": 49,
"bottom": 48
},
"minScaleDenominator": 10000,
"maxScaleDenominator": 450000
}]
}]
}
}
}));
```
- **BC** : Les metadatas sont utilisées dans les API par le contrôle gestionnaire de couches (LayerSwitcher). Celui-ci va lire les metadatas des couches ajoutées à la carte et les afficher dans l'encart d'information dédié du LayerSwitcher. **Pour les couches WMTS uniquement**, désormais, pour que les metadatas apparaissent dans l'onglet "informations" du LayerSwitcher, il faudra les renseigner manuellement à la configuration de la couche Géoportail lors de son ajout à la carte.

```javascript
// Couche WMTS Geoportail
globeView.addLayer(new Gp.itownsExtended.layer.GeoportalWMTS({
layer: "ORTHOIMAGERY.ORTHOPHOTOS",
ssl: true,
metadata: [
{
format: "xml",
url: "lien/Vers/Une/MetaDonnee.xml"
}
]
}));
```

* [Fixed]
* [Security]
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
"name": "geoportal-extensions",
"description": "French Geoportal Extensions for OpenLayers, Leaflet and iTowns libraries",
"version": "2.8.0",
"date": "02/06/2023",
"date": "07/06/2023",
"leafletExtName": "French Geoportal Extension for Leaflet",
"leafletExtVersion": "2.2.9",
"leafletExtVersion": "2.3.0",
"olExtName": "French Geoportal Extension for OpenLayers",
"olExtVersion": "3.3.0",
"itownsExtName": "French Geoportal Extension for Itowns",
"itownsExtVersion": "2.3.11",
"itownsExtVersion": "2.4.0",
"main": "dist/leaflet/GpPluginLeaflet.js, dist/openlayers/GpPluginOpenLayers.js, dist/itowns/GpPluginItowns.js",
"types": "dist/leaflet/index.d.ts, dist/openlayers/index.d.ts, dist/itowns/index.d.ts",
"module": "src/Leaflet/index.js, src/OpenLayers/index.js, src/Itowns/index.js",
Expand Down

0 comments on commit 7fab093

Please sign in to comment.