The ScaleBarAdornmentLayer class allows you show a bar graphic on the map that displays the distance scale for the current map extent.

• System.Object
  • ThinkGeo.MapSuite.Core.Layer
    • ThinkGeo.MapSuite.Core.AdornmentLayer
      • ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer

AlternateBarBrush

• Return:GeoBrush
• Summary:The property is the GeoBrush that will be used to draw the alternate ScaleBar.

Attribution

• Return:String
• Summary:N/A

BackgroundMask

• Return:AreaStyle
• Summary:N/A

BarBrush

• Return:GeoBrush
• Summary:The property is the GeoBrush that will be used to draw the ScaleBar.

BarPen

• Return:GeoPen
• Summary:N/A

BlueTranslation

• Return:Single
• Summary:N/A

DisplayUnitString

• Return:Dictionary<String,String>
• Summary:This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.

DrawingExceptionMode

• Return:DrawingExceptionMode
• Summary:N/A

DrawingTime

• Return:TimeSpan
• Summary:N/A

GreenTranslation

• Return:Single
• Summary:N/A

HasBoundingBox

• Return:Boolean
• Summary:N/A

HasMask

• Return:Boolean
• Summary:Gets or sets whether the ScaleBar will have a mask or not. A boolean value representing whether or not a mask is shown.

Height

• Return:Single
• Summary:N/A

IsGrayscale

• Return:Boolean
• Summary:N/A

IsNegative

• Return:Boolean
• Summary:N/A

IsOpen

• Return:Boolean
• Summary:N/A

IsVisible

• Return:Boolean
• Summary:N/A

KeyColors

• Return:Collection<GeoColor>
• Summary:N/A

Location

• Return:AdornmentLocation
• Summary:N/A

MaskBrush

• Return:GeoBrush
• Summary:Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.

MaskContour

• Return:GeoPen
• Summary:Gets or sets the pen for the outline of the ScaleBar mask.

MaxWidth

• Return:Int32
• Summary:Gets or Sets the MaxWidth of the ScaleBar.

Name

• Return:String
• Summary:N/A

ProjectionToDecimalDegrees

• Return:Projection
• Summary:Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.

RedTranslation

• Return:Single
• Summary:N/A

RequestDrawingInterval

• Return:TimeSpan
• Summary:N/A

TextStyle

• Return:TextStyle
• Summary:N/A

Thickness

• Return:Int32
• Summary:Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.

Transparency

• Return:Single
• Summary:N/A

UnitFamily

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

Width

• Return:Single
• Summary:N/A

XOffsetInPixel

• Return:Single
• Summary:N/A

YOffsetInPixel

• Return:Single
• Summary:N/A

IsOpenCore

• Return:Boolean
• Summary:N/A

iBk=

• Return:Single
• Summary:N/A

DrawingAttribution

• Event Arguments:DrawingAttributionLayerEventArgs
• Summary:N/A

DrawingException

• Event Arguments:DrawingExceptionLayerEventArgs
• Summary:N/A

DrawingProgressChanged

• Event Arguments:DrawingProgressChangedEventArgs
• Summary:N/A

DrawnAttribution

• Event Arguments:DrawnAttributionLayerEventArgs
• Summary:N/A

DrawnException

• Event Arguments:DrawnExceptionLayerEventArgs
• Summary:N/A

RequestedDrawing

• Event Arguments:RequestedDrawingLayerEventArgs
• Summary:N/A

RequestingDrawing

• Event Arguments:RequestingDrawingLayerEventArgs
• Summary:N/A

Creates a new instance of the ScaleBarAdornmentLayer class.

When displaying a ScaleBarAdornmentLayer, we need to instance a ScaleLineAdornmentLayer and add it to MapEngine. The ScaleBar will not be drawn when the CurrentExtent is outside of the world Extent(-90,180-,90,-180).

Go Back

N/A

N/A

Return Value

• Return Type:Layer
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

labelsInAllLayers

• Type:Collection<SimpleCandidate>
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Boolean
• Description:N/A

obj

• Type:Object
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:RectangleShape
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:ScreenPointF
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

adornmentWidth

• Type:Single
• Description:N/A

adornmentHeight

• Type:Single
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Int32
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:ThreadSafetyLevel
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Type
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentToRefresh

• Type:RectangleShape
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

extentsToRefresh

• Type:IEnumerable<RectangleShape>
• Description:N/A

bufferTime

• Type:TimeSpan
• Description:N/A

bufferTimeType

• Type:RequestDrawingBufferTimeType
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:String
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Layer
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

attribution

• Type:String
• Description:N/A

Go Back

This method draws the Layer.

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

• Return Type:Void
• Description:None

canvas

• Type:GeoCanvas
• Description:This parameter is the canvas object or a GeoImage to draw on.

labelsInAllLayers

• Type:Collection<SimpleCandidate>
• Description:This parameter represents the labels used for collision detection and duplication checking.

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

e

• Type:Exception
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

e

• Type:Exception
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:RectangleShape
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:ThreadSafetyLevel
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Object
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

args

• Type:DrawingAttributionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawingExceptionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawingProgressChangedEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

args

• Type:DrawnAttributionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

e

• Type:DrawnExceptionLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

eventArgs

• Type:RequestedDrawingLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

eventArgs

• Type:RequestingDrawingLayerEventArgs
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

Go Back

N/A

N/A

Return Value

• Return Type:Void
• Description:N/A

canvas

• Type:GeoCanvas
• Description:N/A

mapUnit

• Type:GeographyUnit
• Description:N/A

Go Back

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

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

Return Type:GeoBrush

Go Back

N/A

N/A

Return Type:String

Go Back

N/A

N/A

Return Type:AreaStyle

Go Back

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

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

Return Type:GeoBrush

Go Back

N/A

N/A

Return Type:GeoPen

Go Back

N/A

N/A

Return Type:Single

Go Back

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

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

Return Type:Dictionary<String,String>

Go Back

N/A

N/A

Return Type:DrawingExceptionMode

Go Back

N/A

N/A

Return Type:TimeSpan

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:Boolean

Go Back

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

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 Type:Boolean

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:Boolean

Go Back

N/A

N/A

Return Type:Boolean

Go Back

N/A

N/A

Return Type:Boolean

Go Back

N/A

N/A

Return Type:Boolean

Go Back

N/A

N/A

Return Type:Collection<GeoColor>

Go Back

N/A

N/A

Return Type:AdornmentLocation

Go Back

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

N/A

Return Type:GeoBrush

Go Back

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

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 Type:GeoPen

Go Back

Gets or Sets the MaxWidth of the ScaleBar.

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 Type:Int32

Go Back

N/A

N/A

Return Type:String

Go Back

Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.

N/A

Return Type:Projection

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:TimeSpan

Go Back

N/A

N/A

Return Type:TextStyle

Go Back

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

N/A

Return Type:Int32

Go Back

N/A

N/A

Return Type:Single

Go Back

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

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

Return Type:UnitSystem

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Return Type:Boolean

Go Back

N/A

N/A

Return Type:Single

Go Back

N/A

N/A

Event Arguments:DrawingAttributionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawingExceptionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawingProgressChangedEventArgs

Go Back

N/A

N/A

Event Arguments:DrawnAttributionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:DrawnExceptionLayerEventArgs

Go Back

N/A

N/A

Event Arguments:RequestedDrawingLayerEventArgs

Go Back

N/A

N/A

Event Arguments:RequestingDrawingLayerEventArgs

Go Back