User Tools

Site Tools


thinkgeo.mapsuite.desktopedition.markeroverlay

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay

<!– Class –>

Remarks

For the most updated Info for this topic, please check it here:<a href=“http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay” target=“_blank”>http://wiki.thinkgeo.com/wiki/ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay</a>

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary

Protected Constructors

Name Parameters DeclaringType Summary
Protected MethodMarkerOverlay

Public Methods

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodDrawAttributionCore GeoCanvas Overlay
Protected MethodDrawCore GeoCanvas Overlay(overriden)
Protected MethodDrawException GeoCanvas, Exception Overlay This method will draw on the canvas when an exception occurs during the drawing process.
Protected MethodDrawExceptionCore GeoCanvas, Exception Overlay 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.
Protected MethodDrawPreviewCore GeoCanvas Overlay This is the core method of DrawPreview which is intended to be overridden by its concrete sub class.
Protected MethodFinalize Object
Protected MethodGetMarkersForDrawingCore RectangleShape
Protected MethodMemberwiseClone Object
Protected MethodOnDrawing DrawingOverlayEventArgs Overlay This event will be fired before Overlay is drawn.
Protected MethodOnDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Protected MethodOnDrawn DrawnOverlayEventArgs Overlay This event will be fired after Overlay is drawn.
Protected MethodOnDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Protected MethodOnRequestedDrawing RequestedDrawingOverlayEventArgs Overlay
Protected MethodOnRequestingDrawing RequestingDrawingOverlayEventArgs Overlay
Protected MethodRefreshCore GeoCanvas, RectangleShape Overlay

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingTime TimeSpan Overlay This property gets the last drawing time for the Overlay.
Public PropertyIsBase Boolean Overlay Gets or sets a value that indicates whether the overlay is a base overlay. The default value is false.
Public PropertyIsEmpty Boolean Overlay 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.
Public PropertyIsVisible Boolean Overlay Gets or sets a value that indicates whether the overlay is visible on the map.
Public PropertyLock OverlayLock Overlay This property gets the OverlayLock object.
Public PropertyMapControl WinformsMap
Public PropertyName String Overlay Gets or sets the name of the overlay, which can be used to represent a specific overlay.
Public PropertyPreviewTileCache BitmapTileCache Overlay 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.
Public PropertyTileCache BitmapTileCache Overlay This property gets or sets the TileCache used for the overlay.

Protected Properties

Name Return DeclaringType Summary

Public Events

Public Constructors

Protected Constructors

MarkerOverlay()

Remarks

Parameters

Name Type Description

Go Back

Public Methods

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

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawPreview(GeoCanvas)

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

Remarks

Return Value

Return Type Description
TilesExistingType<!– ThinkGeo.MapSuite.DesktopEdition.TilesExistingType –> The tile existing type, which indicates whether any tiles exist.

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Equals(Object)

Remarks

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Remarks

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetMarkersForDrawing(RectangleShape)

Remarks

Return Value

Return Type Description
GeoCollection<Marker><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.DesktopEdition.Marker} –>

Parameters

Name Type Description
boundingBox RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay –> Go Back

GetType()

Remarks

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Refresh(GeoCanvas, RectangleShape)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>
extent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(RectangleShape, TimeSpan)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(TimeSpan)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
bufferTime TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(IEnumerable<RectangleShape>)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(RectangleShape)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestDrawing()

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

ToString()

Remarks

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

DrawAttributionCore(GeoCanvas)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawCore(GeoCanvas)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay(overriden) –> Go Back

DrawException(GeoCanvas, Exception)

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

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.
e Exception<!– System.Exception –> This parameter is the exception that is occurring.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

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

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.
e Exception<!– System.Exception –> This parameter is the exception that is occurring.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawPreviewCore(GeoCanvas)

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

Remarks

Return Value

Return Type Description
TilesExistingType<!– ThinkGeo.MapSuite.DesktopEdition.TilesExistingType –> The tile existing type, which indicates whether any tiles exist.

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Finalize()

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetMarkersForDrawingCore(RectangleShape)

Remarks

Return Value

Return Type Description
GeoCollection<Marker><!– ThinkGeo.MapSuite.Core.GeoCollection{ThinkGeo.MapSuite.DesktopEdition.Marker} –>

Parameters

Name Type Description
boundingBox RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay –> Go Back

MemberwiseClone()

Remarks

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawing(DrawingOverlayEventArgs)

This event will be fired before Overlay is drawn.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs –> The OverlayDrawingEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnDrawn(DrawnOverlayEventArgs)

This event will be fired after Overlay is drawn.

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
e DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs –> The OverlayDrawnEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
args DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnRequestedDrawing(RequestedDrawingOverlayEventArgs)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
eventArgs RequestedDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

OnRequestingDrawing(RequestingDrawingOverlayEventArgs)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
eventArgs RequestingDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RefreshCore(GeoCanvas, RectangleShape)

Remarks

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>
extent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Public Properties

Attribution

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

AutoRefreshInterval

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawingExceptionMode

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

Remarks

Return Value

Return Type
DrawingExceptionMode<!– ThinkGeo.MapSuite.Core.DrawingExceptionMode –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

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

Return Type
TimeSpan<!– System.TimeSpan –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

IsBase

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

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

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

IsVisible

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

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Lock

This property gets the OverlayLock object.

Remarks

Return Value

Return Type
OverlayLock<!– ThinkGeo.MapSuite.DesktopEdition.OverlayLock –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

MapControl

Remarks

Return Value

Return Type
WinformsMap<!– ThinkGeo.MapSuite.DesktopEdition.WinformsMap –>

<!– ThinkGeo.MapSuite.DesktopEdition.MarkerOverlay –> Go Back

Name

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

Remarks

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

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

Return Type
BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

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

Return Type
BitmapTileCache<!– ThinkGeo.MapSuite.Core.BitmapTileCache –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Protected Properties

Public Events

Drawing

This event will be fired before the Overlay is drawn.

Remarks

Event Arguments

Event Arguments
DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawingAttribution

Remarks

Event Arguments

Event Arguments
DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawingAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

Drawn

This event will be fired after the Overlay is drawn.

Remarks

Event Arguments

Event Arguments
DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

DrawnAttribution

Remarks

Event Arguments

Event Arguments
DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.DrawnAttributionOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestedDrawing

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Event Arguments

Event Arguments
RequestedDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestedDrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

RequestingDrawing

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Event Arguments

Event Arguments
RequestingDrawingOverlayEventArgs<!– ThinkGeo.MapSuite.DesktopEdition.RequestingDrawingOverlayEventArgs –>

<!– ThinkGeo.MapSuite.DesktopEdition.Overlay –> Go Back

NOTOC DesktopEdition ThinkGeo.MapSuite.DesktopEdition UpdateDocumentation

thinkgeo.mapsuite.desktopedition.markeroverlay.1440040130.txt.gz · Last modified: 2015/09/18 03:03 (external edit)