Table of Contents
ThinkGeo.MapSuite.Core.ScaleLineAdornmentLayer
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
The ScaleLineAdornmentLayer is a concrete class inherited from AdornmentLayer. The ScaleLineAdornmentLayer class allows you show a ScaleLine graphic on the map.
Inheritance Hierarchy
- System.Object
- ThinkGeo.MapSuite.Core.Layer
- ThinkGeo.MapSuite.Core.AdornmentLayer
- ThinkGeo.MapSuite.Core.ScaleLineAdornmentLayer
Members Summary
Public 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.
Remarks
- N/A
Parameters
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.
Remarks
- N/A
Parameters
- startPoint
- Type:ScreenPointF
- Description: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.
Remarks
- N/A
Parameters
- location
- Type:AdornmentLocation
- Description:This parameter specifies the location of the start point of the ScaleLineAdornmentLayer.
Protected Constructors
Public Methods
GetDrawingLocation(GeoCanvas,Single,Single)
- N/A
Remarks
- N/A
Return Value
- Type:ScreenPointF
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- adornmentWidth
- Type:Single
- Description:N/A
- adornmentHeight
- Type:Single
- Description:N/A
RequestDrawing()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
RequestDrawing(RectangleShape)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- bufferTime
- Type:TimeSpan
- Description:N/A
RequestDrawing(TimeSpan,RequestDrawingBufferTimeType)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- bufferTime
- Type:TimeSpan
- Description:N/A
- bufferTimeType
- Description:N/A
RequestDrawing(RectangleShape,TimeSpan)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- extentToRefresh
- Type:RectangleShape
- Description:N/A
- bufferTime
- Type:TimeSpan
- Description:N/A
RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- extentToRefresh
- Type:RectangleShape
- Description:N/A
- bufferTime
- Type:TimeSpan
- Description:N/A
- bufferTimeType
- Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A
- bufferTime
- Type:TimeSpan
- Description:N/A
RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- extentsToRefresh
- Type:IEnumerable<RectangleShape>
- Description:N/A
- bufferTime
- Type:TimeSpan
- Description:N/A
- bufferTimeType
- Description:N/A
GetThreadSafetyLevel()
- N/A
Remarks
- N/A
Return Value
- Type:ThreadSafetyLevel
- Description:N/A
Parameters
CloneDeep()
- N/A
Remarks
- N/A
Return Value
- Type:Layer
- Description:N/A
Parameters
Open()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Close()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
GetBoundingBox()
- N/A
Remarks
- N/A
Return Value
- Type:RectangleShape
- Description:N/A
Parameters
Draw(GeoCanvas,Collection<SimpleCandidate>)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:N/A
ToString()
- N/A
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- N/A
Return Value
- Type:Type
- Description:N/A
Parameters
Protected Methods
DrawCore(GeoCanvas,Collection<SimpleCandidate>)
- 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:Void
- Description:None
Parameters
- 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.
OnRequestedDrawing(RequestedDrawingLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- eventArgs
- Description:N/A
OnRequestingDrawing(RequestingDrawingLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:ThreadSafetyLevel
- Description:N/A
Parameters
CloneDeepCore()
- N/A
Remarks
- N/A
Return Value
- Type:Layer
- Description:N/A
Parameters
OpenCore()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
CloseCore()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
GetBoundingBoxCore()
- N/A
Remarks
- N/A
Return Value
- Type:RectangleShape
- Description:N/A
Parameters
DrawException(GeoCanvas,Exception)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- e
- Type:Exception
- Description:N/A
DrawExceptionCore(GeoCanvas,Exception)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- e
- Type:Exception
- Description:N/A
OnDrawingException(DrawingExceptionLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- e
- Description:N/A
OnDrawnException(DrawnExceptionLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- attribution
- Type:String
- Description:N/A
OnDrawingAttribution(DrawingAttributionLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- args
- Description:N/A
OnDrawnAttribution(DrawnAttributionLayerEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- args
- Description:N/A
OnDrawingProgressChanged(DrawingProgressChangedEventArgs)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- N/A
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
ProjectionToDecimalDegrees
Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.
Remarks
N/A
Return Value
- Type:Projection
DisplayUnitString
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
- Type:Dictionary<String,String>
UnitSystem
Gets or sets the UnitSystem to be used for the ScaleLine.
Remarks
By setting this property, you can set the top and button unit for the ScaleLine.
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Single
Height
N/A
Remarks
N/A
Return Value
- Type:Single
BackgroundMask
N/A
Remarks
N/A
Return Value
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Single
YOffsetInPixel
N/A
Remarks
N/A
Return Value
- Type:Single
RequestDrawingInterval
N/A
Remarks
N/A
Return Value
- Type:TimeSpan
IsOpen
N/A
Remarks
N/A
Return Value
- Type:Boolean
HasBoundingBox
N/A
Remarks
N/A
Return Value
- Type:Boolean
DrawingTime
N/A
Remarks
N/A
Return Value
- Type:TimeSpan
Name
N/A
Remarks
N/A
Return Value
- Type:String
Attribution
N/A
Remarks
N/A
Return Value
- Type:String
IsVisible
N/A
Remarks
N/A
Return Value
- Type:Boolean
Transparency
N/A
Remarks
N/A
Return Value
- Type:Single
BlueTranslation
N/A
Remarks
N/A
Return Value
- Type:Single
RedTranslation
N/A
Remarks
N/A
Return Value
- Type:Single
GreenTranslation
N/A
Remarks
N/A
Return Value
- Type:Single
KeyColors
N/A
Remarks
N/A
Return Value
Remarks
N/A
Return Value
- Type:Boolean
IsGrayscale
N/A
Remarks
N/A
Return Value
- Type:Boolean
DrawingExceptionMode
N/A
Remarks
N/A
Return Value
- Type:DrawingExceptionMode
Protected Properties
ActualWidth
N/A
Remarks
N/A
Return Value
- Type:Single
IsOpenCore
N/A
Remarks
N/A
Return Value
- Type:Boolean
Public Events
RequestedDrawing
N/A
Remarks
Remarks
Remarks
Remarks
Remarks
Remarks
Remarks
N/A
Event Arguments:DrawnAttributionLayerEventArgs