mirror of
https://github.com/umap-project/umap.git
synced 2025-04-28 11:32:38 +02:00
docs-users: Also document the data
URL parameter
This commit is contained in:
parent
9f7f9b08be
commit
393ae0df6b
2 changed files with 33 additions and 13 deletions
|
@ -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` :
|
||||||
(avec la méthode `encodeURIComponent()` en JavaScript par exemple).
|
|
||||||
|
|
||||||
Vous pouvez aussi utiliser le paramètre `dataFormat` en fonction de la
|
* Le paramètre `data` doit être URI encodé
|
||||||
ressource distante vers laquelle vous faites un lien:
|
(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)
|
* `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
|
||||||
|
|
|
@ -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
|
||||||
|
|
Loading…
Reference in a new issue