ThinkGeo.MapSuite.Core.WmsRasterSource

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

• System.Object
  • ThinkGeo.MapSuite.Core.RasterSource
    • ThinkGeo.MapSuite.Core.WmsRasterSource

WmsRasterSource()

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

• None

WmsRasterSource(Uri)

• This is the constructor the for the class.

• This constructor initializes a new WmsRasterSource and 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.

• uri
  • Type:Uri
  • Description:URI of the WMS server.

WmsRasterSource(Uri,WebProxy)

• This is the constructor the for the class.

• This constructor initializes a new WmsRasterSource and 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.

• uri
  • Type:Uri
  • Description:URI of the WMS server.

• proxy
  • Type:WebProxy
  • Description:Proxy to use for the current WMS layer.

GetServerLayerNames()

• This method returns the names of all layers at the server side.

• None.

• Type:Collection<String>
• Description:The names of all layers at the server side.

GetServerStyleNames()

• This method returns the names of all styles at the server side.

• None.

• Type:Collection<String>
• Description:The names of all styles at the server side.

GetServerOutputFormats()

• This method returns the output format at the server side.

• None.

• Type:Collection<String>
• Description:The output format at the server side.

GetServerCrss()

• This method returns the projected or geographic coordinate reference systems to be used.

• N/A

• Type:Collection<String>
• Description:N/A

GetServerExceptionFormats()

• This method returns the exception format at the server side.

• None.

• Type:Collection<String>
• Description:The exception format at the server side.

GetServiceVersion()

• This API gets the WMS server version of the service.

• N/A

• Type:String
• Description:Returns a string reflecting the version of the service in WMS.

GetServerFeatureInfoFormats()

• This API gets the WMS server FeatureInfo formats of the service.

• N/A

• Type:Collection<String>
• Description:This API returns the FeatureInfo formats supported on the server-side.

GetServerCapabilitiesXml()

• This API gets the GetCapabilites document of the service.

• N/A

• Type:String
• Description:This API returns the GetCapabilites document of the service.

GetRequestUrl(RectangleShape,Int32,Int32)

• Get the request URL from the client to the WMS.

• N/A

• Type:String
• Description:The request URL from the client to the WMS.

• worldExtent
  • Type:RectangleShape
  • Description:The world extent requested by the client to get the map.

• 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

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

GetFeatureInfo(ScreenPointF,String)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

• infoFormat
  • Type:String
  • Description:N/A

GetFeatureInfo(ScreenPointF,Int32)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

• maxFeatures
  • Type:Int32
  • Description:N/A

GetFeatureInfo(ScreenPointF,String,Int32)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

• infoFormat
  • Type:String
  • Description:N/A

• maxFeatures
  • Type:Int32
  • Description:N/A

CloneDeep()

• N/A

• N/A

• Type:RasterSource
• Description:N/A

GetWorldFileText()

• N/A

• N/A

• Type:String
• Description:N/A

GetImageWidth()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetImageHeight()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetHorizontalResolution()

• N/A

• N/A

• Type:Single
• Description:N/A

GetVerticalResolution()

• N/A

• N/A

• Type:Single
• Description:N/A

GetBoundingBox()

• N/A

• N/A

• Type:RectangleShape
• Description:N/A

GetProjectionText()

• N/A

• N/A

• Type:String
• Description:N/A

Open()

• N/A

• N/A

• Type:Void
• Description:N/A

Close()

• N/A

• N/A

• Type:Void
• Description:N/A

GetImage(RectangleShape,Int32,Int32)

• N/A

• N/A

• Type:GeoImage
• Description:N/A

• worldExtent
  • Type:RectangleShape
  • Description:N/A

• canvasWidth
  • Type:Int32
  • Description:N/A

• canvasHeight
  • Type:Int32
  • Description:N/A

ToString()

• N/A

• N/A

• Type:String
• Description:N/A

Equals(Object)

• N/A

• N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetType()

• N/A

• N/A

• Type:Type
• Description:N/A

SendWebRequest(WebRequest)

