AdornmentOverlay¶

Namespace: ThinkGeo.UI.Android

public class AdornmentOverlay : Overlay, System.IDisposable

Inheritance Object → OverlayBase → Overlay → AdornmentOverlay
Implements IDisposable

Properties¶

IsEmpty¶

This property indicates whether this overlay is empty or not.

public bool IsEmpty { get; }

Property Value¶

Boolean
true if this instance is empty; otherwise, false.

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.

Layers¶

This property gets a collection of the AdornmentLayers that are added to the AdornmentOverlay.

public GeoCollection<AdornmentLayer> Layers { get; }

Property Value¶

GeoCollection<AdornmentLayer>

        A collection of AdornmentLayers that are added to the
        AdornmentOverlay to be drawn.

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.

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

Constructors¶

AdornmentOverlay()¶

Initializes a new instance of the AdornmentOverlay class.

public AdornmentOverlay()

Methods¶

InitializeCore(MapArguments)¶

This method initializes overlay object.

protected void InitializeCore(MapArguments mapArguments)

Parameters¶

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

Remarks:

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

DrawCore(MapArguments, OverlayRefreshType)¶

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

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.

Dispose(Boolean)¶

Releases unmanaged and - optionally - managed resources.

protected void Dispose(bool disposing)

Parameters¶

disposing Boolean
true to release both managed and unmanaged resources; false to release only unmanaged resources.

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;