Skip to content

WmsAsyncLayer

Namespace: ThinkGeo.Core

Represents an object that encapsulates a Web Map Service (WMS) layer.

public class WmsAsyncLayer : WebBasedAsyncLayer, IWmsEntity

Inheritance Object → LayerBase → AsyncLayer → WebBasedAsyncLayer → WmsAsyncLayer
Implements IWmsEntity

Remarks:

A Web Map Service (WMS) produces maps of spatially referenced data dynamically from geographic information. This International Standard defines a "map" to be a portrayal of geographic information as a digital image file suitable for display on a computer screen. A map is not the data itself. WMS-produced maps are generally rendered in a pictorial format such as PNG, GIF or JPEG, or occasionally as vector-based graphical elements in Scalable Vector Graphics (SVG) or Web Computer Graphics Metafile (WebCGM) formats.

Properties

ActiveLayerNames

This property allows the active layers requested from the client to be shown on the map.

public Collection<string> ActiveLayerNames { get; }

Property Value

Collection<String>

Remarks:

When requesting a map, a client may specify the layers to be shown on the map.

ActiveStyleNames

This property allows the active styles requested from the client to be shown on the map.

public Collection<string> ActiveStyleNames { get; }

Property Value

Collection<String>

Remarks:

When requesting a map, a client may specify the styles to be shown on the map.

Uri

This property specifies the URI of the WMS server.

public Uri Uri { get; set; }

Property Value

Uri

Version

This property gets the version.

public string Version { get; }

Property Value

String

IsTransparent

This property gets or sets whether the response map image's background color is transparent or not.

public bool IsTransparent { get; set; }

Property Value

Boolean

OutputFormat

This property gets or sets the desired output format for the map being requested from the WMS.

public string OutputFormat { get; set; }

Property Value

String

Remarks:

When requesting a map, a client may specify the output format in which to show the map. Formats are specified as MIME types such as "image/gif" or "image/png".

Crs

This property gets or sets the projected or geographic coordinate reference system to be used.

public string Crs { get; set; }

Property Value

String

Exceptions

This property indicates the format in which the client wishes to be notified of service exceptions.

public string Exceptions { get; set; }

Property Value

String

Remarks:

Upon receiving a request that is invalid according to the OGC standard, the server shall issue a service exception report. The service report is meant to describe to the client application or its human user the reason(s) that the request is invalid.

Parameters

This property specifies a dictionary used to update the request sent from the client to the WMS server.

public Dictionary<string, string> Parameters { get; }

Property Value

Dictionary<String, String>

AxisOrder

This property specifies the order in which the coordinate axes are arranged when making requests to a Web Map Service (WMS) server. It is used to define the spatial reference system for the layer.

public WmsAxisOrder AxisOrder { get; set; }

Property Value

WmsAxisOrder

FastMode

This property gets or sets whether request and parse capabilities.

public bool FastMode { get; set; }

Property Value

Boolean

CapabilitiesCacheTimeout

The timeout for Capabilities Cache, its 10 minutes by default

public TimeSpan CapabilitiesCacheTimeout { get; set; }

Property Value

TimeSpan

HasBoundingBox

This property checks to see if a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.

public bool HasBoundingBox { get; }

Property Value

Boolean

Remarks:

The override in the WmsRasterLayer sets it to true.

WebProxy

public IWebProxy WebProxy { get; set; }

Property Value

IWebProxy

TimeoutInSeconds

public int TimeoutInSeconds { get; set; }

Property Value

Int32

UpperThreshold

This property gets and sets the upper threshold in the scale at which to display the image.

public double UpperThreshold { get; set; }

Property Value

Double
This property gets the upper threshold in the scale at which to display the image.

Remarks:

Above the upper threshold in scale, the image will not be displayed. This, in conjunction with the LowerThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is 0. This means the image should always display.

LowerThreshold

This property gets and sets the lower threshold in the scale at which to display the image.

public double LowerThreshold { get; set; }

Property Value

