User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.tiledwmsoverlay

This is an old revision of the document!


ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay

This class is used in Desktop Edition to access the WMS Server.

Inheritance Hierarchy

  • System.Object
    • ThinkGeo.MapSuite.DesktopEdition.Overlay
      • ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay

Members Summary

Public Constructors

TiledWmsOverlay()

  • This is the constructor of the class.
Remarks
  • If you use this constructor, you must set the properties manually before use, otherwise it will use their default values.
Parameters

TiledWmsOverlay(Uri)

  • This is the constructor of the class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#TiledWmsOverlay.28Uri.29
Parameters
  • serverUri
    • Type:Uri
    • Description:The URI of WMS Serer you are consuming

TiledWmsOverlay(Uri,WebProxy)

  • This is the constructor of the class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#TiledWmsOverlay.28Uri.2C_WebProxy.29
Parameters
  • serverUri
    • Type:Uri
    • Description:The URI of WMS Serer you are consuming
  • webProxy
    • Type:WebProxy
    • Description:Proxy to use for the WMS Server.

TiledWmsOverlay(Uri,String,String)

  • This is the constructor of the class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#TiledWmsOverlay.28Uri.2C_String.2C_String.29
Parameters
  • serverUri
    • Type:Uri
    • Description:The URI of WMS Serer you are consuming
  • clientId
    • Type:String
    • Description:The clientId for the WMS Server.
  • privateKey
    • Type:String
    • Description:The privateKey for the WMS Server.

TiledWmsOverlay(Uri,WebProxy,String,String)

  • This is the constructor of the class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#TiledWmsOverlay.28Uri.2C_WebProxy.2C_String.2C_String.29
Parameters
  • serverUri
    • Type:Uri
    • Description:The URI of WMS Serer you are consuming
  • webProxy
    • Type:WebProxy
    • Description:Proxy to use for the WMS Server.
  • clientId
    • Type:String
    • Description:The clientId for the WMS Server.
  • privateKey
    • Type:String
    • Description:The privateKey for the WMS Server.

Protected Constructors

Public Methods

ClearCache()

  • This method will clear the cache for the Overlay.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#ClearCache.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

