LayerOverlay &para;

Layers¶

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

public GeoCollection<LayerBase> Layers { get; }

Property Value¶

GeoCollection<LayerBase>
A GeoCollection of layers.

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.

ImageFormat¶

Gets and sets drawing format for the tiles.

public GeoImageFormat ImageFormat { get; set; }

Property Value¶

GeoImageFormat

JpegQuality¶

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

public int JpegQuality { get; set; }

Property Value¶

IsCacheOnly¶

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

public bool IsCacheOnly { get; set; }

Property Value¶

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

Opacity¶

public double Opacity { get; set; }

Property Value¶

Double

IsVisible¶

Gets or sets if this overlay is visible.

public bool IsVisible { get; set; }

Property Value¶

DrawingQuality¶

public DrawingQuality DrawingQuality { get; set; }

Property Value¶

DrawingQuality

TileSizeMode¶

Gets or sets the tile size mode.

public TileSizeMode TileSizeMode { get; set; }

Property Value¶

TileSizeMode

        The tile size mode.

TileType¶

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

public TileType TileType { get; set; }

Property Value¶

TileType

TileWidth¶

Gets and sets the width of the tile.

public int TileWidth { get; set; }

Property Value¶

TileHeight¶

Gets and sets the height of the tile.

public int TileHeight { get; set; }

Property Value¶

TileCache¶

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

public RasterTileCache TileCache { get; set; }

Property Value¶

RasterTileCache

TileSnappingMode¶

Gets or sets the tileView snapping mode.

public TileSnappingMode TileSnappingMode { get; set; }

Property Value¶

TileSnappingMode

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.

public int TileBuffer { get; set; }

Property Value¶

MaxExtent¶

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

public RectangleShape MaxExtent { get; set; }

Property Value¶

RectangleShape

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 (-20037508.2314698, 20037508.2314698, 20037508.2314698, -20037508.2314698); It's allowed to modify it to customize the matrix.

WrappingMode¶

Thie property gets or sets whether allow wrap date line.

public WrappingMode WrappingMode { get; set; }

Property Value¶

WrappingMode

WrappingExtent¶

public RectangleShape WrappingExtent { get; set; }

Property Value¶

RectangleShape

CanRefreshRegion¶

public bool CanRefreshRegion { get; protected set; }

Property Value¶

IsBase¶

public bool IsBase { get; set; }

Property Value¶

Name¶

Gets or sets the name of this overaly.

public string Name { get; set; }

Property Value¶

String

MapArguments¶

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

public MapArguments MapArguments { get; set; }

Property Value¶

MapArguments

OverlayCanvas¶

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

public Canvas OverlayCanvas { get; set; }

Property Value¶

Canvas

DrawingExceptionMode¶

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

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

Attribution¶

public string Attribution { get; set; }

Property Value¶

String

AutoRefreshInterval¶

public TimeSpan AutoRefreshInterval { get; set; }

Property Value¶

TimeSpan

Constructors¶

LayerOverlay()¶

Constructor of LayerOverlay class.

public LayerOverlay()

LayerOverlay(IEnumerable<LayerBase>)¶

Constructor of LayerOverlay class.

public LayerOverlay(IEnumerable<LayerBase> layers)

Parameters¶

layers IEnumerable<LayerBase>
This parameter indicates a layer collection which needs to be drawn.

Methods¶

RefreshAsyncCore(RectangleShape, CancellationToken)¶

protected Task RefreshAsyncCore(RectangleShape extent, CancellationToken cancellationToken)

Parameters¶

extent RectangleShape

cancellationToken CancellationToken

Returns¶

OnTileTypeChanged(TileTypeChangedTileOverlayEventArgs)¶

protected void OnTileTypeChanged(TileTypeChangedTileOverlayEventArgs e)

Parameters¶

e TileTypeChangedTileOverlayEventArgs

Dispose(Boolean)¶

protected void Dispose(bool disposing)

Parameters¶

disposing Boolean

SaveStateCore()¶

This method saves overlay state to a byte array.

protected Byte[] SaveStateCore()

Returns¶

Byte[]
A byte array indicates current overlay state.

LoadStateCore(Byte[])¶

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

protected void LoadStateCore(Byte[] state)

Parameters¶

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

GetTileCore()¶

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

protected TileView GetTileCore()

Returns¶

TileView
A TileView object to form an overlay.

DrawAsyncCore(RectangleShape, OverlayRefreshType, CancellationToken)¶

protected Task DrawAsyncCore(RectangleShape targetExtent, OverlayRefreshType overlayRefreshType, CancellationToken cancellationToken)

Parameters¶

targetExtent RectangleShape

overlayRefreshType OverlayRefreshType

cancellationToken CancellationToken

Returns¶

DrawExceptionCore(GeoCanvas, Exception)¶

protected void DrawExceptionCore(GeoCanvas canvas, Exception e)

Parameters¶

canvas GeoCanvas

e Exception

GetBoundingBoxCore()¶

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

protected RectangleShape GetBoundingBoxCore()

Returns¶

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

CloseAsyncCore()¶

protected Task CloseAsyncCore()

Returns¶

OpenAsyncCore()¶

protected Task OpenAsyncCore()

Returns¶