OpenLayers.Layer.WMS

Create a new WMS layer object

Examples

The code below creates a simple WMS layer using the image/jpeg format.

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

Note the 3rd argument (params).  Properties added to this object will be added to the WMS GetMap requests used for this layer’s tiles.  The only mandatory parameter is “layers”.  Other common WMS params include “transparent”, “styles” and “format”.  Note that the “srs” param will always be ignored.  Instead, it will be derived from the baseLayer’s or map’s projection.

The code below creates a transparent WMS layer with additional options.

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

Note that by default, a WMS layer is configured as baseLayer.  Setting the “transparent” param to true will apply some magic (see noMagic).  The default image format changes from image/jpeg to image/png, and the layer is not configured as baseLayer.

Parameters