thinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay

<!– Class –> This class inherits from InterativeOverlay abstract class. This specified overlay describle the Extent Changing interative process with MapControl using Mouse or Keyborad.

Remarks

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodExtentInteractiveOverlay Default constructor of the class. If you use thi constructor, please set the properties correctly or it will use their default values.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Overlay
Public MethodDispose Overlay This method dispose unmanaged resource used in this class.
Public MethodDraw RectangleShape, OverlayRefreshType Overlay This method draws the overlay with the provided extent in world coordinate.
Public MethodDraw RectangleShape Overlay This method draws the overlay with the provided extent in world coordinate.
Public MethodEquals Object Object
Public MethodGetBoundingBox Overlay This method gets a bounding box of the Overlay.
Public MethodGetHashCode Object
Public MethodGetType Object
Public MethodInitialize MapArguments Overlay This method initializes overlay object.
Public MethodKeyDown KeyEventInteractionArguments InteractiveOverlay Occurs when key down on the map.
Public MethodKeyUp KeyEventInteractionArguments InteractiveOverlay Occurs when key up on the map.
Public MethodLoadState Byte[] Overlay This method restore the overlay state back from the specified state.
Public MethodManipulationCompleted InteractionArguments InteractiveOverlay
Public MethodManipulationDelta InteractionArguments InteractiveOverlay
Public MethodManipulationStarted InteractionArguments InteractiveOverlay
Public MethodMouseClick InteractionArguments InteractiveOverlay This method will simulate the MouseClick interaction.
Public MethodMouseDoubleClick InteractionArguments InteractiveOverlay This method will simulate the MouseDoubleClick interaction.
Public MethodMouseDown InteractionArguments InteractiveOverlay This method will simulate the MouseDown interaction.
Public MethodMouseEnter InteractionArguments InteractiveOverlay Occurs when the mouse enter the map.
Public MethodMouseLeave InteractionArguments InteractiveOverlay Occurs when the mouse leave the map.
Public MethodMouseMove InteractionArguments InteractiveOverlay This method will simulate the MouseMove interaction.
Public MethodMouseUp InteractionArguments InteractiveOverlay This method will simulate the MouseUp interaction.
Public MethodMouseWheel InteractionArguments InteractiveOverlay This method will simulate the MouseWheel interaction.
Public MethodOpen Overlay
Public MethodPanTo RectangleShape Overlay This method pans the overlay to the provided world extent.
Public MethodRefresh TimeSpan Overlay
Public MethodRefresh Overlay This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.
Public MethodRefresh RectangleShape Overlay
Public MethodRefresh IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRefresh IEnumerable<RectangleShape>, TimeSpan Overlay
Public MethodRefresh RectangleShape, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRefresh RectangleShape, TimeSpan Overlay
Public MethodRefresh TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRefresh IEnumerable<RectangleShape> Overlay
Public MethodSaveState Overlay This method saves overlay state to a byte array.
Public MethodToString Object
Public MethodStatic Memberget_InteractiveClickInterval InteractiveOverlay
Public MethodStatic Memberset_InteractiveClickInterval Int32 InteractiveOverlay

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Overlay
Protected MethodDispose Boolean Overlay This method dispose unmanaged resource used in this class.
Protected MethodDrawAttributionCore GeoCanvas Overlay
Protected MethodDrawCore RectangleShape, OverlayRefreshType Overlay(overriden) This method actually draws this overlay.
Protected MethodDrawTileCore GeoCanvas InteractiveOverlay
Protected MethodFinalize Object(overriden)
Protected MethodGetBoundingBoxCore Overlay This method returns the bounding box of the Overlay.
Protected MethodInitializeCore MapArguments Overlay This method initializes overlay object.
Protected MethodKeyDownCore KeyEventInteractionArguments InteractiveOverlay(overriden)
Protected MethodKeyUpCore KeyEventInteractionArguments InteractiveOverlay Occurs when key up on the map.
Protected MethodLoadStateCore Byte[] Overlay This method restore the overlay state back from the specified state.
Protected MethodManipulationCompletedCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodManipulationDeltaCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodManipulationStartedCore InteractionArguments InteractiveOverlay(overriden)
Protected MethodMemberwiseClone Object
Protected MethodMouseClickCore InteractionArguments InteractiveOverlay This protected virtual method is the Core method of MouseClick API.
Protected MethodMouseDoubleClickCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseDoubleClick logic in its base class InterativeOverlay.
Protected MethodMouseDownCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseDown logic in its base class InterativeOverlay.
Protected MethodMouseEnterCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseEnter logic in its base class InterativeOverlay.
Protected MethodMouseLeaveCore InteractionArguments InteractiveOverlay Occurs when the mouse leave the map.
Protected MethodMouseMoveCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseMove logic in its base class InterativeOverlay.
Protected MethodMouseUpCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseUp logic in its base class InterativeOverlay.
Protected MethodMouseWheelCore InteractionArguments InteractiveOverlay(overriden) This overrides the MouseWheel logic in its base class InterativeOverlay.
Protected MethodOnDrawing DrawingOverlayEventArgs Overlay This method raises before the overlay is drawing.
Protected MethodOnDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Protected MethodOnDrawn DrawnOverlayEventArgs Overlay This method raises after the overlay is drawn.
Protected MethodOnDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Protected MethodOnMapKeyDown MapKeyDownInteractiveOverlayEventArgs InteractiveOverlay Occurs when key down on the map object.
Protected MethodOnMapKeyUp MapKeyUpInteractiveOverlayEventArgs InteractiveOverlay Occurs when key up on the map object.
Protected MethodOnMapMouseClick MapMouseClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseClick is called.
Protected MethodOnMapMouseDoubleClick MapMouseDoubleClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseDoubleClick is called.
Protected MethodOnMapMouseDown MapMouseDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseDown is called.
Protected MethodOnMapMouseEnter MapMouseEnterInteractiveOverlayEventArgs InteractiveOverlay Occurs when mouse enter on the map object.
Protected MethodOnMapMouseLeave MapMouseLeaveInteractiveOverlayEventArgs InteractiveOverlay Occurs when mouse leave from the map object.
Protected MethodOnMapMouseMove MapMouseMoveInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseMove is called.
Protected MethodOnMapMouseUp MapMouseUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseUp is called.
Protected MethodOnMapMouseWheel MapMouseWheelInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when MapMouseWheel is called.
Protected MethodOpenCore Overlay
Protected MethodPanToCore RectangleShape Overlay This method pans the overlay to the provided world extent.
Protected MethodRefreshCore RectangleShape Overlay
Protected MethodRefreshCore Overlay This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.
Protected MethodSaveStateCore Overlay This method saves overlay state to a byte array.

