User Tools

Site Tools


thinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay

This is an old revision of the document!


Table of Contents

ThinkGeo.MapSuite.WpfDesktopEdition.BingMapsTileOverlay

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

Remarks

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodBingMapsTileOverlay This is constructor of BingMapsTileOverlay class.
Public MethodBingMapsTileOverlay String This is constructor of BingMapsTileOverlay class.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodClose Overlay
Public MethodDispose Overlay This method dispose unmanaged resource used in this class.
Public MethodDraw RectangleShape Overlay This method draws the overlay with the provided extent in world coordinate.
Public MethodDraw RectangleShape, 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 MethodLoadState Byte[] Overlay This method restore the overlay state back from the specified state.
Public MethodOpen Overlay
Public MethodPanTo RectangleShape Overlay This method pans the overlay to the provided world extent.
Public MethodRefresh IEnumerable<RectangleShape> Overlay
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 MethodRefresh RectangleShape Overlay
Public MethodRefresh IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRefresh IEnumerable<RectangleShape>, TimeSpan Overlay
Public MethodRefresh RectangleShape, TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodRefresh RectangleShape, TimeSpan Overlay
Public MethodRefresh TimeSpan Overlay
Public MethodRefresh TimeSpan, RequestDrawingBufferTimeType Overlay
Public MethodSaveState Overlay This method saves overlay state to a byte array.
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodCloseCore Overlay
Protected MethodDispose Boolean Overlay(overriden)
Protected MethodDrawAttributionCore GeoCanvas Overlay
Protected MethodDrawCore RectangleShape, OverlayRefreshType Overlay(overriden)
Protected MethodDrawException GeoCanvas, Exception TileOverlay 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 TileOverlay This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
Protected MethodDrawStretchTiles RectangleShape TileOverlay
Protected MethodDrawTile Tile, RectangleShape TileOverlay Redraws a specified tile with the provided world extent.
Protected MethodDrawTileCore Tile, RectangleShape TileOverlay(overriden) This method redraws a tile by an extent and geography unit.
Protected MethodFinalize Object(overriden)
Protected MethodGetBoundingBoxCore Overlay(overriden)
Protected MethodGetDrawingCells RectangleShape TileOverlay This method gets the cells for drawing in the passed world extent.
Protected MethodGetDrawingCellsCore RectangleShape TileOverlay(overriden)
Protected MethodGetSortedCells Dictionary<String, TileMatrixCell>, RectangleShape TileOverlay
Protected MethodGetSortedCellsCore Dictionary<String, TileMatrixCell>, RectangleShape TileOverlay
Protected MethodGetTileCore TileOverlay(overriden) This method overrides from its base class TileOverlay.
Protected MethodGetTileMatrix Double, Int32, Int32, GeographyUnit TileOverlay(overriden)
Protected MethodInitializeCore MapArguments Overlay(overriden)
Protected MethodLoadStateCore Byte[] Overlay(overriden)
Protected MethodMemberwiseClone Object
Protected MethodOnDrawTilesProgressChanged DrawTilesProgressChangedTileOverlayEventArgs TileOverlay Occurs when Tiles' download progress is changed.
Protected MethodOnDrawing DrawingOverlayEventArgs Overlay This method raises before the overlay is drawing.
Protected MethodOnDrawingAttribution DrawingAttributionOverlayEventArgs Overlay
Protected MethodOnDrawingException DrawingExceptionTileOverlayEventArgs TileOverlay
Protected MethodOnDrawingTile DrawingTileTileOverlayEventArgs TileOverlay This method raises before a tile is drawing.
Protected MethodOnDrawn DrawnOverlayEventArgs Overlay This method raises after the overlay is drawn.
Protected MethodOnDrawnAttribution DrawnAttributionOverlayEventArgs Overlay
Protected MethodOnDrawnException DrawnExceptionTileOverlayEventArgs TileOverlay
Protected MethodOnDrawnTile DrawnTileTileOverlayEventArgs TileOverlay This method raises after a tile is drawn.
Protected MethodOnSendingWebRequest SendingWebRequestEventArgs
Protected MethodOnSentWebRequest SentWebRequestEventArgs
Protected MethodOnTileTypeChanged TileTypeChangedTileOverlayEventArgs TileOverlay
Protected MethodOpenCore Overlay
Protected MethodPanToCore RectangleShape Overlay This method pans the overlay to the provided world extent.
Protected MethodPrefillDataToTiles IEnumerable<Tile> TileOverlay
Protected MethodPrefillDataToTilesCore IEnumerable<Tile> TileOverlay
Protected MethodRefreshCore RectangleShape Overlay
Protected MethodRefreshCore Overlay(overriden)
Protected MethodSaveStateCore Overlay(overriden)

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
Public PropertyAutoRefreshInterval TimeSpan Overlay
Public PropertyCanRefreshRegion Boolean Overlay
Public PropertyDrawingExceptionMode DrawingExceptionMode Overlay This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.
Public PropertyImageFormat TileImageFormat TileOverlay Gets and sets drawing format for the tiles.
Public PropertyIsBase Boolean Overlay
Public PropertyIsEmpty Boolean Overlay This property gets if this overlay is empty or not.
Public PropertyIsVisible Boolean Overlay(overriden)
Public PropertyJpegQuality Int32 TileOverlay Gets or sets the image quality when the TileImageFormat is Jpeg; otherwise this property has no effects. Its default value is 80.
Public PropertyLogo GeoImage
Public PropertyMapArguments MapArguments Overlay Gets or sets current map information which will be used for calculating mechanism.
Public PropertyMapStyle BingMapsMapType This property gets or sets the requesting map type from Bing Maps Imagery Service.
Public PropertyMaxExtent RectangleShape TileOverlay This property gets or sets the max extent of matrix to calculate the tiles.
Public PropertyName String Overlay Gets or sets the name of this overaly.
Public PropertyOverlayCanvas Canvas Overlay Gets or sets the actual canvas which maintains all the visual elements on the overlay.
Public PropertyTileBuffer Int32 TileOverlay This property gets and sets the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.
Public PropertyTileCache BitmapTileCache TileOverlay Gets and sets a tile cache object for saving the tiles.
Public PropertyTileHeight Int32 TileOverlay Gets and sets the height of the tile.
Public PropertyTileType TileType TileOverlay Gets and sets the overlay is formed by multiple tiles or single tile.
Public PropertyTileWidth Int32 TileOverlay Gets and sets the width of the tile.
Public PropertyTimeoutInSeconds Int32 Gets or sets the length of time, in seconds, before the request times out.
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.
Public PropertyWebProxy WebProxy This property gets or sets the proxy used for requesting a Web Response.
Public PropertyWrappingExtent RectangleShape TileOverlay
Public PropertyWrappingMode WrappingMode TileOverlay Thie property gets or sets whether allow wrap date line.

