Skip to content

< Back


MagneticDeclinationAdornmentLayer

Namespace: ThinkGeo.Core

public class MagneticDeclinationAdornmentLayer : AdornmentLayer

Inheritance ObjectLayerAdornmentLayerMagneticDeclinationAdornmentLayer

Properties

GridNorthLineStyle

public LineStyle GridNorthLineStyle { get; set; }

Property Value

LineStyle

TrueNorthLineStyle

public LineStyle TrueNorthLineStyle { get; set; }

Property Value

LineStyle

MagneticNorthLineStyle

public LineStyle MagneticNorthLineStyle { get; set; }

Property Value

LineStyle

TextStyle

public TextStyle TextStyle { get; set; }

Property Value

TextStyle

TrueNorthPointStyle

public PointStyle TrueNorthPointStyle { get; set; }

Property Value

PointStyle

ElevationUnit

public DistanceUnit ElevationUnit { get; set; }

Property Value

DistanceUnit

MagneticFieldPathFilename

International Geomagnetic Reference Field (IGRF)

public string MagneticFieldPathFilename { get; }

Property Value

String

Elevation

public double Elevation { get; set; }

Property Value

Double

SampleDateTime

public DateTime SampleDateTime { get; set; }

Property Value

DateTime

Width

public float Width { get; set; }

Property Value

Single

Height

public float Height { get; set; }

Property Value

Single

BackgroundMask

public AreaStyle BackgroundMask { get; set; }

Property Value

AreaStyle

Location

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

public AdornmentLocation Location { get; set; }

Property Value

AdornmentLocation

XOffsetInPixel

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

public float XOffsetInPixel { get; set; }

Property Value

Single

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

Single

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.

IsOpen

This property returns true if the Layer is open and false if it is not.

public bool IsOpen { get; }

Property Value

Boolean

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.

HasBoundingBox

This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.

public bool HasBoundingBox { get; }

Property Value

Boolean

Remarks:

The default value is false.

DrawingTime

This property gets the last drawing time for the layer.

public TimeSpan DrawingTime { get; protected set; }

Property Value

TimeSpan

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.

Name

This property gets and sets the name for the layer.

public string Name { get; set; }

Property Value

String

Remarks:

The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.

Attribution

public string Attribution { get; set; }

Property Value

String

IsVisible

This property gets and set the visible state of the layer.

public bool IsVisible { get; set; }

Property Value

Boolean

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.

Transparency

This property gets and sets the amount of transparency to apply to the image.

public float Transparency { get; set; }

Property Value

Single
This property gets the amount of transparency to apply to the image.

Remarks:

None

BlueTranslation

This property gets and sets the amount of blue to apply to the image.

public float BlueTranslation { get; set; }

Property Value

Single
This property gets the amount of blue to apply to the image.

Remarks:

None

RedTranslation

This property gets and sets the amount of red to apply to the image.

public float RedTranslation { get; set; }

Property Value

Single
This property gets the amount of red to apply to the image.

Remarks:

None

GreenTranslation

This property gets and sets the amount of green to apply to the image.

public float GreenTranslation { get; set; }

Property Value

Single
This property gets the amount of green to apply to the image.

Remarks:

None

KeyColors

Gets a value represents a collection of key colors. If SupportKeyColor property is false, it will throw exception when you use KeyColors.

public Collection<GeoColor> KeyColors { get; }

Property Value

Collection<GeoColor>

Remarks:

It will make these colors transparent when draw image.

IsNegative

This property gets and sets whether the image should be converted to negative (inverse colors).

public bool IsNegative { get; set; }

Property Value

Boolean
This property gets and sets whether the image should be converted to negative (inverse colors).

Remarks:

None

IsGrayscale

This property gets and sets if the image should be converted to grayscale.

public bool IsGrayscale { get; set; }

Property Value

Boolean

        This property gets and sets if the image should be converted to grayscale.

Remarks:

None

ColorMappings

ColorMapping

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

Property Value

Dictionary<GeoColor, GeoColor>

DrawingExceptionMode

Gets or sets the DrawExceptionMode when exception happens.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value

DrawingExceptionMode

ThreadSafe

public ThreadSafetyLevel ThreadSafe { get; set; }

Property Value

ThreadSafetyLevel

Projection

Gets the projection of the layer.

public Projection Projection { get; set; }

Property Value

Projection

Background

Gets and sets the background of the layer.

public GeoColor Background { get; set; }

Property Value

GeoColor

RequestDrawingInterval

public TimeSpan RequestDrawingInterval { get; set; }

Property Value

TimeSpan

Constructors

MagneticDeclinationAdornmentLayer()

public MagneticDeclinationAdornmentLayer()

