documentation

L’utilisation de l’extension Géoplateforme pour Leaflet se fait via les étapes suivantes :

• Téléchargement de l’extension Géoplateforme

• Intégration de l’extension dans une page web

• Configuration de l’accès à la Géoplateforme

Une documentation technique (jsdoc), une demo et un generateur de carte sont disponibles ici.

Téléchargement

Vous pouvez récupérer l’extension Géoplateforme pour Leaflet soit par téléchargement direct, soit en utilisant le gestionnaire de dépendances javascript NPM.

L’extension Géoplateforme pour Leaflet comprend l’arborescence de fichiers suivante :

  <Extension Géoplateforme pour Leaflet>/
    GpPluginLeaflet.js         (version minifiée du code javascript pour une utilisation en production)
    GpPluginLeaflet.css        (version minifiée des css pour une utilisation en production)
    GpPluginLeaflet-map.js     (version du code javascript sous forme de sources pour une utilisation en développement)
    GpPluginLeaflet-map.css    (version du css sous forme de sources pour une utilisation en développement)
    GpPluginLeaflet-src.js     (version non minifiée du code javascript pour une utilisation en développement)
    GpPluginLeaflet-src.css    (version non minifiée des css pour une utilisation en développement)

Les scripts de Leaflet s’obtiennent sur la page de téléchargement de Leaflet.

Téléchargement direct

Vous pouvez télécharger la dernière version de l’extension Géoplateforme pour Leaflet directement sur la page des releases des extensions Géoplateforme.

L’archive téléchargée comprend l’arborescence décrite ci-dessus.

Récupération avec NPM

L’extension Géoplateforme pour Leaflet est aussi disponible dans les dépôts NPM.

Prérequis : NodeJS et npm installés.

npm i geoportal-extensions-leaflet

L’arborescence décrite ci-dessus sera alors accessible dans le répertoire node_modules/geoportal-extensions-leaflet/dist/ de votre projet.

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 :

http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet.js
http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet.css
http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet-map.js
http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet-map.css
http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet-src.js
http://ignf.github.io/geoportal-extensions/leaflet-latest/dist/GpPluginLeaflet-src.css

Intégration dans une page web

Dézippez l’extension Géoplateforme dans l’arborescence de votre serveur web. Vous pouvez positionner à votre guise les fichiers css et javascript.

Intégrez l’extension Géoplateforme pour Leaflet dans votre page web classiquement à l’aide d’une balise script pour charger le fichier javascript et d’une balise link pour charger le fichier css en plus des balises correspondantes utilisées pour charger la bibliothèque Leaflet.

<!-- Library Leaflet -->
<link rel="stylesheet" href="chemin/vers/leaflet/leaflet.css" />
<script src="chemin/vers/leaflet/leaflet.js"></script>

<!-- Extension Géoplateforme pour Leaflet -->
<script src="chemin/vers/GpPluginLeaflet.js"></script>
<link rel="stylesheet" href="chemin/vers/GpPluginLeaflet.css" />

Configuration de l’accès à la Géoplateforme

L’extension Géoplateforme pour Leaflet exploite les services web exposés par la Géoplateforme. Ceux-ci sont en libre accès.

Vous pouvez cependant paramétrer l'utilisation de l'extension avec une ou plusieurs thématiques Géoplateforme qui correspondent à vos besoins en générant un fichier de configuration local à partir de cette interface ou en passant par le paramètre apiKey.

Si ni apiKey, ni fichier de configuration local n'est spécifié, l'utilisateur récupérera une configuration complète avec toutes les ressources de la Géoplateforme (qui pourra donc être très volumineuse).

Vous pouvez configurer les extensions des manières suivantes :

Méthode 1 : Au chargement de l’extension en utilisant l’attribut "data-key" de la balise script de chargement de l’extension :

<script data-key="THEME" src="chemin/vers/GpPluginLeaflet.js"></script>

Thèmes multiples : Si vous devez utiliser plusieurs thèmes, il est possible de mettre une liste de clés dans l'attribut data-key :