Protected Properties

Name Return DeclaringType Summary
Protected PropertyDrawingCanvas Canvas TileOverlay Gets current drawing canvas which holds actual tile controls.
Protected PropertyIsOverlayInitialized Boolean Overlay Gets or sets if the overlay canvas is initialized.
Protected PropertyPreviousExtent RectangleShape Overlay Gets or sets the previous exent of the overlay.
Protected PropertyStretchCanvas Canvas TileOverlay Gets current stretch canvas which holds stretched tile controls during the stretch transition.

Public Events

Public Constructors

BingMapsTileOverlay()

This is constructor of BingMapsTileOverlay class.

Remarks

Parameters

Name Type Description

Go Back

BingMapsTileOverlay(String)

This is constructor of BingMapsTileOverlay class.

Remarks

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()

Remarks

Return Value

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

Parameters

Name Type Description

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

Dispose()

This method dispose unmanaged resource used in this class.

Remarks

Return Value

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

Parameters

Name Type Description

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

Draw(RectangleShape)

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

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter indicates an extent in world coordinate for drawing the overlay.

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

Draw(RectangleShape, OverlayRefreshType)

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

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter indicates an extent in world coordinate for drawing the overlay.
refreshType OverlayRefreshType<!– ThinkGeo.MapSuite.WpfDesktopEdition.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.WpfDesktopEdition.Overlay –> Go Back

Equals(Object)

Remarks

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

GetHashCode()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

GetType()

Remarks

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

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

LoadState(Byte[])

This method restore the overlay state back from the specified state.

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
state Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay –> This parameter indicates the state for restore the overlay.

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

Open()

Remarks

Return Value

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

Parameters

Name Type Description

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

