Skip to content

WmsRasterLayer

Namespace: ThinkGeo.Core

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

public class WmsRasterLayer : RasterLayer

Inheritance ObjectLayerRasterLayerWmsRasterLayer

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

Uri

This property specifies the URI of the WMS server.

public Uri Uri { get; set; }

Property Value

Uri

ActiveLayerNames

This property represents the available layers that can be requested from the client and 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 represents the available styles that can be requested from the client and 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.

OutputFormat

This property gets or sets the desired output format for the map 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. Format are specified as MIME types such as "image/gif" or "image/png".

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

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

Proxy

This property gets or sets the proxy used for requesting a Web Response.

public IWebProxy Proxy { get; set; }

Property Value

IWebProxy

Crs

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

public string Crs { get; set; }

Property Value

String

TimeoutInSecond

This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds.

public int TimeoutInSecond { get; set; }

Property Value

Int32

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.

CapabilitesCacheTimeOut

public TimeSpan CapabilitesCacheTimeOut { get; set; }

Property Value

TimeSpan

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>

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.

AxisOrder

public WmsAxisOrder AxisOrder { get; set; }

Property Value

WmsAxisOrder

UserAgent

public string UserAgent { get; set; }

Property Value

String

ImageSource

This property gets and sets the Image used by the RasterLayer.

public RasterSource ImageSource { get; protected set; }

Property Value

RasterSource
This property gets the Image used by the RasterLayer.

Remarks:

The set for this property is protected and only intended to be used by developers who are creating their own ImageSources. This is the main property to set for developers who are creating their own RasterLayer derivatives.

WrappingMode

public WrappingMode WrappingMode { get; set; }

Property Value

WrappingMode

WrappingExtent

public RectangleShape WrappingExtent { get; set; }

Property Value

RectangleShape

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 double.min. 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 double.min. This means the image should always display.

ScaleFactor

The scale factor when drawing the primitive image. For example I am looking for an image with 100100px, If the ScaleFactor is set to 2, it means the component will get the image with 200200px. We want to keep it as 1 (by default) for most cases.

public double ScaleFactor { get; set; }

Property Value

Double

Projection

public Projection Projection { get; }

Property Value

Projection

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.

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.

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.

Attribution

public string Attribution { get; set; }

Property Value

String

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.

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

ColorMappings

ColorMapping

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

Property Value

Dictionary<GeoColor, GeoColor>

DrawingExceptionMode

Gets or sets the DrawExceptionMode when exception happens.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value

DrawingExceptionMode

ThreadSafe

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value

ThreadSafetyLevel

Background

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value

GeoColor

RequestDrawingInterval

public TimeSpan RequestDrawingInterval { get; set; }

Property Value

TimeSpan

Constructors

WmsRasterLayer()

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

public WmsRasterLayer()

Remarks:

None

WmsRasterLayer(Uri)

This is the constructor the for the class.

public WmsRasterLayer(Uri uri)

Parameters

uri Uri
URI of the WMS server.

Remarks:

This constructor initializes a new layer, then 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.

WmsRasterLayer(Uri, IWebProxy)

This is the constructor the for the class.

public WmsRasterLayer(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 layer, then 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.

Methods

GetServerLayerNames()

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

public Collection<string> GetServerLayerNames()

Returns

Collection<String>
This method returns 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>
This method returns 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>
This method returns the output format at the server side.

Remarks:

None.

GetServerCrss()

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

public Collection<string> GetServerCrss()

Returns

Collection<String>

GetServerExceptionFormats()

This method returns the exception format at the server side.

public Collection<string> GetServerExceptionFormats()

Returns

Collection<String>
This method returns 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
Returning a string reflecting the version of the service in WMS.

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 GetCapabilites document of the service.

public string GetServerCapabilitiesXml()

Returns

String
This API returns the GetCapabilites 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

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)

Get the request URL from the client to the WMS.

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

Parameters

worldExtent RectangleShape

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.

GetFeatureInfo(ScreenPointF)

public Dictionary<string, Collection<Feature>> GetFeatureInfo(ScreenPointF screenPointF)

Parameters

screenPointF ScreenPointF

Returns

Dictionary<String, Collection<Feature>>

GetFeatureInfo(ScreenPointF, String)

public Dictionary<string, Collection<Feature>> GetFeatureInfo(ScreenPointF screenPointF, string infoFormat)

Parameters

screenPointF ScreenPointF

infoFormat String

Returns

Dictionary<String, Collection<Feature>>

GetFeatureInfo(ScreenPointF, Int32)

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

Parameters

screenPointF ScreenPointF

maxFeatures Int32

Returns

Dictionary<String, Collection<Feature>>

GetFeatureInfo(ScreenPointF, String, Int32)

public Dictionary<string, Collection<Feature>> GetFeatureInfo(ScreenPointF screenPointF, string infoFormat, int maxFeatures)

Parameters

screenPointF ScreenPointF

infoFormat String

maxFeatures Int32

Returns

Dictionary<String, Collection<Feature>>

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

protected void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters

canvas GeoCanvas

labelsInAllLayers Collection<SimpleCandidate>

Events

SendingWebRequest

public event EventHandler<SendingWebRequestEventArgs> SendingWebRequest;

RequestedImageException

public event EventHandler<RequestedImageExceptionEventArgs> RequestedImageException;

SentWebRequest

public event EventHandler<SentWebRequestEventArgs> SentWebRequest;

DrawingProgressChanged

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

DrawingException

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;

DrawingAttribution

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

RequestedDrawing

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;