Skip to content

LayerOverlay

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name Description
LayerOverlay() Initializes a new instance of the class.
LayerOverlay(IEnumerable<Layer>) Initializes a new instance of the class.

Protected Constructors Summary

Name Description
N/A 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
IsEmpty Boolean N/A
IsVisible Boolean N/A
Layers GeoCollection<Layer> N/A
LayerType LayerType N/A
LockLayerMode LockLayerMode N/A
MapArguments MapArguments N/A
MaxExtent RectangleShape N/A
Name String N/A
Opacity Double N/A
OverlayView MapLayout N/A
TileCache RasterTileCache N/A
TileSizeMode TileSizeMode N/A
TileSnappingMode TileSnappingMode N/A
TileType TileType N/A
TransitionEffect TransitionEffect N/A

Protected Properties Summary

Name Return Type Description
SingleTile TileView N/A

Public Methods Summary

Name Description
Close() N/A
Dispose() N/A
Draw(MapArguments,OverlayRefreshType) N/A
Equals(Object) N/A
GetBoundingBox() N/A
GetHashCode() N/A
GetType() N/A
Initialize(MapArguments) N/A
Open() N/A
PostTransform(TransformArguments,MapArguments) N/A
Refresh() N/A
Refresh(RectangleShape) N/A
Refresh(IEnumerable<RectangleShape>) N/A
Refresh(TimeSpan) N/A
Refresh(TimeSpan,RequestDrawingBufferTimeType) N/A
Refresh(RectangleShape,TimeSpan) N/A
Refresh(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) N/A
Refresh(IEnumerable<RectangleShape>,TimeSpan) N/A
Refresh(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) N/A
ToString() N/A

Protected Methods Summary

Name Description
CloseCore() N/A
Dispose(Boolean) N/A
DrawCore(MapArguments,OverlayRefreshType) N/A
DrawException(GeoCanvas,Exception) N/A
DrawExceptionCore(GeoCanvas,Exception) N/A
DrawTile(TileView,MapArguments) N/A
DrawTileCore(GeoCanvas,TileView) N/A
Finalize() N/A
GetBoundingBoxCore() N/A
GetTile(Context) N/A
GetTileCore(Context) N/A
GetTileMatrix(Double,Int32,Int32,GeographyUnit) N/A
GetTileMatrixCells(MapArguments,Double) N/A
InitializeCore(MapArguments) N/A
MemberwiseClone() N/A
OnDrawingException(DrawingExceptionOverlayEventArgs) N/A
OnDrawnException(DrawnExceptionOverlayEventArgs) N/A
OpenCore() N/A
PostTransformCore(TransformArguments,MapArguments) N/A
RefreshCore() N/A
RefreshCore(RectangleShape) N/A

Public Events Summary

Name Event Arguments Description
DrawingException DrawingExceptionOverlayEventArgs N/A
DrawnException DrawnExceptionOverlayEventArgs N/A

Members Detail

Public Constructors

Name Description
LayerOverlay() Initializes a new instance of the class.
LayerOverlay(IEnumerable<Layer>) Initializes a new instance of the class.

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


IsEmpty

Summary

N/A

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

Boolean


IsVisible

Summary

N/A

Remarks

N/A

Return Value

Boolean


Layers

Summary

N/A

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>


LayerType

Summary

N/A

Remarks

N/A

Return Value

LayerType


LockLayerMode

Summary

N/A

Remarks

N/A

Return Value

LockLayerMode


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


Opacity

Summary

N/A

Remarks

N/A

Return Value

Double


OverlayView

Summary

N/A

Remarks

N/A

Return Value

MapLayout


TileCache

Summary

N/A

Remarks

N/A

Return Value

RasterTileCache


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


TransitionEffect

Summary

N/A

Remarks

N/A

Return Value

TransitionEffect


Protected Properties

SingleTile

Summary

N/A

Remarks

N/A

Return Value

TileView


Public Methods

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(MapArguments,OverlayRefreshType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
mapArguments MapArguments 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

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

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

PostTransform(TransformArguments,MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
transformInfo TransformArguments N/A
mapArguments MapArguments 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(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extent RectangleShape 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

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

DrawCore(MapArguments,OverlayRefreshType)

Summary

N/A

Remarks

This method draws the representation of the overlay based on the extent you provided. When implementing this abstract method, consider each feature and its column data values. You can use the full power of the GeoCanvas to do the drawing. If you need column data for a feature, be sure to override the GetRequiredColumnNamesCore and add the columns you need to the collection. In many of the styles, we add properties that allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.

Return Value

Type Description
Void none

Parameters

Name Type Description
mapArguments MapArguments This parameter maintains current map information for calculating mechanism.
refreshType OverlayRefreshType This parameter indicates whether the elements of this overlay needs to be refreshed. For example, TileOverlay is formed by tiles. When panning the map around, the existing tile doesn't need to be redraw, the only thing we need to do is modifying the position of these tiles. On another hand, when click to change the style of the overlay, we need to redraw the tile images to change the appearance. So we need refresh mode.

DrawException(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
geoCanvas GeoCanvas N/A
exception Exception N/A

DrawExceptionCore(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
geoCanvas GeoCanvas N/A
ex 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

DrawTileCore(GeoCanvas,TileView)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
geoCanvas GeoCanvas This parameter is the canvas object to draw on.
tile TileView A Tile object that is created by the GetTile(Context) method to draw.

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

N/A

Remarks

This method returns the bounding box of the Overlay.

Return Value

Type Description
RectangleShape This method returns the bounding box of the Overlay.

Parameters

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

GetTile(Context)

Summary

N/A

Remarks

N/A

Return Value

Type Description
TileView N/A

Parameters

Name Type Description
context Context N/A

GetTileCore(Context)

Summary

N/A

Remarks

N/A

Return Value

Type Description
TileView A tile object to form the TileOverlay.

Parameters

Name Type Description
context Context Interface to global information about an application environment.

GetTileMatrix(Double,Int32,Int32,GeographyUnit)

Summary

N/A

Remarks

N/A

Return Value

Type Description
TileMatrix N/A

Parameters

Name Type Description
scale Double N/A
tileWidth Int32 N/A
tileHeight Int32 N/A
boundingBoxUnit GeographyUnit N/A

GetTileMatrixCells(MapArguments,Double)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<MatrixCell> N/A

Parameters

Name Type Description
mapArguments MapArguments N/A
targetScale Double N/A

InitializeCore(MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
mapArgument MapArguments N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

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

OnDrawingException(DrawingExceptionOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingExceptionOverlayEventArgs N/A

OnDrawnException(DrawnExceptionOverlayEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnExceptionOverlayEventArgs 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

PostTransformCore(TransformArguments,MapArguments)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
transformInfo TransformArguments N/A
mapArguments MapArguments N/A

RefreshCore()

Summary

N/A

Remarks

The difference from Draw() method is that Refresh() method refreshs all the elements while Draw() does not.

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A 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

Public Events

DrawingException

N/A

Remarks

N/A

Event Arguments

DrawingExceptionOverlayEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments

DrawnExceptionOverlayEventArgs