Refresh(GeoCanvas,RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#Refresh.28GeoCanvas.2C_RectangleShape.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawPreview(GeoCanvas)

  • This method will be used to draw preview tiles to the canvas.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawPreview.28GeoCanvas.29
Return Value
  • Description:The tile existing type, which indicates whether any tiles exist.
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

Draw(GeoCanvas)

  • This method draws the Overlay.
Remarks
  • This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the overlay based on the extent you provided. As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

RequestDrawing()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(IEnumerable<RectangleShape>)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

RequestDrawing(TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • bufferTime
    • Type:TimeSpan
    • Description:N/A

ToString()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#ToString.28.29
Return Value
  • Type:String
  • Description:N/A
Parameters

Equals(Object)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#Equals.28Object.29
Return Value
  • Type:Boolean
  • Description:N/A
Parameters
  • obj
    • Type:Object
    • Description:N/A

GetHashCode()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#GetHashCode.28.29
Return Value
  • Type:Int32
  • Description:N/A
Parameters

GetType()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

DrawCore(GeoCanvas)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawCore.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

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
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawExceptionCore.28GeoCanvas.2C_Exception.29
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().

OnSendingWebRequest(SendingWebRequestEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnSendingWebRequest.28SendingWebRequestEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnSentWebRequest(SentWebRequestEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnSentWebRequest.28SentWebRequestEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawing(DrawingOverlayEventArgs)

  • This event will be fired before Overlay is drawn.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawing.28DrawingOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawn(DrawnOverlayEventArgs)

  • This event will be fired after Overlay is drawn.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawn.28DrawnOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

RefreshCore(GeoCanvas,RectangleShape)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#RefreshCore.28GeoCanvas.2C_RectangleShape.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawPreviewCore(GeoCanvas)

  • This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawPreviewCore.28GeoCanvas.29
Return Value
  • Description:The tile existing type, which indicates whether any tiles exist.
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.

sBM=(GeoCanvas)

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

DrawAttributionCore(GeoCanvas)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawAttributionCore.28GeoCanvas.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawingAttribution.28DrawingAttributionOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawnAttribution.28DrawnAttributionOverlayEventArgs.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

DrawException(GeoCanvas,Exception)

  • This method will draw on the canvas when an exception occurs during the drawing process.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#DrawException.28GeoCanvas.2C_Exception.29
Return Value
  • Type:Void
  • Description:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object to draw on.
  • e
    • Type:Exception
    • Description:This parameter is the exception that is occurring.

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:
Return Value
  • Type:Void
  • Description:N/A
Parameters

Finalize()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#Finalize.28.29
Return Value
  • Type:Void
  • Description:N/A
Parameters

MemberwiseClone()

  • N/A
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

ClientId

Gets or sets a value that is your Client Id.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#ClientId

Return Value
  • Type:String

PrivateKey

Gets or sets a value that is unique to your client ID, please keep your key secure.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#PrivateKey

Return Value
  • Type:String

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>

Parameters

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

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#Parameters

Return Value
  • Type:Dictionary<String,String>

TileCache

Gets or sets the BitmapTileCache for the Overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#PreviewTileCache

Return Value

WebProxy

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

Remarks
Return Value
  • Type:WebProxy

ServerUri

This property specifies the URI of the WMS server.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#ServerUri

Return Value
  • Type:Uri

AxisOrder

N/A

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#AxisOrder

Return Value

CapabilitiesCacheTimeout

N/A

Remarks
Return Value
  • Type:TimeSpan

Attribution

N/A

Remarks
Return Value
  • Type:String

Lock

This property gets the OverlayLock object.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#Lock

Return Value

IsBase

Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#IsBase

Return Value
  • Type:Boolean

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

Remarks
Return Value

IsVisible

Gets or sets a value that indicates whether the overlay is visible on the map.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#IsVisible

Return Value
  • Type:Boolean

Name

Gets or sets the name of the overlay, which can be used to represent a specific overlay.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#ActiveLayerNames

Return Value
  • Type:String

PreviewTileCache

This property gets or sets the preview tile cache system. In order for this system to work, you must be in multi-threaded mode and have the tile cache set.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#PreviewTileCache

Return Value

IsEmpty

This property can be overridden by its base class. If it is not overridden, its default return value will be false. If this property is empty, we can skip drawing to achieve better performance.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#IsEmpty

Return Value
  • Type:Boolean

DrawingTime

This property gets the last drawing time for the Overlay.

Remarks

We track the drawing time for the Overlay and report it back in this method. This is useful to determine the speed of various Overlays.

Return Value
  • Type:TimeSpan

AutoRefreshInterval

N/A

Remarks

For the most updated Info for this topic, please check it here:

Return Value
  • Type:TimeSpan

Protected Properties

rxM=

N/A

Remarks

N/A

Return Value

Public Events

SendingWebRequest N/A

Remarks
Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnSentWebRequest.28SentWebRequestEventArgs.29

Event Arguments:SentWebRequestEventArgs

Drawing This event will be fired before the Overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawing.28DrawingOverlayEventArgs.29

Event Arguments:DrawingOverlayEventArgs

Drawn This event will be fired after the Overlay is drawn.

Remarks

For the most updated Info for this topic, please check it here:http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay#OnDrawn.28DrawnOverlayEventArgs.29

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution N/A

Remarks
Remarks
Remarks

For the most updated Info for this topic, please check it here:

Event Arguments:RequestedDrawingOverlayEventArgs

RequestingDrawing N/A

Remarks

For the most updated Info for this topic, please check it here:

Event Arguments:RequestingDrawingOverlayEventArgs

thinkgeo.mapsuite.desktopedition.tiledwmsoverlay.1442909580.txt.gz · Last modified: 2015/09/22 08:13 by admin