Public Properties

Name Return DeclaringType Summary
Public PropertyAttribution String Overlay
Public PropertyAutoRefreshInterval TimeSpan Overlay
Public PropertyCanRefreshRegion Boolean Overlay
Public PropertyDoubleLeftClickMode MapDoubleLeftClickMode Gets or sets the DoubleLeftClickMode used for the ExtentInteractiveOverlay.
Public PropertyDoubleRightClickMode MapDoubleRightClickMode Gets or sets the DoubleRightClickMode used for the ExtentInteractiveOverlay.
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingMarginPercentage Double InteractiveOverlay
Public PropertyExtentChangedType ExtentChangedType Gets or sets the ExtentChangedType for the ExtentInteractiveOverlay.
Public PropertyIsBase Boolean Overlay
Public PropertyIsEmpty Boolean Overlay This property gets if this overlay is empty or not.
Public PropertyIsVisible Boolean Overlay Gets or sets if this overlay is visible.
Public PropertyLeftClickDragKey Keys Gets or sets the Keys used in LeftClickDrag for the ExtentInteractiveOverlay.
Public PropertyLeftClickDragMode MapLeftClickDragMode Gets or sets the LeftClickDragMode used for the ExtentInteractiveOverlay.
Public PropertyMapArguments MapArguments Overlay Gets or sets current map information which will be used for calculating mechanism.
Public PropertyMapZoomMode MapZoomMode
Public PropertyMinimumExtentInPixels Int32
Public PropertyMouseWheelMode MapMouseWheelMode Gets or sets the MouseWheelMode used for the ExtentInteractiveOverlay.
Public PropertyName String Overlay Gets or sets the name of this overaly.
Public PropertyOverlayCanvas Canvas Overlay Gets or sets the actual canvas which maintains all the visual elements on the overlay.
Public PropertyPanMode MapPanMode Gets or sets the PanMode used for the ExtentInteractiveOverlay.
Public PropertyRenderMode RenderMode InteractiveOverlay This property gets and sets the render mode for drawing this overlay.
Public PropertyRightClickDragKey Keys Gets or sets the Keys used in RightClickDrag for the ExtentInteractiveOverlay.
Public PropertyRightClickDragMode MapRightClickDragMode Gets or sets the RightClickDragMode used for the ExtentInteractiveOverlay.
Public PropertyZoomPercentage Int32 Gets or sets the zoom percentage when using the mouse wheel or double-clicking to zoom the MapControl.
Public PropertyZoomSnapDirection ZoomSnapDirection

