Skip to content

LayerOverlay

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
LayerOverlay()
LayerOverlay(IEnumerable<Layer>)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
Attribution String N/A
AutoRefreshInterval TimeSpan N/A
CanRefreshRegion Boolean N/A
DrawingExceptionMode DrawingExceptionMode N/A
DrawingQuality DrawingQuality N/A
ImageFormat RasterTileFormat N/A
IsBase Boolean N/A
IsCacheOnly Boolean N/A
IsEmpty Boolean This property indicates whether this overlay is empty or not.
IsVisible Boolean N/A
JpegQuality Int32 N/A
Layers GeoCollection<Layer> Gets a GeoCollection that contains the layers that will draw on the image.
MapArguments MapArguments N/A
MaxExtent RectangleShape N/A
Name String N/A
OverlayCanvas Canvas N/A
RenderMode RenderMode N/A
TileBuffer Int32 N/A
TileCache RasterTileCache N/A
TileHeight Int32 N/A
TileResolution TileResolution N/A
TileSizeMode TileSizeMode N/A
TileSnappingMode TileSnappingMode N/A
TileType TileType N/A
TileWidth Int32 N/A
WrappingExtent RectangleShape N/A
WrappingMode WrappingMode N/A

Protected Properties Summary

Name Return Type Description
DrawingCanvas Canvas N/A
IsOverlayInitialized Boolean N/A
PreviousExtent RectangleShape N/A
PreviousScale Double N/A

Public Methods Summary

Name
ClearTiles()
Close()
Dispose()
Draw(RectangleShape)
Draw(RectangleShape,OverlayRefreshType)
Equals(Object)
GetBoundingBox()
GetHashCode()
GetType()
Initialize(MapArguments)
LoadState(Byte[])
Open()
PanTo(RectangleShape)
Refresh(RectangleShape)
Refresh()
Refresh(IEnumerable<RectangleShape>)
Refresh(TimeSpan)
Refresh(TimeSpan,RequestDrawingBufferTimeType)
Refresh(RectangleShape,TimeSpan)
Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
Refresh(IEnumerable<RectangleShape>,TimeSpan)
Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
SaveState()
ToString()

Protected Methods Summary

Name
CloseCore()
Dispose(Boolean)
DrawAttribution(GeoCanvas)
DrawAttributionCore(GeoCanvas)
DrawCore(RectangleShape,OverlayRefreshType)
DrawException(GeoCanvas,Exception)
DrawExceptionCore(GeoCanvas,Exception)
DrawTile(TileView,MapArguments)
DrawTileAsync(TileView,MapArguments)
DrawTileCore(GeoCanvas,TileView)
DrawTileCoreAsync(GeoCanvas,TileView)
Finalize()
GetBoundingBoxCore()
GetBufferedExtent(RectangleShape,Double)
GetDrawingCells(RectangleShape)
GetDrawingCellsCore(RectangleShape)
GetSortedCells(Dictionary<String,MatrixCell>,RectangleShape)
GetSortedCellsCore(Dictionary<String,MatrixCell>,RectangleShape)
GetTile(RectangleShape,Int32,Int32,Int64,Int64,Int32)
GetTileCore()
GetTileMatrix(Double)
InitializeCore(MapArguments)
LoadStateCore(Byte[])
MemberwiseClone()
OnDrawing(DrawingOverlayEventArgs)
OnDrawingAttribution(DrawingAttributionOverlayEventArgs)
OnDrawingException(DrawingExceptionTileOverlayEventArgs)
OnDrawingTile(DrawingTileTileOverlayEventArgs)
OnDrawn(DrawnOverlayEventArgs)
OnDrawnAttribution(DrawnAttributionOverlayEventArgs)
OnDrawnException(DrawnExceptionTileOverlayEventArgs)
OnDrawnTile(DrawnTileTileOverlayEventArgs)
OnDrawTilesProgressChanged(DrawTilesProgressChangedTileOverlayEventArgs)
OnRefreshing(OverlayRefreshType)
OnTileTypeChanged(TileTypeChangedTileOverlayEventArgs)
OnTileTypeChanging(TileTypeChangingTileOverlayEventArgs)
OpenCore()
PanToCore(RectangleShape)
PrefillDataToTiles(IEnumerable<TileView>)
PrefillDataToTilesCore(IEnumerable<TileView>)
RefreshCore(RectangleShape)
RefreshCore()
SaveStateCore()

Public Events Summary

Name Event Arguments Description
DrawTilesProgressChanged DrawTilesProgressChangedTileOverlayEventArgs N/A
DrawingTile DrawingTileTileOverlayEventArgs N/A
DrawnTile DrawnTileTileOverlayEventArgs N/A
DrawingException DrawingExceptionTileOverlayEventArgs N/A
DrawnException DrawnExceptionTileOverlayEventArgs N/A
TileTypeChanged TileTypeChangedTileOverlayEventArgs N/A
TileTypeChanging TileTypeChangingTileOverlayEventArgs N/A
Drawing DrawingOverlayEventArgs N/A
Drawn DrawnOverlayEventArgs N/A
DrawingAttribution DrawingAttributionOverlayEventArgs N/A
DrawnAttribution DrawnAttributionOverlayEventArgs N/A

