ScaleLineAdornmentLayer¶

Namespace: ThinkGeo.Core

The ScaleLineAdornmentLayer is a concrete class inherited from AdornmentLayer. The ScaleLineAdornmentLayer class allows you show a ScaleLine graphic on the map.

public class ScaleLineAdornmentLayer : AdornmentLayer

Inheritance Object → Layer → AdornmentLayer → ScaleLineAdornmentLayer

Remarks:

The ScaleLineAdornmentLayer of the map is a quick way to implement a ScaleLine. When doing this, we also have to add a ScaleLineAdornmentLayer to the map control.

Properties¶

DisplayUnitString¶

This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.

public Dictionary<string, string> DisplayUnitString { get; }

Property Value¶

Dictionary<String, String>

Remarks:

We will display different letters for different units of measure; for example: "m" for meters, "ft" for feet, etc.

UnitSystem¶

Gets or sets the UnitSystem to be used for the ScaleLine.

public ScaleLineUnitSystem UnitSystem { get; set; }

Property Value¶

ScaleLineUnitSystem

Remarks:

By setting this property, you can set the top and button unit for the ScaleLine.

TextStyle¶

public TextStyle TextStyle { get; set; }

Property Value¶

TextStyle

Pen¶

public GeoPen Pen { get; set; }

Property Value¶

GeoPen

HaloPen¶

public GeoPen HaloPen { get; set; }

Property Value¶

GeoPen

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¶

ScaleLineAdornmentLayer()¶

Creates a new instance of the ScaleLineAdornmentLayer class. The default location of this ScaleLineAdornmentLayer is the lower left corner of the CurrentExtent of the map.

public ScaleLineAdornmentLayer()

ScaleLineAdornmentLayer(ScreenPointF)¶

Creates a new instance of the ScaleLineAdornmentLayer class by passing in the specified ScreenPoint, which will be the start position of this ScaleLineAdornmentLayer when it is shown on the map.

public ScaleLineAdornmentLayer(ScreenPointF startPoint)

Parameters¶

startPoint ScreenPointF
The start position of the ScaleLineAdornmentLayer that will be shown on the Map.

ScaleLineAdornmentLayer(AdornmentLocation)¶

Creates a new instance of the ScaleLineAdornmentLayer class by passing in the specified enumeration of the AdornmentLocation that will be used to set the start position of this ScaleLineAdornmentLayer when it is shown on the map.

public ScaleLineAdornmentLayer(AdornmentLocation location)

Parameters¶

location AdornmentLocation

        This parameter specifies the location of the start point of the
        ScaleLineAdornmentLayer.

Methods¶

DrawCore(GeoCanvas, Collection<SimpleCandidate>)¶

This method draws the Layer.

protected 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 abstract method is called from the concrete public method Draw. This method draws the representation of the layer 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 to allow the user to specify which field they need; then, in the GetRequiredColumnNamesCore, we read that property and add it to the collection.

OpenCore()¶

protected void OpenCore()

CloseCore()¶

protected void CloseCore()

Events¶

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;