Skip to content

WmtsLayer

Namespace: ThinkGeo.Core.Async

public class WmtsLayer : XyzTileLayer

Inheritance Object → LayerBase → Layer → LayerAsync → WebBasedLayer → XyzTileLayer → WmtsLayer

Properties

ServerUris

public Collection<Uri> ServerUris { get; }

Property Value

Collection<Uri>

ServerUri

public Uri ServerUri { get; set; }

Property Value

Uri

CapabilitesCacheTimeout

The timeout for Capabilities Cache, its 10 minutes by default

public TimeSpan CapabilitesCacheTimeout { get; set; }

Property Value

TimeSpan

ActiveLayerName

public string ActiveLayerName { get; set; }

Property Value

String

WmtsSeverEncodingType

public WmtsSeverEncodingType WmtsSeverEncodingType { get; set; }

Property Value

WmtsSeverEncodingType

WmtsServerLayers

public Collection<WmtsServerLayer> WmtsServerLayers { get; set; }

Property Value

Collection<WmtsServerLayer>

ActiveStyleName

public string ActiveStyleName { get; set; }

Property Value

String

Parameters

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

Property Value

Dictionary<String, String>

OutputFormat

public string OutputFormat { get; set; }

Property Value

String

LowerScale

public double LowerScale { get; set; }

Property Value

Double

UpperScale

public double UpperScale { get; set; }

Property Value

Double

TileMatrixSetName

public string TileMatrixSetName { get; set; }

Property Value

String

AxisOrder

public WmtsAxisOrder AxisOrder { get; set; }

Property Value

WmtsAxisOrder

ProjectionConverter

public ProjectionConverter ProjectionConverter { get; set; }

Property Value

ProjectionConverter

ProjectedTileCache

public RasterTileCache ProjectedTileCache { get; set; }

Property Value

RasterTileCache

IsCacheOnly

public bool IsCacheOnly { get; set; }

Property Value

Boolean

TileMatrixSets

The tile matrix sets of this WmtsLayer in Dictionary.

public Dictionary<string, WmtsTileMatrixSet> TileMatrixSets { get; }

Property Value

Dictionary<String, WmtsTileMatrixSet>

HasBoundingBox

public bool HasBoundingBox { get; }

Property Value

Boolean

TileWidth

public int TileWidth { get; protected set; }

Property Value

Int32

TileHeight

public int TileHeight { get; protected set; }

Property Value

Int32

MapUnit

public GeographyUnit MapUnit { get; protected set; }

Property Value

GeographyUnit

MaxExtent

public RectangleShape MaxExtent { get; protected set; }

Property Value

RectangleShape

TileCache

public RasterTileCache TileCache { get; set; }

Property Value

RasterTileCache

ProjectionConverterFromServerProjection

public ProjectionConverter ProjectionConverterFromServerProjection { get; set; }

Property Value

ProjectionConverter

WebProxy

public IWebProxy WebProxy { get; set; }

Property Value

IWebProxy

TimeoutInSeconds

public int TimeoutInSeconds { get; set; }

Property Value

Int32

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

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.

Attribution

public string Attribution { get; set; }

Property Value

String

RequestDrawingInterval

public TimeSpan RequestDrawingInterval { get; set; }

Property Value

TimeSpan

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

WmtsLayer()

public WmtsLayer()

WmtsLayer(IEnumerable<Uri>)

public WmtsLayer(IEnumerable<Uri> serverUris)

Parameters

serverUris IEnumerable<Uri>

WmtsLayer(IEnumerable<Uri>, IWebProxy)

public WmtsLayer(IEnumerable<Uri> serverUris, IWebProxy webProxy)

Parameters

serverUris IEnumerable<Uri>

webProxy IWebProxy

WmtsLayer(IEnumerable<Uri>, IWebProxy, WmtsSeverEncodingType)

public WmtsLayer(IEnumerable<Uri> serverUris, IWebProxy webProxy, WmtsSeverEncodingType wmtsSeverEncodingType)

Parameters

serverUris IEnumerable<Uri>

