Geoportal Extension for OpenLayers
API Reference

Class: GeoportalWMS

ol.source.GeoportalWMS

Geoportal tile WMS source creation (inherit from ol.source.TileWMS)

new GeoportalWMS(options)

Layers/SourceWMS.js, line 37
Name Type Description
options Object

options for function call.

Name Type Description
layer String

Layer name (e.g. "ORTHOIMAGERY.ORTHOPHOTOS")

configuration Object optional

configuration (cf. example)

ssl Boolean optional

if set true, enforce protocol https (only for nodejs)

apiKey String optional

Access key to Geoportal platform

legends Array optional

Legends objects associated to the layer

metadata Array optional

Metadata objects associated to the layer

title String optional

title of the layer

description String optional

description of the layer

quicklookUrl String optional

quicklookUrl of the layer

olParams Object optional

other options for ol.source.TileWMS function (see ol.source.TileWMS)

Example
var sourceWMS = new ol.source.GeoportalWMS({
     layer  : "ORTHOIMAGERY.ORTHOPHOTOS"
});

Extends

  • ol.source.TileWMS