Skip to content

TileOverlay

Namespace: ThinkGeo.UI.Android

Represents an overlay that maintains tiles.

public abstract class TileOverlay : Overlay, System.IDisposable

Inheritance ObjectOverlayBaseOverlayTileOverlay
Implements IDisposable

Properties

LayerType

Gets or sets the LayerType of the Overlay.

public LayerType LayerType { get; set; }

Property Value

LayerType

TileSizeMode

public TileSizeMode TileSizeMode { get; set; }

Property Value

TileSizeMode

TileWidth

Gets or sets the width of the tile.

public int TileWidth { get; set; }

Property Value

Int32
The width of the tile.

TileHeight

Gets or sets the height of the tile.

public int TileHeight { get; set; }

Property Value

Int32
The height of the tile.

IsCacheOnly

Gets or sets a value indicating whether this instance is cache only.

public bool IsCacheOnly { get; set; }

Property Value

Boolean
true if this instance is cache only; otherwise, false.

TileCache

Gets or sets the tile cache.

public RasterTileCache TileCache { get; set; }

Property Value

RasterTileCache
The tile cache.

TileType

Gets and sets the overlay is formed by multiple tiles or single tile.

public TileType TileType { get; set; }

Property Value

TileType
The type of the tile.

TileSnappingMode

Gets or sets the tile snapping mode.

public TileSnappingMode TileSnappingMode { get; set; }

Property Value

TileSnappingMode
The tile snapping mode.

TransitionEffect

Gets or sets the tile transition effect.

public TransitionEffect TransitionEffect { get; set; }

Property Value

TransitionEffect
The tile snapping mode.

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

GetTile(Context)

Chooses a tile object to form the TileOverlay.

When overriding this method, consider the initialize parameters setting on the tile.

protected TileView GetTile(Context context)

Parameters

context Context
Interface to global information about an application environment.

Returns

TileView

GetTileCore(Context)

Chooses a tile object to form the TileOverlay. When overriding this method, consider the initialize parameters setting on the tile.

protected TileView GetTileCore(Context context)

Parameters

context Context
Interface to global information about an application environment.

Returns

TileView
A tile object to form the TileOverlay.

GetOneTile()

Gets the one tile.

public TileView GetOneTile()

Returns

TileView

DrawCore(MapArguments, OverlayRefreshType)

Draws current overlay with provided mapArguments.

protected void DrawCore(MapArguments mapArguments, OverlayRefreshType refreshType)

Parameters

mapArguments MapArguments
The map arguments.

refreshType OverlayRefreshType
Type of the refresh.

DrawAsyncCore(MapArguments, OverlayRefreshType)

Draws current overlay with provided mapArguments.

protected Task DrawAsyncCore(MapArguments mapArguments, OverlayRefreshType refreshType)

Parameters

mapArguments MapArguments
The map arguments.

refreshType OverlayRefreshType
Type of the refresh.

Returns

Task

DrawTileAsyncCore(GeoCanvas, TileView)

Redraws a specified tile with the provided geoCanvas.

protected Task DrawTileAsyncCore(GeoCanvas geoCanvas, TileView tile)

Parameters

geoCanvas GeoCanvas
A geoCanvas for drawing this overlay.

tile TileView
A tile which needs to be drawn.

Returns

Task

DrawTileCore(GeoCanvas, TileView)

Redraws a specified tile with the provided geoCanvas.

protected void DrawTileCore(GeoCanvas geoCanvas, TileView tile)

Parameters

geoCanvas GeoCanvas
A geoCanvas for drawing this overlay.

tile TileView
A tile which needs to be drawn.

DrawTileAsync(TileView, MapArguments)

Redraws a specified tile with the provided world extent.

protected Task DrawTileAsync(TileView tileView, MapArguments mapArguments)

Parameters

tileView TileView
A Tile object that is created by the GetTile() method to draw.

mapArguments MapArguments
A mapArguments for drawing the passed tile.

Returns

Task

DrawTile(TileView, MapArguments)

Redraws a specified tile with the provided world extent.

protected void DrawTile(TileView tileView, MapArguments mapArguments)

Parameters

tileView TileView
A Tile object that is created by the GetTile() method to draw.

mapArguments MapArguments
A mapArguments for drawing the passed tile.

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.

PostTransformCore(TransformArguments, MapArguments)

Posts the transform for the TileOverlay.

protected void PostTransformCore(TransformArguments transformInfo, MapArguments mapArguments)

Parameters

transformInfo TransformArguments
The transform information.

mapArguments MapArguments
The map arguments.

GetTileMatrixCore(Double, Int32, Int32, GeographyUnit)

Gets the tile matrix for TileOverlay.

protected TileMatrix GetTileMatrixCore(double scale, int tileWidth, int tileHeight, GeographyUnit boundingBoxUnit)

Parameters

scale Double
The scale.

tileWidth Int32
Width of the tile.

tileHeight Int32
Height of the tile.

boundingBoxUnit GeographyUnit
The bounding box unit.

Returns

TileMatrix
TileMatrix.

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;