geoportal-extensions-openlayers

French Geoportal Extensions for OpenLayers

Usage no npm install needed!

<script type="module">
  import geoportalExtensionsOpenlayers from 'https://cdn.skypack.dev/geoportal-extensions-openlayers';
</script>

README

Extension Géoportail pour OpenLayers

release

L'extension Géoportail pour OpenLayers propose les fonctionnalités suivantes à utiliser en complément de la bibliothèque OpenLayers dans ses versions 3 et supérieures :

Mise en oeuvre

L'utilisation de l'extension Géoportail pour OpenLayers se fait via les étapes suivantes :

Téléchargement

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

L'extension Géoportail pour OpenLayers comprend l'arborescence de fichiers suivante :

    <Extension Géoportail pour OpenLayers>/
        GpPluginOpenLayers.js
            (version minifiée du code javascript pour une utilisation en production)
        GpPluginOpenLayers.css
            (version minifiée des css pour une utilisation en production)
        GpPluginOpenLayers-src.js
            (version non minifiée du code javascript pour une utilisation en développement)
        GpPluginOpenLayers-src.css
            (version non minifiée des css pour une utilisation en développement)

Les scripts d'OpenLayers s'obtiennent sur la page de téléchargement d'OpenLayers.

Téléchargement direct

Vous pouvez télécharger la dernière version de l'extension Géoportail pour OpenLayers directement sur la page des releases des extensions Géoportail.

L'archive téléchargée (.zip) comprend l'arborescence décrite ci-dessus.

Récupération avec NPM

L'extension Géoportail pour OpenLayers est aussi disponible dans les dépôts NPM.

Prérequis : NodeJS et npm installés.

npm i geoportal-extensions-openlayers

L'arborescence décrite ci-dessus sera alors accessible dans le répertoire node_modules/geoportal-extensions-openlayers/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/openlayers-latest/dist/GpPluginOpenLayers.js
http://ignf.github.io/geoportal-extensions/openlayers-latest/dist/GpPluginOpenLayers.css
http://ignf.github.io/geoportal-extensions/openlayers-latest/dist/GpPluginOpenLayers-src.js
http://ignf.github.io/geoportal-extensions/openlayers-latest/dist/GpPluginOpenLayers-src.css

Intégration dans une page web

Dézippez l'extension géoportail dans l'arborescence votre de serveur web. Vous pouvez positionner à votre guise les fichiers css et javascript.

Intégrez l'extension géoportail pour OpenLayers 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 OpenLayers.

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

<!-- Extension Géoportail pour OpenLayers -->
<script src="chemin/vers/GpPluginOpenLayers.js"></script>
<link rel="stylesheet" href="chemin/vers/GpPluginOpenLayers.css" />

Configuration de l'accès à la plateforme Géoportail

L'extension Géoportail pour OpenLayers exploite les services web exposés par la plateforme Géoportail. Ceux-ci sont soumis à l'utilisation d'une ou de plusieurs clef d'accès gratuites disponibles sur le site geoservices.ign.fr ayant les droits sur les ressources que vous souhaitez exploiter.

Vous pouvez ensuite paramétrer l'utilisation de l'extension avec la ou les clefs qui correspondent à vos besoins de deux manières possibles :

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="CLEF" src="chemin/vers/GpPluginOpenLayers.js"></script>

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

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

Votre utilisation des fonctionnalités de l'extension Géoportail 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 OpenLayers -->
        <link rel="stylesheet" href="ol.css" />
        <script src="ol.js"></script>
        <!-- Extension Géoportail pour OpenLayers -->
        <link rel="stylesheet" href="GpPluginOpenLayers.css" />
        <script src="GpPluginOpenLayers.js" data-key="CLEF"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                // votre utilisation de l'extension Géoportail pour OpenLayers
            }
        </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 OpenLayers -->
        <link rel="stylesheet" href="ol.css" />
        <script src="ol.js"></script>
        <!-- Extension Géoportail pour OpenLayers -->
        <link rel="stylesheet" href="GpPluginOpenLayers.css" />
        <script src="GpPluginOpenLayers.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                Gp.Services.getConfig({
                    apiKey: 'CLEF',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoportail pour OpenLayers
                    }
                });
            }
        </script>
    </body>
