User Tools

Site Tools

Trace: • thinkgeo.mapsuite.desktopedition.overlay

Sidebar

ThinkGeo Cloud

ThinkGeo UI Controls

ThinkGeo Open Source

Help and Support

External Resources

thinkgeo.mapsuite.desktopedition.overlay

Table of Contents

ThinkGeo.MapSuite.DesktopEdition.Overlay

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.

Serves as the base class that defines the properties and methods shared by all types of overlays.

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

Overlay()

  • Initialize an instance of the Overlay class.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#Overlay.28.29
Parameters

Public Methods

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.Overlay#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.Overlay#DrawPreview.28GeoCanvas.29
Return Value
  • Type:TilesExistingType
  • 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.Overlay#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.Overlay#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.Overlay#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.Overlay#GetType.28.29
Return Value
  • Type:Type
  • Description:N/A
Parameters

Protected Methods

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.Overlay#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.Overlay#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.Overlay#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.Overlay#DrawPreviewCore.28GeoCanvas.29
Return Value
  • Type:TilesExistingType
  • 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.Overlay#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.Overlay#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.Overlay#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.Overlay#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.

DrawExceptionCore(GeoCanvas,Exception)

  • This method is the Core method of DrawException, which can be overridden if you want to change its logic. This method will draw on the canvas when an exception occurs during drawing process.
Remarks
  • For the most updated Info for this topic, please check it here:http:wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.Overlay#DrawExceptionCore.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.

DrawCore(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. 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:N/A
Parameters
  • canvas
    • Type:GeoCanvas
    • Description:This parameter is the canvas object or a GeoImage to draw on.

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.Overlay#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.Overlay#MemberwiseClone.28.29
Return Value
  • Type:Object
  • Description:N/A
Parameters

Public Properties

Attribution

  • N/A
Remarks
Return Value

IsBase

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

IsVisible

  • Gets or sets a value that indicates whether the overlay is visible on the map.
Remarks
Return Value
  • Type:String

TileCache

  • This property gets or sets the TileCache used for the overlay.
Remarks
  • The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.
Return Value

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

Drawing

  • This event will be fired before the Overlay is drawn.
Remarks

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution

  • N/A
Remarks

Event Arguments:DrawnAttributionOverlayEventArgs

RequestedDrawing

  • N/A
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.overlay.txt · Last modified: 2017/03/16 21:59 (external edit)

Page Tools