Class WMSLayer

Object
   |
   +--WMSLayer

class WMSLayer

WMSLayer represents a Non-Tiled layer. It will generate a map image for every view change. Note: If you are querying a WMS server for a png file and have special characters in the url parameters such as "&, =, #, +" your server must be able to escape ._- into % and then urlDecode the value.
Defined in APIJS.js

Constructor Detail

WMSLayer

WMSLayer(<map> map, <string[]> layers, <string> serverPath)

Create a new WMSLayer.

Parameters:
map - Virtual Earth or Google Maps map object
layers - Names of layers to enable
serverPath - The optional server path.

draw

void draw()

Forces the Layer to redraw.

getFormat

string getFormat()

Gets the format type.

Returns:
The format type of the layer.

getMaxZoomLevel

int getMaxZoomLevel()

Returns the maximum zoom level.

getMinZoomLevel

int getMinZoomLevel()

Returns the minimum zoom level.

getOpacity

float getOpacity()

Returns the opacity of the layer (VE Only).

getProperty

string getProperty(<string> name)

Returns the value associated with the property name.

Parameters:
name - Name of the property

Returns:
The property value. If the property does not exists null is returned.

getStyleLayerDescriptorText

string getStyleLayerDescriptorText()

Returns the SLD text.

getStyleLayerDescriptorUrl

string getStyleLayerDescriptorUrl()

Returns the SLD url.

getVisible

bool getVisible()

Returns true if the layer is visible and false otherwise.

getZIndex

int getZIndex()

Gets the Zindex (VE Only).

Returns:
The ZIndex of the layer.

initialize

void initialize()

Initializes the layer. Must be called before the layer renders.

setFormat

void setFormat(<int> val)

Sets the format type for the image layer. ex. ("image/gif", "image/jpeg", "image/png")

Parameters:
val - The format of the layer.

setMaxZoomLevel

void setMaxZoomLevel(<int> val)

Sets the maximum zoom level.

Parameters:
val - The zoom level.

setMinZoomLevel

void setMinZoomLevel(<int> val)

Sets the minimum zoom level.

Parameters:
val - The zoom level.

setOpacity

void setOpacity(<float> val)

Sets the opacity (VE Only). Valid range [0 - 1]

Parameters:
val - The opacity level.

setProperty

void setProperty(<string> name, <string> value)

Sets the value of a property. This property will be appended to each tile request.

Parameters:
name - Name of the property
value - Value of the property

setStyleLayerDescriptorText

void setStyleLayerDescriptorText(<string> val)

Sets the SLD text. This SLD text will be passed in the tile request string.

Parameters:
val - Text of sld file.

setStyleLayerDescriptorUrl

void setStyleLayerDescriptorUrl(<string> val)

Sets the SLD url. This SLD url will be passed in the tile request string.

Parameters:
val - Url to sld file.

setVisible

void setVisible(<bool> bool)

Sets the visibility of the layer

Parameters:
bool - The visibility

setZIndex

void setZIndex(<int> val)

Sets the ZIndex (VE Only). This will determine the rendering order of the layer.

Parameters:
val - The ZIndex of the layer