</html>

Clés multiples : Si vous devez utiliser plusieurs clés d'accès, il est possible de mettre une liste de clés dans l'attribut apiKey de la fonction getConfig :

<html>
    <head>
        <!-- Bibliothèque OpenLayers -->
        <link rel="stylesheet" href="ol.css" />
        <script src="ol.js"></script>
        <!-- Extension Géoportail pour OpenLayers -->
        <link rel="stylesheet" href="GpPluginOpenLayers.css" />
        <script src="GpPluginOpenLayers.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                Gp.Services.getConfig({
                    apiKey: 'CLEF-1,CLEF-2,CLEF-3',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoportail pour OpenLayers
                    }
                });
            }
        </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 la configuration associée à votre clef d'accès. Il vous suffit pour cela de récupérer le fichier de configuration (autoconf.json) obtenu à l'aide du formulaire de ce tutoriel.

Si vous souhaitez une autoconfiguration locale unique avec plusieurs clés, c'est possible. Pour cela, enregistrez le contenu de la requête suivante dans un fichier autoconf.json (en remplacant key1, key2, key3... par les clefs génériques que vous souhaitez utiliser) : autoconf multi-clés : https://wxs.ign.fr/key1/autoconf/?keys=key1,key2,key&output=json&callback=callback

Enregistrez ce fichier sur votre plateforme et paramétrez l'extension Géoportail 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/autoconf.json" src="chemin/vers/GpPluginOpenLayers.js"></script>

Votre utilisation des fonctionnalités de l'extension Géoportail 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 OpenLayers -->
        ...
        <script data-url="chemin/vers/autoconf.json" src="chemin/vers/GpPluginOpenLayers.js"></script>
    </head>
    <body>
        <script>
            window.onload = function () {
                // votre utilisation de l'extension Géoportail pour OpenLayers
            }
        </script>
    </body>
</html>

Méthode 2 : Utilisez le paramètre serverUrl 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({
                    serverUrl: 'chemin/vers/autoconf.json',
                    callbackSuffix : '',
                    onSuccess: function (response) {
                        // votre utilisation de l'extension Géoportail pour OpenLayers
                    }
                });
            }
        </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 openlayers étendu). L'utilisateur a le choix entre plusieurs méthodes d'import.

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

import {Services, olExtended as Ol} from 'geoportal-extensions-openlayers';

// votre utilisation de l'extension
var map = new Ol.Map(...)
Services.getConfig(...)

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

Variante 1 : le module openlayers étendu est récupéré depuis l'espace de noms

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

// votre utilisation de l'extension
const Ol = Gp.olExtended;
var map = new Ol.Map(...)
Gp.Services.getConfig(...)

Variante 2 : le module openlayers est importé indépendamment de l'extension

import Ol from 'openlayers';
import * as Gp from 'geoportal-extensions-openlayers';

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

Compatibilités

Versions de OpenLayers supportées

Les versions 3.1.z et supérieures de l'extension Géoportail pour OpenLayers peuvent s'utiliser avec la version 6.3.1 d'OpenLayers.

Les versions 3.0.z de l'extension Géoportail pour OpenLayers peuvent s'utiliser avec les versions 5.0.3 et supérieures d'OpenLayers.

La compatibilité avec les versions 4.0.z n'est assurée que par les versions 2.1.2 et antérieures de l'extension Géoportail pour OpenLayers.

Le support des versions d'OpenLayers antérieures à la version 3.14 n'a pas été complètement testé.

Navigateurs supportés

Navigateur version
Chrome Versions récentes (21+)
Firefox Versions récentes (28+)
IE IE10, IE11
Edge 12+
Safari Versions récentes (6.1+)

Fonctionnalités

Systèmes de coordonnées

OpenLayers utilise par défaut les systèmes de coordonnées mondiaux "standards" : EPSG:4326 (coordonnées géographiques) et EPSG:3857 (Projection Web Mercator utilisée par Google, Bings, OSM ... et le Géoportail) comme expliqué ici.

L'extension Géoportail pour OpenLayers embarque de nombreuses projections en EPSG, CRS ainsi que sous le registre IGNF. Il est possible d'utiliser ces projections :

Exemple :


