User Tools

Site Tools


api:thinkgeo.mapsuite.winforms.overlay

ThinkGeo.MapSuite.WinForms.Overlay

Inheritance Hierarchy

Members Summary

Public Constructors

Protected Constructors

Overlay()

  • Initialize an instance of the Overlay class.
Remarks
  • N/A
Parameters

Public Methods

Refresh(GeoCanvas,RectangleShape)

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

DrawPreview(GeoCanvas)

  • N/A
Remarks
  • N/A
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)

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

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(TimeSpan,RequestDrawingBufferTimeType)

  • 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(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

  • 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

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

  • 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

OnDrawing(DrawingOverlayEventArgs)

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

OnDrawn(DrawnOverlayEventArgs)

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

RefreshCore(GeoCanvas,RectangleShape)

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

DrawPreviewCore(GeoCanvas)

  • N/A
Remarks
  • N/A
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.

DrawAttribution(GeoCanvas)

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

DrawAttributionCore(GeoCanvas)

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

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

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

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

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

DrawException(GeoCanvas,Exception)

  • N/A
Remarks
  • N/A
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)

  • N/A
Remarks
  • N/A
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)

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

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

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

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

  • 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

Public Properties

Attribution

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

Lock

  • N/A
Remarks
  • N/A
Return Value

IsBase

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

DrawingExceptionMode

  • N/A
Remarks
  • N/A
Return Value

IsVisible

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

Name

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

TileCache

  • N/A
Remarks
  • The TileCache system is always used for better performance, especially in the case where your application tiles can be pregenerated.
Return Value

PreviewTileCache

  • N/A
Remarks
  • N/A
Return Value

IsEmpty

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

DrawingTime

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

Protected Properties

ScreenBitmapTile

  • N/A
Remarks
  • N/A
Return Value

Public Events

Drawing

  • N/A
Remarks
  • N/A

Event Arguments:DrawingOverlayEventArgs

Drawn

  • N/A
Remarks
  • N/A

Event Arguments:DrawnOverlayEventArgs

DrawingAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawingAttributionOverlayEventArgs

DrawnAttribution

  • N/A
Remarks
  • N/A

Event Arguments:DrawnAttributionOverlayEventArgs

RequestedDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestedDrawingOverlayEventArgs

RequestingDrawing

  • N/A
Remarks
  • N/A

Event Arguments:RequestingDrawingOverlayEventArgs

api/thinkgeo.mapsuite.winforms.overlay.txt · Last modified: 2017/01/11 07:24 (external edit)