edu.ucdavis.cstars.client.layers

Class WMSLayer

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

edu.ucdavis.cstars.client.layers.Layer

edu.ucdavis.cstars.client.layers.DynamicMapServiceLayer

edu.ucdavis.cstars.client.layers.WMSLayer

public class WMSLayer
extends DynamicMapServiceLayer

A layer for OGC Web Map Services (WMS). If the first layer added to the map is a WMS layer, the map will use the spatial reference of this layer. The default behavior of a WMSLayer is to execute a WMS GetCapabilities request, which requires using a proxy page. See the Using the proxy page help topic for more details. An alternate approach is to pass a resourceInfo object into the constructor which does not require a GetCapabilities request. Note:The WMSLayer does not support using Styled Layer Descriptor (SLD) documents. Requires Package: esri.layers.WMSLayer

Author:

Justin Merz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WMSLayer.Options
static class	WMSLayer.ResourceInfo An optional resource info object.

Method Summary

Methods

Modifier and Type	Method and Description
static boolean	assertLoaded() Check that the esri.layers.WMSLayer package has been loaded
static WMSLayer	create(java.lang.String url) Creates a new WMSLayer object.
static WMSLayer	create(java.lang.String url, WMSLayer.Options options) Creates a new WMSLayer object.
java.lang.String	getCopyright() Copyright of the WMS service.
java.lang.String	getDescription() Description of the WMS service.
Extent	getExtent() Extent of the WMS service.
java.lang.String	getGetMapUrl() The URL for the WMS GetMap call.
java.lang.String	getImageFormat() The map image format.
com.google.gwt.core.client.JsArray<WMSLayerInfo>	getLayerInfos() List of layers in the WMS service.
int	getMaxHeight() Maximum height in pixels the WMS service supports.
int	getMaxWidth() Maximum width in pixels the WMS service supports.
java.lang.String	getTitle() Title of the WMS service.
java.lang.String	getVersion() Version of the WMS service.
void	setImageFormat(java.lang.String format) Set the map image format, valid values are "png","jpg","pdf","bmp","gif" and "svg".
void	setImageTransparency(boolean transparency) Specify whether the background image is transparent.
void	setVisibleLayer(java.lang.String[] layers) Specify a list of layer names to updates the visible layers.

Methods inherited from class edu.ucdavis.cstars.client.layers.DynamicMapServiceLayer

getFullExtent, getImageUrl, getInitialExtent, getSpatialReference, refresh

Methods inherited from class edu.ucdavis.cstars.client.layers.Layer

addErrorHandler, addLoadHandler, addOpacityChangeHandler, addUpdateEndHandler, addUpdateHandler, addUpdateStartHandler, addVisibilityChangeHandler, getCredential, getId, getOpacity, getUrl, hide, isloaded, isVisible, setOpacity, setVisibility, show

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static WMSLayer create(java.lang.String url)

Creates a new WMSLayer object.

Parameters:

url - - URL to the OGC Web Map Service.

Returns:

WMSLayer

create

public static WMSLayer create(java.lang.String url,
              WMSLayer.Options options)

Creates a new WMSLayer object.

Parameters:

url - - URL to the OGC Web Map Service.

options - - Optional parameters.

Returns:

WMSLayer

assertLoaded

public static boolean assertLoaded()

Check that the esri.layers.WMSLayer package has been loaded

Returns:

boolean

getCopyright

public final java.lang.String getCopyright()

Copyright of the WMS service. This is the value of the AccessConstraints capabilities property.

Returns:

String

getDescription

public final java.lang.String getDescription()

Description of the WMS service. This is the value of the Abstract capabilities property.

Returns:

String

getExtent

public final Extent getExtent()

Extent of the WMS service.

Returns:

Extent

getGetMapUrl

public final java.lang.String getGetMapUrl()

The URL for the WMS GetMap call.

Returns:

String

getImageFormat

public final java.lang.String getImageFormat()

The map image format.

Returns:

String

getLayerInfos

public final com.google.gwt.core.client.JsArray<WMSLayerInfo> getLayerInfos()

List of layers in the WMS service.

Returns:

JsArray

getMaxHeight

public final int getMaxHeight()

Maximum height in pixels the WMS service supports.

Returns:

int

getMaxWidth

public final int getMaxWidth()

Maximum width in pixels the WMS service supports.

Returns:

int

getTitle

public final java.lang.String getTitle()

Title of the WMS service.

Returns:

String

getVersion

public final java.lang.String getVersion()

Version of the WMS service. Supported versions are: 1.1.0,1.1.1 and 1.3.0.

Returns:

String

setImageFormat

public final void setImageFormat(java.lang.String format)

Set the map image format, valid values are "png","jpg","pdf","bmp","gif" and "svg".

Parameters:

format - - The image format.

setImageTransparency

public final void setImageTransparency(boolean transparency)

Specify whether the background image is transparent. Only valid if the WMS service supports transparency.

Parameters:

transparency - - When true the background image is transparent.

setVisibleLayer

public final void setVisibleLayer(java.lang.String[] layers)

Specify a list of layer names to updates the visible layers.

Parameters:

layers - - An array of layer ids.