WfsV2AsyncLayer¶
Namespace: ThinkGeo.Core
Represents a web layer that asynchronously requests and renders data from a WFS 2.0 service.
public class WfsV2AsyncLayer : WebBasedAsyncLayer, IHttpRequestService
Inheritance Object → LayerBase → AsyncLayer → WebBasedAsyncLayer → WfsV2AsyncLayer
Implements IHttpRequestService
Properties¶
Url¶
Gets or sets the base URL of the target WFS service.
public string Url { get; set; }
Property Value¶
TypeName¶
Gets or sets the fully qualified feature type (layer) name that will be requested.
public string TypeName { get; set; }
Property Value¶
WfsAxisOrder¶
Gets or sets the axis order that should be used when interpreting coordinates from the service.
public WfsAxisOrder WfsAxisOrder { get; set; }
Property Value¶
ZoomLevelSet¶
Gets or sets the ZoomLevelSet that controls how the layer draws.
public ZoomLevelSet ZoomLevelSet { get; set; }
Property Value¶
ProjectionConverter¶
Gets or sets the projection converter that transforms data between the WFS coordinate system and the map projection.
public ProjectionConverter ProjectionConverter { get; set; }
Property Value¶
HasBoundingBox¶
Gets a value indicating whether the WFS layer advertises a bounding box that can be used by the map.
public bool HasBoundingBox { get; }
Property Value¶
HttpClient¶
Gets or sets the HTTP client reused for outbound requests.
public HttpClient HttpClient { get; set; }
Property Value¶
HttpClient
WebProxy¶
Gets or sets the proxy through which all HTTP requests should be routed.
public IWebProxy WebProxy { get; set; }
Property Value¶
IWebProxy
TimeoutInSeconds¶
Gets or sets the request timeout, in seconds.
public int TimeoutInSeconds { get; set; }
Property Value¶
Credentials¶
Gets or sets the credential provider used when authenticating HTTP requests.
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¶
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.
UpperScale¶
This property gets and sets the upper threshold in the scale at which to display the image.
public double UpperScale { 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.
LowerScale¶
This property gets and sets the lower threshold in the scale at which to display the image.
public double LowerScale { 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.
Name¶
Gets or sets the display name for the layer.
public string Name { get; set; }
Property Value¶
String
The name used to identify the layer within UI components such as legends.
Remarks:
The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.
IsOpen¶
Gets a value indicating whether the layer is currently open.
public bool IsOpen { get; }
Property Value¶
Boolean
true if the layer has completed its open routine; otherwise, false.
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¶
Gets or sets a value indicating whether the layer is visible.
public bool IsVisible { get; set; }
Property Value¶
Boolean
true to draw the layer; otherwise, false.
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¶
Gets the last recorded drawing time for the layer.
public TimeSpan DrawingTime { get; protected set; }
Property Value¶
TimeSpan
The duration of the most recent draw operation.
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¶
DrawingExceptionMode¶
Gets or sets how drawing exceptions are handled when the layer renders.
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets or sets the background color used when rendering the layer.
public GeoColor Background { get; set; }
Property Value¶
GeoColor
The fill applied to areas not covered by layer content.
Transparency¶
Gets or sets the amount of transparency applied to the rendered image.
public float Transparency { get; set; }
Property Value¶
Single
A value between 0 (fully transparent) and 255 (fully opaque).
BlueTranslation¶
Gets or sets the intensity adjustment applied to the blue channel.
public float BlueTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the blue channel translation.
RedTranslation¶
Gets or sets the intensity adjustment applied to the red channel.
public float RedTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the red channel translation.
GreenTranslation¶
Gets or sets the intensity adjustment applied to the green channel.
public float GreenTranslation { get; set; }
Property Value¶
Single
A value between -255 and 255 representing the green channel translation.
KeyColors¶
Gets the collection of key colors that should be rendered as transparent.
public Collection<GeoColor> KeyColors { get; }
Property Value¶
Remarks:
Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.
IsNegative¶
Gets or sets a value indicating whether the image should be rendered with inverted colors.
public bool IsNegative { get; set; }
Property Value¶
Boolean
true to invert the color channels; otherwise, false.
IsGrayscale¶
Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.
public bool IsGrayscale { get; set; }
Property Value¶
Boolean
true to apply a grayscale filter; otherwise, false.
ThreadSafe¶
Gets or sets the threading guarantees provided by the layer implementation.
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.
ColorMappings¶
Gets the color translation map that will be applied when rendering the layer.
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
Gets or sets how the layer wraps when the map extent crosses world boundaries.
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
Gets or sets the geographic extent to use when wrapping is enabled.
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
WfsV2AsyncLayer()¶
Initializes a new instance of the WfsV2AsyncLayer class.
public WfsV2AsyncLayer()
WfsV2AsyncLayer(String, String)¶
Initializes a new instance of the WfsV2AsyncLayer class using the specified service endpoint and feature type name.
public WfsV2AsyncLayer(string url, string typeName)
Parameters¶
url String
The base URL of the WFS service.
typeName String
The fully qualified type name (feature type) to request.
Methods¶
GetCapabilities(String)¶
Issues a WFS GetCapabilities request and returns the raw XML response as a string.
public static string GetCapabilities(string url)
Parameters¶
url String
The base URL of the WFS service.
Returns¶
String
The GetCapabilities XML response.
GetCapabilities(Uri)¶
Issues a WFS GetCapabilities request against the specified URI.
public static string GetCapabilities(Uri serverUri)
Parameters¶
serverUri Uri
The URI of the WFS service.
Returns¶
String
The GetCapabilities XML response.
GetCapabilities(Uri, IWebProxy)¶
Issues a WFS GetCapabilities request using the supplied URI and proxy settings.
public static string GetCapabilities(Uri serverUri, IWebProxy webProxy)
Parameters¶
serverUri Uri
The URI of the WFS service.
webProxy IWebProxy
An optional proxy used when issuing the request.
Returns¶
String
The GetCapabilities XML response.
GetLayers(String)¶
Retrieves the collection of feature type names that are published by the specified WFS endpoint.
public static Collection<string> GetLayers(string url)
Parameters¶
url String
The base URL of the WFS service.
Returns¶
Collection<String>
A collection that contains the discoverable feature type names.
GetLayers(Uri)¶
Retrieves the collection of feature type names that are published by the specified WFS endpoint.
public static Collection<string> GetLayers(Uri serverUri)
Parameters¶
serverUri Uri
The URI of the WFS service.
Returns¶
Collection<String>
A collection that contains the discoverable feature type names.
GetLayers(Uri, IWebProxy)¶
Retrieves the collection of feature type names using the supplied URI and proxy settings.
public static Collection<string> GetLayers(Uri serverUri, IWebProxy webProxy)
Parameters¶
serverUri Uri
The URI of the WFS service.
webProxy IWebProxy
An optional proxy used when issuing the request.
Returns¶
Collection<String>
A collection that contains the discoverable feature type names.
GetRasterContentTypeCore()¶
WFS responses are feature vectors rendered as cartography.
protected RasterContentType GetRasterContentTypeCore()
Returns¶
OpenAsyncCore(CancellationToken)¶
Provides the overridable implementation that asynchronously opens the instance and initializes the resources it depends on.
protected Task OpenAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken CancellationToken
A cancellation or authentication token, depending on context.
Returns¶
Task
A task that represents the asynchronous operation.
CloseAsyncCore(CancellationToken)¶
Provides the overridable implementation that asynchronously closes the instance and releases any resources it holds.
protected Task CloseAsyncCore(CancellationToken cancellationToken)
Parameters¶
cancellationToken CancellationToken
A cancellation or authentication token, depending on context.
Returns¶
Task
A task that represents the asynchronous operation.
DrawAsyncCore(GeoCanvas, Collection<SimpleCandidate>)¶
Provides the overridable implementation that asynchronously draws onto and appends any label candidates to .
protected Task DrawAsyncCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)
Parameters¶
canvas GeoCanvas
The to draw to.
labelsInAllLayers Collection<SimpleCandidate>
A shared collection that receives label candidates generated during drawing.
Returns¶
Task
A task that represents the asynchronous operation.
GetBoundingBoxCore()¶
Provides the overridable implementation that returns the bounding box that encloses the relevant geometry.
protected RectangleShape GetBoundingBoxCore()
Returns¶
RectangleShape
The result of the operation.
GetRequestUrl(RectangleShape, Int32, Int32)¶
Builds a WFS GetFeature request URL for the specified bounding box and paging parameters.
public string GetRequestUrl(RectangleShape boundingBox, int count, int startIndex)
Parameters¶
boundingBox RectangleShape
The spatial extent that should be requested.
count Int32
The maximum number of features to return.
startIndex Int32
The zero-based index of the first feature to request.
Returns¶
String
A fully qualified GetFeature URL.
GetFeaturesAsync(String, CancellationToken)¶
Submits a GetFeature request to the WFS service and parses the returned features.
public Task<ValueTuple<int, Collection<Feature>>> GetFeaturesAsync(string requestUrl, CancellationToken cancellationToken)
Parameters¶
requestUrl String
The full request URL that will be executed.
cancellationToken CancellationToken
A token that can be used to cancel the operation.
Returns¶
Task<ValueTuple<Int32, Collection<Feature>>>
A tuple that contains the reported match count and the retrieved features.
Events¶
SendingHttpRequest¶
Occurs before an HTTP request is dispatched so callers can inspect or cancel it.
public event EventHandler<SendingHttpRequestMessageEventArgs> SendingHttpRequest;
ReceivedHttpResponse¶
Occurs after an HTTP response is received.
public event EventHandler<ReceivedHttpResponseMessageEventArgs> ReceivedHttpResponse;
DrawingException¶
Occurs when the DrawingException event is raised.
public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;
DrawnException¶
Occurs when the DrawnException event is raised.
public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;