Double
This property gets the lower threshold in the scale at which to display the image.

Remarks:

Below the lower threshold in scale, the image will not be displayed. This, in conjunction with the UpperThreshold property, allows you to create a band in which it is suitable to display the image source. By default, the upper threshold is double.max and lower threshold is 0. This means the image should always display.

Credentials

This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.

public ICredentials Credentials { get; set; }

Property Value

ICredentials

UserAgent

This property allows you to specify a custom user-agent request header when making requests to a Web server. This header provides information about the client application or device and can be useful for server-side logging and analytics.

public string UserAgent { get; set; }

Property Value

String

Name

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value

String

Remarks:

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

IsOpen

This property returns true if the Layer is open and false if it is not.

public bool IsOpen { get; }

Property Value

Boolean

Remarks:

This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

IsVisible

This property gets and set the visible state of the layer.

public bool IsVisible { get; set; }

Property Value

Boolean

Remarks:

If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.

DrawingTime

This property gets the last drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value

TimeSpan

Remarks:

We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.

Projection

Gets the projection of the layer.

public Projection Projection { get; set; }

Property Value

Projection

DrawingExceptionMode

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value

DrawingExceptionMode

Background

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value

GeoColor

Transparency

This property gets and sets the amount of transparency to apply to the image.

public float Transparency { get; set; }

Property Value

Single
This property gets the amount of transparency to apply to the image.

Remarks:

None

BlueTranslation

This property gets and sets the amount of blue to apply to the image.

public float BlueTranslation { get; set; }

Property Value

Single
This property gets the amount of blue to apply to the image.

Remarks:

None

RedTranslation

This property gets and sets the amount of red to apply to the image.

public float RedTranslation { get; set; }

Property Value

Single
This property gets the amount of red to apply to the image.

Remarks:

None

GreenTranslation

This property gets and sets the amount of green to apply to the image.

public float GreenTranslation { get; set; }

Property Value

Single
This property gets the amount of green to apply to the image.

Remarks:

None

KeyColors

Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.

public Collection<GeoColor> KeyColors { get; }

Property Value

Collection<GeoColor>

Remarks:

It will make these colors transparent when draw image.

IsNegative

This property gets and sets whether the image should be converted to negative (inverse colors).

public bool IsNegative { get; set; }

Property Value

Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).

Remarks:

None

IsGrayscale

This property gets and sets if the image should be converted to grayscale.

public bool IsGrayscale { get; set; }

Property Value

Boolean

        This property gets and sets if the image should be converted to grayscale.

Remarks:

None

ThreadSafe

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value

ThreadSafetyLevel

ColorMappings

ColorMapping

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value

Dictionary<GeoColor, GeoColor>

WrappingMode

public WrappingMode WrappingMode { get; set; }

Property Value

WrappingMode

WrappingExtent

public RectangleShape WrappingExtent { get; set; }

Property Value

RectangleShape

Constructors

WmsAsyncLayer()

This is the constructor for the class. If you use this constructor, then you need to set the required properties manually.

public WmsAsyncLayer()

Remarks:

None

WmsAsyncLayer(Uri)

This is the constructor the for the class.

public WmsAsyncLayer(Uri uri)

Parameters

uri Uri
URI of the WMS server.

Remarks:

This constructor initializes a new WmsRasterSource and downloads and parses the service description. In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified.

WmsAsyncLayer(Uri, IWebProxy)

This is the constructor the for the class.

public WmsAsyncLayer(Uri uri, IWebProxy webProxy)

Parameters

uri Uri
URI of the WMS server.

webProxy IWebProxy
Proxy to use for the current WMS layer.

Remarks:

This constructor initializes a new WmsRasterSource and downloads and parses the service description. In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified.

WmsAsyncLayer(Uri, IWebProxy, String, WmsAxisOrder, String, Boolean)

This is the constructor the for the class.

public WmsAsyncLayer(Uri uri, IWebProxy webProxy, string crs, WmsAxisOrder axisOrder, string version, bool fastMode)