// création d'une vue OpenLayers avec la projection définie
var view = new ol.View({
    center: [48, 2],
    zoom: 12,
    projection: "IGNF:RGF93G"
})

La définition d'autres systèmes de coordonnées est cependant possible par l'adjonction de la bibliothèque Proj4js permettant de définir des systèmes de coordonnées et d'effectuer des transformations de coordonnées entre systèmes. Cette bibliothèque est directement compatible avec OpenLayers.

L'extension Géoportail pour OpenLayers intègre nativement cette bibliothèque. Si vous l'utilisez vous pouvez donc directement définir les systèmes de coordonnées que vous souhaitez selon la syntaxe proj4 et utiliser les alias ainsi définis en paramètres des fonctions d'OpenLayers.

Exemple :

// Définition de la Projection UTM 20N
proj4.defs("EPSG:4559",
    "+proj=utm +zone=20 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs") ;

// création d'une vue OpenLayers avec la projection définie
var view = new ol.View({
    center: [656481, 1796270],
    zoom: 12,
    projection: "EPSG:4559"
})

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 IGN-F peuvent être trouvées ici.

Affichage des couches WMTS Géoportail

Le modèle de données OpenLayers fait la distinction entre la notion de couche (ol.layer) et la notion de source de données (ol.source). Ainsi, une carte OpenLayers est constituée d'un empilement de "ol.layer", avec des propriétés relatives à leurs visibilité sur la carte, dont le contenu est alimenté par des "ol.source", avec des propriétés relatives à la manière d'obtenir ces données.

L'extension Géoportail pour OpenLayers propose deux manières d'accéder aux couches Géoportail selon ce modèle :

  1. On souhaite une mise en oeuvre simple, où on saisit uniquement le nom de sa couche, et d'éventuels paramètres d'affichage (visibilité ou opacité). Définition d'un layer WMTS Géoportail.

  2. On souhaite pouvoir paramétrer plus finement l'affichage de sa couche dans la carte, ainsi que d'éventuels paramètres du service (format, style, ...). Définition d'une source WMTS Géoportail.

Utilisation d'un layer WMTS Géoportail

L'affichage se fait par la création d'une nouvelle instance de la classe ol.layer.GeoportalWMTS, de la manière suivante :

new ol.layer.GeoportalWMTS(options);

Cette fonction retourne un objet ol.layer.GeoportalWMTS, qui hérite de l'objet OpenLayers ol.layer.Tile, qui peut ainsi être interprété par la librairie OpenLayers pour l'ajout dans la carte.

Exemple d'utilisation

Affichage simple des ortho-images du Géoportail : création d'une layer Géoportail, et ajout à la map OpenLayers.

var map = new ol.Map({
        target: 'map',
        layers: [
            new ol.layer.GeoportalWMTS({
                layer: "ORTHOIMAGERY.ORTHOPHOTOS"
            })
        ],
        view: new ol.View({
            center: [288074.8449901076, 6247982.515792289],
            zoom: 12
        })
    });

Exemple d'utilisation jsFiddle

Affichage en Lambert 93 (EPSG:2154)

La plateforme Géoportail diffuse aussi des ressources WMTS en projection Lambert 93. Pour permettre de les afficher, l'extension Géoportail pour OpenLayers pré-définit l'alias "EPSG:2154" correspondant à cette projection.

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

var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "ORTHOIMAGERY.ORTHOPHOTOS.BDORTHO.L93"
        })
    ],
    view: new ol.View({
        center: [600000, 6750000],
        zoom: 12,
        projection : "EPSG:2154"
    })
});

Exemple d'utilisation jsFiddle

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

Utilisation d'une source WMTS Géoportail

Cette méthode permet plus de paramétrages : on crée une nouvelle instance de la classe ol.source.GeoportalWMTS, de la manière suivante :

var gpsource = new ol.source.GeoportalWMTS(options);

Cette fonction retourne un objet ol.source.GeoportalWMTS, qui hérite de l'objet OpenLayers ol.source.WMTS. Cette source sert ensuite à la création d'un layer OpenLayers qui pourra ensuite être ajouté à la carte.

var layer = new ol.layer.Tile({
    source : gpsource
});
Exemple d'utilisation

Affichage simple des ortho-images du Géoportail : création d'un layer OpenLayers associé à une source Géoportail, et ajout à la map OpenLayers.