MagneticDeclinationAdornmentLayer(ScreenPointF)

public MagneticDeclinationAdornmentLayer(ScreenPointF startPoint)

Parameters

startPoint ScreenPointF

MagneticDeclinationAdornmentLayer(AdornmentLocation)

public MagneticDeclinationAdornmentLayer(AdornmentLocation adornmentLocation)

Parameters

adornmentLocation AdornmentLocation

MagneticDeclinationAdornmentLayer(String, AdornmentLocation)

public MagneticDeclinationAdornmentLayer(string magneticFieldPathFilename, AdornmentLocation adornmentLocation)

Parameters

magneticFieldPathFilename String

adornmentLocation AdornmentLocation

Methods

OnStreamLoading(StreamLoadingEventArgs)

This method allows you to raise the StreamLoading event.

protected void OnStreamLoading(StreamLoadingEventArgs e)

Parameters

e StreamLoadingEventArgs

        This parameter represents the event arguments you want to raise the StreamLoading
        event with.

Remarks:

This method allows you to raise the StreamLoading event. Normally events are not accessible to derived classes, so we exposed a way to raise the event as necessary through this protected method.

GetDrawingLocation(GeoCanvas, Single, Single)

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

Parameters

canvas GeoCanvas

adornmentWidth Single

adornmentHeight Single

Returns

ScreenPointF

GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime)

public static MagneticDeclination GetMagneticDeclination(Feature pointFeature, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime)

Parameters

pointFeature Feature

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

Returns

MagneticDeclination

GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime, String)

public static MagneticDeclination GetMagneticDeclination(Feature pointFeature, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, string magneticFieldPathFilename)

Parameters

pointFeature Feature

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldPathFilename String

Returns

MagneticDeclination

GetMagneticDeclination(Feature, Double, DistanceUnit, DateTime, Stream)

public static MagneticDeclination GetMagneticDeclination(Feature pointFeature, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, Stream magneticFieldStream)

Parameters

pointFeature Feature

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldStream Stream

Returns

MagneticDeclination

GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime)

public static MagneticDeclination GetMagneticDeclination(PointShape point, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime)

Parameters

point PointShape

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

Returns

MagneticDeclination

GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime, String)

public static MagneticDeclination GetMagneticDeclination(PointShape point, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, string magneticFieldPathFilename)

Parameters

point PointShape

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldPathFilename String

Returns

MagneticDeclination

GetMagneticDeclination(PointShape, Double, DistanceUnit, DateTime, Stream)

public static MagneticDeclination GetMagneticDeclination(PointShape point, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, Stream magneticFieldStream)

Parameters

point PointShape

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldStream Stream

Returns

MagneticDeclination

GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime)

public static MagneticDeclination GetMagneticDeclination(double x, double y, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime)

Parameters

x Double

y Double

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

Returns

MagneticDeclination

GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime, String)

public static MagneticDeclination GetMagneticDeclination(double x, double y, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, string magneticFieldPathFilename)

Parameters

x Double

y Double

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldPathFilename String

Returns

MagneticDeclination

GetMagneticDeclination(Double, Double, Double, DistanceUnit, DateTime, Stream)

public static MagneticDeclination GetMagneticDeclination(double x, double y, double elevation, DistanceUnit elevationUnit, DateTime sampleDateTime, Stream magneticFieldStream)

Parameters

x Double

y Double

elevation Double

elevationUnit DistanceUnit

sampleDateTime DateTime

magneticFieldStream Stream

Returns

MagneticDeclination

OpenCore()

protected void OpenCore()

CloseCore()

protected void CloseCore()

DrawCore(GeoCanvas, Collection<SimpleCandidate>)

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

Parameters

canvas GeoCanvas

labelsInAllLayers Collection<SimpleCandidate>

Events

StreamLoading

This event allows you to pass in your own stream to represent the image.

public event EventHandler<StreamLoadingEventArgs> StreamLoading;

DrawingProgressChanged

public event EventHandler<DrawingProgressChangedEventArgs> DrawingProgressChanged;

DrawingException

public event EventHandler<DrawingExceptionLayerEventArgs> DrawingException;

DrawnException

public event EventHandler<DrawnExceptionLayerEventArgs> DrawnException;

DrawingAttribution

public event EventHandler<DrawingAttributionLayerEventArgs> DrawingAttribution;

DrawnAttribution

public event EventHandler<DrawnAttributionLayerEventArgs> DrawnAttribution;

RequestedDrawing

public event EventHandler<RequestedDrawingLayerEventArgs> RequestedDrawing;

RequestingDrawing

public event EventHandler<RequestingDrawingLayerEventArgs> RequestingDrawing;

< Back