Parameters

uri Uri
URI of the WMS server.

webProxy IWebProxy
Proxy to use for the current WMS layer.

crs String
the projected or geographic coordinate reference system to be used.

axisOrder WmsAxisOrder
the axis order of the layer

version String
version of the WMS server

fastMode Boolean
whether request and parse capabilities

Remarks:

This constructor initializes a new WmsRasterSource and downloads and parses the service description In an ASP.NET application, the service description is automatically cached for 24 hours when it is not specified.

WmsAsyncLayer(Collection<WmsServerLayer>)

public WmsAsyncLayer(Collection<WmsServerLayer> flatWmsServerLayers)

Parameters

flatWmsServerLayers Collection<WmsServerLayer>

Methods

OnRequestedImageException(RequestedImageExceptionEventArgs)

protected void OnRequestedImageException(RequestedImageExceptionEventArgs e)

Parameters

e RequestedImageExceptionEventArgs

GetServerLayers()

This method returns all layers at the server side.

public Collection<WmsServerLayer> GetServerLayers()

Returns

Collection<WmsServerLayer>
The names of all layers at the server side.

Remarks:

None.

GetServerStyleNames()

This method returns the names of all styles at the server side.

public Collection<string> GetServerStyleNames()

Returns

Collection<String>
The names of all styles at the server side.

Remarks:

None.

GetServerOutputFormats()

This method returns the output format at the server side.

public Collection<string> GetServerOutputFormats()

Returns

Collection<String>
The output format at the server side.

Remarks:

None.

GetServerCrsCollection()

This method returns the projected or geographic coordinate reference systems to be used.

public Collection<string> GetServerCrsCollection()

Returns

Collection<String>

GetServerExceptionFormats()

This method returns the exception format at the server side.

public Collection<string> GetServerExceptionFormats()

Returns

Collection<String>
The exception format at the server side.

Remarks:

None.

GetServiceVersion()

This API gets the WMS server version of the service.

public string GetServiceVersion()

Returns

String
Returns a string reflecting the version of the service in WMS.

GetServiceBaseUrl()

This API gets the WMS base url of the service.

public string GetServiceBaseUrl()

Returns

String
Returns a string reflecting the WMS base url.

GetServerFeatureInfoFormats()

This API gets the WMS server FeatureInfo formats of the service.

public Collection<string> GetServerFeatureInfoFormats()

Returns

Collection<String>
This API returns the FeatureInfo formats supported on the server-side.

GetServerCapabilitiesXml()

This API gets the GetCapabilities document of the service.

public string GetServerCapabilitiesXml()

Returns

String
This API returns the GetCapabilities document of the service.

GetRequestUrl(RectangleShape, Int32, Int32)

Get the request URL from the client to the WMS.

public string GetRequestUrl(RectangleShape worldExtent, int canvasWidth, int canvasHeight)

Parameters

worldExtent RectangleShape
The world extent requested by the client to get the map.

canvasWidth Int32
The returning map width, as well as the drawing view width.

canvasHeight Int32
The returning map height, as well as the drawing view height.

Returns

String
The request URL from the client to the WMS.

GetRequestUrlCore(RectangleShape, Int32, Int32)

protected string GetRequestUrlCore(RectangleShape worldExtent, int canvasWidth, int canvasHeight)

Parameters

worldExtent RectangleShape

canvasWidth Int32

canvasHeight Int32

Returns

String

OpenAsyncCore(CancellationToken)

This method opens the RasterSource so that it is initialized and ready to use.

protected Task OpenAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task
None

Exceptions

InvalidOperationException
In the event you attempt to call this method on an image source which has already been opened, it will throw an InvalidOperationException.

Remarks:

This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterSource.

When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource.

CloseAsyncCore(CancellationToken)

protected Task CloseAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

GetBoundingBoxCore()

This method returns the bounding box of the RasterSource.

protected RectangleShape GetBoundingBoxCore()

Returns

