Skip to content

ScaleBarAdornmentLayer

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
ScaleBarAdornmentLayer()

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
AlternateBarBrush GeoBrush The property is the GeoBrush that will be used to draw the alternate ScaleBar.
Attribution String N/A
Background GeoColor N/A
BackgroundMask AreaStyle N/A
BarBrush GeoBrush The property is the GeoBrush that will be used to draw the ScaleBar.
BarPen GeoPen N/A
BlueTranslation Single N/A
ColorMappings Dictionary<GeoColor,GeoColor> N/A
DisplayUnitString Dictionary<String,String> This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.
DrawingExceptionMode DrawingExceptionMode N/A
DrawingTime TimeSpan N/A
GreenTranslation Single N/A
HasBoundingBox Boolean N/A
HasMask Boolean Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.
Height Single N/A
IsGrayscale Boolean N/A
IsNegative Boolean N/A
IsOpen Boolean N/A
IsVisible Boolean N/A
KeyColors Collection<GeoColor> N/A
Location AdornmentLocation N/A
MaskBrush GeoBrush Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.
MaskContour GeoPen Gets or sets the pen for the outline of the ScaleBar mask.
MaxWidth Int32 Gets or Sets the MaxWidth of the ScaleBar.
Name String N/A
Projection Projection N/A
RedTranslation Single N/A
RequestDrawingInterval TimeSpan N/A
TextStyle TextStyle N/A
Thickness Int32 Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
ThreadSafe ThreadSafetyLevel N/A
Transparency Single N/A
UnitFamily UnitSystem Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
Width Single N/A
XOffsetInPixel Single N/A
YOffsetInPixel Single N/A

Protected Properties Summary

Name Return Type Description
ActualWidth Single N/A
IsOpenCore Boolean N/A

Public Methods Summary

Name
CloneDeep()
Close()
Draw(GeoCanvas,Collection<SimpleCandidate>)
Equals(Object)
GetBoundingBox()
GetDrawingLocation(GeoCanvas,Single,Single)
GetHashCode()
GetType()
Open()
RequestDrawing()
RequestDrawing(RectangleShape)
RequestDrawing(IEnumerable<RectangleShape>)
RequestDrawing(TimeSpan)
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(RectangleShape,TimeSpan)
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
ToString()

Protected Methods Summary

Name
CloneDeepCore()
CloseCore()
DrawAttributionCore(GeoCanvas,String)
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
DrawException(GeoCanvas,Exception)
DrawExceptionCore(GeoCanvas,Exception)
Finalize()
GetBoundingBoxCore()
MemberwiseClone()
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
OnDrawingException(DrawingExceptionLayerEventArgs)
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
OnDrawnException(DrawnExceptionLayerEventArgs)
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
OpenCore()
UpdateScale(GeoCanvas,GeographyUnit)

Public Events Summary

Name Event Arguments Description
DrawingProgressChanged DrawingProgressChangedEventArgs N/A
DrawingException DrawingExceptionLayerEventArgs N/A
DrawnException DrawnExceptionLayerEventArgs N/A
DrawingAttribution DrawingAttributionLayerEventArgs N/A
DrawnAttribution DrawnAttributionLayerEventArgs N/A
RequestedDrawing RequestedDrawingLayerEventArgs N/A
RequestingDrawing RequestingDrawingLayerEventArgs N/A

Members Detail

Public Constructors

Name
ScaleBarAdornmentLayer()

Protected Constructors

Public Properties

AlternateBarBrush

Summary

The property is the GeoBrush that will be used to draw the alternate ScaleBar.

Remarks

This AlternateBarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.

Return Value

GeoBrush


Attribution

Summary

N/A

Remarks

N/A

Return Value

String


Background

Summary

N/A

Remarks

N/A

Return Value

GeoColor


BackgroundMask

Summary

N/A

Remarks

N/A

Return Value

AreaStyle


BarBrush

Summary

The property is the GeoBrush that will be used to draw the ScaleBar.

Remarks

This BarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.

Return Value

GeoBrush


BarPen

Summary

N/A

Remarks

N/A

Return Value

GeoPen


BlueTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


ColorMappings

Summary

N/A

Remarks

N/A

Return Value

Dictionary<GeoColor,GeoColor>


DisplayUnitString

Summary

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

Remarks

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

Return Value

Dictionary<String,String>


DrawingExceptionMode

Summary

N/A

Remarks

N/A

Return Value

DrawingExceptionMode


DrawingTime

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


GreenTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


HasBoundingBox

Summary

N/A

Remarks

N/A

Return Value

Boolean


HasMask

Summary

Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.

Remarks

Depending upon the look of your map and your requirements, you may or may not want a mask on the ScaleBar. You can control whether or not the ScaleBar has a mask by setting this property. If you set the HasMask property to true, be sure to specify a mask color (or texture) by using the MaskBrush property.