<script data-key="THEME-1,THEME-2,THEME-3" src="chemin/vers/GpPluginLeaflet.js"></script>

Votre utilisation des fonctionnalités de l’extension Géoplateforme sera alors simplement conditionnée par la réception de l’événement onload de la page web, comme sur l’exemple suivant :

<html>
    <head>
        <!-- Library Leaflet -->
        <link rel="stylesheet" href="leaflet.css" />
        <script src="leaflet.js"></script>
        <!-- Extension Géoplateforme pour Leaflet -->
        <link rel="stylesheet" href="GpPluginLeaflet.css" />
        <script src="GpPluginLeaflet.js" data-key="THEME"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                // votre utilisation de l'extension Géoplateforme pour Leaflet
            }
        </script>
    </body>
</html>

Méthode 2 : A la fin du chargement de la page en utilisant la fonction Gp.Services.getConfig() et en conditionnant alors l’utilisation de l’extension à l’exécution de la fonction de rappel onSuccess passée en paramètres de Gp.Services.getConfig() comme sur l’exemple suivant :

<html>
    <head>
        <!-- Library Leaflet -->
        <link rel="stylesheet" href="leaflet.css" />
        <script src="leaflet.js"></script>
        <!-- Extension Géoplateforme pour Leaflet -->
        <link rel="stylesheet" href="GpPluginLeaflet.css" />
        <script src="GpPluginLeaflet.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                Gp.Services.getConfig({
                    apiKey: 'THEME',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoplateforme pour Leaflet
                    }
                });
            }
        </script>
    </body>
</html>

Thèmes multiples : Si vous devez utiliser plusieurs thématiques, il est possible de mettre une liste de thèmes dans l'attribut apikey de la fonction getConfig :

<html>
    <head>
        <!-- Bibliothèque Leaflet -->
        <link rel="stylesheet" href="leaflet.css" />
        <script src="leaflet.js"></script>
        <!-- Extension Géoplateforme pour Leaflet -->
        <link rel="stylesheet" href="GpPluginLeaflet.css" />
        <script src="GpPluginLeaflet.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                Gp.Services.getConfig({
                    apiKey: 'THEME-1,THEME-2,THEME-3',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoplateforme pour Leaflet 
                    }
                });
            }
        </script>
    </body>
</html>

Optimisation du chargement : configuration locale

Vous pouvez améliorer le temps de chargement de votre page en mettant en cache sur votre plateforme un fichier de configuration Géoplateforme, qui contient les information nécéssaires des ressources que vous souhaitez utiliser uniquement. Il vous suffit pour cela de récupérer le fichier de configuration (configFile.json) obtenu à l’aide de cet utilitaire en ligne.

Enregistrez ce fichier sur votre plateforme et paramétrez l'extension Géoplateforme de la manière suivante (selon les méthodes citées précédemment) :

Méthode 1 : Utilisez l’attribut "data-url" de la balise script chargeant l’extension pour pointer vers votre fichier :

<script data-url="chemin/vers/customConfig.json" src="chemin/vers/GpPluginLeaflet.js"></script>

Votre utilisation des fonctionnalités de l’extension Géoplateforme sera alors simplement conditionnée par la réception de l’événement onload de la page web, comme sur l’exemple suivant :

<html>
    <head>
        <!-- Library Leaflet -->
        ...
        <script data-url="chemin/vers/customConfig.json" src="chemin/vers/GpPluginLeaflet.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                // votre utilisation de l'extension Géoplateforme pour Leaflet
            }
        </script>
    </body>
</html>

Méthode 2 : Utilisez le paramètre customConfigFile de la fonction Gp.Services.getConfig() pour pointer vers votre fichier, ainsi que le paramètre callbackSuffix, de la manière suivante :

<html>
    ...
    <body>
        <script>
            window.onload = function () {
                Gp.Services.getConfig({
                    customConfigFile: 'chemin/vers/customConfig.json',
                    callbackSuffix : '',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoplateforme pour Leaflet
                    }
                });
            }
        </script>
    </body>
