search

IGNF / geoportal-access-lib

French Geoportal resources access library
https://ignf.github.io/geoportal-access-lib/
Other
25 stars 13 forks source link
geoportail services

readme

Bibliothèque d'accès aux services Géoplateforme

Build GitHub release DeepScan grade

La bibliothèque d’accès aux services Géoplateforme est une bibliothèque de fonctions javascript permettant d'accéder aux ressources délivrées par les services web de la Géoplateforme.

Elle permet plus particulièrement d'effectuer les opérations suivantes :

Mise en oeuvre

Vous pouvez récupérer la bibliothèque d'accès soit en la téléchargeant directement, soit en utilisant le gestionnaire de dépendances javascript NPM.

Une documentation technique (jsdoc) et un testeur sont disponibles ici.

Téléchargement direct

Vous pouvez récupérer ici la version compilée et autonome de la bibliothèque d'accès : GpServices.js, dans la partie "Downloads".

Récupération avec NPM

La bibliothèque d'accès est aussi disponible dans les dépôts NPM.

Prérequis : NodeJS et npm installés.

npm install geoportal-access-lib

Accès direct

Vous pouvez aussi choisir d'utiliser des fichiers hébergés en ligne, pour y accéder directement, lors de vos tests par exemple. Cependant, pour une utilisation en production, nous vous conseillons de télécharger ces fichiers et de les héberger vous-même, sur le même serveur qui héberge votre application.

Par exemple sur Github Pages :

https://ignf.github.io/geoportal-access-lib/latest/dist/GpServices.js
https://ignf.github.io/geoportal-access-lib/latest/dist/GpServices-src.js

Intégration dans une page web

Intégrez la bibliothèque d'accès dans votre page WEB classiquement à l'aide d'une balise script.

<script src="https://github.com/IGNF/geoportal-access-lib/raw/develop/chemin/vers/GpServices.js"></script>

Intégration dans NodeJS

Intégrez la bibliothèque d'accès dans votre script à l'aide de la fonction require.

var Gp = require("chemin/vers/GpServices.js");

Note : Par défaut, les services sont intérrogés en HTTP. On a la possibilité de forcer le HTTPS avec l'option ssl. Ce comportement est ignoré dans les environnements clients (navigateur). Les services sont alors interrogés suivant le même protocole que la page en cours.

var Gp = require("chemin/vers/GpServices.js");

Gp.Services.geocode({
    ssl : true,
    location : "...",
    onSuccess : function (result) {
        ...
    }
});
// --> https://wxs.ign.fr/KEY/geoportail/ols?

Note : Dans un environnement NodeJS, il faut installer les 2 dépendances suivantes dans votre projet :

  • xmldom
  • request

Intégration dans un module ES6

Intégrez la bibliothèque d'accès dans votre page WEB à l'aide d'une balise script de type module.

<script type="module">
    import * as Gp from "chemin/vers/GpServices.js";
    // puis, utilisation de la variable globale 'Gp' dans le module ES6...
</script>

Intégration dans un front-end type Angular ou React

Intégrez la bibliothèque d'accès dans votre module à l'aide de la fonction import.

import * as Gp from "chemin/vers/GpServices.js";

Note : Dans un environnement Front-End, il faut installer les 2 dépendances suivantes dans votre projet :

  • xmldom
  • request

(back to top)

Utilisation

Le chargement de la bibliothèque d'accès vous donne accès au namespace Gp.Services à partir duquel vous pouvez utiliser les différentes fonctions proposées.

Géocoder des adresses, toponymes et parcelles cadastrales

La fonction Gp.Services.geocode permet d'utiliser le service de géocodage de la plateforme Géoportail pour obtenir la position d'un toponyme, d'une adresse ou d'une parcelle cadastrale. Elle prend en paramètres :

Gp.Services.geocode({
    location : "tour eiffel",            // localisant à géocoder
    filterOptions : {
        type : ["PositionOfInterest"]    // type de localisant
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.GeocodeResponse
        ...
    }

});

