Skip to content

InteractiveOverlay

Namespace: ThinkGeo.UI.Android

This class inherits from Overlay abstract class. This specified overlay describe the interactive process with MapControl using Mouse or Keyboard.

public class InteractiveOverlay : Overlay, System.IDisposable

Inheritance ObjectOverlayBaseOverlayInteractiveOverlay
Implements IDisposable

Properties

InteractiveView

Gets or sets Overlay's the interactiveView.

public TileView InteractiveView { get; set; }

Property Value

TileView

OverlayView

Gets or sets the overlay view.

public MapLayout OverlayView { get; set; }

Property Value

MapLayout
The overlay view.

IsVisible

public bool IsVisible { get; set; }

Property Value

Boolean

Name

Gets or sets the name of this overaly.

public string Name { get; set; }

Property Value

String

DrawingExceptionMode

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

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value

DrawingExceptionMode
The drawing exception mode.

MapArguments

Gets or sets the map arguments.

public MapArguments MapArguments { get; set; }

Property Value

MapArguments
The map arguments.

Attribution

Gets or sets the attribution.

public string Attribution { get; set; }

Property Value

String
The attribution.

IsEmpty

Gets a value indicating whether this instance is empty.

public bool IsEmpty { get; }

Property Value

Boolean

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.

DrawingQuality

Gets or sets the drawingQuality for this overlay.

public DrawingQuality DrawingQuality { get; set; }

Property Value

DrawingQuality

Opacity

Gets or sets the opacity for this overlay.

public double Opacity { get; set; }

Property Value

Double

Methods

InitializeCore(MapArguments)

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

protected void InitializeCore(MapArguments mapArguments)

Parameters

mapArguments MapArguments
This parameter maintains current map information for calculating mechanism.

PostTransformCore(TransformArguments, MapArguments)

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

protected void PostTransformCore(TransformArguments transformInfo, MapArguments mapArguments)

Parameters

transformInfo TransformArguments
This parameter maintains the transform information for calculating transform.

mapArguments MapArguments
This parameter maintains current map information for calculating mechanism.

Dispose(Boolean)

This method dispose unmanaged resource used in this class.

protected void Dispose(bool disposing)

Parameters

disposing Boolean

DrawCore(MapArguments, OverlayRefreshType)

This method draws the InteractiveOverlay abstract class. You have to override this API in its sub concrete classes, Or you will see nothing.

protected void DrawCore(MapArguments mapArguments, OverlayRefreshType refreshType)

Parameters

mapArguments MapArguments
This parameter maintains current map information for calculating mechanism.

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

Remarks:

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.

TouchUp(InteractionArguments)

This method will simulate the TouchUp interaction.

public InteractiveResult TouchUp(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

TouchUpCore(InteractionArguments)

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

protected InteractiveResult TouchUpCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

TouchRotate(InteractionArguments)

This method will simulate the TouchRotate interaction.

public InteractiveResult TouchRotate(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult

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.

TouchRotateCore(InteractionArguments)

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

protected InteractiveResult TouchRotateCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

TouchDown(InteractionArguments)

This method will simulate the TouchDown interaction.

public InteractiveResult TouchDown(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult

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.

TouchDownCore(InteractionArguments)

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

protected InteractiveResult TouchDownCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

TouchMove(InteractionArguments)

This method will simulate the TouchMove interaction.

public InteractiveResult TouchMove(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

TouchMoveCore(InteractionArguments)

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

protected InteractiveResult TouchMoveCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

TouchPointerDown(InteractionArguments)

This method will simulate the TouchPointerDown interaction.

public InteractiveResult TouchPointerDown(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

TouchPointerDownCore(InteractionArguments)

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

protected InteractiveResult TouchPointerDownCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

TouchPointerUp(InteractionArguments)

This method will simulate the TouchPointerUp interaction.

public InteractiveResult TouchPointerUp(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

TouchPointerUpCore(InteractionArguments)

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

protected InteractiveResult TouchPointerUpCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

SingleTap(InteractionArguments)

This method will simulate the SingleTap interaction.

public InteractiveResult SingleTap(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

SingleTapCore(InteractionArguments)

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

protected InteractiveResult SingleTapCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

DoubleTap(InteractionArguments)

This method will simulate the DoubleTap interaction.

public InteractiveResult DoubleTap(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

DoubleTapCore(InteractionArguments)

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

protected InteractiveResult DoubleTapCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

LongPress(InteractionArguments)

This method will simulate the LongPress interaction.

public InteractiveResult LongPress(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

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.

LongPressCore(InteractionArguments)

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

protected InteractiveResult LongPressCore(InteractionArguments e)

Parameters

e InteractionArguments
This parameter is the interaction arguments for the method.

Returns

InteractiveResult
Interaction results of this method.

Events

DrawingException

Occurs before exception is drawing on map.

public event EventHandler<DrawingExceptionOverlayEventArgs> DrawingException;

DrawnException

Occurs after exception is drawn on map.

public event EventHandler<DrawnExceptionOverlayEventArgs> DrawnException;

Drawing

This event raises before the overlay is drawing.

public event EventHandler<DrawingOverlayEventArgs> Drawing;

Drawn

This event raises after the overlay is drawn.

public event EventHandler<DrawnOverlayEventArgs> Drawn;