C# Class SharpMap.Layers.WmsLayer

Web Map Service layer
The WmsLayer is currently very basic and doesn't support automatic fetching of the WMS Service Description. Instead you would have to add the nessesary parameters to the URL, and the WmsLayer will set the remaining BoundingBox property and proper requests that changes between the requests. See the example below.
Inheritance: SharpMap.Layers.Layer
Datei anzeigen Open project: jumpinjackie/fdotoolbox Class Usage Examples

Public Methods

Method Description
AddLayer ( string name ) : void

Adds a layer to WMS request

Layer names are case sensitive.

AddStyle ( string name ) : void

Adds a style to the style collection

Clone ( ) : object

Clones the object

GetRequestUrl ( SharpMap box, System size ) : string

Gets the URL for a map request base on current settings, the image size and boundingbox

RemoveAllLayers ( ) : void

Removes all layers

RemoveAllStyles ( ) : void

Removes all styles from the list

RemoveLayer ( string name ) : void

Removes a layer from the layer list

RemoveLayerAt ( int index ) : void

Removes the layer at the specified index

RemoveStyle ( string name ) : void

Removes a style from the collection

RemoveStyleAt ( int index ) : void

Removes a style at specified index

Render ( System g, Map map ) : void

Renders the layer

SetImageFormat ( string mimeType ) : void

Sets the image type to use when requesting images from the WMS server

See the OutputFormats property for a list of available mime types supported by the WMS server

WmsLayer ( string layername, string url ) : System

Initializes a new layer, and downloads and parses the service description

In and ASP.NET application the service description is automatically cached for 24 hours when not specified

WmsLayer ( string layername, string url, System.TimeSpan cachetime ) : System

Initializes a new layer, and downloads and parses the service description

Private Methods

Method Description
GetPreferredMethod ( ) : SharpMap.Web.Wms.Client.WmsOnlineResource
LayerExists ( SharpMap layer, string name ) : bool

Recursive method for checking whether a layername exists

StyleExists ( SharpMap layer, string name ) : bool

Recursive method for checking whether a layername exists

Method Details

AddLayer() public method

Adds a layer to WMS request
Layer names are case sensitive.
Throws an exception is an unknown layer is added
public AddLayer ( string name ) : void
name string Name of layer
return void

AddStyle() public method

Adds a style to the style collection
Throws an exception is an unknown layer is added
public AddStyle ( string name ) : void
name string Name of style
return void

Clone() public method

Clones the object
public Clone ( ) : object
return object

GetRequestUrl() public method

Gets the URL for a map request base on current settings, the image size and boundingbox
public GetRequestUrl ( SharpMap box, System size ) : string
box SharpMap Area the WMS request should cover
size System Size of image
return string

RemoveAllLayers() public method

Removes all layers
public RemoveAllLayers ( ) : void
return void

RemoveAllStyles() public method

Removes all styles from the list
public RemoveAllStyles ( ) : void
return void

RemoveLayer() public method

Removes a layer from the layer list
public RemoveLayer ( string name ) : void
name string Name of layer to remove
return void

RemoveLayerAt() public method

Removes the layer at the specified index
public RemoveLayerAt ( int index ) : void
index int
return void

RemoveStyle() public method

Removes a style from the collection
public RemoveStyle ( string name ) : void
name string Name of style
return void

RemoveStyleAt() public method

Removes a style at specified index
public RemoveStyleAt ( int index ) : void
index int Index
return void

Render() public method

Renders the layer
public Render ( System g, Map map ) : void
g System Graphics object reference
map Map Map which is rendered
return void

SetImageFormat() public method

Sets the image type to use when requesting images from the WMS server

See the OutputFormats property for a list of available mime types supported by the WMS server

Throws an exception if either the mime type isn't offered by the WMS /// or GDI+ doesn't support this mime type.
public SetImageFormat ( string mimeType ) : void
mimeType string Mime type of image format
return void

WmsLayer() public method

Initializes a new layer, and downloads and parses the service description
In and ASP.NET application the service description is automatically cached for 24 hours when not specified
public WmsLayer ( string layername, string url ) : System
layername string
url string
return System

WmsLayer() public method

Initializes a new layer, and downloads and parses the service description
public WmsLayer ( string layername, string url, System.TimeSpan cachetime ) : System
layername string
url string Url of service description
cachetime System.TimeSpan Time for caching Service Description (ASP.NET only)
return System