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

• System.Object
  • ThinkGeo.MapSuite.DesktopEdition.Overlay
    • ThinkGeo.MapSuite.DesktopEdition.InteractiveOverlay
    • ThinkGeo.MapSuite.DesktopEdition.AdornmentOverlay
    • ThinkGeo.MapSuite.DesktopEdition.BackgroundOverlay
    • ThinkGeo.MapSuite.DesktopEdition.BingMapsOverlay
    • ThinkGeo.MapSuite.DesktopEdition.GoogleMapsOverlay
    • ThinkGeo.MapSuite.DesktopEdition.LayerOverlay
    • ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay
    • ThinkGeo.MapSuite.DesktopEdition.OpenStreetMapOverlay
    • ThinkGeo.MapSuite.DesktopEdition.TiledWmsOverlay
    • ThinkGeo.MapSuite.DesktopEdition.WmtsOverlay
    • ThinkGeo.MapSuite.DesktopEdition.WorldMapKitWmsDesktopOverlay

Overlay()

Initialize an instance of the Overlay class.

N/A

Refresh(GeoCanvas,RectangleShape)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

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

DrawPreview(GeoCanvas)

This method will be used to draw preview tiles to the canvas.

N/A

• Type:TilesExistingType
• Description:The tile existing type, which indicates whether any tiles exist.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

Draw(GeoCanvas)

This method draws the Overlay.

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.

• Type:Void
• Description:None

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

RequestDrawing()

N/A

N/A

• Type:Void
• Description:N/A

RequestDrawing(RectangleShape)

N/A

N/A

• Type:Void
• Description:N/A

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

RequestDrawing(IEnumerable<RectangleShape>)

N/A

N/A

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

RequestDrawing(TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

N/A

N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

N/A

N/A

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

N/A

N/A

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

N/A

N/A

• Type:Void
• Description:N/A

• extentsToRefresh
  • Type:IEnumerable<RectangleShape>
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

• bufferTimeType
  • Type:RequestDrawingBufferTimeType
  • 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

OnDrawing(DrawingOverlayEventArgs)

This event will be fired before Overlay is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingOverlayEventArgs
  • Description:The OverlayDrawingEventArgs passed for the event raised.

OnDrawn(DrawnOverlayEventArgs)

This event will be fired after Overlay is drawn.

N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawnOverlayEventArgs
  • Description:The OverlayDrawnEventArgs passed for the event raised.

RefreshCore(GeoCanvas,RectangleShape)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

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

DrawPreviewCore(GeoCanvas)

This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.

N/A

• Type:TilesExistingType
• Description:The tile existing type, which indicates whether any tiles exist.

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object to draw on.

sBM=(GeoCanvas)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

DrawAttributionCore(GeoCanvas)

N/A

N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionOverlayEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionOverlayEventArgs
  • Description:N/A

DrawException(GeoCanvas,Exception)

This method will draw on the canvas when an exception occurs during the drawing process.

N/A

• Type:Void
• Description:N/A

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

N/A

• Type:Void
• Description:N/A

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

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.

• Type:Void
• Description:None

• canvas
  • Type:GeoCanvas
  • Description:This parameter is the canvas object or a GeoImage to draw on.

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestedDrawingOverlayEventArgs
  • Description:N/A

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

N/A

N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestingDrawingOverlayEventArgs
  • Description:N/A

Finalize()

N/A

N/A

• Type:Void
• Description:N/A

MemberwiseClone()

N/A

N/A

• Type:Object
• Description:N/A

Attribution

N/A

N/A

• Type:String

Lock

This property gets the OverlayLock object.

N/A

• Type:OverlayLock

IsBase

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

N/A

• Type:Boolean

DrawingExceptionMode

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

N/A

• Type:DrawingExceptionMode

IsVisible

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

N/A

• Type:Boolean

Name

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

N/A

• Type:String

TileCache

This property gets or sets the TileCache used for the overlay.

The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.

• Type:BitmapTileCache

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.

N/A

• Type:BitmapTileCache

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.

N/A

• Type:Boolean

DrawingTime

This property gets the last drawing time for the Overlay.

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.

• Type:TimeSpan

AutoRefreshInterval

N/A

N/A

• Type:TimeSpan

rxM=

N/A

N/A

• Type:BitmapTile

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

N/A

Event Arguments:DrawingOverlayEventArgs

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

N/A

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution N/A

N/A

Event Arguments:DrawingAttributionOverlayEventArgs

DrawnAttribution N/A

N/A

Event Arguments:DrawnAttributionOverlayEventArgs

RequestedDrawing N/A

N/A

Event Arguments:RequestedDrawingOverlayEventArgs

RequestingDrawing N/A

N/A

Event Arguments:RequestingDrawingOverlayEventArgs