RectangleShape
The bounding box of the RasterSource.

Exceptions

InvalidOperationException
In the event you attempt to call this method on an image source which has not been opened, it will throw an InvalidOperationException.

Remarks:

This method returns the bounding box of the RasterSource.

DrawAsyncCore(GeoCanvas, Collection<SimpleCandidate>)

protected Task DrawAsyncCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters

canvas GeoCanvas

labelsInAllLayers Collection<SimpleCandidate>

Returns

Task

BuildWmsGetFeatureInfoUri(ScreenPointF, String, Int32)

protected string BuildWmsGetFeatureInfoUri(ScreenPointF screenPointF, string infoFormat, int maxFeatures)

Parameters

screenPointF ScreenPointF

infoFormat String

maxFeatures Int32

Returns

String

GetFeatureInfoAsync(ScreenPointF, Int32, CancellationToken)

public Task<Dictionary<string, Collection<Feature>>> GetFeatureInfoAsync(ScreenPointF screenPointF, int maxFeatures, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

maxFeatures Int32

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

GetFeatureInfoAsync(ScreenPointF, CancellationToken)

public Task<Dictionary<string, Collection<Feature>>> GetFeatureInfoAsync(ScreenPointF screenPointF, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

GetFeatureInfoAsync(ScreenPointF, String, CancellationToken)

public Task<Dictionary<string, Collection<Feature>>> GetFeatureInfoAsync(ScreenPointF screenPointF, string infoFormat, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

infoFormat String

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

GetFeatureInfo(ScreenPointF, Int32, CancellationToken)

public Task<Dictionary<string, Collection<Feature>>> GetFeatureInfo(ScreenPointF screenPointF, int maxFeatures, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

maxFeatures Int32

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

GetFeatureInfoAsync(ScreenPointF, String, Int32, CancellationToken)

public Task<Dictionary<string, Collection<Feature>>> GetFeatureInfoAsync(ScreenPointF screenPointF, string infoFormat, int maxFeatures, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

infoFormat String

maxFeatures Int32

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

GetFeatureInfoAsyncCore(ScreenPointF, String, Int32, CancellationToken)

protected Task<Dictionary<string, Collection<Feature>>> GetFeatureInfoAsyncCore(ScreenPointF screenPointF, string infoFormat, int maxFeatures, CancellationToken cancellationToken)

Parameters

screenPointF ScreenPointF

infoFormat String

maxFeatures Int32

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

DownloadImageAsyncCore(Double, Double, Double, RectangleShape, GeographyUnit, CancellationToken)

protected Task<Byte[]> DownloadImageAsyncCore(double width, double height, double scaleFactor, RectangleShape extent, GeographyUnit mapUnit, CancellationToken cancellationToken)

Parameters

width Double

height Double

scaleFactor Double

extent RectangleShape

mapUnit GeographyUnit

cancellationToken CancellationToken

Returns

Task<Byte[]>

HandleResponseAsync(HttpRequestMessage, CancellationToken)

internal Task<Dictionary<string, Collection<Feature>>> HandleResponseAsync(HttpRequestMessage request, CancellationToken cancellationToken)

Parameters

request HttpRequestMessage

cancellationToken CancellationToken

Returns

Task<Dictionary<String, Collection<Feature>>>

HandleXmlInfoFormatResponse(XmlDocument)

internal Dictionary<string, Collection<Feature>> HandleXmlInfoFormatResponse(XmlDocument xmlDocument)

Parameters

xmlDocument XmlDocument

Returns

Dictionary<String, Collection<Feature>>

Events

RequestedImageException

This event is called after the image request done with some OnSendingWebRequest.

public event EventHandler<RequestedImageExceptionEventArgs> RequestedImageException;

Remarks:

This event is called before sending the request for raster image.
It is typical that user want to get the url of request and modify it according to their requirements. For example, user could create a signature for it, and verify it on the server side.

SendingHttpRequest

public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;

ReceivedHttpResponse

public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;

DrawingException

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;