</html>

Appel de l’extension dans un module ES6

Le module de l’extension expose de multiples exports nommés (dont le module Leaflet étendu). L’utilisateur a le choix entre plusieurs méthodes d’import.

Méthode 1 : import des exports nommés du module

import {Services, LExtended as L} from 'geoportal-extensions-leaflet';

// votre utilisation de l'extension
var map  = L.map(...)
Services.getConfig(...)

Méthode 2 : import d’un objet d’espace de noms pour le module

Variante 1 : le module Leaflet étendu est récupéré depuis l’espace de noms

import * as Gp from 'geoportal-extensions-leaflet';

// votre utilisation de l'extension
const L = Gp.LExtended;
var map  = L.map(...)
Gp.Services.getConfig(...)

Variante 2 : le module Leaflet est importé indépendamment de l’extension

import L from 'leaflet';
import * as Gp from 'geoportal-extensions-leaflet';

// votre utilisation de l'extension
var map  = L.map(...)
Gp.Services.getConfig(...)

Versions de Leaflet supportées

L’extension Géoplateforme pour Leaflet peut s’utiliser avec les versions de Leaflet suivantes :

• version 0.7.X
• version 1.0.X
• version 1.2.X
• version 1.3.X
• version 1.4.X
• version 1.5.1
• version 1.7.1

La release Leaflet version 1.1.0 est incompatible avec l’utilisation du plugin Leaflet-Draw.

Pour profiter de toutes les fonctionnalités, il faut utiliser la dernière release Leaflet version 1.7.1.

Navigateurs supportés

Leaflet utilise par défaut les systèmes de coordonnées mondiaux “standards” dont on peut trouver la liste ici.

L’extension Géoplateforme pour Leaflet embarque de nombreuses projections en EPSG, CRS ainsi que sous le registre IGNF. Il est possible d’appeler ces projections avec le mécanisme de Leaflet.

Exemple :

// Appel de la Projection Lambert 93
var LAMB93 = new L.Proj.CRS('IGNF:LAMB93');

La définition d’autres systèmes de coordonnées est cependant possible par l’adjonction de deux bibliothèques Proj4js et Proj4Leaflet. La première permettant de définir des systèmes de coordonnées et d’effectuer des transformations de coordonnées entre systèmes ; la seconde permettant d’utiliser la première dans Leaflet.

L’extension Géoplateforme pour Leaflet intègre nativement ces deux bibliothèques. Si vous l’utilisez vous pouvez donc directement définir les systèmes de coordonnées que vous souhaitez selon la syntaxe proj4 et en utilisant le mécanisme de Leaflet.

Exemple :

// Définition de la Projection UTM 20N
var utm20 = new L.Proj.CRS('EPSG:4559',
    '+proj=utm +zone=20 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs');

NB :

• Le site epsg.io recense un grand nombre de registres de systèmes de coordonnées avec leurs définitions.

• Les définitions des systèmes de coordonnées du registre IGNF peuvent être trouvées ici.

L'extension Géoplateforme pour Leaflet définit par défaut la projection légale Lambert 93 (EPSG:2154) qu'elle expose sous la variable globale suivante.

L.geoportalCRS.EPSG2154

L’affichage des couches WMTS Géoplateforme se fait à l’aide de la fonction L.geoportalLayer.WMTS(), utilisée de la manière suivante :

L.geoportalLayer.WMTS(options, [leafletParams]);

Cette fonction retourne un objet de type L.TileLayer.

Exemples d’utilisation

Utilisation simple de la fonction

Affichage simple des ortho-images de la Géoplateforme : création d’une layer Géoplateforme, et ajout à la map Leaflet :

// Création de la carte
var map  = L.map('map', {
    zoom : 10,
    center : L.latLng(48, 2)
});

// Création de la couche
var lyr = L.geoportalLayer.WMTS({
    layer  : "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
}) ;

lyr.addTo(map); // ou map.addLayer(lyr);

Exemple d’utilisation :

Affichage en Lambert 93 (EPSG:2154)

