User Tools

Site Tools


thinkgeo.mapsuite.androidedition.bingmapstileoverlay

This is an old revision of the document!


ThinkGeo.MapSuite.AndroidEdition.BingMapsTileOverlay

<!– Class –> This class represents an overlay that requesting from Bing Maps Imagery Service.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodBingMapsTileOverlay Initializes a new instance of the class.
Public MethodBingMapsTileOverlay String Initializes a new instance of the class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Overlay This method will simulate the Close interaction.
Public MethodDispose Overlay This method dispose unmanaged resource used in this class.
Public MethodDraw MapArguments, OverlayRefreshType 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 MethodOpen Overlay This method will simulate the Open interaction.
Public MethodPostTransform TransformArguments, MapArguments Overlay This method will simulate the PostTransform interaction.
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 MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Overlay This protected virtual method is the Core method of Close API.
Protected MethodDispose Boolean Overlay(overriden)
Protected MethodDrawCore MapArguments, OverlayRefreshType Overlay(overriden)
Protected MethodDrawException GeoCanvas, Exception Overlay This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawExceptionCore GeoCanvas, Exception Overlay(overriden) This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawTile TileView, MapArguments TileOverlay Redraws a specified tile with the provided world extent.
Protected MethodDrawTileCore GeoCanvas, TileView TileOverlay(overriden) Redraws a specified tile with the provided world extent.
Protected MethodFinalize Object(overriden)
Protected MethodGetBoundingBoxCore Overlay(overriden) This method returns the bounding box of the Overlay.
Protected MethodGetTile Context TileOverlay Get a new tile object to form the TileOverlay.
Protected MethodGetTileCore Context TileOverlay Chooses a tile object to form the TileOverlay. When overriding this method, consider the initialize parameters setting on the tile.
Protected MethodGetTileMatrix Double, Int32, Int32, GeographyUnit TileOverlay(overriden) Gets the tile matrix.
Protected MethodGetTileMatrixCells MapArguments, Double TileOverlay
Protected MethodInitializeCore MapArguments Overlay This method initializes overlay object.
Protected MethodMemberwiseClone Object
Protected MethodOnDrawingException DrawingExceptionOverlayEventArgs Overlay This method raises before the overlay is drawing exception.
Protected MethodOnDrawnException DrawnExceptionOverlayEventArgs Overlay This method raises after the overlay is drawn exception.
Protected MethodOpenCore Overlay This protected virtual method is the Core method of Open API.
Protected MethodPostTransformCore TransformArguments, MapArguments Overlay(overriden)
Protected MethodRefreshCore Overlay(overriden) 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 Properties

Name Return DeclaringType Summary
Public PropertyApplicationId String This property gets or sets an application account registered from Bing Maps Imagery Service.
Public PropertyAttribution String Overlay Gets or sets the attribution for this overlay.
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyDrawingQuality DrawingQuality Overlay Gets or sets the drawingQuality for this overlay.
Public PropertyIsEmpty Boolean Overlay This property gets if this overlay is empty or not.
Public PropertyIsVisible Boolean Overlay(overriden)
Public PropertyLayerType LayerType TileOverlay Gets or sets the LayerType of the Overlay.
Public PropertyMapArguments MapArguments Overlay Gets or sets the mapArguments for this overlay.
Public PropertyMapType BingMapsMapType This property gets or sets the requesting map type from Bing Maps Imagery Service.
Public PropertyName String Overlay Gets or sets the name of this overaly.
Public PropertyOpacity Double Overlay Gets or sets the opacity for this overlay.
Public PropertyTileCache BitmapTileCache TileOverlay Gets and sets a tile cache object for saving the tiles.
Public PropertyTileSnappingMode TileSnappingMode TileOverlay Gets or sets the tile snapping mode.
Public PropertyTileType TileType TileOverlay Gets and sets the overlay is formed by multiple tiles or single tile.
Public PropertyTransitionEffect TransitionEffect TileOverlay Gets and sets the transition effect of the overlay when zooming. After zooming, the existing tiles stretch and leave in current viewport. Set to None when its background is transparent.

Protected Properties