var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.Tile({
            source: new ol.source.GeoportalWMTS({
                layer: "ORTHOIMAGERY.ORTHOPHOTOS"
            }),
            opacity: 0.7
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

Exemple d'utilisation jsFiddle

Affichage en Lambert 93 (EPSG:2154)

La plateforme Géoportail diffuse aussi des ressources WMTS en projection Lambert 93. Pour permettre de les afficher, l'extension Géoportail pour OpenLayers pré-définit l'alias "EPSG:2154" correspondant à cette projection.

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

var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.Tile({
            source: new ol.source.GeoportalWMTS({
                layer: "ORTHOIMAGERY.ORTHOPHOTOS.BDORTHO.L93"
            }),
            opacity: 0.7
        })
    ],
    view: new ol.View({
        center: [600000, 6750000],
        zoom: 12,
        projection : "EPSG:2154"
    })
});

Exemple d'utilisation jsFiddle

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

Affichage des couches WMS Géoportail

Le modèle de données OpenLayers fait la distinction entre la notion de couche (ol.layer) et la notion de source de données (ol.source). Ainsi, une carte OpenLayers est constituée d'un empilement de "ol.layer", avec des propriétés relatives à leurs visibilité sur la carte, dont le contenu est alimenté par des "ol.source", avec des propriétés relatives à la manière d'obtenir ces données.

L'extension Géoportail pour OpenLayers propose deux manières d'accéder aux couches Géoportail selon ce modèle :

  1. on souhaite une mise en oeuvre simple, où on saisit uniquement le nom de sa couche, et d'éventuels paramètres d'affichage (visibilité ou opacité). Définition d'un layer WMS Géoportail.

  2. On souhaite pouvoir paramétrer plus finement l'affichage de sa couche dans la carte, ainsi que d'éventuels paramètres du service (format, style, ...). Définitions d'une source WMS Géoportail.

Utilisation d'un layer WMS Géoportail

L'affichage se fait par la création d'une nouvelle instance de la classe ol.layer.GeoportalWMS, de la manière suivante :

new ol.layer.GeoportalWMTS(options);

Cette fonction retourne un objet ol.layer.GeoportalWMS, qui hérite de l'objet OpenLayers ol.layer.Tile, qui peut ainsi être interprété par la librairie OpenLayers pour l'ajout dans la carte.

Exemple d'utilisation

Affichage d'une couche du serveur WMS INSPIRE raster du Géoportail (OI.OrthoimageCoverage) sur une carte en EPSG:4326.

var map = new ol.Map({
    target: 'map',
    layers: [
      new ol.layer.GeoportalWMS({
        layer: "OI.OrthoimageCoverage",
      })
    ],
    view: new ol.View({
      center: [2, 46],
      zoom: 12,
      projection: "EPSG:4326"
    })
});

Exemple d'utilisation jsFiddle

Utilisation d'une source WMS Géoportail

Cette méthode permet plus de paramétrages : on crée une nouvelle instance de la classe ol.source.GeoportalWMS, de la manière suivante :

var gpsource = new ol.source.GeoportalWMS(options);

Cette fonction retourne un objet ol.source.GeoportalWMS, qui hérite de l'objet OpenLayers ol.source.TileWMS. Cette source sert ensuite à la création d'un layer OpenLayers qui pourra ensuite être ajouté à la carte.

var layer = new ol.layer.Tile({
    source : gpsource
});
Exemple d'utilisation

Utilisation des service WMS INSPIRE raster (OI.OrthoimageCoverage) du Géoportail : création d'un layer OpenLayers associés à un source Géoportail, et ajout à la map OpenLayers.

var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.Tile({
            source: new ol.source.GeoportalWMS({
                layer: "OI.OrthoimageCoverage",
            })
        })
    ],
    view: new ol.View({
        center: [-61.55, 16.25],
        zoom: 12,
        projection : "EPSG:4326"
    })
});

Exemple d'utilisation jsFiddle

Widget de gestion d'empilement des couches

Ce widget permet à l'utilisateur de gérer l'empilement des couches composant la carte ol.Map et, pour chacune d'elles, 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, instance de la classe ol.control.LayerSwitcher , que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var layerSwitcher = new ol.control.LayerSwitcher(opts) ;
map.addControl(layerSwitcher);

