User Tools

Site Tools


thinkgeo.mapsuite.core.wmsrasterlayer

ThinkGeo.MapSuite.Core.WmsRasterLayer

Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.

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

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.Layer
      • ThinkGeo.MapSuite.Core.RasterLayer
        • ThinkGeo.MapSuite.Core.WmsRasterLayer

Members Summary

Public Constructors

WmsRasterLayer()

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

WmsRasterLayer(Uri)

  • This is the constructor the for the class.
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.
Parameters
  • uri
    • Type:Uri
    • Description:URI of the WMS server.

WmsRasterLayer(Uri,WebProxy)

  • This is the constructor the for the class.
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.
Parameters
  • uri
    • Type:Uri
    • Description:URI of the WMS server.
  • proxy
    • Type:WebProxy
    • Description:Proxy to use for the current WMS layer.

Protected Constructors

Public Methods

GetServerLayerNames()

  • This method returns the names of all layers at the server side.
Remarks
  • None.
Return Value
  • Type:Collection<String>
  • Description:This method returns the names of all layers at the server side.
Parameters

GetServerStyleNames()

  • This method returns the names of all styles at the server side.
Remarks
  • None.
Return Value
  • Type:Collection<String>
  • Description:This method returns the names of all styles at the server side.
Parameters

GetServerOutputFormats()

  • This method returns the output format at the server side.
Remarks
  • None.
Return Value
  • Type:Collection<String>
  • Description:This method returns the output format at the server side.
Parameters

GetServerCrss()

  • This method returns the projected or geographic coordinate reference systems to be used.
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:N/A
Parameters

GetServerExceptionFormats()

  • This method returns the exception format at the server side.
Remarks
  • None.
Return Value
  • Type:Collection<String>
  • Description:This method returns the exception format at the server side.
Parameters

GetServiceVersion()

  • This API gets the WMS server version of the service.
Remarks
  • N/A
Return Value
  • Type:String
  • Description:Returning a string reflecting the version of the service in WMS.
Parameters

GetServerFeatureInfoFormats()

  • This API gets the WMS server FeatureInfo formats of the service.
Remarks
  • N/A
Return Value
  • Type:Collection<String>
  • Description:This API returns the FeatureInfo formats supported on the server-side.
Parameters

GetServerCapabilitiesXml()

  • This API gets the GetCapabilites document of the service.
Remarks
  • N/A
Return Value
  • Type:String
  • Description:This API returns the GetCapabilites document of the service.
Parameters

GetRequestUrl(RectangleShape,Int32,Int32)

  • Get the request URL from the client to the WMS.
Remarks
  • N/A
Return Value
  • Type:String
  • Description:The request URL from the client to the WMS.
Parameters
  • canvasWidth
    • Type:Int32
    • Description:The returning map width, as well as the drawing canvas width.
  • canvasHeight
    • Type:Int32
    • Description:The returning map height, as well as the drawing canvas height.

GetFeatureInfo(ScreenPointF)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,Collection<Feature»
  • Description:N/A
Parameters

