Geoportal Extension for OpenLayers API Reference

The Geoportal Extension for OpenLayers provides additionnal javascript functionalities (Sources, Layers and Controls) making access to french geoportal webservices easier when using OpenLayers javascript library.

This extension is not standalone and has to be used together with OpenLayers library. In a web page, you thus have to include both OpenLayers and Geoportal Extension resources. For instance :

<!-- OpenLayers -->
<link rel="stylesheet" href="path/to/ol/ol.css" />
<script src="path/to/ol/ol.js"></script>

<!-- Geoportal Extension for OpenLayers -->
<script src="path/to/GpfExtOL.js" data-key="{your-geoportal-access-key}"></script>
<link rel="stylesheet" href="path/to/GpfExtOL.css" />

NB : to have complete access to this extension functionnalities, you need to freely provide a geoportal access key among the one available here : . Use it either when loading extension script (using the data-key attribute) or by conditinning their use to the onSuccess callback function of a Gp.Services.GetConfig() call with that key. Otherwhise some functionalities may not work as announced.

Geoportal Sources

Sources provided by the Geoportal Extension are additionnal OpenLayers Sources that give simple access to Geoportal data that can then be used to feed OpenLayers layers.

Geoportal Layers

Layers provided by the Geoportal Extension are additionnal OpenLayers layers already connected to previous Geoportal Extension sources that can be added to an OpenLayers Map like any other OpenLayers layer.

Geoportal Controls

Controls provided by the Geoportal Extension are additionnal OpenLayers controls that, when added to an OpenLayers Map, allows user to interact with it.