Protected Properties

Name Return DeclaringType Summary
Protected PropertyIsOverlayInitialized Boolean Overlay Gets or sets if the overlay canvas is initialized.
Protected PropertyPreviousExtent RectangleShape Overlay Gets or sets the previous exent of the overlay.

Public Events

Name Event Arguments DeclaringType Summary
Public EventDrawing DrawingOverlayEventArgs Overlay This event raises before the overlay is drawing.
Public EventDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Public EventDrawn DrawnOverlayEventArgs Overlay This event raises after the overlay is drawn.
Public EventDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Public EventMapKeyDown MapKeyDownInteractiveOverlayEventArgs InteractiveOverlay Occurs when key down on the map canvas.
Public EventMapKeyUp MapKeyUpInteractiveOverlayEventArgs InteractiveOverlay Occurs when key up on the map canvas.
Public EventMapMouseClick MapMouseClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse clicked(mouse up and mouse down in the same postion) on the Map.
Public EventMapMouseDoubleClick MapMouseDoubleClickInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse double clicked on the Map.
Public EventMapMouseDown MapMouseDownInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse pressed Down on the Map.
Public EventMapMouseEnter MapMouseEnterInteractiveOverlayEventArgs InteractiveOverlay Occurs when mouse enter the map canvas.
Public EventMapMouseLeave MapMouseLeaveInteractiveOverlayEventArgs InteractiveOverlay Occurs when mouse leave the map canvas.
Public EventMapMouseMove MapMouseMoveInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse moved on the Map.
Public EventMapMouseUp MapMouseUpInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse released up on the Map.
Public EventMapMouseWheel MapMouseWheelInteractiveOverlayEventArgs InteractiveOverlay This event will be fired when Mouse wheel on the Map.

Public Constructors

ExtentInteractiveOverlay()

Default constructor of the class. If you use thi constructor, please set the properties correctly or it will use their default values.

Remarks

Parameters

Name Type Description

Go Back

Protected Constructors

Public Methods

Close()

Remarks

Return Value

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

Parameters

Name Type Description

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

Dispose()

This method dispose unmanaged resource used in this class.

Remarks

Return Value

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

Parameters

Name Type Description

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

Draw(RectangleShape, OverlayRefreshType)

This method draws the overlay with the provided extent in world coordinate.

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter indicates an extent in world coordinate for drawing the overlay.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType –> This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode.

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

Draw(RectangleShape)

This method draws the overlay with the provided extent in world coordinate.

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter indicates an extent in world coordinate for drawing the overlay.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.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

GetBoundingBox()

This method gets a bounding box of the Overlay.

Remarks

This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay.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
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> A RectangleShape indicating the bounding box of this overlay

Parameters

Name Type Description

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

GetHashCode()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Initialize(MapArguments)

This method initializes overlay object.

Remarks

This is a wrapper method for the virtual method InitializeCore.

Return Value

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

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.

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

KeyDown(KeyEventInteractionArguments)

Occurs when key down on the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for key down on the map.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.KeyEventInteractionArguments –> Interaction arguments for key down on the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

KeyUp(KeyEventInteractionArguments)

Occurs when key up on the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for key up on the map.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.KeyEventInteractionArguments –> Interaction arguments for key up on the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

LoadState(Byte[])

This method restore the overlay state back from the specified state.

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
state Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay –> This parameter indicates the state for restore the overlay.

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

