WfsFeatureLayer¶
Namespace: ThinkGeo.Core
This class represents the wfs(web feature service) FeauteLayer.
public class WfsFeatureLayer : FeatureLayer
Inheritance Object → LayerBase → Layer → FeatureLayer → WfsFeatureLayer
Remarks:
This class allows you to get features from an wfs server.
Properties¶
LastXmlResponse¶
The xml text represnets last respone, it will pass out by RequestedData event with parameter.
public string LastXmlResponse { get; }
Property Value¶
ServiceLocationUrl¶
The url of wfs service.
public string ServiceLocationUrl { get; set; }
Property Value¶
TypeName¶
The typename in the specify wfs service.
public string TypeName { get; set; }
Property Value¶
TimeoutInSeconds¶
This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds.
public int TimeoutInSeconds { get; set; }
Property Value¶
HasBoundingBox¶
This property indicates whether 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¶
Remarks:
The default value is false.
WebProxy¶
This property gets or sets the proxy used for requesting a Web Response.
public IWebProxy WebProxy { get; set; }
Property Value¶
IWebProxy
Projection¶
public Projection Projection { get; }
Property Value¶
EditTools¶
This property gets the EditTools that allow you to easily edit InternalFeatures in the Feature Layer.
public EditTools EditTools { get; protected set; }
Property Value¶
This property gets the EditTools that allow you to easily edit InternalFeatures in the
Feature Layer.
Remarks:
The EditTools are supplied as an easily accessible wrapper for the editing methods of the FeatureSource.
FeatureIdsToExclude¶
A collection of strings representing record id of features not to get in the Layer.
public Collection<string> FeatureIdsToExclude { get; }
Property Value¶
Remarks:
This string collection is a handy place to specify what records not to get from the source. Suppose you have a shape file of roads and you want to hide the roads within a particular rectangle, simply execute GetFeaturesInsideBoundingBox() and add the id of the return features to the collection and forget about them. Since you can set this by Layer it makes is easy to determine what to and what not to.
QueryTools¶
This property gets the QueryTools that allow you to easily query Features from the Feature Layer.
public QueryTools QueryTools { get; protected set; }
Property Value¶
This property gets the QueryTools that allow you to easily query Features from the
Feature Layer.
Remarks:
This property gets the QueryTools that allow you to easily query Features from the Feature Layer. The QueryTools are supplied as an easily accessible wrapper for the query methods of the FeatureSource.
MaxRecordsToDraw¶
public int MaxRecordsToDraw { get; set; }
Property Value¶
FeatureSource¶
This property gets the FeatureSource for the FeatureLayer.
public FeatureSource FeatureSource { get; set; }
Property Value¶
FeatureSource
This property gets the FeatureSource for the FeatureLayer.
Remarks:
The FeatureSource is the provider of data to the FeatureLayer. There are different FeatureSource classes to match the various ways that feature data is stored. It is important that, when you inherit from the FeatureLayer, in the constructor you set the FeatureSource you want to use.
DrawingQuality¶
This property gets and sets the general drawing quality for the FeatureLayer's view.
public DrawingQuality DrawingQuality { get; set; }
Property Value¶
This property gets the general drawing quality for the FeatureLayer's
view.
Remarks:
The DrawingQuality enumeration allows you to control, in a macro sense, the drawing quality that will be used in the GeoCanvas. Each GeoCanvas, which is responsible for drawing of the features, may have its own specialized drawing quality properties. What the DrawingQuality enumeration does is define some general guidelines for each GeoCanvas. For example, if you set the DrawingQuality to HighSpeed, then inside of the PlatformGeoCanvas there is a profile for HighSpeed. This profile sets specific properties, such as the smoothing mode and composing drawing mode of the PlatformGeoCanvas. As each GeoCanvas may have different drawing quality properties, this offers a general way to control drawing quality and speed.
If you need complete control over how a specific GeoCanvas will draw, then you can set the DrawingQuality to Custom. This will tell the specific GeoCanvas to use the properties on its own object instead of one of the pre-defined profiles. If one of the profiles -- such as HighSpeed or HighQuality -- is set, then the specific GeoCanvas ignores its own properties for drawing quality.
ZoomLevelSet¶
This property gets and sets the ZoomLevelSet, which contains the specific zoom levels for the FeatureLayer.
public ZoomLevelSet ZoomLevelSet { get; set; }
Property Value¶
This property gets the ZoomLevelSet, which contains the specific zoom levels for
the FeatureLayer.
Remarks:
The ZoomLevelSet is a class that contains all of the ZoomLevels for the FeatureLayer. Each ZoomLevel contains the styles that are used to determine how to draw the InternalFeatures.
DrawingMarginInPixel¶
public float DrawingMarginInPixel { get; set; }
Property Value¶
Attribution¶
public string Attribution { get; set; }
Property Value¶
RequestDrawingInterval¶
public TimeSpan RequestDrawingInterval { get; set; }
Property Value¶
Name¶
This property gets and sets the name for the layer.
public string Name { get; set; }
Property Value¶
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¶
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¶
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¶
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.
DrawingExceptionMode¶
public DrawingExceptionMode DrawingExceptionMode { get; set; }
Property Value¶
Background¶
Gets and sets the background of the layer.
public GeoColor Background { get; set; }
Property Value¶
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¶
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¶
This property gets and sets if the image should be converted to grayscale.
Remarks:
None
ThreadSafe¶
public ThreadSafetyLevel ThreadSafe { get; set; }
Property Value¶
ColorMappings¶
ColorMapping
public Dictionary<GeoColor, GeoColor> ColorMappings { get; }
Property Value¶
Dictionary<GeoColor, GeoColor>
WrappingMode¶
public WrappingMode WrappingMode { get; set; }
Property Value¶
WrappingExtent¶
public RectangleShape WrappingExtent { get; set; }
Property Value¶
Constructors¶
WfsFeatureLayer()¶
WfsFeatureLayer Constructor.
public WfsFeatureLayer()
WfsFeatureLayer(String, String)¶
WfsFeatureSource Constructor
public WfsFeatureLayer(string serviceLocationUrl, string typeName)
Parameters¶
serviceLocationUrl String
The url of wfs service.
typeName String
The typename in the specify wfs service.
Remarks:
The parameters can not be null.
Methods¶
GetCapabilities(String)¶
Get capabilities from the specific wfs service url.
public static string GetCapabilities(string serviceLocationUrl)
Parameters¶
serviceLocationUrl String
The url of wfs service.
Returns¶
String
The xml text represents capabilities of this wfs server.
Exceptions¶
ArgumentNullException
If serviceLocationUrl is null, we will throw an ArgumentNullException.
ArgumentException
If serviceLocationUrl is empty, we will throw an ArgumentException.
Remarks:
Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document.
The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
GetCapabilities(Uri)¶
Get capabilities from the specific wfs service url.
public static string GetCapabilities(Uri serverUri)
Parameters¶
serverUri Uri
The url of wfs service.
Returns¶
String
The xml text represents capabilities of this wfs server.
Exceptions¶
ArgumentNullException
If serviceLocationUrl is null, we will throw an ArgumentNullException.
ArgumentException
If serviceLocationUrl is empty, we will throw an ArgumentException.
Remarks:
Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document.
The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
GetCapabilities(Uri, IWebProxy)¶
Get capabilities from the specific wfs service url.
public static string GetCapabilities(Uri serverUri, IWebProxy webProxy)
Parameters¶
serverUri Uri
The url of wfs service.
webProxy IWebProxy
The proxy of the wfs service.
Returns¶
String
The xml text represents capabilities of this wfs server.
Exceptions¶
ArgumentNullException
If serviceLocationUrl is null, we will throw an ArgumentNullException.
ArgumentException
If serviceLocationUrl is empty, we will throw an ArgumentException.
Remarks:
Every OGC Web Service (OWS), including a Web Feature Service, must have the ability to describe its capabilities by returning service metadata in response to a GetCapabilities request. Specifically, every web feature service must support the KVP encoded form of the GetCapabilities request over HTTP GET so that a client can always know how to obtain a capabilities document.
The capabilities response document contains the following sections: 1. Service Identification section The service identification section provides information about the WFS service itself. 2. Service Provider section The service provider section provides metadata about the organization operating the WFS server. 3. Operation Metadata section The operations metadata section provides metadata about the operations defined in this specification and implemented by a particular WFS server. This metadata includes the DCP, parameters and constraints for each operation. 4. FeatureType list section This section defines the list of feature types (and operations on each feature type) that are available from a web feature service. Additional information, such as the default SRS, any other supported SRSs, or no SRS whatsoever (for non-spatial feature types), for WFS requests is provided for each feature type. 5. ServesGMLObjectType list section This section defines the list of GML Object types, not derived from gml:AbstractFeatureType, that are available from a web feature service that supports the GetGMLObject operation. These types may be defined in a base GML schema, or in an application schema using its own namespace. 6. SupportsGMLObjectType list section The Supports GML Object Type section defines the list of GML Object types that a WFS server would be capable of serving if it was deployed to serve data. described by an application schema that either used those GML Object types directly (for non-abstract types), or defined derived types based on those types. 7. Filter capabilities section The schema of the Filter Capabilities Section is defined in the Filter Encoding Implementation Specification [3]. This is an optional section. If it exists, then the WFS should support the operations advertised therein. If the Filter Capabilities Section is not defined, then the client should assume that the server only supports the minimum default set of filter operators.
GetLayers(String)¶
Get layer names from specific wfs service url.
public static Collection<string> GetLayers(string serviceLocationUrl)
Parameters¶
serviceLocationUrl String
The url of wfs service.
Returns¶
Collection<String>
The collection represent layer names.
Exceptions¶
ArgumentNullException
If serviceLocationUrl is null, we will throw an ArgumentNullException.
ArgumentException
If serviceLocationUrl is empty, we will throw an ArgumentException.
Remarks:
Typically, it will call WfsFeatureSource.GetLayers(serviceLocationUrl) internally.
GetLayers(Uri, IWebProxy)¶
Get layer names from specific wfs service url.
public static Collection<string> GetLayers(Uri serverUri, IWebProxy webProxy)
Parameters¶
serverUri Uri
The url of wfs service.
webProxy IWebProxy
The proxy of the wfs service.
Returns¶
Collection<String>
The collection represent layer names.
Remarks:
Typically, it will call WfsFeatureSource.GetLayers(serverUri) internally.
GetLayers(Uri)¶
Get layer names from specific wfs service url.
public static Collection<string> GetLayers(Uri serverUri)
Parameters¶
serverUri Uri
The url of wfs service.
Returns¶
Collection<String>
The collection represent layer names.
Events¶
SendingWebRequest¶
public event EventHandler<SendingWebRequestEventArgs> SendingWebRequest;
SentWebRequest¶
public event EventHandler<SentWebRequestEventArgs> SentWebRequest;
DrawingFeatures¶
This event is raised when features are about to be drawn in the layer.
public event EventHandler<DrawingFeaturesEventArgs> DrawingFeatures;
Remarks:
This event is raised when features are about to be drawn in the layer. In the event arguments, there is a collection of features to be drawn. You can easily add or remove items from this collection so that extra items will draw or not draw.
DrawingWrappingFeatures¶
public event EventHandler<DrawingWrappingFeaturesFeatureLayerEventArgs> DrawingWrappingFeatures;
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;