webProxy IWebProxy

wmtsSeverEncodingType WmtsSeverEncodingType

WmtsLayer(Uri)

public WmtsLayer(Uri serverUri)

Parameters

serverUri Uri

WmtsLayer(Uri, IWebProxy)

public WmtsLayer(Uri serverUri, IWebProxy webProxy)

Parameters

serverUri Uri

webProxy IWebProxy

WmtsLayer(Uri, IWebProxy, WmtsSeverEncodingType)

public WmtsLayer(Uri serverUri, IWebProxy webProxy, WmtsSeverEncodingType wmtsSeverEncodingType)

Parameters

serverUri Uri

webProxy IWebProxy

wmtsSeverEncodingType WmtsSeverEncodingType

Methods

OpenAsyncCore(CancellationToken)

protected Task OpenAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

GetWGS84BoundingBox()

public RectangleShape GetWGS84BoundingBox()

Returns

RectangleShape

GetBoundingBoxCore()

protected RectangleShape GetBoundingBoxCore()

Returns

RectangleShape

GetRequestUris(RectangleShape, Int32, Int32)

public Collection<Uri> GetRequestUris(RectangleShape requestExtent, int canvasWidth, int canvasHeight)

Parameters

requestExtent RectangleShape

canvasWidth Int32

canvasHeight Int32

Returns

Collection<Uri>

GetRequestUrisCore(RectangleShape, Int32, Int32)

protected Collection<Uri> GetRequestUrisCore(RectangleShape requestExtent, int canvasWidth, int canvasHeight)

Parameters

requestExtent RectangleShape

canvasWidth Int32

canvasHeight Int32

Returns

Collection<Uri>

GetServerCapabilitiesXml()

public string GetServerCapabilitiesXml()

Returns

String

GetServerLayerNames()

public Collection<string> GetServerLayerNames()

Returns

Collection<String>

GetServerLayerStyles()

public Collection<string> GetServerLayerStyles()

Returns

Collection<String>

GetServerTileMatrixSetNames()

public Collection<string> GetServerTileMatrixSetNames()

Returns

Collection<String>

GetServerEncodingType()

Get encoding types for GetTile request

public Collection<WmtsSeverEncodingType> GetServerEncodingType()

Returns

Collection<WmtsSeverEncodingType>

GetLayerOutputFormats(String)

public Collection<string> GetLayerOutputFormats(string layerName)

Parameters

layerName String

Returns

Collection<String>

CloseAsyncCore(CancellationToken)

protected Task CloseAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

RemoveCachedCapability()

public bool RemoveCachedCapability()

Returns

Boolean

GetZoomLevelSet(String)

public ZoomLevelSet GetZoomLevelSet(string tileMatrixSetName)

Parameters

tileMatrixSetName String

Returns

ZoomLevelSet

GetTileMatrix(String, Double)

public TileMatrix GetTileMatrix(string tileMatrixSetName, double scale)

Parameters

tileMatrixSetName String

scale Double

Returns

TileMatrix

DrawAsyncCore(GeoCanvas, Collection<SimpleCandidate>)

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

Parameters

canvas GeoCanvas

labelsInAllLayers Collection<SimpleCandidate>

Returns

Task

DrawExceptionCore(GeoCanvas, Exception)

protected void DrawExceptionCore(GeoCanvas canvas, Exception e)

Parameters

canvas GeoCanvas

e Exception

GetRequestUri(Int64, Int64, Int32)

public string GetRequestUri(long x, long y, int zoomLevel)

Parameters

x Int64

y Int64

zoomLevel Int32

Returns

String

GetImageUriAsyncCore(Int32, Int64, Int64, Single)

protected Task<string> GetImageUriAsyncCore(int zoomLevel, long x, long y, float resolutionFactor)

Parameters

zoomLevel Int32

x Int64

y Int64

resolutionFactor Single

Returns

Task<String>

Events

SendingHttpRequest

public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;

ReceivedHttpResponse

public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;

DrawingAttribution

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

DrawingProgressChanged

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

RequestedDrawing

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;

DrawingException

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;