WmsRasterLayer¶
Inheritance Hierarchy¶
ObjectLayerRasterLayerWmsRasterLayer
Members Summary¶
Public Constructors Summary¶
| Name |
|---|
WmsRasterLayer() |
WmsRasterLayer(Uri) |
WmsRasterLayer(Uri,IWebProxy) |
Protected Constructors Summary¶
| Name |
|---|
| N/A |
Public Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
ActiveLayerNames | Collection<String> | This property represents the available layers that can be requested from the client and shown on the map. |
ActiveStyleNames | Collection<String> | This property represents the available styles that can be requested from the client and shown on the map. |
Attribution | String | N/A |
AxisOrder | WmsAxisOrder | N/A |
Background | GeoColor | N/A |
BlueTranslation | Single | N/A |
CapabilitesCacheTimeOut | TimeSpan | N/A |
ColorMappings | Dictionary<GeoColor,GeoColor> | N/A |
Credentials | ICredentials | This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication. |
Crs | String | This property gets or sets the projected or geographic coordinate reference system to be used. |
DrawingExceptionMode | DrawingExceptionMode | N/A |
DrawingTime | TimeSpan | N/A |
Exceptions | String | This property indicates the format in which the client wishes to be notified of service exceptions. |
GreenTranslation | Single | N/A |
HasBoundingBox | Boolean | 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. |
ImageSource | RasterSource | N/A |
IsGrayscale | Boolean | N/A |
IsNegative | Boolean | N/A |
IsOpen | Boolean | N/A |
IsTransparent | Boolean | This property gets or sets whether the response map image's background color is transparent or not. |
IsVisible | Boolean | N/A |
KeyColors | Collection<GeoColor> | N/A |
LowerThreshold | Double | N/A |
Name | String | N/A |
OutputFormat | String | This property gets or sets the desired output format for the map requested from the WMS. |
Parameters | Dictionary<String,String> | This property specifies a dictionary used to update the request sent from the client to the WMS server. |
Projection | Projection | N/A |
Proxy | IWebProxy | This property gets or sets the proxy used for requesting a Web Response. |
RedTranslation | Single | N/A |
RequestDrawingInterval | TimeSpan | N/A |
ScaleFactor | Double | N/A |
ThreadSafe | ThreadSafetyLevel | N/A |
TimeoutInSecond | Int32 | This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds. |
Transparency | Single | N/A |
UpperThreshold | Double | N/A |
Uri | Uri | This property specifies the URI of the WMS server. |
WrappingExtent | RectangleShape | N/A |
WrappingMode | WrappingMode | N/A |
Protected Properties Summary¶
| Name | Return Type | Description |
|---|---|---|
IsOpenCore | Boolean | N/A |
Public Methods Summary¶
Protected Methods Summary¶
Public Events Summary¶
Members Detail¶
Public Constructors¶
| Name |
|---|
WmsRasterLayer() |
WmsRasterLayer(Uri) |
WmsRasterLayer(Uri,IWebProxy) |
Protected Constructors¶
Public Properties¶
ActiveLayerNames¶
Summary
This property represents the available layers that can be requested from the client and shown on the map.
Remarks
When requesting a map, a client may specify the layers to be shown on the map.
Return Value
Collection<String>
ActiveStyleNames¶
Summary
This property represents the available styles that can be requested from the client and shown on the map.
Remarks
When requesting a map, a client may specify the styles to be shown on the map.
Return Value
Collection<String>
Attribution¶
Summary
N/A
Remarks
N/A
Return Value
String
AxisOrder¶
Summary
N/A
Remarks
N/A
Return Value
Background¶
Summary
N/A
Remarks
N/A
Return Value
BlueTranslation¶
Summary
N/A
Remarks
N/A
Return Value
Single
CapabilitesCacheTimeOut¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
ColorMappings¶
Summary
N/A
Remarks
N/A
Return Value
Credentials¶
Summary
This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.
Remarks
N/A
Return Value
ICredentials
Crs¶
Summary
This property gets or sets the projected or geographic coordinate reference system to be used.
Remarks
N/A
Return Value
String
DrawingExceptionMode¶
Summary
N/A
Remarks
N/A
Return Value
DrawingTime¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
Exceptions¶
Summary
This property indicates the format in which the client wishes to be notified of service exceptions.
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.
Return Value
String
GreenTranslation¶
Summary
N/A
Remarks
N/A
Return Value
Single
HasBoundingBox¶
Summary
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.
Remarks
The override in the WmsRasterLayer sets it to true.
Return Value
Boolean
ImageSource¶
Summary
N/A
Remarks
N/A
Return Value
IsGrayscale¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsNegative¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsOpen¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
IsTransparent¶
Summary
This property gets or sets whether the response map image's background color is transparent or not.
Remarks
N/A
Return Value
Boolean
IsVisible¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
KeyColors¶
Summary
N/A
Remarks
N/A
Return Value
Collection<GeoColor>
LowerThreshold¶
Summary
N/A
Remarks
N/A
Return Value
Double
Name¶
Summary
N/A
Remarks
N/A
Return Value
String
OutputFormat¶
Summary
This property gets or sets the desired output format for the map requested from the WMS.
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".
Return Value
String
Parameters¶
Summary
This property specifies a dictionary used to update the request sent from the client to the WMS server.
Remarks
N/A
Return Value
Dictionary<String,String>
Projection¶
Summary
N/A
Remarks
N/A
Return Value
Proxy¶
Summary
This property gets or sets the proxy used for requesting a Web Response.
Remarks
N/A
Return Value
IWebProxy
RedTranslation¶
Summary
N/A
Remarks
N/A
Return Value
Single
RequestDrawingInterval¶
Summary
N/A
Remarks
N/A
Return Value
TimeSpan
ScaleFactor¶
Summary
N/A
Remarks
N/A
Return Value
Double
ThreadSafe¶
Summary
N/A
Remarks
N/A
Return Value
TimeoutInSecond¶
Summary
This property specifies the timeout of the web request in seconds. The default timeout value is 20 seconds.
Remarks
N/A
Return Value
Int32
Transparency¶
Summary
N/A
Remarks
N/A
Return Value
Single
UpperThreshold¶
Summary
N/A
Remarks
N/A
Return Value
Double
Uri¶
Summary
This property specifies the URI of the WMS server.
Remarks
N/A
Return Value
Uri
WrappingExtent¶
Summary
N/A
Remarks
N/A
Return Value
WrappingMode¶
Summary
N/A
Remarks
N/A
Return Value
Protected Properties¶
IsOpenCore¶
Summary
N/A
Remarks
N/A
Return Value
Boolean
Public Methods¶
CloneDeep()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Layer | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Close()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Draw(GeoCanvas,Collection<SimpleCandidate>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| labelsInAllLayers | Collection<SimpleCandidate> | N/A |
Equals(Object)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Boolean | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | N/A |
GetBoundingBox()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetFeatureInfo(ScreenPointF)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Dictionary<String,Collection<Feature>> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| screenPointF | ScreenPointF | N/A |
GetFeatureInfo(ScreenPointF,String)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Dictionary<String,Collection<Feature>> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| screenPointF | ScreenPointF | N/A |
| infoFormat | String | N/A |
GetFeatureInfo(ScreenPointF,Int32)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Dictionary<String,Collection<Feature>> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| screenPointF | ScreenPointF | N/A |
| maxFeatures | Int32 | N/A |
GetFeatureInfo(ScreenPointF,String,Int32)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Dictionary<String,Collection<Feature>> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| screenPointF | ScreenPointF | N/A |
| infoFormat | String | N/A |
| maxFeatures | Int32 | N/A |
GetHashCode()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Int32 | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetHorizontalResolution()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Single | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetRequestUrl(RectangleShape,Int32,Int32)¶
Summary
Get the request URL from the client to the WMS.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | The request URL from the client to the WMS. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape | N/A |
| 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. |
GetServerCapabilitiesXml()¶
Summary
This API gets the GetCapabilites document of the service.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | This API returns the GetCapabilites document of the service. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerCrss()¶
Summary
This method returns the projected or geographic coordinate reference systems to be used.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Collection<String> | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerExceptionFormats()¶
Summary
This method returns the exception format at the server side.
Remarks
None.
Return Value
| Type | Description |
|---|---|
Collection<String> | This method returns the exception format at the server side. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerFeatureInfoFormats()¶
Summary
This API gets the WMS server FeatureInfo formats of the service.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Collection<String> | This API returns the FeatureInfo formats supported on the server-side. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerLayerNames()¶
Summary
This method returns the names of all layers at the server side.
Remarks
None.
Return Value
| Type | Description |
|---|---|
Collection<String> | This method returns the names of all layers at the server side. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerOutputFormats()¶
Summary
This method returns the output format at the server side.
Remarks
None.
Return Value
| Type | Description |
|---|---|
Collection<String> | This method returns the output format at the server side. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServerStyleNames()¶
Summary
This method returns the names of all styles at the server side.
Remarks
None.
Return Value
| Type | Description |
|---|---|
Collection<String> | This method returns the names of all styles at the server side. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetServiceVersion()¶
Summary
This API gets the WMS server version of the service.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | Returning a string reflecting the version of the service in WMS. |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetType()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Type | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetVerticalResolution()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Single | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Open()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
RequestDrawing()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
RequestDrawing(RectangleShape)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
RequestDrawing(IEnumerable<RectangleShape>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
RequestDrawing(TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(RectangleShape,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentToRefresh | RectangleShape | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| extentsToRefresh | IEnumerable<RectangleShape> | N/A |
| bufferTime | TimeSpan | N/A |
| bufferTimeType | RequestDrawingBufferTimeType | N/A |
ToString()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Protected Methods¶
CloneDeepCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Layer | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
CloseCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
DrawAttributionCore(GeoCanvas,String)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| attribution | String | N/A |
DrawCore(GeoCanvas,Collection<SimpleCandidate>)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| labelsInAllLayers | Collection<SimpleCandidate> | N/A |
DrawException(GeoCanvas,Exception)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| e | Exception | N/A |
DrawExceptionCore(GeoCanvas,Exception)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| canvas | GeoCanvas | N/A |
| e | Exception | N/A |
Finalize()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetBoundingBoxCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
RectangleShape | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
GetRequestUrlCore(RectangleShape,Int32,Int32)¶
Summary
Get the request URL from the client to the WMS.
Remarks
N/A
Return Value
| Type | Description |
|---|---|
String | The request URL from the client to the WMS. |
Parameters
| Name | Type | Description |
|---|---|---|
| worldExtent | RectangleShape | N/A |
| 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. |
MemberwiseClone()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Object | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
OnDrawingAttribution(DrawingAttributionLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawingAttributionLayerEventArgs | N/A |
OnDrawingException(DrawingExceptionLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingExceptionLayerEventArgs | N/A |
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawingProgressChangedEventArgs | N/A |
OnDrawnAttribution(DrawnAttributionLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| args | DrawnAttributionLayerEventArgs | N/A |
OnDrawnException(DrawnExceptionLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| e | DrawnExceptionLayerEventArgs | N/A |
OnRequestedDrawing(RequestedDrawingLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| eventArgs | RequestedDrawingLayerEventArgs | N/A |
OnRequestingDrawing(RequestingDrawingLayerEventArgs)¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| eventArgs | RequestingDrawingLayerEventArgs | N/A |
OpenCore()¶
Summary
N/A
Remarks
N/A
Return Value
| Type | Description |
|---|---|
Void | N/A |
Parameters
| Name | Type | Description |
|---|---|---|
| N/A | N/A | N/A |
Public Events¶
SendingWebRequest¶
N/A
Remarks
N/A
Event Arguments
SentWebRequest¶
N/A
Remarks
N/A
Event Arguments
DrawingProgressChanged¶
N/A
Remarks
N/A
Event Arguments
DrawingProgressChangedEventArgs
DrawingException¶
N/A
Remarks
N/A
Event Arguments
DrawingExceptionLayerEventArgs
DrawnException¶
N/A
Remarks
N/A
Event Arguments
DrawingAttribution¶
N/A
Remarks
N/A
Event Arguments
DrawingAttributionLayerEventArgs
DrawnAttribution¶
N/A
Remarks
N/A
Event Arguments
DrawnAttributionLayerEventArgs
RequestedDrawing¶
N/A
Remarks
N/A
Event Arguments
RequestedDrawingLayerEventArgs
RequestingDrawing¶
N/A
Remarks
N/A
Event Arguments