almet/umap
1
0
Fork 0
mirror of https://github.com/umap-project/umap.git synced 2025-04-28 19:42:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs-users: Also document the data URL parameter

Browse source
This commit is contained in:
David Larlet 2024-06-26 14:16:16 -04:00
parent 9f7f9b08be
commit 393ae0df6b
No known key found for this signature in database
GPG key ID: 3E2953A359E7E7BD
2 changed files with 33 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
docs-users/fr/support/advanced.md
View file

@ -3,11 +3,15 @@
## Précharger une carte avec des données {: #preloading-data } ## Précharger une carte avec des données {: #preloading-data }
Il est possible de précharger une carte avec des données en utilisant 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 les paramètres `data` ou `dataUrl` :
* 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). (avec la méthode `encodeURIComponent()` en JavaScript par exemple).
Vous pouvez aussi utiliser le paramètre `dataFormat` en fonction de la Vous pouvez ajouter le paramètre `dataFormat` en fonction de la
ressource distante vers laquelle vous faites un lien: nature de vos données:
* `geojson` (défaut) * `geojson` (défaut)
* `csv` * `csv`
@ -16,8 +20,13 @@ ressource distante vers laquelle vous faites un lien:
* `kml` * `kml`
* `osm` * `osm`
Cet exemple va charger une carte avec les contours géographiques pour Cet exemple, utilisant le paramètre `data`, va charger une carte avec un marqueur
la commune d’Arles, récupérés dynamiquement depuis positionné sur les Chutes du Niagara à partir de données en CSV :
[geo.api.gouv.fr](https://geo.api.gouv.fr/):
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

21
docs-users/support/advanced.md
View file

@ -2,10 +2,14 @@
## Preloading a map with data {: #preloading-data } ## Preloading a map with data {: #preloading-data }
You can preload a map using the `dataUrl` parameter, that parameter must link You can preload a map using the `data` or the `dataUrl` parameter:
to an encoded URL (using JavaScript’s `encodeURIComponent()` for instance).
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) * `geojson` (default)
* `csv` * `csv`
@ -14,7 +18,14 @@ You can also set the `dataFormat` parameter given the resource you are linking t
* `kml` * `kml`
* `osm` * `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 https://umap.openstreetmap.fr/en/map/?dataUrl=https%3A%2F%2Fgeo.api.gouv.fr%2Fcommunes%3Fcode%3D13004%26format%3Dgeojson%26geometry%3Dcontour