Members Detail

Public Constructors

Name
LayerOverlay()
LayerOverlay(IEnumerable<Layer>)

Protected Constructors

Public Properties

Attribution

Summary

N/A

Remarks

N/A

Return Value

String


AutoRefreshInterval

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


CanRefreshRegion

Summary

N/A

Remarks

N/A

Return Value

Boolean


DrawingExceptionMode

Summary

N/A

Remarks

N/A

Return Value

DrawingExceptionMode


DrawingQuality

Summary

N/A

Remarks

N/A

Return Value

DrawingQuality


ImageFormat

Summary

N/A

Remarks

N/A

Return Value

RasterTileFormat


IsBase

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsCacheOnly

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsEmpty

Summary

This property indicates whether this overlay is empty or not.

Remarks

N/A

Return Value

Boolean


IsVisible

Summary

N/A

Remarks

N/A

Return Value

Boolean


JpegQuality

Summary

N/A

Remarks

N/A

Return Value

Int32


Layers

Summary

Gets a GeoCollection that contains the layers that will draw on the image.

Remarks

The Layers property holds all of the layers that are used by the Draw method. The Draw method loops through all layers to filter out features and draw on the image with the specified styles.

Return Value

GeoCollection<Layer>


MapArguments

Summary

N/A

Remarks

N/A

Return Value

MapArguments


MaxExtent

Summary

N/A

Remarks

N/A

Return Value

RectangleShape


Name

Summary

N/A

Remarks

N/A

Return Value

String


OverlayCanvas

Summary

N/A

Remarks

N/A

Return Value

Canvas


RenderMode

Summary

N/A

Remarks

N/A

Return Value

RenderMode


TileBuffer

Summary

N/A

Remarks

N/A

Return Value

Int32


TileCache

Summary

N/A

Remarks

N/A

Return Value

RasterTileCache


TileHeight

Summary

N/A

Remarks

N/A

Return Value

Int32


TileResolution

Summary

N/A

Remarks

N/A

Return Value

TileResolution


TileSizeMode

Summary

N/A

Remarks

N/A

Return Value

TileSizeMode


TileSnappingMode

Summary

N/A

Remarks

N/A

Return Value

TileSnappingMode


TileType

Summary

N/A

Remarks

N/A

Return Value

TileType


TileWidth

Summary

N/A

Remarks

N/A

Return Value

Int32


WrappingExtent

Summary

N/A

Remarks

N/A

Return Value

RectangleShape


WrappingMode

Summary

N/A

Remarks

N/A

Return Value

WrappingMode


Protected Properties

DrawingCanvas

Summary

N/A

Remarks

N/A

Return Value

Canvas


IsOverlayInitialized

Summary

N/A

Remarks

N/A

Return Value

Boolean


PreviousExtent

Summary

N/A

Remarks

N/A

Return Value

RectangleShape


PreviousScale

Summary

N/A

Remarks

N/A

Return Value

Double


Public Methods

