User Tools

Site Tools


thinkgeo.mapsuite.portablecore.tiledwmslayer

ThinkGeo.MapSuite.Core.TiledWmsLayer

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.

This class is use for tiled WMS Server, and you also can get map from ThinkGeo world map kit server.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.Core.Layer
      • ThinkGeo.MapSuite.Core.TiledWmsLayer

Members Summary

Public Constructors

TiledWmsLayer()

  • 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

TiledWmsLayer(IEnumerable<Uri>)

  • N/A
Remarks
  • N/A
Parameters
  • serverUris
    • Type:IEnumerable<Uri>
    • Description:N/A

TiledWmsLayer(IEnumerable<Uri>,GeoWebProxy)

  • N/A
Remarks
  • N/A
Parameters
  • serverUris
    • Type:IEnumerable<Uri>
    • Description:N/A

TiledWmsLayer(IEnumerable<Uri>,String,String)

  • N/A
Remarks
  • N/A
Parameters
  • serverUris
    • Type:IEnumerable<Uri>
    • Description:N/A
  • clientId
    • Type:String
    • Description:N/A
  • privateKey
    • Type:String
    • Description:N/A

TiledWmsLayer(IEnumerable<Uri>,GeoWebProxy,String,String)

  • N/A
Remarks
  • N/A
Parameters
  • serverUris
    • Type:IEnumerable<Uri>
    • Description:N/A
  • clientId
    • Type:String
    • Description:N/A
  • privateKey
    • Type:String
    • Description:N/A

Protected Constructors

Public Methods

GetRequestUris(RectangleShape,Int32,Int32)

  • Get the request URLs from the client to the WMS servers.
Remarks
  • N/A
Return Value
  • Type:Collection<Uri>
  • Description:The request URLs from the client to the WMS servers.
Parameters
  • requestExtent
    • 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

ClearCache()

  • This method clears the tile cache of client.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters

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

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

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

  • N/A
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • 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

GetRequestUrisCore(RectangleShape,Int32,Int32)

  • Get the request URLs from the client to the WMS servers.
Remarks
  • N/A
Return Value
  • Type:Collection<Uri>
  • Description:The request URLs from the client to the WMS servers.
Parameters
  • requestExtent
    • 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.

CloseCore()

  • This method closes the Layer and releases any resources it was using.
Remarks
  • This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called. If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
Return Value
  • Type:Void
  • Description:None
Parameters

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

  • This method draws the Layer.
Remarks
  • This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.
Return Value
  • Type:Void
  • Description:None
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object or a GeoImage to draw on.
  • labelsInAllLayers
    • Type:Collection<SimpleCandidate>
    • Description:This parameter represents the labels used for collision detection and duplication checking.

DrawExceptionCore(GeoCanvas,Exception)

  • This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Remarks
  • N/A
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:The target canvas to draw the layer.
  • e
    • Type:Exception
    • Description:The exception thrown when layer.Draw().

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

GetThreadSafetyLevelCore()

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

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

OpenCore()

  • This method opens the Layer so that it is initialized and ready to use.
Remarks
  • This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened 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 Layer. When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
Return Value
  • Type:Void
  • Description:None
Parameters

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

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

CloneDeepCore()

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

GetBoundingBoxCore()

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

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

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

  • 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

IsEqual(Double,Double)

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • firstValue
    • Type:Double
    • Description:N/A
  • secondValue
    • Type:Double
    • Description:N/A

Contains(RectangleShape,RectangleShape)

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

Public Properties

Credentials

  • This property gets or sets the base authentication interface for retrieving credentials for Web Client authentication.
Remarks
  • N/A
Return Value
  • Type:ICredentials

ClientId

  • Gets or sets a value that is your Client Id.
Remarks
  • N/A
Return Value
  • Type:String

PrivateKey

  • Gets or sets a value that is unique to your client ID, please keep your key secure.
Remarks
  • N/A
Return Value
  • Type:String

ZoomLevelSet

  • N/A
Remarks
  • N/A
Return Value

AxisOrder

  • N/A
Remarks
  • N/A
Return Value

CapabilitesCacheTimeout

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

CapabilitiesCacheTimeout

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

ServerUri

  • Gets or sets a server uri of Tiled WMS Server.
Remarks
  • N/A
Return Value
  • Type:Uri

ServerUris

  • N/A
Remarks
  • N/A
Return Value
  • Type:Collection<Uri>

WebProxy

  • This property gets or sets the proxy used for requesting a Web Response.
Remarks
  • N/A
Return Value

TileWidth

  • Gets or sets the width of the tile requested
Remarks
  • N/A
Return Value
  • Type:Int32

TileHight

  • Gets or sets the height of the tile requested
Remarks
  • N/A
Return Value
  • Type:Int32

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

Crs

  • This property gets or sets the projected or geographic coordinate reference system to be used.
Remarks
  • N/A
Return Value
  • Type:String

TileCache

  • Gets or sets a BitmapTileCache represents which tile cache will be used.
Remarks
  • N/A
Return Value

ImageSource

  • N/A
Remarks
  • N/A
Return Value

UpperScale

  • Gets or sets a value represents upper threshold for scale.
Remarks
  • Is the current scale is beyond this value, the map will not render.
Return Value
  • Type:Double

LowerScale

  • Gets or sets a value represents lower threshold for scale.
Remarks
  • Is the current scale is less than this value, the map will not render.
Return Value
  • Type:Double

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>

TimeoutInSeconds

  • 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

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 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.
Remarks
  • The value of TileWmsLayer is false.
Return Value
  • Type:Boolean

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

IsVisible

  • N/A
Remarks
  • N/A
Return Value
  • Type:Boolean

Transparency

  • 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

DrawingExceptionMode

  • N/A
Remarks
  • N/A
Return Value

Attribution

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

RequestDrawingInterval

  • N/A
Remarks
  • N/A
Return Value
  • Type:TimeSpan

Protected Properties

IsOpenCore

  • This property returns true if the Layer is open and false if it is not.
Remarks
  • 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.
Return Value
  • Type:Boolean

Public Events

SendingWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SendingWebRequestEventArgs

SentWebRequest

  • N/A
Remarks
  • N/A

Event Arguments:SentWebRequestEventArgs

DrawingException

  • N/A
Remarks
  • N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawingProgressChanged

  • N/A
Remarks
  • N/A

Event Arguments:DrawingProgressChangedEventArgs

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

RequestedDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestingDrawingLayerEventArgs

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