release-3.3.6

IGNF · Jan 28, 2022 · baa4a21 · baa4a21
2 parents 1443287 + ab5d71e
commit baa4a21
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 26 deletions.
diff --git a/DRAFT_CHANGELOG.md b/DRAFT_CHANGELOG.md
@@ -1,23 +1,27 @@
-# SDK Geoportail 2D/3D, version 3.3.5
+# SDK Geoportail 2D/3D, version 3.3.6
 
-**17/01/2022 : version 3.3.5**
+**28/01/2022 : version 3.3.6**
 
 > Release SDK Geoportail 2D/3D
 
 ## Summary
 
-* Mise à jour des extensions : ol 3.2.6
+Mise à jour de la documentation et des extensions geoportail pour openlayers en version 3.2.7
 
 ## Changelog
 
 * [Added]
 
 * [Changed]
 
+    - Mise à jour de la documentation et des README (#88)
+    - Mise à jour des extensions geoportail pour openlayers en version 3.2.7
+
 * [Removed]
 
 * [Fixed]
 
 * [Deprecated]
 
 * [Security]
+
diff --git a/README-SDK-2D.md b/README-SDK-2D.md
@@ -147,8 +147,8 @@ var map = Gp.Map.load(
     "mapDiv",   // identifiant du conteneur HTML
     // options d'affichage de la carte (Gp.MapOptions)
     {           
-         // clef d'accès à la plateforme
-         apiKey: "APIKEY",
+         // clef(s) d'accès à la plateforme
+         apiKey: "APIKEY-1,APIKEY-2",
          // centrage de la carte
          center : {
              location : "73 avenue de Paris, Saint-Mandé"
@@ -177,7 +177,7 @@ var map = Gp.Map.load(
 
 Permet, d'afficher une carte avec les options suivantes :
 
-* utilisation des **droits de la clef** 'APIKEY' ([Plus d'infos sur les possibilités de paramétrage des droits...](#config));
+* utilisation des **droits d'une ou de plusieurs clefs** 'APIKEY-1', 'APIKEY-2' ([Plus d'infos sur les possibilités de paramétrage des droits...](#config));
 
 * **centrage** sur l'adresse *"73 avenue de Paris, Saint-Mandé"* (en utilisant le service de géocodage du Géoportail) zoomée au niveau 17 ; ([Plus d'infos sur les possibilités de centrage...](#center))
 
@@ -196,12 +196,12 @@ Permet, d'afficher une carte avec les options suivantes :
 
 ### Configuration de l'accès à la plateforme Géoportail
 
-Le SDK Géoportail exploite les services web exposés par la plateforme Géoportail. Ceux-ci sont soumis à l'obtention d'une **clef d'accès** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources que vous souhaitez exploiter.
+Le SDK Géoportail exploite les services web exposés par la plateforme Géoportail. Ceux-ci sont soumis à l'obtention d'une ou de plusieurs **clefs d'accès génériques** obtenues sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources que vous souhaitez exploiter. Il est possible de savoir quelle clef est associée à quelle ressource [ici](https://geoservices.ign.fr/documentation/services/tableau_ressources).
 
 
 ### Configuration dynamique
 
-Une fois la clef obtenue, vous pouvez l'utiliser pour paramétrer le SDK à l'aide de la propriété **apiKey** lors de l'initialisation de la carte :
+Une fois la ou les clefs voulues choisies, vous pouvez les utiliser pour paramétrer le SDK à l'aide de la propriété **apiKey** lors de l'initialisation de la carte :
 
 
 ``` javascript
@@ -211,7 +211,7 @@ var map = Gp.Map.load(
     {
          ...
          // clef d'accès à la plateforme
-         apiKey: "APIKEY",
+         apiKey: "APIKEY-1,APIKEY-2",
          ...
     }
 ) ;
@@ -222,7 +222,7 @@ Lors du chargement de la carte, le SDK récupèrera automatiquement la configura
 
 ### Optimisation du chargement : configuration locale
 
-Vous pouvez améliorer le temps de chargement de votre page en mettant en cache sur votre plateforme la configuration associée à votre clef d'accès. Il vous suffit pour cela de récupérer le fichier de configuration (autoconf.json) obtenu à l'aide [du formulaire de ce tutoriel](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/tutorial-optimize-getconfig.html).
+Vous pouvez améliorer le temps de chargement de votre page en mettant en cache sur votre plateforme la configuration associée à votre ou vos clefs d'accès. Il vous suffit pour cela de récupérer le fichier de configuration (autoconf.json) obtenu à l'aide [du formulaire de ce tutoriel](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/tutorial-optimize-getconfig.html).
 
 Enregistrez ce fichier sur votre plateforme et paramétrez le SDK à l'aide de la propriété **configUrl** lors de l'initialisation de la carte :
 
@@ -299,7 +299,7 @@ var map = Gp.Map.load(
 ) ;
 ```
 
-*NB* : Cette possibilité de centrage ne fonctionne que si [la clef d'accès à la plateforme Géoportail utilisée pour paramétrer le SDK](#config) possède les droits nécessaires sur les ressources utilisées pour le Géocodage.
+*NB* : Cette possibilité de centrage ne fonctionne que si au moins [une clef d'accès à la plateforme Géoportail utilisée pour paramétrer le SDK](#config) possède les droits nécessaires sur les ressources utilisées pour le Géocodage.
 
 
 #### Centrage par géolocalisation du terminal utilisé
@@ -339,7 +339,7 @@ Selon le type de couches à afficher ("Géoportail" ou externe), le paramétrage
 
 #### Affichage des couches Géoportail WMS et WMTS
 
-Les couches Géoportail sont les couches auxquelles donne droit [la clef utilisée pour paramétrer la carte](#config). Pour ajouter une telle couche à la carte, il suffit d'utiliser son nom technique comme clef de l'objet **layersOptions** et de passer comme valeur associée, un objet javascript de type [Gp.LayerOptions](https://ignf.github.io/geoportal-sdk/latest/jsdoc/Gp.LayerOptions.html) contenant, si besoin, des propriétés particulières ou vide si la configuration par défaut convient.
+Les couches Géoportail sont les couches auxquelles donne droit [les clefs utilisées pour paramétrer la carte](#config). Pour ajouter une telle couche à la carte, il suffit d'utiliser son nom technique comme clef de l'objet **layersOptions** et de passer comme valeur associée, un objet javascript de type [Gp.LayerOptions](https://ignf.github.io/geoportal-sdk/latest/jsdoc/Gp.LayerOptions.html) contenant, si besoin, des propriétés particulières ou vide si la configuration par défaut convient.
 
 **Exemple 1** : ajout des couches WMTS Photographies aériennes et cartes avec une opacité de 30%.
 
@@ -594,7 +594,7 @@ map = Gp.Map.load(
     "mapDiv",   // identifiant du conteneur HTML
     // options d'affichage de la carte (Gp.MapOptions)
     {
-         apiKeys : "API-KEY",
+         apiKey : "APIKEY-1, APIKEY-2",
          ...
          mapEventsOptions : {
              // Appel de la fonction après le chargement de la carte

diff --git a/README-SDK-3D.md b/README-SDK-3D.md
@@ -121,7 +121,7 @@ import * as Gp from "@ignf-geoportal/sdk-3d";
 
 // votre utilisation du SDK
 var map = Gp.Map.load("myDivId",{
-    apiKey : "myApiKey",
+    apiKey : "myApiKey1,myApiKey2",
     viewMode : "2d", // ou "3d"
     ...
 });
@@ -153,7 +153,7 @@ var map = Gp.Map.load(
     // options d'affichage de la carte (Gp.MapOptions)
     {           
          // clef d'accès à la plateforme
-         apiKey: "APIKEY",
+         apiKey: "APIKEY-1,APIKEY-2",
          // chargement de la cartographie en 3D avec la librairie itowns
          viewMode : "3d",
 
@@ -181,7 +181,7 @@ var map = Gp.Map.load(
 
 Permet, d'afficher une carte avec les options suivantes :
 
-* utilisation des **droits de la clef** 'APIKEY' ([Plus d'infos sur les possibilités de paramétrage des droits...](#config));
+* utilisation des **droits de la ou des clefs** 'APIKEY-1, APIKEY-2' ([Plus d'infos sur les possibilités de paramétrage des droits...](#config));
 
 * **viewMode** : "**3d**" pour un chargement de la cartographie en 3D, **avec la librairie iTowns,** ou "**2d**" (par défaut) pour un chargement de la cartographie en 2D, **avec la librairie OpenLayers.** Il sera ensuite possible de basculer d'un mode de visualisation à l'autre (Voir la partie "Bascule entre 2D et 3D).
 
@@ -198,7 +198,7 @@ Permet, d'afficher une carte avec les options suivantes :
 
 ### Configuration de l'accès à la plateforme Géoportail
 
-Le SDK Géoportail exploite les services web exposés par la plateforme Géoportail. Ceux-ci sont soumis à l'obtention d'une **clef d'accès** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources que vous souhaitez exploiter.
+Le SDK Géoportail exploite les services web exposés par la plateforme Géoportail. Ceux-ci sont soumis à l'obtention d'une ou de plusieurs **clefs d'accès génériques** obtenues sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources que vous souhaitez exploiter. Il est possible de savoir quelle clef est associée à quelle ressource [ici](https://geoservices.ign.fr/documentation/services/tableau_ressources).
 
 
 ### Configuration dynamique
@@ -213,7 +213,7 @@ var map = Gp.Map.load(
     {
          ...
          // clef d'accès à la plateforme
-         apiKey: "APIKEY",
+         apiKey: "APIKEY-1,APIKEY-2",
          ...
     }
 ) ;
@@ -303,7 +303,7 @@ var map = Gp.Map.load(
 ) ;
 ```
 
-*NB* : Cette possibilité de centrage ne fonctionne que si [la clef d'accès à la plateforme Géoportail utilisée pour paramétrer le SDK](#config) possède les droits nécessaires sur les ressources utilisées pour le Géocodage.
+*NB* : Cette possibilité de centrage ne fonctionne que si au moins [une clef d'accès à la plateforme Géoportail utilisée pour paramétrer le SDK](#config) possède les droits nécessaires sur les ressources utilisées pour le Géocodage.
 
 
 #### Centrage par géolocalisation du terminal utilisé
@@ -345,7 +345,7 @@ Selon le type de couches à afficher ("Géoportail" ou externe), le paramétrage
 
 #### Affichage des couches Géoportail WMS et WMTS
 
-Les couches Géoportail sont les couches auxquelles donne droit [la clef utilisée pour paramétrer la carte](#config). Pour ajouter une telle couche à la carte, il suffit d'utiliser son nom technique comme clef de l'objet **layersOptions** et de passer comme valeur associée, un objet javascript de type [Gp.LayerOptions](https://ignf.github.io/geoportal-sdk/latest/jsdoc/Gp.LayerOptions.html) contenant, si besoin, des propriétés particulières ou vide si la configuration par défaut convient.
+Les couches Géoportail sont les couches auxquelles donne droit [les clefs utilisées pour paramétrer la carte](#config). Pour ajouter une telle couche à la carte, il suffit d'utiliser son nom technique comme clef de l'objet **layersOptions** et de passer comme valeur associée, un objet javascript de type [Gp.LayerOptions](https://ignf.github.io/geoportal-sdk/latest/jsdoc/Gp.LayerOptions.html) contenant, si besoin, des propriétés particulières ou vide si la configuration par défaut convient.
 
 Pour afficher un MNT IGN dans un contexte 3D, il suffit de renseigner le paramètre "isElevation" à true.
 

diff --git a/package.json b/package.json
@@ -1,9 +1,9 @@
 {
     "name": "geoportal-sdk",
-    "version": "3.3.5",
-    "date": "17/01/2022",
-    "SDK2DVersion": "3.3.5",
-    "SDK3DVersion": "3.3.5",
+    "version": "3.3.6",
+    "date": "28/01/2022",
+    "SDK2DVersion": "3.3.6",
+    "SDK3DVersion": "3.3.6",
     "description": "French Geoportal SDK based on OpenLayers (2D) and iTowns (3D) libraries",
     "main": "dist/2d/GpSDK2D-src.js, dist/3d/GpSDK3d-src.js",
     "module": "src/SDK2D.js, src/SDK3D.js",
@@ -73,7 +73,7 @@
         "expose-loader": "^0.7.5",
         "fs-extra": "^9.0.0",
         "geoportal-extensions-itowns": "2.3.4",
-        "geoportal-extensions-openlayers": "3.2.6",
+        "geoportal-extensions-openlayers": "3.2.7",
         "handlebars": "^4.7.5",
         "handlebars-layouts": "^3.1.4",
         "html-webpack-plugin": "^4.0.4",

diff --git a/src/Map.js b/src/Map.js
@@ -182,7 +182,7 @@ var mapLoadedEvent = {
  *
  * | property | Type | Argument | Default | Description |
  * | - | - | - | - | - |
- * | apiKey | String / Array.<String> | | | access key(s) to Geoportal platform, obtained [here](http://professionnels.ign.fr/ign/contrats) |
+ * | apiKey | String / Array.<String> | | | generic access key(s) to Geoportal platform, obtained [here](https://geoservices.ign.fr/services-web) |
  * | viewMode | String | optional | "2d" | Library to load the map with. Values are : <ul> <li> "2d" (default) to load the map with OpenLayers (2D) </li> <li>"3d" to be able to use 2D (OpenLayers) and 3D (iTowns) views. In this case, you have to use GpSDK3D.js file (instead of GpSDK2D.js)</li></ul> |
  * | center | {@link Gp.Center Gp.Center} | optional | | Map Centering information. Either with coordinates, with geoportal geocoding service or with user geo-localization. |
  * | azimuth | Float | optional | 0 | Map orientation in decimal degrees clockwise to the north. |