From 393ae0df6bea62f4adecbb1148bea6b86b8f7506 Mon Sep 17 00:00:00 2001 From: David Larlet Date: Wed, 26 Jun 2024 14:16:16 -0400 Subject: [PATCH] docs-users: Also document the `data` URL parameter --- docs-users/fr/support/advanced.md | 25 +++++++++++++++++-------- docs-users/support/advanced.md | 21 ++++++++++++++++----- 2 files changed, 33 insertions(+), 13 deletions(-) diff --git a/docs-users/fr/support/advanced.md b/docs-users/fr/support/advanced.md index 1e8a68fc..42624378 100644 --- a/docs-users/fr/support/advanced.md +++ b/docs-users/fr/support/advanced.md @@ -3,11 +3,15 @@ ## Précharger une carte avec des données {: #preloading-data } Il est possible de précharger une carte avec des données en utilisant -le paramètre `dataUrl`, ce paramètre doit lier vers une URL encodée -(avec la méthode `encodeURIComponent()` en JavaScript par exemple). +les paramètres `data` ou `dataUrl` : -Vous pouvez aussi utiliser le paramètre `dataFormat` en fonction de la -ressource distante vers laquelle vous faites un lien: +* Le paramètre `data` doit être URI encodé + (avec la méthode `encodeURIComponent()` en JavaScript par exemple). +* Le paramètre `dataUrl` doit lier vers une URL encodée + (avec la méthode `encodeURIComponent()` en JavaScript par exemple). + +Vous pouvez ajouter le paramètre `dataFormat` en fonction de la +nature de vos données: * `geojson` (défaut) * `csv` @@ -16,8 +20,13 @@ ressource distante vers laquelle vous faites un lien: * `kml` * `osm` -Cet exemple va charger une carte avec les contours géographiques pour -la commune d’Arles, récupérés dynamiquement depuis -[geo.api.gouv.fr](https://geo.api.gouv.fr/): +Cet exemple, utilisant le paramètre `data`, va charger une carte avec un marqueur +positionné sur les Chutes du Niagara à partir de données en CSV : -https://umap.openstreetmap.fr/en/map/?dataUrl=https%3A%2F%2Fgeo.api.gouv.fr%2Fcommunes%3Fcode%3D13004%26format%3Dgeojson%26geometry%3Dcontour +https://umap.openstreetmap.fr/fr/map/?data=name%252Clatitude%252Clongitude%250AChutes%20du%20Niagara%252C43.084799710219066%252C-79.0693759918213&dataFormat=csv + +Cet exemple, utilisant le paramètre `dataUrl`, va charger une carte avec les contours géographiques pour +la commune d’Arles, récupérés dynamiquement depuis +[geo.api.gouv.fr](https://geo.api.gouv.fr/) en GeoJSON : + +https://umap.openstreetmap.fr/fr/map/?dataUrl=https%3A%2F%2Fgeo.api.gouv.fr%2Fcommunes%3Fcode%3D13004%26format%3Dgeojson%26geometry%3Dcontour diff --git a/docs-users/support/advanced.md b/docs-users/support/advanced.md index 12965952..89e6dc4f 100644 --- a/docs-users/support/advanced.md +++ b/docs-users/support/advanced.md @@ -2,10 +2,14 @@ ## Preloading a map with data {: #preloading-data } -You can preload a map using the `dataUrl` parameter, that parameter must link -to an encoded URL (using JavaScript’s `encodeURIComponent()` for instance). +You can preload a map using the `data` or the `dataUrl` parameter: -You can also set the `dataFormat` parameter given the resource you are linking to: +* The `data` parameter must be URI encoded + (using JavaScript’s `encodeURIComponent()` for instance). +* The `dataURL` parameter must link to an encoded URL + (using JavaScript’s `encodeURIComponent()` for instance). + +You can add the `dataFormat` parameter given the nature of your data: * `geojson` (default) * `csv` @@ -14,7 +18,14 @@ You can also set the `dataFormat` parameter given the resource you are linking t * `kml` * `osm` -This example will load a map with borders for Arles, dynamically fetched -from [geo.api.gouv.fr](https://geo.api.gouv.fr/) : + +This example, using the `data` parameter, will load a map with a marker +set on Niagara Falls from CSV formatted data: + +https://umap.openstreetmap.fr/en/map/?data=name%252Clatitude%252Clongitude%250ANiagara%20Falls%252C43.084799710219066%252C-79.0693759918213&dataFormat=csv + +That example, using the `dataUrl` parameter, will load a map with +borders for Arles, dynamically fetched from +[geo.api.gouv.fr](https://geo.api.gouv.fr/) in GeoJSON: https://umap.openstreetmap.fr/en/map/?dataUrl=https%3A%2F%2Fgeo.api.gouv.fr%2Fcommunes%3Fcode%3D13004%26format%3Dgeojson%26geometry%3Dcontour