Le widget affiche l'ensemble des couches composant la carte ol.Map.

Pour chaque couche de la carte ol.Map, le widget affiche son titre et sa description (par défaut : l'identifiant OpenLayers 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 :

Exemples d'utilisation

Utilisation simple

Ajout du widget de gestion de l'empilement des couches. Paramétrage des couches non Géoportail.

// couche OSM (non Géoportail)
var osmLyr = new ol.layer.Tile({
    source: new ol.source.OSM()
});
// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        osmLyr,
        // couche Géoportail
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2",
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});    
// Création du Layer Switcher
var lsControl = new ol.control.LayerSwitcher({
    // paramétrage de l'affichage de la couche OSM
    layers : [{
        layer: osmLyr,
        config: {
            title: "OSM",
            description: "Couche OpenStreet Map"
        }
    }]
});
// Ajout du LayerSwitcher à la carte
map.addControl(lsControl);

Exemple d'utilisation jsFiddle

Barre de recherche

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 plateforme Géoportail.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la calsse ol.control.SearchEngine, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var search = new ol.control.SearchEngine(opts) ;
map.addControl(search);

Exemples d'utilisation

Utilisation simple

Ajout du moteur de recherche sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var searchControl = new ol.control.SearchEngine({
});

// Ajout à la carte
map.addControl(searchControl);

Exemple d'utilisation jsFiddle

Calculs d'itinéraires

Le widget de calcul d'itinéraires permet d'intéragir avec une carte OpenLayers pour effectuer des calculs d'itinéraires utilisant le service dédié de la plateforme Géoportail.

Son utilisation se fait par la création d'un nouveau contrôle instance de la classe ol.control.Route, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var route = new ol.control.Route(opts) ;
map.addControl(route);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var routeControl = new ol.control.Route({
});

// Ajout à la carte
map.addControl(routeControl);

Exemple d'utilisation jsFiddle

Calculs d'isochrones / isodistances

Ce widget permet d'intéragir avec une carte OpenLayers pour effectuer des calculs d'isochrones / isodistances utilisant le service dédié de la plateforme Géoportail.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.Isocurve(), que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var iso = new ol.control.Isocurve(opts);
map.addControl(iso);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var isoControl = new ol.control.Isocurve({
});

// Ajout à la carte
map.addControl(isoControl);

Exemple d'utilisation jsFiddle

Coordonnées et altitude en un point de la carte

Ce widget permet d'afficher les coordonnées d'un point choisi par l'internaute sur une carte OpenLayers 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 plateforme Géoportail. Un mode "édition" permet de localiser des coordonnées sur la carte en éditant les coordonnées affichées dans le widget.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.GeoportalMousePosition, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var mp = new ol.control.GeoportalMousePosition(opts);
map.addControl(mp);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var mpControl = new ol.control.GeoportalMousePosition({
});

// Ajout à la carte
map.addControl(mpControl);

Exemple d'utilisation avec affichage unique de l'altitude jsFiddle

Exemple d'utilisation avec paramétrage des systèmes de coordonnées jsFiddle

Exemple d'utilisation avec activation de l'édition de coordonnées pour localisation jsFiddle

Affichage dynamique des attributions

Ce widget a pour but d'afficher les attributions associées aux couches visibles sur la carte. Il étend les fonctionnalités du contrôle natif d'OpenLayers (ol.control.Attribution) dont il hérite en permettant l'affichage des attributions en fonction du positionnement de la carte (centre, zoom) pour les couches ayant des originators multiples.

Les couches Géoportail (de type WMS ou WMTS) possèdent nativement cette propriété. Pour les autres, le paramétrage dynamique des originators se fait par l'adjonction à l'objet source de la couche de la propriété "_originators", tableau de Gp.Services.Config.Originator.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.GeoportalAttribution, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var att = new ol.control.GeoportalAttribution(opts);
map.addControl(att);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var attControl = new ol.control.GeoportalAttribution({
});

// Ajout à la carte
map.addControl(attControl);

Exemple d'utilisation jsFiddle

