Class AdornmentLayer

Namespace

ThinkGeo.Core

Assembly

ThinkGeo.Core.dll

This is the base class of AdornmentLayers. The AdornmentLayer is used to place adornments on the map. Two types of AdornmentLayers are provided: ScaleLineAdornmentLayer and ScaleBarAdornmentLayer.

public abstract class AdornmentLayer : Layer

Inheritance

object

Layer

AdornmentLayer

Derived

LegendAdornmentLayer

LogoAdornmentLayer

MagneticDeclinationAdornmentLayer

ScaleBarAdornmentLayer

ScaleLineAdornmentLayer

ScaleTextAdornmentLayer

Inherited Members

Layer.CloneDeep()

Layer.CloneDeepCore()

Layer.LoadLayer(Uri)

Layer.LoadLayer(Stream)

Layer.Open()

Layer.OpenCore()

Layer.Close()

Layer.CloseCore()

Layer.GetBoundingBox()

Layer.GetBoundingBoxCore()

Layer.Draw(GeoCanvas, Collection<SimpleCandidate>)

Layer.DrawWithColorTransformation(GeoCanvas, Collection<SimpleCandidate>, RectangleShape, float, float)

Layer.DrawException(GeoCanvas, Exception)

Layer.DrawExceptionCore(GeoCanvas, Exception)

Layer.OnDrawingException(DrawingExceptionLayerEventArgs)

Layer.OnDrawnException(DrawnExceptionLayerEventArgs)

Layer.IsDrawingNeeded(double)

Layer.IsDrawingNeededCore(double)

Layer.DrawAttributionCore(GeoCanvas, string)

Layer.OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Layer.OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Layer.OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Layer.RequestDrawing()

Layer.RequestDrawing(RectangleShape)

Layer.RequestDrawing(IEnumerable<RectangleShape>)

Layer.RequestDrawing(TimeSpan)

Layer.RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)

Layer.RequestDrawing(RectangleShape, TimeSpan)

Layer.RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)

Layer.RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)

Layer.RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)

Layer.StartRequestDrawing()

Layer.OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Layer.OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Layer.IsOpen

Layer.HasBoundingBox

Layer.IsOpenCore

Layer.DrawingTime

Layer.Name

Layer.Attribution

Layer.IsVisible

Layer.Transparency

Layer.BlueTranslation

Layer.RedTranslation

Layer.GreenTranslation

Layer.KeyColors

Layer.IsNegative

Layer.IsGrayscale

Layer.ColorMappings

Layer.DrawingExceptionMode

Layer.ThreadSafe

Layer.Projection

Layer.Background

Layer.WrappingMode

Layer.WrappingExtent

Layer.RequestDrawingInterval

Layer.DrawingProgressChanged

Layer.DrawingException

Layer.DrawnException

Layer.DrawingAttribution

Layer.DrawnAttribution

Layer.RequestedDrawing

Layer.RequestingDrawing

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

AdornmentLayer()

This method is the default constructor for the AdornmentLayer.

protected AdornmentLayer()

Remarks

None

Properties

BackgroundMask

public AreaStyle BackgroundMask { get; set; }

Property Value

AreaStyle

Height

public float Height { get; set; }

Property Value

float

Location

This property gets and sets the drawing location of the AdornmentLayer.

public AdornmentLocation Location { get; set; }

Property Value

AdornmentLocation

Width

public float Width { get; set; }

Property Value

float

XOffsetInPixel

This property gets and sets the X pixel offset for the AdornmentLayer.

public float XOffsetInPixel { get; set; }

Property Value

float

Remarks

This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment.

YOffsetInPixel

This property gets and sets the Y pixel offset for the AdornmentLayer.

public float YOffsetInPixel { get; set; }

Property Value

float

Remarks

This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment.

Methods

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

This method draws the AdornmentLayer.

protected override void DrawCore(GeoCanvas canvas, Collection<SimpleCandidate> labelsInAllLayers)

Parameters

canvas GeoCanvas

This parameter is the view object (or a NativeImage) to draw on.

labelsInAllLayers Collection<SimpleCandidate>

This parameter represents the labels used for collision detection and duplication checking.

Remarks

This virtual method is called from the concrete public method Draw. This method draws the representation of the layer based on the extent you provided.

You can use the full power of the GeoCanvas to do the drawing.

Exceptions

ArgumentNullException

If you pass a null as the geoCanvas, we will throw an ArgumentNullException.

ArgumentNullException

If you pass a null as the labelsInAllLayers, we will throw an ArgumentNullException.

GetDrawingLocation(GeoCanvas, float, float)

This method returns the drawing location of the AdornmentLayer.

public virtual ScreenPointF GetDrawingLocation(GeoCanvas canvas, float adornmentWidth, float adornmentHeight)

Parameters

canvas GeoCanvas

This parameter is the view used in drawing.

adornmentWidth float

This parameter is the width of the adornment.

adornmentHeight float

This parameter is the height of the adornment

Returns

ScreenPointF

It returns the upper left screen point of where the AdornmentLayer will be drawn.