Name Return DeclaringType Summary
Protected PropertySingleTile TileView TileOverlay Gets or sets the single tile.

Public Events

Name Event Arguments DeclaringType Summary
Public EventDrawingException DrawingExceptionOverlayEventArgs Overlay Occurs before exception is drawing on map.
Public EventDrawnException DrawnExceptionOverlayEventArgs Overlay Occurs after exception is drawn on map.

Public Constructors

BingMapsTileOverlay()

Initializes a new instance of the class.

Parameters

Name Type Description

Go Back

BingMapsTileOverlay(String)

Initializes a new instance of the class.

Parameters

Name Type Description
applicationId String<!– System.String –> This parameter indicates an application account registered from Bing Maps Account Center.

Go Back

Protected Constructors

Public Methods

Close()

This method will simulate the Close interaction.

Return Value

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

Parameters

Name Type Description

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

Dispose()

This method dispose unmanaged resource used in this class.

Return Value

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

Parameters

Name Type Description

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

Draw(MapArguments, OverlayRefreshType)

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

Return Value

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

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.AndroidEdition.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.AndroidEdition.Overlay –> Go Back

Equals(Object)

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.AndroidEdition.Overlay –> Go Back

GetHashCode()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

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.AndroidEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.

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

Open()

This method will simulate the Open interaction.

Return Value

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

Parameters

Name Type Description

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

PostTransform(TransformArguments, MapArguments)

This method will simulate the PostTransform interaction.

Return Value

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

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.AndroidEdition.TransformArguments –> This parameter maintains the transfrom information for calculating transform.
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.

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

ToString()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloseCore()

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

Return Value

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

Parameters

Name Type Description

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

Dispose(Boolean)

Return Value

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

Parameters

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

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

DrawCore(MapArguments, OverlayRefreshType)

Return Value

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

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –>
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.AndroidEdition.OverlayRefreshType –>

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

DrawException(GeoCanvas, Exception)

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

Remarks

This method can be overriden its logic by rewrite the DrawExceptionCore.

Return Value

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

Parameters

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

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

DrawExceptionCore(GeoCanvas, Exception)

This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.

Return Value

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

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>
ex Exception<!– System.Exception –> The exception thrown when layer.Draw().

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

DrawTile(TileView, MapArguments)

Redraws a specified tile with the provided world extent.

Return Value

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

Parameters

Name Type Description
tile TileView<!– ThinkGeo.MapSuite.AndroidEdition.TileView –> A Tile object that is created by the GetTile(Context) method to draw.
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –> This parameter maintains current map information for calculating mechanism.

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

DrawTileCore(GeoCanvas, TileView)

Redraws a specified tile with the provided world extent.

Return Value

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

Parameters

Name Type Description
geoCanvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> This parameter is the canvas object to draw on.
tile TileView<!– ThinkGeo.MapSuite.AndroidEdition.TileView –> A Tile object that is created by the GetTile(Context) method to draw.

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay(overriden) –> Go Back

Finalize()

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.AndroidEdition.Overlay(overriden) –> Go Back

GetTile(Context)

Get a new tile object to form the TileOverlay.

Return Value

Return Type Description
TileView<!– ThinkGeo.MapSuite.AndroidEdition.TileView –>

Parameters

Name Type Description
context Context<!– Android.Content.Context –> Interface to global information about an application environment.

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

GetTileCore(Context)

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

Return Value

Return Type Description
TileView<!– ThinkGeo.MapSuite.AndroidEdition.TileView –> A tile object to form the TileOverlay.

Parameters

Name Type Description
context Context<!– Android.Content.Context –> Interface to global information about an application environment.

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

GetTileMatrix(Double, Int32, Int32, GeographyUnit)

Gets the tile matrix.

Return Value

Return Type Description
TileMatrix<!– ThinkGeo.MapSuite.Core.TileMatrix –> TileMatrix.

Parameters

Name Type Description
scale Double<!– System.Double –> The scale.
tileWidth Int32<!– System.Int32 –> Width of the tile.
tileHeight Int32<!– System.Int32 –> Height of the tile.
boundingBoxUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –> The bounding box unit.

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay(overriden) –> Go Back

