XyzTilesAsyncLayer¶

Namespace: ThinkGeo.Core

Provides shared tile-matrix logic for XYZ-based asynchronous layers.

public abstract class XyzTilesAsyncLayer : AsyncLayer

Inheritance object → LayerBase → AsyncLayer → XyzTilesAsyncLayer

Properties¶

ProjectionConverter¶

Gets or sets the projection converter used to transform coordinates during rendering.

public ProjectionConverter ProjectionConverter { get; set; }

Property Value¶

ProjectionConverter

TileMatrixSet¶

Gets or sets the tile matrix set describing the XYZ grid.

public TileMatrixSet TileMatrixSet { get; set; }

Property Value¶

TileMatrixSet

TileWidth¶

Gets or sets the TileWidth.

public int TileWidth { get; set; }

Property Value¶

int

TileHeight¶

Gets or sets the TileHeight.

public int TileHeight { get; set; }

Property Value¶

int

MaxExtent¶

This is the full extent of the matrix griding the xyz tiles. It's NOT the bounding box of the data itself.

public RectangleShape MaxExtent { get; set; }

Property Value¶

RectangleShape

MapUnit¶

Gets or sets the MapUnit.

public GeographyUnit MapUnit { get; set; }

Property Value¶

GeographyUnit

HasBoundingBox¶

Gets or sets the HasBoundingBox.

public bool HasBoundingBox { get; }

Property Value¶

bool

Name¶

Gets or sets the display name for the layer.

public string Name { get; set; }

Property Value¶

string
The name used to identify the layer within UI components such as legends.

Remarks:

The name is user defined. Assign a descriptive value so tooling such as legends and layer lists can surface a meaningful label to end users.

IsOpen¶

Gets a value indicating whether the layer is currently open.

public bool IsOpen { get; }

Property Value¶

bool
true if the layer has completed its open routine; otherwise, false.

Remarks:

This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.

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.

IsVisible¶

Gets or sets a value indicating whether the layer is visible.

public bool IsVisible { get; set; }

Property Value¶

bool
true to draw the layer; otherwise, false.

Remarks:

If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.

DrawingTime¶

Gets the last recorded drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value¶

TimeSpan
The duration of the most recent draw operation.

Remarks:

We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.

Projection¶

Gets the projection of the layer.

public Projection Projection { get; set; }

Property Value¶

Projection

DrawingExceptionMode¶

Gets or sets how drawing exceptions are handled when the layer renders.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value¶

DrawingExceptionMode

Background¶

Gets or sets the background color used when rendering the layer.

public GeoColor Background { get; set; }

Property Value¶

GeoColor
The fill applied to areas not covered by layer content.

Transparency¶

Gets or sets the amount of transparency applied to the rendered image.

public float Transparency { get; set; }

Property Value¶

float
A value between 0 (fully transparent) and 255 (fully opaque).

BlueTranslation¶

Gets or sets the intensity adjustment applied to the blue channel.

public float BlueTranslation { get; set; }

Property Value¶

float
A value between -255 and 255 representing the blue channel translation.

RedTranslation¶

Gets or sets the intensity adjustment applied to the red channel.

public float RedTranslation { get; set; }

Property Value¶

float
A value between -255 and 255 representing the red channel translation.

GreenTranslation¶

Gets or sets the intensity adjustment applied to the green channel.

public float GreenTranslation { get; set; }

Property Value¶

float
A value between -255 and 255 representing the green channel translation.

KeyColors¶

Gets the collection of key colors that should be rendered as transparent.

public Collection<GeoColor> KeyColors { get; }

Property Value¶

Collection<GeoColor>

Remarks:

Attempting to access this collection when the associated GeoCanvas does not support key colors (see GeoCanvas.SupportKeyColor) results in an exception. Add colors to this collection to ensure they render as transparent.

IsNegative¶

Gets or sets a value indicating whether the image should be rendered with inverted colors.

public bool IsNegative { get; set; }

Property Value¶

bool
true to invert the color channels; otherwise, false.

IsGrayscale¶

Gets or sets a value indicating whether the image should be converted to grayscale prior to rendering.

public bool IsGrayscale { get; set; }

Property Value¶

bool
true to apply a grayscale filter; otherwise, false.

ThreadSafe¶

Gets or sets the threading guarantees provided by the layer implementation.

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value¶

ThreadSafetyLevel
The level of thread safety that callers can expect when interacting with the layer.

ColorMappings¶

Gets the color translation map that will be applied when rendering the layer.

public Dictionary<GeoColor, GeoColor> ColorMappings { get; }

Property Value¶

Dictionary<GeoColor, GeoColor>

WrappingMode¶

Gets or sets how the layer wraps when the map extent crosses world boundaries.

public WrappingMode WrappingMode { get; set; }

Property Value¶

WrappingMode

WrappingExtent¶

Gets or sets the geographic extent to use when wrapping is enabled.

public RectangleShape WrappingExtent { get; set; }

Property Value¶

RectangleShape

Methods¶

GetBoundingBoxCore()¶

Provides the overridable implementation that returns the bounding box that encloses the relevant geometry.

protected RectangleShape GetBoundingBoxCore()

Returns¶

RectangleShape
The result of the operation.

Events¶

DrawingException¶

Occurs when the DrawingException event is raised.

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException¶

Occurs when the DrawnException event is raised.

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;