Skip to content

PopupOverlay

Namespace: ThinkGeo.UI.Android

This class represents an overlay to place popups on the map.

public class PopupOverlay : Overlay, System.IDisposable

Inheritance ObjectOverlayBaseOverlayPopupOverlay
Implements IDisposable

Properties

Popups

This property gets a collection of popup that are added into this overlay.

public GeoCollection<Popup> Popups { get; set; }

Property Value

GeoCollection<Popup>

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

Constructors

PopupOverlay()

Initializes a new instance of the PopupOverlay class.

public PopupOverlay()

PopupOverlay(IEnumerable<Popup>)

This is constructor of PopupOverlay class.

public PopupOverlay(IEnumerable<Popup> popups)

Parameters

popups IEnumerable<Popup>
This parameter indicates a collection of popup that are added into this overlay.

Methods

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.

DrawAsyncCore(MapArguments, OverlayRefreshType)

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

protected Task DrawAsyncCore(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.

Returns

Task

GetBoundingBoxCore()

This method returns a bounding box to hold all popups.

protected RectangleShape GetBoundingBoxCore()

Returns

RectangleShape
A RectangleShape value that to hold all popups.

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)

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;