====== ThinkGeo.Core.ScaleLineAdornmentLayer ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.Core.Layer *ThinkGeo.Core.AdornmentLayer ***ThinkGeo.Core.ScaleLineAdornmentLayer** ===== Members Summary ===== ==== Public Constructors ==== ** {{wiki:PublicMethod.gif|}} 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 ==
** {{wiki:PublicMethod.gif|}} 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:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:The start position of the ScaleLineAdornmentLayer that will be shown on the Map.
** {{wiki:PublicMethod.gif|}} 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:[[ThinkGeo.Core.AdornmentLocation|AdornmentLocation]] * Description:This parameter specifies the location of the start point of the ScaleLineAdornmentLayer.
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} GetDrawingLocation(GeoCanvas,Single,Single) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.ScreenPointF|ScreenPointF]] * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //adornmentWidth// * Type:Single * Description:N/A * //adornmentHeight// * Type:Single * Description:N/A
** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Open() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Close() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetBoundingBox() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.Core.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentToRefresh// * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A
** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable,TimeSpan,RequestDrawingBufferTimeType) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //extentsToRefresh// * Type:IEnumerable<[[ThinkGeo.Core.RectangleShape|RectangleShape]]> * Description:N/A * //bufferTime// * Type:TimeSpan * Description:N/A * //bufferTimeType// * Type:[[ThinkGeo.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]] * Description:N/A
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection) ** * //N/A// == 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:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:This parameter is the view object or a NativeImage to draw on. * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.Core.SimpleCandidate|SimpleCandidate]]> * Description:This parameter represents the labels used for collision detection and duplication checking.
** {{wiki:ProtectedMethod.gif|}} OpenCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloseCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Layer|Layer]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.RectangleShape|RectangleShape]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //e// * Type:Exception * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.Core.GeoCanvas|GeoCanvas]] * Description:N/A * //attribution// * Type:String * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //args// * Type:[[ThinkGeo.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //e// * Type:[[ThinkGeo.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //eventArgs// * Type:[[ThinkGeo.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} DisplayUnitString ** * //N/A// == Remarks == * //We will display different letters for different units of measure; for example: "m" for meters, "ft" for feet, etc.// == Return Value == * Type:Dictionary ** {{wiki:PublicProperty.gif|}} UnitSystem ** * //N/A// == Remarks == * //By setting this property, you can set the top and button unit for the ScaleLine.// == Return Value == * Type:[[ThinkGeo.Core.ScaleLineUnitSystem|ScaleLineUnitSystem]] ** {{wiki:PublicProperty.gif|}} TextStyle ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.TextStyle|TextStyle]] ** {{wiki:PublicProperty.gif|}} Pen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.GeoPen|GeoPen]] ** {{wiki:PublicProperty.gif|}} HaloPen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.GeoPen|GeoPen]] ** {{wiki:PublicProperty.gif|}} Width ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} Height ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BackgroundMask ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.AreaStyle|AreaStyle]] ** {{wiki:PublicProperty.gif|}} Location ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.AdornmentLocation|AdornmentLocation]] ** {{wiki:PublicProperty.gif|}} XOffsetInPixel ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} YOffsetInPixel ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} IsOpen ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} HasBoundingBox ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} DrawingTime ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} Attribution ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} IsVisible ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} Transparency ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} BlueTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} RedTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} GreenTranslation ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:PublicProperty.gif|}} KeyColors ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection<[[ThinkGeo.Core.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} IsNegative ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsGrayscale ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} ColorMappings ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Dictionary<[[ThinkGeo.Core.GeoColor|GeoColor]],[[ThinkGeo.Core.GeoColor|GeoColor]]> ** {{wiki:PublicProperty.gif|}} DrawingExceptionMode ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.DrawingExceptionMode|DrawingExceptionMode]] ** {{wiki:PublicProperty.gif|}} ThreadSafe ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.ThreadSafetyLevel|ThreadSafetyLevel]] ** {{wiki:PublicProperty.gif|}} Projection ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.Core.Projection|Projection]] ** {{wiki:PublicProperty.gif|}} RequestDrawingInterval ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:TimeSpan ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} ActualWidth ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Single ** {{wiki:ProtectedProperty.gif|}} IsOpenCore ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ==== Public Events ==== ** {{wiki:PublicEvent.gif|}} DrawingProgressChanged ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnException ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawingAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} DrawnAttribution ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestedDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]] ** {{wiki:PublicEvent.gif|}} RequestingDrawing ** * //N/A// == Remarks == * //N/A// Event Arguments:[[ThinkGeo.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]