Exemple d'utilisation jsFiddle

(back to top)

Obtenir des suggestions d'adresses ou de toponymes à partir de textes incomplets

La fonction Gp.Services.autoComplete permet d'utiliser le service d'autocomplétion de la Géoplateforme pour obtenir des suggestions de loclalisants (toponyme ou adresse) à partir d'un texte incomplet. Elle prend en paramètres :

Gp.Services.autoComplete({
    text : "23 rue des et",              // texte à compléter
    filterOptions : {
        type : ["StreetAddress"]         // type de texte
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.AutoCompleteResponse
        ...
    }

});

Exemple d'utilisation jsFiddle

(back to top)

Obtenir des localisants (toponymes, adresses, parcelles cadastrales) proches d'une position donnée (géocodage inverse)

La fonction Gp.Services.reverseGeocode permet d'utiliser le service de géocodage inverse de la plateforme Géoportail pour trouver des toponymes, adresses ou parcelles cadastrales proches d'une position donnée. Elle prend en paramètres :

Gp.Services.reverseGeocode({
    position : {                         // position de recherche
      x: 2.29,
      y: 48.85
    },
    filterOptions : {
        type : ["PositionOfInterest"]    // type de localisant
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.ReverseGeocodeResponse
        ...
    }

});

Exemple d'utilisation jsFiddle

(back to top)

Obtenir des altitudes en un ou plusieurs points ou calculer des profils altimétriques

La fonction Gp.Services.getAltitude() permet d'utiliser le service d'altimétrie de la plateforme Géoportail pour obtenir les altitudes de une ou plusieurs positions données ou calculer un profil altimétrique le long d'une liste de positions. Elle prend en paramètres :

Gp.Services.getAltitude({
    positions : [                        // positions pour le calcul alti
        { lon: 2.29, lat: 48.85 },      
        { lon: 2.3, lat: 48.9 },
        { lon: 2.4, lat: 49 }
    ],
    sampling : 50,                      // nombre de points pour le profil
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.AltiResponse
        ...
    }
});

Exemple d'utilisation jsFiddle

(back to top)

Calculer un itinéraire piéton ou routier

La fonction Gp.Services.route() permet d'utiliser le service de calcul d'itinéraires de la plateforme Géoportail. Elle prend en paramètres :

Gp.Services.route({
    startPoint : { x: 2, y: 45},       // point de départ
    viaPoints : [                        // points intermédiaires
        { x: 3, y: 46 },      
        { x: 3.5, y: 46 }
    ],
    endPoint : { x: 4, y: 47},          // point d'arrivée
    graph : "Voiture",                 // grapĥe utilisé
    resource : "bdtopo-osrm",              //ressource utilisée
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.RouteResponse
        ...
    }
});

Exemple d'utilisation jsFiddle

(back to top)

Calculer des isochrones / isodistances autour d'un point

La fonction Gp.Services.isoCurve() permet d'utiliser le service de calcul d'isochrones / isodistances de la plateforme Géoportail. Elle prend en paramètres :

Gp.Services.isoCurve({
    position : { x: 2, y: 45},       // point de référence
    method : "time",                   // méthode de calcul (isochrone)
    time : 1000,                       // limite de temps (isochrone)
    graph : "Pieton",                 // grapĥe utilisé
    resource : "valhalla",              //ressource utilisée
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.IsoCurveResponse
        ...
    }
});

Exemple d'utilisation jsFiddle

(back to top)

Obtenir des informations relatives à un contrat d'accès au Géoportail

La fonction Gp.Services.getConfig() permet de consulter les ressources disponibles pour une thématique Géoplateforme et d'avoir les paramètres permettant leur utilisation. Elle prend en paramètres :

Gp.Services.getConfig({
    apiKey : "carte", // clef d'accès à la plateforme
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.GetConfigResponse
        ...
    }
});

Exemple d'utilisation jsFiddle

(back to top)