La Géoplateforme diffuse aussi des ressources WMTS en projection Lambert 93. Pour permettre de les afficher, l’extension Géoplateforme pour Leaflet prédéfinit la projection correspondante accessible via la constante :

L.geoportalCRS.EPSG2154

Il vous suffit alors de paramétrer la carte Leaflet avec cette projection et d’y rajouter la ressource WMTS de la même manière que précédemment.

// Création de la carte
var map = L.map('divmap', {
    crs : L.geoportalCRS.EPSG2154
}).setView([48, 2], 10);

// Création de la couche
var lyr = L.geoportalLayer.WMTS({
    layer  : "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2.L93"
}) ;

lyr.addTo(map); // ou map.addLayer(lyr);

Exemple d’utilisation :

NB : D'autres systèmes de coordonnées peuvent être définis : plus d'informations...

L’affichage des couches WMS Géoplateforme se fait à l’aide de la fonction L.geoportalLayer.WMS(), utilisée de la manière suivante :

L.geoportalLayer.WMS(options[,leafletParams]);

Cette fonction retourne un objet de type L.TileLayer.WMS.

Exemple d’utilisation

Utilisation simple de la fonction

Affichage des orthos-images servies par le service WMS INSPIRE de la Géoplateforme sur une carte Leaflet en projection EPSG:4326.

// creation de la carte
var map = L.map("map",{
    crs : L.CRS.EPSG4326
}).setView([16.239, -61.545], 12);

// creation et ajout de la couche WMS à la carte
L.geoportalLayer.WMS({
    layer: "OI.OrthoimageCoverage"
}).addTo(map);

Exemple d’utilisation :