PanTo(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter is the target world extent for panning.

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

Refresh(IEnumerable<RectangleShape>)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>

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

Refresh(RectangleShape)

Remarks

Return Value

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

Parameters

Name Type Description
extent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

Refresh(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

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

Refresh(IEnumerable<RectangleShape>, TimeSpan)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} –>
bufferTime TimeSpan<!– System.TimeSpan –>

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

Refresh(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

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

Refresh(RectangleShape, TimeSpan)

Remarks

Return Value

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

Parameters

Name Type Description
extentToRefresh RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>
bufferTime TimeSpan<!– System.TimeSpan –>

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

Refresh(TimeSpan)

Remarks

Return Value

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

Parameters

Name Type Description
bufferTime TimeSpan<!– System.TimeSpan –>

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

Refresh(TimeSpan, RequestDrawingBufferTimeType)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
bufferTime TimeSpan<!– System.TimeSpan –>
bufferTimeType RequestDrawingBufferTimeType<!– ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType –>

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

SaveState()

This method saves overlay state to a byte array.

Remarks

Return Value

Return Type Description
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay –> A byte array indicates current overlay state.

Parameters

Name Type Description

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

ToString()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

CloseCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

Dispose(Boolean)

Remarks

Return Value

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

Parameters

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

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

DrawAttributionCore(GeoCanvas)

Remarks

Return Value

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

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –>

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

DrawCore(RectangleShape, OverlayRefreshType)

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>
overlayRefreshType OverlayRefreshType<!– ThinkGeo.MapSuite.WpfDesktopEdition.OverlayRefreshType –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.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
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The target canvas to draw the layer.
e Exception<!– System.Exception –> The exception thrown when layer.Draw().

<!– ThinkGeo.MapSuite.WpfDesktopEdition.TileOverlay –> 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.

Remarks

Return Value

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

Parameters

Name Type Description
canvas GeoCanvas<!– ThinkGeo.MapSuite.Core.GeoCanvas –> The target canvas to draw the layer.
e Exception<!– System.Exception –> The exception thrown when layer.Draw().

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

DrawStretchTiles(RectangleShape)

Remarks

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

DrawTile(Tile, RectangleShape)

Redraws a specified tile with the provided world extent.

Remarks

Return Value

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

Parameters

Name Type Description
tile Tile<!– ThinkGeo.MapSuite.WpfDesktopEdition.Tile –> A Tile object that is created by the GetTile() method to draw.
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> A world extent for drawing the passed tile.

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

DrawTileCore(Tile, RectangleShape)

This method redraws a tile by an extent and geography unit.

Remarks

Return Value

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

Parameters

Name Type Description
tile Tile<!– ThinkGeo.MapSuite.WpfDesktopEdition.Tile –> A tile which needs to be redrawn.
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> An extent to be redrawn.

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

Finalize()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object(overriden) –> Go Back

GetBoundingBoxCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

GetDrawingCells(RectangleShape)

This method gets the cells for drawing in the passed world extent.

Remarks

Return Value

Return Type Description
Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –> A dictionary of cells for drawing in the passed world extent.

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> A world extent for getting the drawing cells.

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

GetDrawingCellsCore(RectangleShape)

Remarks

Return Value

Return Type Description
Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –>

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

GetSortedCells(Dictionary<String, TileMatrixCell>, RectangleShape)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –>

Parameters

Name Type Description
cells Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –>
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

GetSortedCellsCore(Dictionary<String, TileMatrixCell>, RectangleShape)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

Return Type Description
Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –>

Parameters

Name Type Description
cells Dictionary<String,TileMatrixCell><!– System.Collections.Generic.Dictionary{System.String,ThinkGeo.MapSuite.Core.TileMatrixCell} –>
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

GetTileCore()

This method overrides from its base class TileOverlay.

Remarks

Return Value

Return Type Description
Tile<!– ThinkGeo.MapSuite.WpfDesktopEdition.Tile –> A BingMapsTile object to form an entire Bing Maps Overlay.

Parameters

Name Type Description

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

GetTileMatrix(Double, Int32, Int32, GeographyUnit)

Remarks

Return Value

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

Parameters

Name Type Description
scale Double<!– System.Double –>
tileWidth Int32<!– System.Int32 –>
tileHeight Int32<!– System.Int32 –>
boundingBoxUnit GeographyUnit<!– ThinkGeo.MapSuite.Core.GeographyUnit –>

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

InitializeCore(MapArguments)

Remarks

Return Value

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

Parameters

Name Type Description
mapArguments MapArguments<!– ThinkGeo.MapSuite.WpfDesktopEdition.MapArguments –>

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

LoadStateCore(Byte[])

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
state Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay –>

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

MemberwiseClone()

Remarks

Return Value

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

Parameters

Name Type Description

<!– System.Object –> Go Back

OnDrawTilesProgressChanged(DrawTilesProgressChangedTileOverlayEventArgs)

Occurs when Tiles' download progress is changed.

Remarks

Return Value

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

Parameters

Name Type Description
args DrawTilesProgressChangedTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawTilesProgressChangedTileOverlayEventArgs –> Event arguments for DownloadProgress event.

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

OnDrawing(DrawingOverlayEventArgs)

This method raises before the overlay is drawing.

Remarks

Return Value

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

Parameters

Name Type Description
e DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs –> This parameter is the event argument for Drawing event.

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

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
args DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs –>

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

OnDrawingException(DrawingExceptionTileOverlayEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
e DrawingExceptionTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingExceptionTileOverlayEventArgs –>

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

OnDrawingTile(DrawingTileTileOverlayEventArgs)

This method raises before a tile is drawing.

Remarks

Return Value

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

Parameters

Name Type Description
args DrawingTileTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingTileTileOverlayEventArgs –> This is an event argument for DrawingTile event.

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

OnDrawn(DrawnOverlayEventArgs)

This method raises after the overlay is drawn.

Remarks

Return Value

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

Parameters

Name Type Description
e DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs –> This parameter is the event argument for Drawn event.

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

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
args DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs –>

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

OnDrawnException(DrawnExceptionTileOverlayEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
e DrawnExceptionTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnExceptionTileOverlayEventArgs –>

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

OnDrawnTile(DrawnTileTileOverlayEventArgs)

This method raises after a tile is drawn.

Remarks

Return Value

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

Parameters

Name Type Description
args DrawnTileTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnTileTileOverlayEventArgs –> This is an event argument for DrawnTile event.

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

OnSendingWebRequest(SendingWebRequestEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
e SendingWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs –>

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

OnSentWebRequest(SentWebRequestEventArgs)

Remarks

Return Value

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

Parameters

Name Type Description
e SentWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SentWebRequestEventArgs –>

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

OnTileTypeChanged(TileTypeChangedTileOverlayEventArgs)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
e TileTypeChangedTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.TileTypeChangedTileOverlayEventArgs –>

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

OpenCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

PanToCore(RectangleShape)

This method pans the overlay to the provided world extent.

Remarks

Some overlay doesn't need to continously drawing all the tile. For example, MarkerOverlay is formed by markers. When mouse down to pan, the markers don't need to redraw, we can only change its position. When mouse up to end panning, we can redraw the overlay for better performance.

Return Value

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

Parameters

Name Type Description
targetExtent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –> This parameter is the target world extent for panning.

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

PrefillDataToTiles(IEnumerable<Tile>)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
tiles IEnumerable<Tile><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WpfDesktopEdition.Tile} –>

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

PrefillDataToTilesCore(IEnumerable<Tile>)

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Return Value

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

Parameters

Name Type Description
tiles IEnumerable<Tile><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.WpfDesktopEdition.Tile} –>

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

RefreshCore(RectangleShape)

Remarks

Return Value

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

Parameters

Name Type Description
extent RectangleShape<!– ThinkGeo.MapSuite.Core.RectangleShape –>

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

RefreshCore()

Remarks

Return Value

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

Parameters

Name Type Description

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

SaveStateCore()

Remarks

Return Value

Return Type Description
Byte[]<!– System.Bytethinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay –>

Parameters

Name Type Description

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

Public Properties

ApplicationId

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

Remarks

Return Value

Return Type
String<!– System.String –>

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

Attribution

Remarks

Return Value

Return Type
String<!– System.String –>

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

AutoRefreshInterval

Remarks

Return Value

Return Type
TimeSpan<!– System.TimeSpan –>

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

CanRefreshRegion

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

DrawingExceptionMode

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

Remarks

Return Value

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

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

ImageFormat

Gets and sets drawing format for the tiles.

Remarks

Return Value

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

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

IsBase

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

IsVisible

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

JpegQuality

Gets or sets the image quality when the TileImageFormat is Jpeg; otherwise this property has no effects. Its default value is 80.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

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

Remarks

Return Value

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

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

MapArguments

Gets or sets current map information which will be used for calculating mechanism.

Remarks

Return Value

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

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

MapStyle

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

Remarks

Return Value

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

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

MaxExtent

This property gets or sets the max extent of matrix to calculate the tiles.

Remarks

By default, MaxExtent is null; the matrix is created depending on the GeographyUnit of current map. When it's DecimalDegree, the matrix' is calculated as (-180, 90, 180, -90) as MaxExtent. While it's not DecimalDegree, the matrix is (-1000000000, 1000000000, 1000000000, -1000000000); It's allowed to modify it to customize the matrix.

Return Value

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

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

Name

Gets or sets the name of this overaly.

Remarks

Return Value

Return Type
String<!– System.String –>

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

OverlayCanvas

Gets or sets the actual canvas which maintains all the visual elements on the overlay.

Remarks

Return Value

Return Type
Canvas<!– System.Windows.Controls.Canvas –>

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

TileBuffer

This property gets and sets the number of extra rows and colums of tiles on each side which will surround the minimum grid tiles to cover the map.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

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

TileCache

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

Remarks

Return Value

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

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

TileHeight

Gets and sets the height of the tile.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

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

TileType

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

Remarks

Return Value

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

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

TileWidth

Gets and sets the width of the tile.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

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

TimeoutInSeconds

Gets or sets the length of time, in seconds, before the request times out.

Remarks

Return Value

Return Type
Int32<!– System.Int32 –>

<!– ThinkGeo.MapSuite.WpfDesktopEdition.BingMapsTileOverlay –> 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.

Remarks

Return Value

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

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

WebProxy

This property gets or sets the proxy used for requesting a Web Response.

Remarks

Return Value

Return Type
WebProxy<!– System.Net.WebProxy –>

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

WrappingExtent

Remarks

Return Value

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

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

WrappingMode

Thie property gets or sets whether allow wrap date line.

Remarks

Return Value

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

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

Protected Properties

DrawingCanvas

Gets current drawing canvas which holds actual tile controls.

Remarks

Return Value

Return Type
Canvas<!– System.Windows.Controls.Canvas –>

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

IsOverlayInitialized

Gets or sets if the overlay canvas is initialized.

Remarks

Return Value

Return Type
Boolean<!– System.Boolean –>

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

PreviousExtent

Gets or sets the previous exent of the overlay.

Remarks

Return Value

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

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

StretchCanvas

Gets current stretch canvas which holds stretched tile controls during the stretch transition.

Remarks

Return Value

Return Type
Canvas<!– System.Windows.Controls.Canvas –>

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

Public Events

DrawTilesProgressChanged

This event raises when download progress is changed.

Remarks

Event Arguments

Event Arguments
DrawTilesProgressChangedTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawTilesProgressChangedTileOverlayEventArgs –>

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

Drawing

This event raises before the overlay is drawing.

Remarks

Event Arguments

Event Arguments
DrawingOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingOverlayEventArgs –>

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

DrawingAttribution

Remarks

Event Arguments

Event Arguments
DrawingAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingAttributionOverlayEventArgs –>

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

DrawingException

Remarks

Event Arguments

Event Arguments
DrawingExceptionTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingExceptionTileOverlayEventArgs –>

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

DrawingTile

This event raises before the tile is drawing.

Remarks

Event Arguments

Event Arguments
DrawingTileTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawingTileTileOverlayEventArgs –>

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

Drawn

This event raises after the overlay is drawn.

Remarks

Event Arguments

Event Arguments
DrawnOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnOverlayEventArgs –>

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

DrawnAttribution

Remarks

Event Arguments

Event Arguments
DrawnAttributionOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnAttributionOverlayEventArgs –>

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

DrawnException

Remarks

Event Arguments

Event Arguments
DrawnExceptionTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnExceptionTileOverlayEventArgs –>

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

DrawnTile

This event raises after the tile is drawn.

Remarks

Event Arguments

Event Arguments
DrawnTileTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.DrawnTileTileOverlayEventArgs –>

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

SendingWebRequest

Remarks

Event Arguments

Event Arguments
SendingWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SendingWebRequestEventArgs –>

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

SentWebRequest

Remarks

Event Arguments

Event Arguments
SentWebRequestEventArgs<!– ThinkGeo.MapSuite.Core.SentWebRequestEventArgs –>

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

TileTypeChanged

Remarks

For the most updated Info for this topic, please check it here:<a href=“” target=“_blank”></a>

Event Arguments

Event Arguments
TileTypeChangedTileOverlayEventArgs<!– ThinkGeo.MapSuite.WpfDesktopEdition.TileTypeChangedTileOverlayEventArgs –>

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

NOTOC WpfDesktopEdition ThinkGeo.MapSuite.WpfDesktopEdition UpdateDocumentation

thinkgeo.mapsuite.wpfdesktopedition.bingmapstileoverlay.1440040136.txt.gz · Last modified: 2015/09/18 03:10 (external edit)