v5 v4

Class: WMS

cercalia.WMS

new cercalia.WMS(name, urls, params, options)

cercalia.wms.js, line 14
Name Type Description
name string

Name of WMS layer to paint
urls string | Array.<string>

URL o URLs (array) from WMS service
params Object

Object with key / value pairs with the required parameters to launch a GETMAP query to WMS server. If not specified some have associated default value: (name options in capital letters) SERVICE: "WMS", VERSION: "1.1.1" REQUEST: "GetMap", STYLES: "", EXCEPTIONS: "application/vnd.ogc.se_inimage" FORMAT: "image/jpeg" The following are mandatory: SRS, LAYERS
options Object

Hash table with extra options to configure the WMS layer

Methods

destroy()

cercalia.wms.js, line 192

Removes the object with all its attributes

getClass(){string}

cercalia.wms.js, line 221
Returns:
ClassName from cercalia.WMS object.

getLayer(){ol.layer.Tile}

cercalia.wms.js, line 214
Returns:
WMS Source. OL3 Object ol.layer.Tile

getMap(){cercalia.Map|null}

cercalia.wms.js, line 171
Returns:
map Map, in case of WMS layer is painted in a map. If not, returns null

getName(){string}

cercalia.wms.js, line 178
Returns:
WMS layer name

getParams(){Object}

cercalia.wms.js, line 185
Returns:
params Returns WMS 'params'

getSource(){ol.source.TileWMS}

cercalia.wms.js, line 207
Returns:
WMS Source. OL3 Object ol.source.TileWMS

setMap(map, position)

cercalia.wms.js, line 137

We assign a map to the object. If it's already exist, is deleted in the existing map and WMS layer is painted on the map passed as parameter. If parameter is "null", it's removed from the map.

Name Type Description
map cercalia.Map | null

Map.
position number

ZIndex position from layers.

updateParams(params)

cercalia.wms.js, line 164

Updates the parameters

Name Type Description
params Object