ClearTiles()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Close()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Dispose()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Draw(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A

Draw(RectangleShape,OverlayRefreshType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A
refreshType OverlayRefreshType N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetBoundingBox()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

Initialize(MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
mapArguments MapArguments N/A

LoadState(Byte[])

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
state Byte[] N/A

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

PanTo(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A

Refresh(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extent RectangleShape N/A

Refresh()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Refresh(IEnumerable<RectangleShape>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A

Refresh(TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A

Refresh(TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

Refresh(RectangleShape,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A

Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A

Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

SaveState()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Byte[] N/A

Parameters

Name Type Description
N/A N/A N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

CloseCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Dispose(Boolean)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
disposing Boolean N/A

DrawAttribution(GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A

DrawAttributionCore(GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A

DrawCore(RectangleShape,OverlayRefreshType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A
overlayRefreshType OverlayRefreshType N/A

DrawException(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

DrawExceptionCore(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

DrawTile(TileView,MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
tile TileView N/A
mapArguments MapArguments N/A

DrawTileAsync(TileView,MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Task N/A

Parameters

Name Type Description
tile TileView N/A
mapArguments MapArguments N/A

DrawTileCore(GeoCanvas,TileView)

Summary

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

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
geoCanvas GeoCanvas N/A
tile TileView A tile which needs to be redrawn.

DrawTileCoreAsync(GeoCanvas,TileView)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Task N/A

Parameters

Name Type Description
geoCanvas GeoCanvas N/A
tile TileView N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetBoundingBoxCore()

Summary

This method gets a bounding box that holds all the layers which are added in this overlay.

Remarks

N/A

Return Value

Type Description
RectangleShape A RectangleShape value that holds all the layers which are added in this overlay.

Parameters

Name Type Description
N/A N/A N/A

GetBufferedExtent(RectangleShape,Double)

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A
resolution Double N/A

GetDrawingCells(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Dictionary<String,MatrixCell> N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A

GetDrawingCellsCore(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Dictionary<String,MatrixCell> N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A

GetSortedCells(Dictionary<String,MatrixCell>,RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Dictionary<String,MatrixCell> N/A

Parameters

Name Type Description
cells Dictionary<String,MatrixCell> N/A
targetExtent RectangleShape N/A

GetSortedCellsCore(Dictionary<String,MatrixCell>,RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Dictionary<String,MatrixCell> N/A

Parameters

Name Type Description
cells Dictionary<String,MatrixCell> N/A
targetExtent RectangleShape N/A

GetTile(RectangleShape,Int32,Int32,Int64,Int64,Int32)

Summary

N/A

Remarks

N/A

Return Value

Type Description
TileView N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A
tileScreenWidth Int32 N/A
tileScreenHeight Int32 N/A
tileColumnIndex Int64 N/A
tileRowIndex Int64 N/A
zoomLevelIndex Int32 N/A

GetTileCore()

Summary

This method gets a specific tile object to form an overlay.

Remarks

N/A

Return Value

Type Description
TileView A TileView object to form an overlay.

Parameters

Name Type Description
N/A N/A N/A

GetTileMatrix(Double)

Summary

N/A

Remarks

N/A

Return Value

Type Description
TileMatrix N/A

Parameters

Name Type Description
scale Double N/A

InitializeCore(MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
mapArguments MapArguments N/A

LoadStateCore(Byte[])

Summary

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

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
state Byte[] This parameter indicates the state for restore the overlay.

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnDrawing(DrawingOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingOverlayEventArgs N/A

OnDrawingAttribution(DrawingAttributionOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingAttributionOverlayEventArgs N/A

OnDrawingException(DrawingExceptionTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingExceptionTileOverlayEventArgs N/A

OnDrawingTile(DrawingTileTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingTileTileOverlayEventArgs N/A

OnDrawn(DrawnOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawnOverlayEventArgs N/A

OnDrawnAttribution(DrawnAttributionOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnAttributionOverlayEventArgs N/A

OnDrawnException(DrawnExceptionTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawnExceptionTileOverlayEventArgs N/A

OnDrawnTile(DrawnTileTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnTileTileOverlayEventArgs N/A

OnDrawTilesProgressChanged(DrawTilesProgressChangedTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawTilesProgressChangedTileOverlayEventArgs N/A

OnRefreshing(OverlayRefreshType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
refreshType OverlayRefreshType N/A

OnTileTypeChanged(TileTypeChangedTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e TileTypeChangedTileOverlayEventArgs N/A

OnTileTypeChanging(TileTypeChangingTileOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e TileTypeChangingTileOverlayEventArgs N/A

OpenCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

PanToCore(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
targetExtent RectangleShape N/A

PrefillDataToTiles(IEnumerable<TileView>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
tiles IEnumerable<TileView> N/A

PrefillDataToTilesCore(IEnumerable<TileView>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
tiles IEnumerable<TileView> N/A

RefreshCore(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extent RectangleShape N/A

RefreshCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

SaveStateCore()

Summary

This method saves overlay state to a byte array.

Remarks

N/A

Return Value

Type Description
Byte[] A byte array indicates current overlay state.

Parameters

Name Type Description
N/A N/A N/A

Public Events

DrawTilesProgressChanged

N/A

Remarks

N/A

Event Arguments

DrawTilesProgressChangedTileOverlayEventArgs

DrawingTile

N/A

Remarks

N/A

Event Arguments

DrawingTileTileOverlayEventArgs

DrawnTile

N/A

Remarks

N/A

Event Arguments

DrawnTileTileOverlayEventArgs

DrawingException

N/A

Remarks

N/A

Event Arguments

DrawingExceptionTileOverlayEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments

DrawnExceptionTileOverlayEventArgs

TileTypeChanged

N/A

Remarks

N/A

Event Arguments

TileTypeChangedTileOverlayEventArgs

TileTypeChanging

N/A

Remarks

N/A

Event Arguments

TileTypeChangingTileOverlayEventArgs

Drawing

N/A

Remarks

N/A

Event Arguments

DrawingOverlayEventArgs

Drawn

N/A

Remarks

N/A

Event Arguments

DrawnOverlayEventArgs

DrawingAttribution

N/A

Remarks

N/A

Event Arguments

DrawingAttributionOverlayEventArgs

DrawnAttribution

N/A

Remarks

N/A

Event Arguments

DrawnAttributionOverlayEventArgs