GetFeatureInfo(ScreenPointF,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,Collection<Feature»
  • Description:N/A
Parameters
  • infoFormat
    • Type:String
    • Description:N/A

GetFeatureInfo(ScreenPointF,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,Collection<Feature»
  • Description:N/A
Parameters
  • maxFeatures
    • Type:Int32
    • Description:N/A

GetFeatureInfo(ScreenPointF,String,Int32)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Dictionary<String,Collection<Feature»
  • Description:N/A
Parameters
  • infoFormat
    • Type:String
    • Description:N/A
  • maxFeatures
    • Type:Int32
    • Description:N/A

GetProjectionText()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

GetHorizontalResolution()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single
  • Description:N/A
Parameters

GetVerticalResolution()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Single
  • Description:N/A
Parameters

RequestDrawing()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

GetThreadSafetyLevel()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeep()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

Open()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Close()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetBoundingBox()

  • N/A
Remarks
  • N/A
Return Value
Parameters

Draw(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

ToString()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

GetRequestUrlCore(RectangleShape,Int32,Int32)

  • Get the request URL from the client to the WMS.
Remarks
  • N/A
Return Value
  • Type:String
  • Description:The request URL from the client to the WMS.
Parameters
  • canvasWidth
    • Type:Int32
    • Description:The returning map width, as well as the drawing canvas width.
  • canvasHeight
    • Type:Int32
    • Description:The returning map height, as well as the drawing canvas height.

GetBoundingBoxCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

OpenCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

CloseCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

GetThreadSafetyLevelCore()

  • N/A
Remarks
  • N/A
Return Value
Parameters

CloneDeepCore()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Layer
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • e
    • Type:Exception
    • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnException(DrawnExceptionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawAttributionCore(GeoCanvas,String)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • attribution
    • Type:String
    • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Uri

This property specifies the URI of the WMS server.

Remarks

N/A

Return Value
  • Type:Uri

ActiveLayerNames

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
  • Type:Collection<String>

ActiveStyleNames

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
  • Type:Collection<String>

OutputFormat

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
  • Type:String

Credentials

This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.

Remarks

N/A

Return Value
  • Type:ICredentials

IsTransparent

This property gets or sets whether the response map image's background color is transparent or not.

Remarks

N/A

Return Value
  • Type:Boolean

Proxy

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

Remarks

N/A

Return Value
  • Type:WebProxy

Crs

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

Remarks

N/A

Return Value
  • Type:String

TimeoutInSecond

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

Remarks

N/A

Return Value
  • Type:Int32

Exceptions

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
  • Type:String

CapabilitesCacheTimeOut

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

Parameters

This property specifies a dictionary used to update the request sent from the client to the WMS server.

Remarks

N/A

Return Value
  • Type: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.

Remarks

The override in the WmsRasterLayer sets it to true.

Return Value
  • Type:Boolean

AxisOrder

N/A

Remarks

N/A

Return Value

ImageSource

N/A

Remarks

N/A

Return Value

WrappingMode

N/A

Remarks

N/A

Return Value

WrappingExtent

N/A

Remarks

N/A

Return Value

UpperThreshold

N/A

Remarks

N/A

Return Value
  • Type:Double

LowerThreshold

N/A

Remarks

N/A

Return Value
  • Type:Double

HasProjectionText

N/A

Remarks

N/A

Return Value
  • Type:Boolean

RequestDrawingInterval

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

IsOpen

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingTime

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

Name

N/A

Remarks

N/A

Return Value
  • Type:String

Attribution

N/A

Remarks

N/A

Return Value
  • Type:String

IsVisible

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Transparency

N/A

Remarks

N/A

Return Value
  • Type:Single

BlueTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

RedTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

GreenTranslation

N/A

Remarks

N/A

Return Value
  • Type:Single

KeyColors

N/A

Remarks

N/A

Return Value

IsNegative

N/A

Remarks

N/A

Return Value
  • Type:Boolean

IsGrayscale

N/A

Remarks

N/A

Return Value
  • Type:Boolean

DrawingExceptionMode

N/A

Remarks

N/A

Return Value

Protected Properties

IsOpenCore

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Public Events

SendingWebRequest N/A

Remarks

N/A

Event Arguments:SendingWebRequestEventArgs

SentWebRequest N/A

Remarks

N/A

Event Arguments:SentWebRequestEventArgs

RequestedDrawing N/A

Remarks

N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing N/A

Remarks

N/A

Event Arguments:RequestingDrawingLayerEventArgs

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:DrawnExceptionLayerEventArgs

DrawingAttribution N/A

Remarks

N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution N/A

Remarks

N/A

Event Arguments:DrawnAttributionLayerEventArgs

thinkgeo.mapsuite.core.wmsrasterlayer.txt · Last modified: 2017/03/16 21:59 (external edit)