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

ScaleBarAdornmentLayer()

• 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).

GetDrawingLocation(GeoCanvas,Single,Single)

• N/A

• N/A

• Type:ScreenPointF
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• adornmentWidth
  • Type:Single
  • Description:N/A

• adornmentHeight
  • Type:Single
  • Description:N/A

GetThreadSafetyLevel()

• N/A

• N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeep()

• N/A

• N/A

• Type:Layer
• Description:N/A

Open()

• N/A

• N/A

• Type:Void
• Description:N/A

Close()

• N/A

• N/A

• Type:Void
• Description:N/A

GetBoundingBox()

• N/A

• N/A

• Type:RectangleShape
• Description:N/A

Draw(GeoCanvas,Collection<SimpleCandidate>)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

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

RequestDrawing()

• N/A

• N/A

• Type:Void
• Description:N/A

RequestDrawing(RectangleShape)

• N/A

• N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>)

• N/A

• N/A

• Type:Void
• Description:N/A

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

RequestDrawing(TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(RectangleShape,TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

• extentToRefresh
  • Type:RectangleShape
  • Description:N/A

• bufferTime
  • Type:TimeSpan
  • Description:N/A

RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)

• N/A

• N/A

• Type:Void
• Description:N/A

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

• bufferTime
  • Type:TimeSpan
  • Description:N/A

ToString()

• N/A

• N/A

• Type:String
• Description:N/A

Equals(Object)

• N/A

• N/A

• Type:Boolean
• Description:N/A

• obj
  • Type:Object
  • Description:N/A

GetHashCode()

• N/A

• N/A

• Type:Int32
• Description:N/A

GetType()

• N/A

• N/A

• Type:Type
• Description:N/A

UpdateScale(GeoCanvas,GeographyUnit)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• mapUnit
  • Type:GeographyUnit
  • Description:N/A

DrawCore(GeoCanvas,Collection<SimpleCandidate>)

• 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.

• 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.

OnRequestingDrawing(RequestingDrawingLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestingDrawingLayerEventArgs
  • Description:N/A

GetThreadSafetyLevelCore()

• N/A

• N/A

• Type:ThreadSafetyLevel
• Description:N/A

CloneDeepCore()

• N/A

• N/A

• Type:Layer
• Description:N/A

OpenCore()

• N/A

• N/A

• Type:Void
• Description:N/A

CloseCore()

• N/A

• N/A

• Type:Void
• Description:N/A

GetBoundingBoxCore()

• N/A

• N/A

• Type:RectangleShape
• Description:N/A

DrawException(GeoCanvas,Exception)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• e
  • Type:Exception
  • Description:N/A

DrawExceptionCore(GeoCanvas,Exception)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• e
  • Type:Exception
  • Description:N/A

OnDrawingException(DrawingExceptionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingExceptionLayerEventArgs
  • Description:N/A

OnDrawnException(DrawnExceptionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawnExceptionLayerEventArgs
  • Description:N/A

DrawAttributionCore(GeoCanvas,String)

• N/A

• N/A

• Type:Void
• Description:N/A

• canvas
  • Type:GeoCanvas
  • Description:N/A

• attribution
  • Type:String
  • Description:N/A

OnDrawingAttribution(DrawingAttributionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawingAttributionLayerEventArgs
  • Description:N/A

OnDrawnAttribution(DrawnAttributionLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• args
  • Type:DrawnAttributionLayerEventArgs
  • Description:N/A

OnDrawingProgressChanged(DrawingProgressChangedEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• e
  • Type:DrawingProgressChangedEventArgs
  • Description:N/A

OnRequestedDrawing(RequestedDrawingLayerEventArgs)

• N/A

• N/A

• Type:Void
• Description:N/A

• eventArgs
  • Type:RequestedDrawingLayerEventArgs
  • Description:N/A

Finalize()

• N/A

• N/A

• Type:Void
• Description:N/A

MemberwiseClone()

• N/A

• N/A

• Type:Object
• Description:N/A

ProjectionToDecimalDegrees

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

• N/A

• Type:Projection

ProjectionParametersString

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

• N/A

• Type:String

DisplayUnitString

• 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.

• Type:Dictionary<String,String>

UnitFamily

• 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.

• Type:UnitSystem

Thickness

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

• N/A

• Type:Int32

MaxWidth

• 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.

• Type:Int32

BarBrush

• 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.

• Type:GeoBrush

TextStyle

• N/A

• N/A

• Type:TextStyle

AlternateBarBrush

• 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.

• Type:GeoBrush

MaskBrush

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

• N/A

• Type:GeoBrush

HasMask

• 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.

• Type:Boolean

MaskContour

• 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.

• Type:GeoPen

BarPen

• N/A

• N/A

• Type:GeoPen

Width

• N/A

• N/A

• Type:Single

Height

• N/A

• N/A

• Type:Single

BackgroundMask

• N/A

• N/A

• Type:AreaStyle

Location

• N/A

• N/A

• Type:AdornmentLocation

XOffsetInPixel

• N/A

• N/A

• Type:Single

YOffsetInPixel

• N/A

• N/A

• Type:Single

IsOpen

• N/A

• N/A

• Type:Boolean

HasBoundingBox

• N/A

• N/A

• Type:Boolean

DrawingTime

• N/A

• N/A

• Type:TimeSpan

Name

• N/A

• N/A

• Type:String

IsVisible

• N/A

• N/A

• Type:Boolean

Transparency

• N/A

• N/A

• Type:Single

IsNegative

• N/A

• N/A

• Type:Boolean

IsGrayscale

• N/A

• N/A

• Type:Boolean

DrawingExceptionMode

• N/A

• N/A

• Type:DrawingExceptionMode

Attribution

• N/A

• N/A

• Type:String

RequestDrawingInterval

• N/A

• N/A

• Type:TimeSpan

ActualWidth

• N/A

• N/A

• Type:Single

IsOpenCore

• N/A

• N/A

• Type:Boolean

DrawingException

• N/A

• N/A

Event Arguments:DrawingExceptionLayerEventArgs

DrawingProgressChanged

• N/A

• N/A

Event Arguments:DrawingProgressChangedEventArgs

DrawnException

• N/A

• N/A

Event Arguments:DrawnExceptionLayerEventArgs

DrawingAttribution

• N/A

• N/A

Event Arguments:DrawingAttributionLayerEventArgs

DrawnAttribution

• N/A

• N/A

Event Arguments:DrawnAttributionLayerEventArgs

RequestedDrawing

• N/A

• N/A

Event Arguments:RequestedDrawingLayerEventArgs

RequestingDrawing

• N/A

• N/A

Event Arguments:RequestingDrawingLayerEventArgs