Adresse ou lieu en un point de la carte

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 OpenLayers.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.ReverseGeocode, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var reverse = new ol.control.ReverseGeocode(opts);
map.addControl(reverse);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var rvControl = new ol.control.ReverseGeocode({
});

// Ajout à la carte
map.addControl(rvControl);

Exemple d'utilisation jsFiddle

Outils de croquis

Ce widget propose un ensemble d'outils de croquis permettant de dessiner sur une carte OpenLayers : poser des markers, dessiner des lignes, polygones ou faire des écritures dans des styles choisis par l'internaute.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.Drawing, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var drawing = new ol.control.Drawing(opts);
map.addControl(drawing);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var drawControl = new ol.control.Drawing({
});

// Ajout à la carte
map.addControl(drawControl);

Exemple d'utilisation jsFiddle

Widget d'import de couches

Ce widget permet à un internaute d'importer ses propres données géographiques dans des formats standards en superposition des données d'une carte OpenLayers.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.LayerImport, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var lyrImport = new ol.control.LayerImport(opts);
map.addControl(lyrImport);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var lyrImport = new ol.control.LayerImport({
});

// Ajout à la carte
map.addControl(lyrImport);

Exemple d'utilisation jsFiddle

Profil altimétrique le long d'un traçé

Ce widget permet d'afficher le profil altimétrique d'un traçé saisi par l'internaute sur une carte OpenLayers. Le profil est calculé à l'aide du service d'altimétrie de la plateforme Géoportail.

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.ElevationPath, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var ep = new ol.control.ElevationPath(opts);
map.addControl(ep);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var ep = new ol.control.ElevationPath({
});

// Ajout à la carte
map.addControl(ep);

Exemple d'utilisation jsFiddle

Outils de mesures

Trois widgets sont proposés permettant à un internaute d'effectuer des mesures sur une carte OpenLayers : mesures de distance, de surface et d'azimuth.

Leur utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.MeasureLength, pour les distances ; ol.control.MeasureArea, pour les surfaces ou ol.control.MeasureAzimuth pour les mesures d'azimuth que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var length = new ol.control.MeasureLength(opts);
map.addControl(length);

Exemples d'utilisation

Utilisation simple

Ajout du widget sans paramétrage particulier.

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        new ol.layer.GeoportalWMTS({
            layer: "GEOGRAPHICALGRIDSYSTEMS.PLANIGNV2"
        })
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Creation du controle
var length = new ol.control.MeasureLength({
});

// Ajout à la carte
map.addControl(length);

Exemple d'utilisation jsFiddle

Accès aux informations attributaires des couches

Ce widget permet, au clic sur la carte, d'afficher dans une popup les informations attributaires des couches présentes dans la carte et spécifiées dans le widget. Dans le cas des couches vecteur, ces informations correspondent aux informations attributaires des objets localisés au point cliqué. Dans le cas des couches raster (WMS et WMTS), c'est le contenu de la réponse d'une requête GetFeatureInfo sur la première couche qui est affiché. Lorsque le contrôle est activé pour plusieurs couches, les informations affichées seront celles de la première couche visible rencontrée dans la carte (en partant du haut de la pile des couches).

Son utilisation se fait par la création d'un nouveau contrôle, instance de la classe ol.control.GetFeatureInfo, que l'on peut ensuite ajouter à la carte comme les autres contrôles OpenLayers, de la manière suivante :

var getFeatureInfo = new ol.control.GetFeatureInfo(opts);
map.addControl(getFeatureInfo);

Exemples d'utilisation

Utilisation simple pour une seule couche

Ajout du widget sans paramétrage particulier.

// Création de la couche que l'on souhaite interroger
var orthos = new ol.layer.GeoportalWMTS({
    layer: "ORTHOIMAGERY.ORTHOPHOTOS"
});

// Création de la carte
var map = new ol.Map({
    target: 'map',
    layers: [
        orthos
    ],
    view: new ol.View({
        center: [288074.8449901076, 6247982.515792289],
        zoom: 12
    })
});

// Création du contrôle, et activation pour la couche orthos créée ci-dessus
var getfeatureinfo = new ol.control.GetFeatureInfo({
    layers : [
        {
            obj : orthos
        }
    ]
});

// Ajout à la carte
map.addControl(getfeatureinfo);

Exemple d'utilisation jsFiddle