ManipulationCompleted(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

ManipulationDelta(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

ManipulationStarted(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseClick(InteractionArguments)

This method will simulate the MouseClick interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseDoubleClick(InteractionArguments)

This method will simulate the MouseDoubleClick interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseDown(InteractionArguments)

This method will simulate the MouseDown interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseEnter(InteractionArguments)

Occurs when the mouse enter the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for mouse entering the map.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> Interaction arguments for mouse entering the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseLeave(InteractionArguments)

Occurs when the mouse leave the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for mouse leave the map.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> Interaction arguments for mouse leave the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseMove(InteractionArguments)

This method will simulate the MouseMove interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseUp(InteractionArguments)

This method will simulate the MouseUp interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseWheel(InteractionArguments)

This method will simulate the MouseWheel interaction.

Remarks

This method is the concrete wrapper for its virtual Core method. 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
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

Open()

Remarks

Return Value

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

Parameters

Name Type Description

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

PanTo(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter is the target world extent for panning.

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

Refresh(TimeSpan)

Remarks

Return Value

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

Parameters

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

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

Refresh()

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

Remarks

The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.

Return Value

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

Parameters

Name Type Description

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

Refresh(RectangleShape)

Remarks

Return Value

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

Parameters

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

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

Refresh(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.WpfDesktopEdition.Overlay –> Go Back

Refresh(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.WpfDesktopEdition.Overlay –> Go Back

Refresh(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.WpfDesktopEdition.Overlay –> Go Back

Refresh(RectangleShape, TimeSpan)

Remarks

Return Value

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

Parameters

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

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

Refresh(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.WpfDesktopEdition.Overlay –> Go Back

Refresh(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.WpfDesktopEdition.Overlay –> Go Back

SaveState()

This method saves overlay state to a byte array.

Remarks

Return Value

Return Type Description
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay –> A byte array indicates current overlay state.

Parameters

Name Type Description

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

ToString()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

get_InteractiveClickInterval()

<!– static –>

Remarks

Return Value

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

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

set_InteractiveClickInterval(Int32)

<!– static –>

Remarks

Return Value

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

Parameters

Name Type Description
value Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

Protected Methods

CloseCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

Dispose(Boolean)

This method dispose unmanaged resource used in this class.

Remarks

Return Value

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

Parameters

Name Type Description
disposing Boolean<!– System.Boolean –>

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

DrawAttributionCore(GeoCanvas)

Remarks

Return Value

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

Parameters

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

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

DrawCore(RectangleShape, OverlayRefreshType)

This method actually draws this overlay.

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> The bounding box to draw.
overlayRefreshType OverlayRefreshType<!– ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType –> The refresh type.

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

DrawTileCore(GeoCanvas)

Remarks

Return Value

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

Parameters

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

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

Finalize()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

GetBoundingBoxCore()

This method returns the bounding box of the Overlay.

Remarks

This method returns the bounding box of the Overlay.

Return Value

Return Type Description
RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This method returns the bounding box of the Overlay.

Parameters

Name Type Description

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

InitializeCore(MapArguments)

This method initializes overlay object.

Remarks

When implementing this method, consider initializing the overlay canvas such as setting its z-index, setting current map reference to the CurrentMap property.

Return Value

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

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.

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

KeyDownCore(KeyEventInteractionArguments)

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.KeyEventInteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

KeyUpCore(KeyEventInteractionArguments)

Occurs when key up on the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for key up on the map.

Parameters

Name Type Description
interactionArguments KeyEventInteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.KeyEventInteractionArguments –> Interaction arguments for key up on the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

LoadStateCore(Byte[])

This method restore the overlay state back from the specified state.

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
state Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay –> This parameter indicates the state for restore the overlay.

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

ManipulationCompletedCore(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

ManipulationDeltaCore(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

ManipulationStartedCore(InteractionArguments)

Remarks

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

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MemberwiseClone()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

MouseClickCore(InteractionArguments)

This protected virtual method is the Core method of MouseClick API.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseDoubleClickCore(InteractionArguments)

This overrides the MouseDoubleClick logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseDownCore(InteractionArguments)

This overrides the MouseDown logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseEnterCore(InteractionArguments)

This overrides the MouseEnter logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –>

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseLeaveCore(InteractionArguments)

Occurs when the mouse leave the map.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> A interactive result for mouse leaving the map.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> Interaction arguments for mouse leaving the map.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MouseMoveCore(InteractionArguments)

This overrides the MouseMove logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseUpCore(InteractionArguments)

This overrides the MouseUp logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

MouseWheelCore(InteractionArguments)

This overrides the MouseWheel logic in its base class InterativeOverlay.

Remarks

Return Value

Return Type Description
InteractiveResult<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveResult –> Interaction results of this method.

Parameters

Name Type Description
interactionArguments InteractionArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractionArguments –> This parameter is the interaction auguments for the method.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay(overriden) –> Go Back

OnDrawing(DrawingOverlayEventArgs)

This method raises before the overlay is drawing.

Remarks

Return Value

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

Parameters

Name Type Description
e DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs –> This parameter is the event argument for Drawing event.

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

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

Remarks

Return Value

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

Parameters

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

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

OnDrawn(DrawnOverlayEventArgs)

This method raises after the overlay is drawn.

Remarks

Return Value

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

Parameters

Name Type Description
e DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs –> This parameter is the event argument for Drawn event.

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

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

Remarks

Return Value

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

Parameters

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

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

OnMapKeyDown(MapKeyDownInteractiveOverlayEventArgs)

Occurs when key down on the map object.

Remarks

Return Value

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

Parameters

Name Type Description
e MapKeyDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapKeyDownInteractiveOverlayEventArgs –> Event argument for the MapKeyDown event.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapKeyUp(MapKeyUpInteractiveOverlayEventArgs)

Occurs when key up on the map object.

Remarks

Return Value

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

Parameters

Name Type Description
e MapKeyUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapKeyUpInteractiveOverlayEventArgs –> Event argument for the MapKeyUp event.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseClick(MapMouseClickInteractiveOverlayEventArgs)

This event will be fired when MapMouseClick is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseClickInteractiveOverlayEventArgs –> The MapMouseClickInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseDoubleClick(MapMouseDoubleClickInteractiveOverlayEventArgs)

This event will be fired when MapMouseDoubleClick is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseDoubleClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseDoubleClickInteractiveOverlayEventArgs –> The MapMouseDoubleClickInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseDown(MapMouseDownInteractiveOverlayEventArgs)

This event will be fired when MapMouseDown is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseDownInteractiveOverlayEventArgs –> The MapMouseDownInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseEnter(MapMouseEnterInteractiveOverlayEventArgs)

Occurs when mouse enter on the map object.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseEnterInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseEnterInteractiveOverlayEventArgs –> Event argument for the MapMouseEnter event.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseLeave(MapMouseLeaveInteractiveOverlayEventArgs)

Occurs when mouse leave from the map object.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseLeaveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseLeaveInteractiveOverlayEventArgs –> Event argument for the MapMouseLeave event.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseMove(MapMouseMoveInteractiveOverlayEventArgs)

This event will be fired when MapMouseMove is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseMoveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseMoveInteractiveOverlayEventArgs –> The MapMouseMoveInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseUp(MapMouseUpInteractiveOverlayEventArgs)

This event will be fired when MapMouseUp is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseUpInteractiveOverlayEventArgs –> The MapMouseUpInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OnMapMouseWheel(MapMouseWheelInteractiveOverlayEventArgs)

This event will be fired when MapMouseWheel is called.

Remarks

Return Value

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

Parameters

Name Type Description
e MapMouseWheelInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseWheelInteractiveOverlayEventArgs –> The MapMouseWheelInteractiveOverlayEventArgs passed for the event raised.

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

OpenCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

PanToCore(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter is the target world extent for panning.

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

RefreshCore(RectangleShape)

Remarks

Return Value

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

Parameters

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

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

RefreshCore()

This method refreshes all the content in the OverlayCanvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

Remarks

The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.

Return Value

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

Parameters

Name Type Description

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

SaveStateCore()

This method saves overlay state to a byte array.

Remarks

Return Value

Return Type Description
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay –> A byte array indicates current overlay state.

Parameters

Name Type Description

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

Public Properties

Attribution

Remarks

Return Value

Return Type
String<!– System.String –>

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

AutoRefreshInterval

Remarks

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

CanRefreshRegion

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

DoubleLeftClickMode

Gets or sets the DoubleLeftClickMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapDoubleLeftClickMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapDoubleLeftClickMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

DoubleRightClickMode

Gets or sets the DoubleRightClickMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapDoubleRightClickMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapDoubleRightClickMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> 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.WpfDesktopEdition.Overlay –> Go Back

DrawingMarginPercentage

Remarks

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

Return Value

Return Type
Double<!– System.Double –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

ExtentChangedType

Gets or sets the ExtentChangedType for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
ExtentChangedType<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentChangedType –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

IsBase

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsEmpty

This property gets if this overlay is empty or not.

Remarks

This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsVisible

Gets or sets if this overlay is visible.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

LeftClickDragKey

Gets or sets the Keys used in LeftClickDrag for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
Keys<!– System.Windows.Forms.Keys –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

LeftClickDragMode

Gets or sets the LeftClickDragMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapLeftClickDragMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapLeftClickDragMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

MapArguments

Gets or sets current map information which will be used for calculating mechanism.

Remarks

Return Value

Return Type
MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –>

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

MapZoomMode

Remarks

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

Return Value

Return Type
MapZoomMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapZoomMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

MinimumExtentInPixels

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

MouseWheelMode

Gets or sets the MouseWheelMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapMouseWheelMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseWheelMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

Name

Gets or sets the name of this overaly.

Remarks

Return Value

Return Type
String<!– System.String –>

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

OverlayCanvas

Gets or sets the actual canvas which maintains all the visual elements on the overlay.

Remarks

Return Value

Return Type
Canvas<!– System.Windows.Controls.Canvas –>

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

PanMode

Gets or sets the PanMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapPanMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapPanMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

RenderMode

This property gets and sets the render mode for drawing this overlay.

Remarks

Set GdiPlus to render map image with Gdi+. We recommend use this value with large data. Set DrawingVisual to render map image with DrawingVisual feature in WPF. Use it when the spatial data is small to get better responding.

Return Value

Return Type
RenderMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.RenderMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

RightClickDragKey

Gets or sets the Keys used in RightClickDrag for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
Keys<!– System.Windows.Forms.Keys –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

RightClickDragMode

Gets or sets the RightClickDragMode used for the ExtentInteractiveOverlay.

Remarks

Return Value

Return Type
MapRightClickDragMode<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapRightClickDragMode –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

ZoomPercentage

Gets or sets the zoom percentage when using the mouse wheel or double-clicking to zoom the MapControl.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

ZoomSnapDirection

Remarks

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

Return Value

Return Type
ZoomSnapDirection<!– ThinkGeo.MapSuite.WpfDesktopEdition.ZoomSnapDirection –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.ExtentInteractiveOverlay –> Go Back

Protected Properties

IsOverlayInitialized

Gets or sets if the overlay canvas is initialized.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

PreviousExtent

Gets or sets the previous exent of the overlay.

Remarks

Return Value

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

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

Public Events

Drawing

This event raises before the overlay is drawing.

Remarks

Event Arguments

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

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

DrawingAttribution

Remarks

Event Arguments

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

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

Drawn

This event raises after the overlay is drawn.

Remarks

Event Arguments

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

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

DrawnAttribution

Remarks

Event Arguments

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

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

MapKeyDown

Occurs when key down on the map canvas.

Remarks

Event Arguments

Event Arguments
MapKeyDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapKeyDownInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapKeyUp

Occurs when key up on the map canvas.

Remarks

Event Arguments

Event Arguments
MapKeyUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapKeyUpInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseClick

This event will be fired when Mouse clicked(mouse up and mouse down in the same postion) on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseClickInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseDoubleClick

This event will be fired when Mouse double clicked on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseDoubleClickInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseDoubleClickInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseDown

This event will be fired when Mouse pressed Down on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseDownInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseDownInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseEnter

Occurs when mouse enter the map canvas.

Remarks

Event Arguments

Event Arguments
MapMouseEnterInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseEnterInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseLeave

Occurs when mouse leave the map canvas.

Remarks

Event Arguments

Event Arguments
MapMouseLeaveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseLeaveInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseMove

This event will be fired when Mouse moved on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseMoveInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseMoveInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseUp

This event will be fired when Mouse released up on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseUpInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseUpInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

MapMouseWheel

This event will be fired when Mouse wheel on the Map.

Remarks

Event Arguments

Event Arguments
MapMouseWheelInteractiveOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapMouseWheelInteractiveOverlayEventArgs –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.InteractiveOverlay –> Go Back

NOTOC WpfDesktopEdition ThinkGeo.MapSuite.WpfDesktopEdition UpdateDocumentation

thinkgeo.mapsuite.wpfdesktopedition.extentinteractiveoverlay.1440040136.txt.gz · Last modified: 2015/09/18 03:11 (external edit)