GetTileMatrixCells(MapArguments, Double)

Return Value

Return Type Description
Collection<TileMatrixCell><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.TileMatrixCell} –>

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –>
targetScale Double<!– System.Double –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> 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
mapArgument MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –>

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

MemberwiseClone()

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawingException(DrawingExceptionOverlayEventArgs)

This method raises before the overlay is drawing exception.

Return Value

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

Parameters

Name Type Description
args DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs –> This parameter is the event argument for DrawingException event.

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

OnDrawnException(DrawnExceptionOverlayEventArgs)

This method raises after the overlay is drawn exception.

Return Value

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

Parameters

Name Type Description
args DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs –> This parameter is the event argument for DrawingException event.

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

OpenCore()

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

Return Value

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

Parameters

Name Type Description

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

PostTransformCore(TransformArguments, MapArguments)

Return Value

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

Parameters

Name Type Description
transformInfo TransformArguments<!– ThinkGeo.MapSuite.AndroidEdition.TransformArguments –>
mapArguments MapArguments<!– ThinkGeo.MapSuite.AndroidEdition.MapArguments –>

<!– ThinkGeo.MapSuite.AndroidEdition.Overlay(overriden) –> 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.AndroidEdition.Overlay(overriden) –> Go Back

Public Properties

ApplicationId

This property gets or sets an application account registered from Bing Maps Imagery Service.

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.AndroidEdition.BingMapsTileOverlay –> Go Back

Attribution

Gets or sets the attribution for this overlay.

Return Value

Return Type
String<!– System.String –>

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

DrawingExceptionMode

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

Return Value

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

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

DrawingQuality

Gets or sets the drawingQuality for this overlay.

Return Value

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

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

IsVisible

Return Value

Return Type
Boolean<!– System.Boolean –>

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

LayerType

Gets or sets the LayerType of the Overlay.

Return Value

Return Type
LayerType<!– Android.Views.LayerType –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

MapArguments

Gets or sets the mapArguments for this overlay.

Return Value

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

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

MapType

This property gets or sets the requesting map type from Bing Maps Imagery Service.

Return Value

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

<!– ThinkGeo.MapSuite.AndroidEdition.BingMapsTileOverlay –> Go Back

Name

Gets or sets the name of this overaly.

Return Value

Return Type
String<!– System.String –>

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

Opacity

Gets or sets the opacity for this overlay.

Return Value

Return Type
Double<!– System.Double –>

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

TileCache

Gets and sets a tile cache object for saving the tiles.

Return Value

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

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

TileSnappingMode

Gets or sets the tile snapping mode.

Return Value

Return Type
TileSnappingMode<!– ThinkGeo.MapSuite.AndroidEdition.TileSnappingMode –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

TileType

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

Return Value

Return Type
TileType<!– ThinkGeo.MapSuite.AndroidEdition.TileType –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

TransitionEffect

Gets and sets the transition effect of the overlay when zooming. After zooming, the existing tiles stretch and leave in current viewport. Set to None when its background is transparent.

Return Value

Return Type
TransitionEffect<!– ThinkGeo.MapSuite.AndroidEdition.TransitionEffect –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

Protected Properties

SingleTile

Gets or sets the single tile.

Return Value

Return Type
TileView<!– ThinkGeo.MapSuite.AndroidEdition.TileView –>

<!– ThinkGeo.MapSuite.AndroidEdition.TileOverlay –> Go Back

Public Events

DrawingException

Occurs before exception is drawing on map.

Event Arguments

Event Arguments
DrawingExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawingExceptionOverlayEventArgs –>

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

DrawnException

Occurs after exception is drawn on map.

Event Arguments

Event Arguments
DrawnExceptionOverlayEventArgs<!– ThinkGeo.MapSuite.AndroidEdition.DrawnExceptionOverlayEventArgs –>

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

NOTOC AndroidEdition ThinkGeo.MapSuite.AndroidEdition UpdateDocumentation

thinkgeo.mapsuite.androidedition.bingmapstileoverlay.1440040127.txt.gz · Last modified: 2015/09/21 10:28 (external edit)