User Tools

Site Tools


thinkgeo.mapsuite.core.wmsrastersource

ThinkGeo.MapSuite.Core.WmsRasterSource

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) source.

Inheritance Hierarchy

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

Members Summary

Public Constructors

WmsRasterSource()

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

WmsRasterSource(Uri)

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

WmsRasterSource(Uri,WebProxy)

  • This is the constructor the for the class.
Remarks
  • 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.
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: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: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: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: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:Returns 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
  • worldExtent
    • 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
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

CloneDeep()

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

GetWorldFileText()

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

GetImageWidth()

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

GetImageHeight()

  • N/A
Remarks
  • N/A
Return Value
  • Type:Int32
  • 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

GetBoundingBox()

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

GetProjectionText()

  • N/A
Remarks
  • N/A
Return Value
  • Type:String
  • 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

GetImage(RectangleShape,Int32,Int32)

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

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

SendWebRequest(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:WebResponse
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

SendWebRequestCore(WebRequest)

  • N/A
Remarks
  • N/A
Return Value
  • Type:WebResponse
  • Description:N/A
Parameters
  • webRequest
    • Type:WebRequest
    • Description:N/A

OnSendingWebRequest(SendingWebRequestEventArgs)

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

OnSentWebRequest(SentWebRequestEventArgs)

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

GetRequestUrlCore(RectangleShape,Int32,Int32)

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

GetImageWidthCore()

  • This method returns the width of the image in screen coordinates.
Remarks
  • This virtual method is called from the concrete method GetImageWidth. It returns the width of the image in screen coordinates.
Return Value
  • Type:Int32
  • Description:The width of the image in screen coordinates.
Parameters

GetImageHeightCore()

  • This method returns the height of the image in screen coordinates.
Remarks
  • This virtual method is called from the concrete method GetImageHeight. It returns the height of the image in screen coordinates.
Return Value
  • Type:Int32
  • Description:The height of the image in screen coordinates.
Parameters

OpenCore()

  • This method opens the RasterSource so that it is initialized and ready to use.
Remarks
  • 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.
Return Value
  • Type:Void
  • Description:None
Parameters

CloseCore()

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

GetBoundingBoxCore()

  • This method returns the bounding box of the RasterSource.
Remarks
  • This method returns the bounding box of the RasterSource.
Return Value
  • Description:The bounding box of the RasterSource.
Parameters

GetImageCore(RectangleShape,Int32,Int32)

  • This method returns an image based on the worldExtent and image width and height.
Remarks
  • 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.
Return Value
  • Type:GeoImage
  • Description:This method returns an image based on the worldExtent and image width and height.
Parameters
  • worldExtent
    • 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
Remarks
  • N/A
Return Value
  • Type:Uri
  • Description:N/A
Parameters
  • infoFormat
    • Type:String
    • Description:N/A
  • maxFeatures
    • Type:Int32
    • Description:N/A

GetFeatureInfoCore(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

HandleResponse(WebRequest)

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

HandleResponseCore(WebRequest)

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

HandleXmlInfoFormatResponse(XmlDocument)

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

HandleXmlInfoFormatResponseCore(XmlDocument)

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

OnOpeningRasterSource(OpeningRasterSourceEventArgs)

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

OnOpenedRasterSource(OpenedRasterSourceEventArgs)

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

OnClosingRasterSource(ClosingRasterSourceEventArgs)

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

OnClosedRasterSource(ClosedRasterSourceEventArgs)

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

CloneDeepCore()

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

GetProjectionTextCore()

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

GetWrappingImageLeft(RectangleShape,Double,Double,RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A

GetWrappingImageRight(RectangleShape,Double,Double,RectangleShape)

  • N/A
Remarks
  • N/A
Return Value
Parameters
  • screenWidth
    • Type:Double
    • Description:N/A
  • screenHeight
    • Type:Double
    • Description:N/A

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

ActiveLayerNames

This property allows the active layers requested from the client to be 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 allows the active styles requested from the client to be 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>

Uri

This property specifies the URI of the WMS server.

Remarks

N/A

Return Value
  • Type:Uri

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

OutputFormat

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

Remarks

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”.

Return Value
  • Type:String

Proxy

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

Remarks

N/A

Return Value
  • Type:WebProxy

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

Crs

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

Remarks

N/A

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

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

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>

AxisOrder

N/A

Remarks

N/A

Return Value

CapabilitesCacheTimeout

N/A

Remarks

N/A

Return Value
  • Type:TimeSpan

Projection

N/A

Remarks

N/A

Return Value

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

IsNegative

N/A

Remarks

N/A

Return Value
  • Type:Boolean

IsGrayscale

N/A

Remarks

N/A

Return Value
  • Type:Boolean

IsOpen

N/A

Remarks

N/A

Return Value
  • Type:Boolean

HasProjectionText

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Protected Properties

HasProjectionTextCore

N/A

Remarks

N/A

Return Value
  • Type:Boolean

Public Events

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

Remarks

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.

Remarks

N/A

Event Arguments:SentWebRequestEventArgs

OpeningRasterSource N/A

Remarks

N/A

Event Arguments:OpeningRasterSourceEventArgs

OpenedRasterSource N/A

Remarks

N/A

Event Arguments:OpenedRasterSourceEventArgs

ClosingRasterSource N/A

Remarks

N/A

Event Arguments:ClosingRasterSourceEventArgs

ClosedRasterSource N/A

Remarks

N/A

Event Arguments:ClosedRasterSourceEventArgs

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