Return Value

Boolean


Height

Summary

N/A

Remarks

N/A

Return Value

Single


IsGrayscale

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsNegative

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsOpen

Summary

N/A

Remarks

N/A

Return Value

Boolean


IsVisible

Summary

N/A

Remarks

N/A

Return Value

Boolean


KeyColors

Summary

N/A

Remarks

N/A

Return Value

Collection<GeoColor>


Location

Summary

N/A

Remarks

N/A

Return Value

AdornmentLocation


MaskBrush

Summary

Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.

Remarks

N/A

Return Value

GeoBrush


MaskContour

Summary

Gets or sets the pen for the outline of the ScaleBar mask.

Remarks

By using this property you can control the border of the mask, if the HasMask property is set to true. If you do not want a contour or border to show, you should set the pen to transparent.

Return Value

GeoPen


MaxWidth

Summary

Gets or Sets the MaxWidth of the ScaleBar.

Remarks

You can use this property to set the maximum width that you want the ScaleBar to occupy on the map. The ScaleBarAdornmentLayer will automatically adjust its size based upon the current extent of the map. By setting this property, you can control the maximum width the ScaleBar will occupy on the map.

Return Value

Int32


Name

Summary

N/A

Remarks

N/A

Return Value

String


Projection

Summary

N/A

Remarks

N/A

Return Value

Projection


RedTranslation

Summary

N/A

Remarks

N/A

Return Value

Single


RequestDrawingInterval

Summary

N/A

Remarks

N/A

Return Value

TimeSpan


TextStyle

Summary

N/A

Remarks

N/A

Return Value

TextStyle


Thickness

Summary

Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.

Remarks

N/A

Return Value

Int32


ThreadSafe

Summary

N/A

Remarks

N/A

Return Value

ThreadSafetyLevel


Transparency

Summary

N/A

Remarks

N/A

Return Value

Single


UnitFamily

Summary

Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.

Remarks

By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.

Return Value

UnitSystem


Width

Summary

N/A

Remarks

N/A

Return Value

Single


XOffsetInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


YOffsetInPixel

Summary

N/A

Remarks

N/A

Return Value

Single


Protected Properties

ActualWidth

Summary

N/A

Remarks

N/A

Return Value

Single


IsOpenCore

Summary

N/A

Remarks

N/A

Return Value

Boolean


Public Methods

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

Close()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

Draw(GeoCanvas,Collection<SimpleCandidate>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetBoundingBox()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

GetDrawingLocation(GeoCanvas,Single,Single)

Summary

N/A

Remarks

N/A

Return Value

Type Description
ScreenPointF N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
adornmentWidth Single N/A
adornmentHeight Single N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

Open()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RequestDrawing()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

RequestDrawing(RectangleShape)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A

RequestDrawing(IEnumerable<RectangleShape>)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A

RequestDrawing(TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A

RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(RectangleShape,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A

RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentToRefresh RectangleShape N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
extentsToRefresh IEnumerable<RectangleShape> N/A
bufferTime TimeSpan N/A
bufferTimeType RequestDrawingBufferTimeType N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Layer N/A

Parameters

Name Type Description
N/A N/A N/A

CloseCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

DrawAttributionCore(GeoCanvas,String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
attribution String N/A

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

Summary

This method draws the Layer.

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.

Return Value

Type Description
Void None

Parameters

Name Type Description
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.

DrawException(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

DrawExceptionCore(GeoCanvas,Exception)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
e Exception N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetBoundingBoxCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
RectangleShape N/A

Parameters

Name Type Description
N/A N/A N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawingAttributionLayerEventArgs N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingExceptionLayerEventArgs N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawingProgressChangedEventArgs N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
args DrawnAttributionLayerEventArgs N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e DrawnExceptionLayerEventArgs N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestedDrawingLayerEventArgs N/A

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
eventArgs RequestingDrawingLayerEventArgs N/A

OpenCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

UpdateScale(GeoCanvas,GeographyUnit)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
mapUnit GeographyUnit N/A

Public Events

DrawingProgressChanged

N/A

Remarks

N/A

Event Arguments

DrawingProgressChangedEventArgs

DrawingException

N/A

Remarks

N/A

Event Arguments

DrawingExceptionLayerEventArgs

DrawnException

N/A

Remarks

N/A

Event Arguments

DrawnExceptionLayerEventArgs

DrawingAttribution

N/A

Remarks

N/A

Event Arguments

DrawingAttributionLayerEventArgs

DrawnAttribution

N/A

Remarks

N/A

Event Arguments

DrawnAttributionLayerEventArgs

RequestedDrawing

N/A

Remarks

N/A

Event Arguments

RequestedDrawingLayerEventArgs

RequestingDrawing

N/A

Remarks

N/A

Event Arguments

RequestingDrawingLayerEventArgs