Ce widget permet à l’utilisateur de gérer l’empilement des couches composant la carte L.Map et, pour chacune d’elle, d’agir sur la visibilité, l’opacité et d’afficher des informations qui lui sont associées (titre, description, métadonnées, légende).

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.LayerSwitcher(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var layerSwitcher = L.geoportalControl.LayerSwitcher(opts);
map.addControl(layerSwitcher);

Le widget affiche l’ensemble des couches composant la carte L.Map.

Pour chaque couche de la carte L.Map, le widget affiche son titre et sa description (par défaut : l’identifiant Leaflet de la couche), et, si elles sont spécifiées, des informations plus détaillées : légendes, métadonnées, aperçu rapide.

La récupération de ces informations n’est pas la même selon la manière dont chaque couche a été ajoutée à la carte :

• Couches ajoutées via la fonctionnalité d’affichage simple des couches WMS ou WMTS de la Géoplateforme de l’extension pour Leaflet : ces informations sont disponibles car elles ont été chargées par lors de la configuration de l'accès à la Géoplateforme, il n’y a donc rien à faire de particulier.

• Autres couches : afin d’afficher ces informations, il est nécessaire de les spécifier dans les options du widget.

Exemples d’utilisation

Utilisation simple

Ajout du widget de gestion de l’empilement des couches sans paramétrage particulier.

// Création de la carte
var map = L.Map('divmap', {center: [2.38, 45.23] , zoom: 13});

// création et ajout d'une couche Géoplateforme
var lyr = L.geoportalLayer.WMTS({
    layer  : "ORTHOIMAGERY.ORTHOPHOTOS",
});
lyr.addTo(map); // ou map.addLayer(lyr);

// Création et ajout du LayerSwitcher
map.addControl(
    L.geoportalControl.LayerSwitcher()
);

Utilisation personnalisée

Paramétrage de l’affichage de la couche dans le LayerSwitcher.

// Création de la carte
var map = L.Map('divmap', {center: [2.38, 45.23] , zoom: 13});

// Création d'une couche quelconque
var lyr = L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png?') ;

// Création et ajout du LayerSwitcher à la carte
map.addControl(
    L.geoportalControl.LayerSwitcher({
        layers : [{
            layer : lyr,
            config : {
                title : "Couche externe",
                description : "Description de ma couche",
                quicklookUrl : "lien/Vers/UnApercuRapide.png",
                legends: [{url : "lien/Vers/UneLegende.png"}],
                metadata : [{url : "lien/Vers/Une/MetaDonnee.xml"}]
            }
        }],
        options : {
            collapsed : true
        }
    })
);

Exemple d’utilisation :

La barre de recherche permet de positionner la carte à partir de la saisie d’un localisant dont la position sera retournée par le service de géocodage de l’IGN.

La saisie de localisants peut s’accompagner d’un mode d’autocomplétion s’appuyant sur le service d’autocomplétion de la Géoplateforme.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.SearchEngine(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var search = L.geoportalControl.SearchEngine(opts);
map.addControl(search);

Exemples d’utilisation

Utilisation simple

Ajout du moteur de recherche sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var searchCtrl = L.geoportalControl.SearchEngine({
});
map.addControl(searchCtrl);

Exemple d’utilisation :

Ce widget permet d’obtenir un ensemble de localisants géographiques (adresses, toponymes ou parcelles cadastrales) en un point ou une zone (cercle ou emprise rectangulaire) saisie interactivement par l’internaute sur une carte Leaflet.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.ReverseGeocode(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var revSearch = L.geoportalControl.ReverseGeocode(opts);
map.addControl(revSearch);

Exemples d’utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var revCtrl = L.geoportalControl.ReverseGeocode({
});
map.addControl(revCtrl);

Exemple d’utilisation :

Le widget de calcul d’itinéraires permet d’interagir avec une carte Leaflet pour effectuer des calculs d’itinéraires utilisant le service dédié de la Géoplateforme.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.Route(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var route = L.geoportalControl.Route(opts);
map.addControl(route);

Exemples d’utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var routeCtrl = L.geoportalControl.Route({
});
map.addControl(routeCtrl);

Exemple d’utilisation :

Ce widget permet d’interagir avec une carte Leaflet pour effectuer des calculs d’isochrones / isodistances utilisant le service dédié de la Géoplateforme.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.Isocurve(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var iso = L.geoportalControl.Isocurve(opts);
map.addControl(iso);

Exemples d’utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var isoCtrl = L.geoportalControl.Isocurve({
});
map.addControl(isoCtrl);

Exemple d’utilisation :

Ce widget permet d’afficher les coordonnées d’un point choisi par l’internaute sur une carte Leaflet dans un ou plusieurs systèmes de coordonnées. Ces coordonnées peuvent comprendre l’altitude obtenue à l’aide du service d’altimétrie de la Géoplateforme.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.MousePosition(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var mp = L.geoportalControl.MousePosition(opts);
map.addControl(mp);

Exemples d’utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "ORTHOIMAGERY.ORTHOPHOTOS",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var mpCtrl = L.geoportalControl.MousePosition({
});
map.addControl(mpCtrl);

Exemple d’utilisation avec affichage unique de l’altitude :

Exemple d’utilisation avec paramétrage des systèmes de coordonnées :

Exemple d’utilisation avec appel d’un système de coordonnées défini :

Exemple d’utilisation avec activation de l’édition de coordonnées pour localisation :

Ce widget permet d’afficher le profil altimétrique d’un tracé saisi par l’internaute sur une carte Leaflet. Le profil est calculé à l’aide du service d’altimétrie de la Géoplateforme.

Son utilisation se fait par la création d’un nouveau contrôle à l’aide de la fonction L.geoportalControl.ElevationPath(), que l’on peut ensuite ajouter à la carte comme les autres contrôles Leaflet, par exemple de la manière suivante :

var ep = L.geoportalControl.ElevationPath(opts);
map.addControl(ep);

Exemples d’utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// creation de la carte
map = L.map("map").setView([47, 2.424], 12);

// ajout d'une couche
var lyrMaps = L.geoportalLayer.WMTS({
    layer: "ORTHOIMAGERY.ORTHOPHOTOS",
});
map.addLayer(lyrMaps) ;

// création et ajout du controle
var ep = L.geoportalControl.ElevationPath({
});
map.addControl(ep);

Exemple d’utilisation :