Geoportal Extension for OpenLayers
API Reference

Class: GeoportalWMS

ol.layer.GeoportalWMS

Geoportal LayerWMS source creation (inherit from ol.layer.Tile)

new GeoportalWMS(options)

Layers/LayerWMS.js, line 40
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

olParams Object optional

other options for ol.layer.Tile function (see ol.layer.Tile)

Name Type Description
sourceParams Object optional

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

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

layerWMS.getLegends();
layerWMS.getMetadata();
layerWMS.getTitle();
layerWMS.getDescription();
layerWMS.getQuicklookUrl();
layerWMS.getOriginators();

Extends

  • ol.layer.Tile

Methods

getDescription(){String}

Layers/LayerWMS.js, line 184

Get description

getLegends(){Array}

Layers/LayerWMS.js, line 168

Get legends

getMetadata(){Array}

Layers/LayerWMS.js, line 176

Get metadata

getOriginators(){Array}

Layers/LayerWMS.js, line 208

Get originators

getQuicklookUrl(){String}

Layers/LayerWMS.js, line 200

Get quicklook url

getTitle(){String}

Layers/LayerWMS.js, line 192

Get title