OpenLayers. Layer.WMS

Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.  Create a new WMS layer with the OpenLayers.Layer.WMS constructor.

Inherits from

Summary
Instances of OpenLayers.Layer.WMS are used to display data from OGC Web Mapping Services.
{Object} Hashtable of default parameter key/value pairs
Deprecated.
{Boolean} Default is true for WMS layer
{Boolean} Should the BBOX commas be encoded? 
Create a new WMS layer object
Destroy this layer
Create a clone of this layer
Return a GetMap query string for this layer
addTile creates a tile, initializes it, and adds it to the layer div.
Catch changeParams and uppercase the new params to be merged in before calling changeParams on the super class.
Combine the layer’s url with its params and these newParams.

Constants

DEFAULT_PARAMS

{Object} Hashtable of default parameter key/value pairs

Properties

reproject

Deprecated.  See http://trac.openlayers.org/wiki/SpatialMercator for information on the replacement for this functionality.  {Boolean} Try to reproject this layer if its coordinate reference system is different than that of the base layer.  Default is true.  Set this in the layer options.  Should be set to false in most cases.

isBaseLayer

{Boolean} Default is true for WMS layer

encodeBBOX

{Boolean} Should the BBOX commas be encoded?  The WMS spec says ‘no’, but some services want it that way.  Default false.

Constructor

OpenLayers. Layer.WMS

Create a new WMS layer object

Example

var wms = new OpenLayers.Layer.WMS("NASA Global Mosaic",
"http://wms.jpl.nasa.gov/wms.cgi",
{layers: "modis,global_mosaic"});

Parameters

name{String} A name for the layer
url{String} Base url for the WMS (e.g.  http://wms.jpl.nasa.gov/wms.cgi)
params{Object} An object with key/value pairs representing the GetMap query string parameters and parameter values.
options{Ojbect} Hashtable of extra options to tag onto the layer

Functions

destroy

destroy: function()

Destroy this layer

clone

clone: function (obj)

Create a clone of this layer

Returns

{OpenLayers.Layer.WMS} An exact clone of this layer

getURL

getURL: function (bounds)

Return a GetMap query string for this layer

Parameters

bounds{OpenLayers.Bounds} A bounds representing the bbox for the request.

Returns

{String} A string with the layer’s url and parameters and also the passed-in bounds and appropriate tile size specified as parameters.

addTile

addTile:function(bounds,
position)

addTile creates a tile, initializes it, and adds it to the layer div.

Parameters

bounds{OpenLayers.Bounds}

Returns

{OpenLayers.Tile.Image} The added OpenLayers.Tile.Image

mergeNewParams

mergeNewParams:function(newParams)

Catch changeParams and uppercase the new params to be merged in before calling changeParams on the super class.

Once params have been changed, we will need to re-init our tiles.

Parameters

newParams{Object} Hashtable of new params to use

getFullRequestString

getFullRequestString:function(newParams)

Combine the layer’s url with its params and these newParams.

Add the SRS parameter from projection -- this is probably more eloquently done via a setProjection() method, but this works for now and always.

Parameters

newParams{Object}

Returns

{String}

destroy: function()
Destroy this layer
clone: function (obj)
Create a clone of this layer
getURL: function (bounds)
Return a GetMap query string for this layer
addTile:function(bounds,
position)
addTile creates a tile, initializes it, and adds it to the layer div.
mergeNewParams:function(newParams)
Catch changeParams and uppercase the new params to be merged in before calling changeParams on the super class.
getFullRequestString:function(newParams)
Combine the layer’s url with its params and these newParams.
Create a new WMS layer object
Base class for layers that use a lattice of tiles.
Instances of this class represent bounding boxes.
Instances of OpenLayers.Tile.Image are used to manage the image tiles used by various layers.