• N/A

• N/A

• Type:WebResponse
• Description:N/A

• webRequest
  • Type:WebRequest
  • Description:N/A

SendWebRequestCore(WebRequest)

• N/A

• N/A

• Type:WebResponse
• Description:N/A

• webRequest
  • Type:WebRequest
  • Description:N/A

OnSendingWebRequest(SendingWebRequestEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:SendingWebRequestEventArgs
  • Description:N/A

OnSentWebRequest(SentWebRequestEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:SentWebRequestEventArgs
  • Description:N/A

GetRequestUrlCore(RectangleShape,Int32,Int32)

• N/A

• N/A

• Type:String
• Description:N/A

• worldExtent
  • Type:RectangleShape
  • Description:N/A

• canvasWidth
  • Type:Int32
  • Description:N/A

• canvasHeight
  • Type:Int32
  • Description:N/A

GetImageWidthCore()

• This method returns the width of the image in screen coordinates.

• This virtual method is called from the concrete method GetImageWidth. It returns the width of the image in screen coordinates.

• Type:Int32
• Description:The width of the image in screen coordinates.

GetImageHeightCore()

• This method returns the height of the image in screen coordinates.

• This virtual method is called from the concrete method GetImageHeight. It returns the height of the image in screen coordinates.

• Type:Int32
• Description:The height of the image in screen coordinates.

OpenCore()

• This method opens the RasterSource so that it is initialized and ready to use.

• This protected virtual method is called from the concrete public method Open. The Open method plays an important role, as it is responsible for initializing the RasterSource. Most methods on the RasterSource will throw an exception if the state of the RasterSource is not opened. When the map draws each layer, it will open the RasterSource as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the RasterSource. When implementing this abstract method, consider opening files for file-based sources, connecting to databases in the database-based sources and so on. You will get a chance to close these in the Close method of the RasterSource.

• Type:Void
• Description:None

CloseCore()

• N/A

• N/A

• Type:Void
• Description:N/A

GetBoundingBoxCore()

• This method returns the bounding box of the RasterSource.

• This method returns the bounding box of the RasterSource.

• Type:RectangleShape
• Description:The bounding box of the RasterSource.

GetImageCore(RectangleShape,Int32,Int32)

• This method returns an image based on the worldExtent and image width and height.

• This method is responsible for returning the image based on the parameters passed in. As the core version of this method is abstract, you will need to override it when creating our own RasterSource.

• Type:GeoImage
• Description:This method returns an image based on the worldExtent and image width and height.

• worldExtent
  • Type:RectangleShape
  • Description:This parameter represents the worldExtent you want to draw.

• canvasWidth
  • Type:Int32
  • Description:This parameter represents the width of the image you want to draw.

• canvasHeight
  • Type:Int32
  • Description:This parameter represents the height of the image you want to draw.

BuildWmsGetFeatureInfoUri(ScreenPointF,String,Int32)

• N/A

• N/A

• Type:Uri
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

• infoFormat
  • Type:String
  • Description:N/A

• maxFeatures
  • Type:Int32
  • Description:N/A

GetFeatureInfoCore(ScreenPointF,String,Int32)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• screenPointF
  • Type:ScreenPointF
  • Description:N/A

• infoFormat
  • Type:String
  • Description:N/A

• maxFeatures
  • Type:Int32
  • Description:N/A

HandleResponse(WebRequest)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• reqeust
  • Type:WebRequest
  • Description:N/A

HandleResponseCore(WebRequest)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• request
  • Type:WebRequest
  • Description:N/A

HandleXmlInfoFormatResponse(XmlDocument)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• xmlDocument
  • Type:XmlDocument
  • Description:N/A

HandleXmlInfoFormatResponseCore(XmlDocument)

• N/A

• N/A

• Type:Dictionary<String,Collection<Feature»
• Description:N/A

• xmlDocument
  • Type:XmlDocument
  • Description:N/A

OnOpeningRasterSource(OpeningRasterSourceEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:OpeningRasterSourceEventArgs
  • Description:N/A

OnOpenedRasterSource(OpenedRasterSourceEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:OpenedRasterSourceEventArgs
  • Description:N/A

OnClosingRasterSource(ClosingRasterSourceEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:ClosingRasterSourceEventArgs
  • Description:N/A

OnClosedRasterSource(ClosedRasterSourceEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:ClosedRasterSourceEventArgs
  • Description:N/A

CloneDeepCore()

• N/A

• N/A

• Type:RasterSource
• Description:N/A

GetProjectionTextCore()

• N/A

• N/A

• Type:String
• Description:N/A

GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape)

• N/A

• N/A

• Type:GeoImage
• Description:N/A

• boundingBox
  • Type:RectangleShape
  • Description:N/A

• screenWidth
  • Type:Double
  • Description:N/A

• screenHeight
  • Type:Double
  • Description:N/A

• wrappingExtent
  • Type:RectangleShape
  • Description:N/A

GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape)

• N/A

• N/A

• Type:GeoImage
• Description:N/A

• boundingBox
  • Type:RectangleShape
  • Description:N/A

• screenWidth
  • Type:Double
  • Description:N/A

• screenHeight
  • Type:Double
  • Description:N/A

• wrappingExtent
  • Type:RectangleShape
  • Description:N/A

Finalize()

• N/A

• N/A

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• N/A

• Type:Object
• Description:N/A

ActiveLayerNames

This property allows the active layers requested from the client to be shown on the map.

When requesting a map, a client may specify the layers to be shown on the map.

• Type:Collection<String>

ActiveStyleNames

This property allows the active styles requested from the client to be shown on the map.

When requesting a map, a client may specify the styles to be shown on the map.

• Type:Collection<String>

Uri

This property specifies the URI of the WMS server.

N/A

• Type:Uri

IsTransparent

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

N/A

• Type:Boolean

OutputFormat

This property gets or sets the desired output format for the map being requested from the WMS.

When requesting a map, a client may specify the output format in which to show the map. Formats are specified as MIME types such as “image/gif” or “image/png”.

• Type:String

Proxy

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

N/A

• Type:WebProxy

TimeoutInSecond

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

N/A

• Type:Int32

Crs

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

N/A

• Type:String

Credentials

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

N/A

• Type:ICredentials

Exceptions

This property indicates the format in which the client wishes to be notified of service exceptions.

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.

• Type:String

Parameters

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

N/A

• Type:Dictionary<String,String>

AxisOrder

N/A

N/A

• Type:WmsAxisOrder

CapabilitesCacheTimeout

N/A

N/A

• Type:TimeSpan

Projection

N/A

N/A

• Type:Projection

Transparency

N/A

N/A

• Type:Single

BlueTranslation

N/A

N/A

• Type:Single

RedTranslation

N/A

N/A

• Type:Single

GreenTranslation

N/A

N/A

• Type:Single

IsNegative

N/A

N/A

• Type:Boolean

IsGrayscale

N/A

N/A

• Type:Boolean

IsOpen

N/A

N/A

• Type:Boolean

HasProjectionText

N/A

N/A

• Type:Boolean

HasProjectionTextCore

N/A

N/A

• Type:Boolean

SendingWebRequest This event is called before sending the reqeust for raster image.

This event is called before sending the reqeust for raster image. It is typical that user want to get the url of reqeust and modify it according to their requirements. For example, user could create a signiture for it, and verify it on the server side.

Event Arguments:SendingWebRequestEventArgs

SentWebRequest This event is called after sent the request for raster image and the HttpWebResponse has come back.

N/A

Event Arguments:SentWebRequestEventArgs

OpeningRasterSource N/A

N/A

Event Arguments:OpeningRasterSourceEventArgs

OpenedRasterSource N/A

N/A

Event Arguments:OpenedRasterSourceEventArgs

ClosingRasterSource N/A

N/A

Event Arguments:ClosingRasterSourceEventArgs

ClosedRasterSource N/A

N/A

Event Arguments:ClosedRasterSourceEventArgs