Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.core.scalebaradornmentlayer [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.core.scalebaradornmentlayer [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 The ScaleBarAdornmentLayer class allows you show a bar graphic on the map that displays the distance scale for the current map extent.
-=== Remarks ===
-Use the <strong>ScaleBarAdornmentLayer</strong> class as a quick way to implement a <strong>ScaleBar</strong>. When using the <strong>ScaleBarAdornmentLayer</strong>, you also need to add a ScaleLineAdornmentLayer to the map control. One thing we should pay attention to is that the ScaleBar will not be drawn when the CurrentExtent is outside of Range(-90,180,90,-180).
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.Core.Layer]]
+    *ThinkGeo.MapSuite.Core.Layer
-***[[ThinkGeo.MapSuite.Core.AdornmentLayer]]
+      *ThinkGeo.MapSuite.Core.AdornmentLayer
-****[[ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer]]
+        ***ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ScaleBarAdornmentLayer() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#ScaleBarAdornmentLayer()|ScaleBarAdornmentLayer]]   |    |    | Creates a new instance of the ScaleBarAdornmentLayer class.   |
+  * //Creates a new instance of the ScaleBarAdornmentLayer class.//
+== Remarks ==
+  * //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).//
+== Parameters ==
+<div newline></div>
 ==== Protected Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} GetDrawingLocation(GeoCanvas,Single,Single) **
-| {{wiki:PublicMethod.gif|Public Method}}[[#CloneDeep()|CloneDeep]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | Create a copy of Layer using the deep clone process.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Close()|Close]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method closes the Layer and releases any resources it was using.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Draw(GeoCanvas, Collection<SimpleCandidate>)|Draw]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method draws the Layer.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetBoundingBox()|GetBoundingBox]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method returns the bounding box of the Layer.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetDrawingLocation(GeoCanvas, Single, Single)|GetDrawingLocation]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Single, Single   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   | This method returns the drawing location of the AdornmentLayer.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Uri)|LoadLayer]]   | Uri   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}{{wiki:Static.gif|Static Member}}[[#LoadLayer(Stream)|LoadLayer]]   | Stream   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#Open()|Open]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method opens the Layer so that it is initialized and ready to use.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan)|RequestDrawing]]   | TimeSpan   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]]   | TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing()|RequestDrawing]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>, TimeSpan)|RequestDrawing]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>, TimeSpan   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType)|RequestDrawing]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan, [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(IEnumerable<RectangleShape>)|RequestDrawing]]   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape)|RequestDrawing]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#RequestDrawing(RectangleShape, TimeSpan)|RequestDrawing]]   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]], TimeSpan   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //N/A//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloneDeepCore()|CloneDeepCore]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | Create a copy of Layer using the deep clone process. The default implemenation uses serialization.   |
+  * //N/A//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#CloseCore()|CloseCore]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method closes the Layer and releases any resources it was using.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawAttributionCore(GeoCanvas, String)|DrawAttributionCore]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], String   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawCore(GeoCanvas, Collection<SimpleCandidate>)|DrawCore]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>   | [[ThinkGeo.MapSuite.Core.Layer|Layer]](overriden)   | This method draws the Layer.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawException(GeoCanvas, Exception)|DrawException]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#DrawExceptionCore(GeoCanvas, Exception)|DrawExceptionCore]]   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]], Exception   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetBoundingBoxCore()|GetBoundingBoxCore]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method returns the bounding box of the Layer.   |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingAttribution(DrawingAttributionLayerEventArgs)|OnDrawingAttribution]]   | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingException(DrawingExceptionLayerEventArgs)|OnDrawingException]]   | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawingProgressChanged(DrawingProgressChangedEventArgs)|OnDrawingProgressChanged]]   | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnAttribution(DrawnAttributionLayerEventArgs)|OnDrawnAttribution]]   | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnDrawnException(DrawnExceptionLayerEventArgs)|OnDrawnException]]   | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestedDrawing(RequestedDrawingLayerEventArgs)|OnRequestedDrawing]]   | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OnRequestingDrawing(RequestingDrawingLayerEventArgs)|OnRequestingDrawing]]   | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#OpenCore()|OpenCore]]   |    | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This method opens the Layer so that it is initialized and ready to use.   |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:[[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]]
-| {{wiki:PublicProperty.gif|Public Property}}[[#AlternateBarBrush|AlternateBarBrush]]   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   |    | The property is the GeoBrush that will be used to draw the alternate ScaleBar.   |
+  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#Attribution|Attribution]]   | String   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#BackgroundMask|BackgroundMask]]   | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#BarBrush|BarBrush]]   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   |    | The property is the GeoBrush that will be used to draw the ScaleBar.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#BarPen|BarPen]]   | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]   |    |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#BlueTranslation|BlueTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets the amount of blue to apply to the image.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DisplayUnitString|DisplayUnitString]]   | Dictionary<String,String>   |    | This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DrawingExceptionMode|DrawingExceptionMode]]   | [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | Gets or sets the DrawExcpetionMode when exception happens.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DrawingTime|DrawingTime]]   | TimeSpan   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets the last drawing time for the layer.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#GreenTranslation|GreenTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets the amount of green to apply to the image.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#HasBoundingBox|HasBoundingBox]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#HasMask|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.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Height|Height]]   | Single   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsGrayscale|IsGrayscale]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets if the image should be converted to grayscale.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsNegative|IsNegative]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets whether the image should be converted to negative (inverse colors).   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsOpen|IsOpen]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property returns true if the Layer is open and false if it is not.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#IsVisible|IsVisible]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and set the visible state of the layer.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#KeyColors|KeyColors]]   | Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Location|Location]]   | [[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]]   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   | This property gets and sets the drawing location of the AdornmentLayer.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#MaskBrush|MaskBrush]]   | [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]   |    | Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#MaskContour|MaskContour]]   | [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]   |    | Gets or sets the pen for the outline of the ScaleBar mask.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#MaxWidth|MaxWidth]]   | Int32   |    | Gets or Sets the MaxWidth of the ScaleBar.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Name|Name]]   | String   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets the name for the layer.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#ProjectionToDecimalDegrees|ProjectionToDecimalDegrees]]   | [[ThinkGeo.MapSuite.Core.Projection|Projection]]   |    | Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RedTranslation|RedTranslation]]   | Single   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets the amount of red to apply to the image.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#RequestDrawingInterval|RequestDrawingInterval]]   | TimeSpan   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TextStyle|TextStyle]]   | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]   |    |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Thickness|Thickness]]   | Int32   |    | Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Transparency|Transparency]]   | Single   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property gets and sets the amount of transparency to apply to the image.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#UnitFamily|UnitFamily]]   | [[ThinkGeo.MapSuite.Core.UnitSystem|UnitSystem]]   |    | Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Width|Width]]   | Single   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   |    |
-| {{wiki:PublicProperty.gif|Public Property}}[[#XOffsetInPixel|XOffsetInPixel]]   | Single   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   | This property gets and sets the X pixel offset for the AdornmentLayer.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#YOffsetInPixel|YOffsetInPixel]]   | Single   | [[ThinkGeo.MapSuite.Core.AdornmentLayer|AdornmentLayer]]   | This property gets and sets the Y pixel offset for the AdornmentLayer.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * //canvas//
-| {{wiki:ProtectedProperty.gif|Protected Property}}[[#IsOpenCore|IsOpenCore]]   | Boolean   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   | This property returns true if the Layer is open and false if it is not.   |
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
-==== Public Events ====
+  * //adornmentWidth//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+    * Type:Single
-| {{wiki:PublicEvent.gif|Public Event}}[[#DrawingAttribution|DrawingAttribution]]   | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
+    * Description:N/A
-| {{wiki:PublicEvent.gif|Public Event}}[[#DrawingException|DrawingException]]   | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicEvent.gif|Public Event}}[[#DrawingProgressChanged|DrawingProgressChanged]]   | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicEvent.gif|Public Event}}[[#DrawnAttribution|DrawnAttribution]]   | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicEvent.gif|Public Event}}[[#DrawnException|DrawnException]]   | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicEvent.gif|Public Event}}[[#RequestedDrawing|RequestedDrawing]]   | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-| {{wiki:PublicEvent.gif|Public Event}}[[#RequestingDrawing|RequestingDrawing]]   | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]   | [[ThinkGeo.MapSuite.Core.Layer|Layer]]   |    |
-===== Public Constructors =====
+  * //adornmentHeight//
-==== ScaleBarAdornmentLayer() ====
+    * Type:Single
-Creates a new instance of the ScaleBarAdornmentLayer class.
+    * Description:N/A
-=== Remarks ===
-When displaying a <strong>ScaleBarAdornmentLayer</strong>, we need to instance a ScaleLineAdornmentLayer and add it to MapEngine. The ScaleBar will not be drawn when the <strong>CurrentExtent</strong> is outside of the world Extent(-90,180-,90,-180).
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+<div newline></div>
-===== Protected Constructors =====
+** {{wiki:PublicMethod.gif|}} RequestDrawing() **
-===== Public Methods =====
-==== CloneDeep() ====
-Create a copy of Layer using the deep clone process.
-=== Remarks ===
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer -->   | A cloned Layer.   |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== Close() ====
+  * Description:N/A
-This method closes the Layer and releases any resources it was using.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method CloseCore. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
-If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **
-As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^ Description ^
+  * //N/A//
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //extentToRefresh//
-==== Draw(GeoCanvas, Collection<SimpleCandidate>) ====
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
-This method draws the Layer.
+    * Description:N/A
-=== Remarks ===
-This method is the concrete wrapper for the abstract method DrawCore. This method draws the representation of the layer based on the extent you provided.
-As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
+<div newline></div>
-=== Return Value ===
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) **
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter is the canvas object or a GeoImage to draw on.   |
+  * //N/A//
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | This parameter represents the labels used for collision detection and duplication checking.   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== Equals(Object) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //extentsToRefresh//
-| obj   | Object<!-- System.Object -->   |    |
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **
-==== GetBoundingBox() ====
-This method returns the bounding box of the Layer.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the RasterLayer.
-As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^ Description ^
+  * //N/A//
-| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the Layer.   |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //bufferTime//
-==== GetDrawingLocation(GeoCanvas, Single, Single) ====
+    * Type:TimeSpan
-This method returns the drawing location of the AdornmentLayer.
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.ScreenPointF|ScreenPointF]]<!-- ThinkGeo.MapSuite.Core.ScreenPointF -->   | It returns the upper left screen point of where the AdornmentLayer will be drawn.   |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) **
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter is the canvas used in drawing.   |
-| adornmentWidth   | Single<!-- System.Single -->   | This parameter is the width of the adornment.   |
-| adornmentHeight   | Single<!-- System.Single -->   | This parameter is the height of the adornment   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetHashCode() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //bufferTime//
-==== GetType() ====
+    * Type:TimeSpan
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+  * //bufferTimeType//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
+    * Description:N/A
-<!-- System.Object -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **
-==== LoadLayer(Uri) ====
-<!-- static -->
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| layerUri   | Uri<!-- System.Uri -->   |    |
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== LoadLayer(Stream) ====
+  * Description:N/A
-<!-- static -->
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //extentToRefresh//
-| layerStream   | Stream<!-- System.IO.Stream -->   |    |
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //bufferTime//
-[[#Public Methods|Go Back]]
+    * Type:TimeSpan
-==== Open() ====
+    * Description:N/A
-This method opens the Layer so that it is initialized and ready to use.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method OpenCore. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.
-When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **
-As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
+  * //N/A//
-=== Return Value ===
+== Remarks ==
-^ Return Type ^ Description ^
+  * //N/A//
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //extentToRefresh//
-==== RequestDrawing(TimeSpan) ====
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //bufferTime//
-^  Name ^  Type ^  Description ^
+    * Type:TimeSpan
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //bufferTimeType//
-[[#Public Methods|Go Back]]
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
-==== RequestDrawing(TimeSpan, RequestDrawingBufferTimeType) ====
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
-| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== RequestDrawing() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+  * //extentsToRefresh//
-==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan, RequestDrawingBufferTimeType) ====
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //bufferTime//
-^  Name ^  Type ^  Description ^
+    * Type:TimeSpan
-| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |
+    * Description:N/A
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
-| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) **
-==== RequestDrawing(IEnumerable<RectangleShape>, TimeSpan) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |
+  * //N/A//
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-==== RequestDrawing(RectangleShape, TimeSpan, RequestDrawingBufferTimeType) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+  * //extentsToRefresh//
-| extentToRefresh   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
+    * Description:N/A
-| bufferTimeType   | [[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]<!-- ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //bufferTime//
-[[#Public Methods|Go Back]]
+    * Type:TimeSpan
-==== RequestDrawing(IEnumerable<RectangleShape>) ====
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //bufferTimeType//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
-| extentsToRefresh   | IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.RectangleShape} -->   |    |
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+<div newline></div>
-[[#Public Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() **
-==== RequestDrawing(RectangleShape) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| extentToRefresh   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]]
-==== RequestDrawing(RectangleShape, TimeSpan) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| extentToRefresh   | [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   |    |
+** {{wiki:PublicMethod.gif|}} CloneDeep() **
-| bufferTime   | TimeSpan<!-- System.TimeSpan -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== ToString() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]]
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-===== Protected Methods =====
+** {{wiki:PublicMethod.gif|}} Open() **
-==== CloneDeepCore() ====
-Create a copy of Layer using the deep clone process. The default implemenation uses serialization.
-=== Remarks ===
-The difference between deep clone and shallow clone is as follows: In shallow cloning, only the object is copied; the objects within it are not. By contrast, deep cloning copies the cloned object as well as all the objects within.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.Layer|Layer]]<!-- ThinkGeo.MapSuite.Core.Layer -->   | A cloned Layer.   |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Void
-==== CloseCore() ====
+  * Description:N/A
-This method closes the Layer and releases any resources it was using.
-=== Remarks ===
-This abstract method is called from the concrete public method Close. The close method plays an important role in the life cycle of the Layer. It may be called after drawing to release any memory and other resources that were allocated since the Open method was called.
-If you override this method, it is recommended that you take the following things into account: This method may be called multiple times, so we suggest you write the method so that that a call to a closed Layer is ignored and does not generate an error. We also suggest that in the Close you free all resources that have been opened. Remember that the object will not be destroyed, but will be re-opened possibly in the near future.
+== Parameters ==
-=== Return Value ===
+<div newline></div>
-^ Return Type ^ Description ^
+** {{wiki:PublicMethod.gif|}} Close() **
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Void
-==== DrawAttributionCore(GeoCanvas, String) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   |    |
+** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
-| attribution   | String<!-- System.String -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== DrawCore(GeoCanvas, Collection<SimpleCandidate>) ====
+  * //N/A//
-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 ==
-=== Return Value ===
+  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
-^ Return Type ^ Description ^
+  * Description:N/A
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | This parameter is the canvas object or a GeoImage to draw on.   |
+** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) **
-| labelsInAllLayers   | Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.SimpleCandidate} -->   | This parameter represents the labels used for collision detection and duplication checking.   |
-<!-- ThinkGeo.MapSuite.Core.Layer(overriden) -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== DrawException(GeoCanvas, Exception) ====
+  * //N/A//
-This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
-=== Remarks ===
-This method can be overriden its logic by rewrite the DrawExceptionCore.
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | The target canvas to draw the layer.   |
+  * Description:N/A
-| e   | Exception<!-- System.Exception -->   | The exception thrown when layer.Draw().   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //canvas//
-==== DrawExceptionCore(GeoCanvas, Exception) ====
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-This method will draw on the canvas when the layer.Draw throw exception and the DrawExceptionMode is set to DrawException instead of ThrowException.
+    * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //labelsInAllLayers//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
-| canvas   | [[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]<!-- ThinkGeo.MapSuite.Core.GeoCanvas -->   | The target canvas to draw the layer.   |
+    * Description:N/A
-| e   | Exception<!-- System.Exception -->   | The exception thrown when layer.Draw().   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:String
-==== GetBoundingBoxCore() ====
+  * Description:N/A
-This method returns the bounding box of the Layer.
-=== Remarks ===
-This method returns the bounding box of the Layer.
-=== Return Value ===
-^ Return Type ^ Description ^
-| [[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]<!-- ThinkGeo.MapSuite.Core.RectangleShape -->   | This method returns the bounding box of the Layer.   |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== MemberwiseClone() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Boolean
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //obj//
-==== OnDrawingAttribution(DrawingAttributionLayerEventArgs) ====
+    * Type:Object
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+<div newline></div>
-^  Name ^  Type ^  Description ^
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-| args   | [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs -->   |    |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== OnDrawingException(DrawingExceptionLayerEventArgs) ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
-| e   | [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs -->   |    |
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-==== OnDrawingProgressChanged(DrawingProgressChangedEventArgs) ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| e   | [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs -->   |    |
+  * //N/A//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Type
-==== OnDrawnAttribution(DrawnAttributionLayerEventArgs) ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
-| args   | [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs -->   |    |
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} UpdateScale(GeoCanvas,GeographyUnit) **
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== OnDrawnException(DrawnExceptionLayerEventArgs) ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Void
-| e   | [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs -->   |    |
+  * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+  * //canvas//
-==== OnRequestedDrawing(RequestedDrawingLayerEventArgs) ====
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-=== Return Value ===
+    * Description:N/A
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //mapUnit//
-^  Name ^  Type ^  Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeographyUnit|GeographyUnit]]
-| eventArgs   | [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs -->   |    |
+    * Description:N/A
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) **
-==== OnRequestingDrawing(RequestingDrawingLayerEventArgs) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+  * //This method draws the Layer.//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| eventArgs   | [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs -->   |    |
+  * //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.//
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Protected Methods|Go Back]]
+  * Type:Void
-==== OpenCore() ====
+  * Description:None
-This method opens the Layer so that it is initialized and ready to use.
-=== Remarks ===
-This abstract method is called from the concrete public method Open. The open method plays an important role, as it is responsible for initializing the Layer. Most methods on the Layer will throw an exception if the state of the Layer is not opened. When the map draws each layer, the layer will be opened as one of its first steps; then, after it is finished drawing with that layer, it will close it. In this way, we are sure to release all resources used by the Layer.
-When implementing the abstract method, consider opening the FeatureSource or RasterSource. You will get a chance to close these in the Close method of the Layer.
+== Parameters ==
-=== Return Value ===
+  * //canvas//
-^ Return Type ^ Description ^
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
-| Void<!-- System.Void -->   |    |
+    * Description:This parameter is the canvas object or a GeoImage to draw on.
-=== Parameters ===
+  * //labelsInAllLayers//
-^  Name ^  Type ^  Description ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
+    * Description:This parameter represents the labels used for collision detection and duplication checking.
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+<div newline></div>
-[[#Protected Methods|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) **
-===== Public Properties =====
-==== AlternateBarBrush ====
-The property is the GeoBrush that will be used to draw the alternate ScaleBar.
-=== Remarks ===
-This <strong>AlternateBarBrush</strong> property will give you full control over the appearance of the <strong>ScaleBarAdornmentLayer</strong>.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.Core.GeoBrush -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+  * //N/A//
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Attribution ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+== Return Value ==
-[[#Public Properties|Go Back]]
+  * Type:Void
-==== BackgroundMask ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+== Parameters ==
-[[#Public Properties|Go Back]]
+  * //eventArgs//
-==== BarBrush ====
+    * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
-The property is the GeoBrush that will be used to draw the ScaleBar.
+    * Description:N/A
-=== Remarks ===
-This <strong>BarBrush</strong> property will give you full control over the appearance of the <strong>ScaleBarAdornmentLayer</strong>.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.Core.GeoBrush -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+<div newline></div>
-[[#Public Properties|Go Back]]
+** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) **
-==== BarPen ====
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+  * //N/A//
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== BlueTranslation ====
+  * //N/A//
-This property gets and sets the amount of blue to apply to the image.
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Void
-| Single<!-- System.Single -->   |
+  * Description:N/A
+== Parameters ==
+  * //eventArgs//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]]
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]]
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OpenCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} CloseCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //canvas//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
+  * //e//
+    * Type:Exception
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //canvas//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
+  * //e//
+    * Type:Exception
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //e//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //e//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //canvas//
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Description:N/A
+  * //attribution//
+    * Type:String
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //args//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //args//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //e//
+    * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Object
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} ProjectionToDecimalDegrees **
+Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.Projection|Projection]]
+** {{wiki:PublicProperty.gif|}} DisplayUnitString **
-<!-- ThinkGeo.MapSuite.Core.Layer -->
-[[#Public Properties|Go Back]]
-==== DisplayUnitString ====
 This propery is a dictionary that exposes what text will be drawn to represent the ScaleLine Unit.
-=== Remarks ===
+== Remarks ==
 We will display different letters for different units of measure; for example: "m" for meters, "ft" for feet, etc.
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Dictionary<String,String>
-| Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+** {{wiki:PublicProperty.gif|}} UnitFamily **
-[[#Public Properties|Go Back]]
-==== DrawingExceptionMode ====
-Gets or sets the DrawExcpetionMode when exception happens.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionMode -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== DrawingTime ====
+By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.
-This property gets the last drawing time for the layer.
+== Return Value ==
-=== Remarks ===
+  * Type:[[ThinkGeo.MapSuite.Core.UnitSystem|UnitSystem]]
-We track the drawing time for the layer and report it back in this method. This is useful for determining the speed of various layers.
-=== Return Value ===
-^ Return Type ^
-| TimeSpan<!-- System.TimeSpan -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} Thickness **
-[[#Public Properties|Go Back]]
-==== GreenTranslation ====
-This property gets and sets the amount of green to apply to the image.
-=== Return Value ===
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== HasBoundingBox ====
+N/A
-This property indicates whether a Layer has a BoundingBox or not. If it has no BoundingBox, it will throw an exception when you call the GetBoundingBox() and GetFullExtent() APIs.
+== Return Value ==
-=== Remarks ===
+  * Type:Int32
-The default value is false.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} MaxWidth **
-[[#Public Properties|Go Back]]
-==== HasMask ====
-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 <strong>HasMask</strong> property to true, be sure to specify a mask color (or texture) by using the <strong>MaskBrush</strong> property.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+Gets or Sets the MaxWidth of the ScaleBar.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Height ====
+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 ===
+== Return Value ==
-^ Return Type ^
+  * Type:Int32
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+** {{wiki:PublicProperty.gif|}} BarBrush **
-[[#Public Properties|Go Back]]
-==== IsGrayscale ====
-This property gets and sets if the image should be converted to grayscale.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+The property is the GeoBrush that will be used to draw the ScaleBar.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== IsNegative ====
+This BarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
-This property gets and sets whether the image should be converted to negative (inverse colors).
+== Return Value ==
-=== Return Value ===
+  * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} TextStyle **
-[[#Public Properties|Go Back]]
-==== IsOpen ====
-This property returns true if the Layer is open and false if it is not.
-=== Remarks ===
-This method is the concrete wrapper for the abstract method IsOpenCore. Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
-As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.
+N/A
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| Boolean<!-- System.Boolean -->   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} AlternateBarBrush **
-[[#Public Properties|Go Back]]
-==== IsVisible ====
-This property gets and set the visible state of the layer.
-=== Remarks ===
-If this property is set to false, the layer will not draw. We ensure this in the Draw method. This is useful for legends and other controls that control the visibility of layers.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+The property is the GeoBrush that will be used to draw the alternate ScaleBar.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== KeyColors ====
+This AlternateBarBrush property will give you full control over the appearance of the ScaleBarAdornmentLayer.
-Gets a value represents a collection of key colors. If HasKeyColor property is false, it will throw exception when you use KeyColors.
+== Return Value ==
-=== Remarks ===
+  * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
-It will make these colors transparent when draw image.
-=== Return Value ===
-^ Return Type ^
-| Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.GeoColor} -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} MaskBrush **
-[[#Public Properties|Go Back]]
-==== Location ====
-This property gets and sets the drawing location of the AdornmentLayer.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]]<!-- ThinkGeo.MapSuite.Core.AdornmentLocation -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
-[[#Public Properties|Go Back]]
-==== MaskBrush ====
 Gets or sets the color for the ScaleBarAdornmentLayer's mask, if the HasMask property is set to true.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+N/A
-| [[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]<!-- ThinkGeo.MapSuite.Core.GeoBrush -->   |
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
+** {{wiki:PublicProperty.gif|}} HasMask **
+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 ==
+  * Type:Boolean
+** {{wiki:PublicProperty.gif|}} MaskContour **
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
-[[#Public Properties|Go Back]]
-==== MaskContour ====
 Gets or sets the pen for the outline of the ScaleBar mask.
-=== Remarks ===
+== Remarks ==
-By using this property you can control the border of the mask, if the <strong>HasMask</strong> property is set to true. If you do not want a contour or border to show, you should set the pen to transparent.
+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 ===
+== Return Value ==
-^ Return Type ^
+  * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
-| [[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]<!-- ThinkGeo.MapSuite.Core.GeoPen -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+** {{wiki:PublicProperty.gif|}} BarPen **
-[[#Public Properties|Go Back]]
-==== MaxWidth ====
-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 <strong>ScaleBarAdornmentLayer</strong> 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 ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Name ====
+N/A
-This property gets and sets the name for the layer.
+== Return Value ==
-=== Remarks ===
+  * Type:[[ThinkGeo.MapSuite.Core.GeoPen|GeoPen]]
-The name is user defined. It is useful to set, as it may be used for higher level components such as legends, etc.
-=== Return Value ===
-^ Return Type ^
-| String<!-- System.String -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} Width **
-[[#Public Properties|Go Back]]
-==== ProjectionToDecimalDegrees ====
-Gets or sets a Proj4 projection parameter string which shows what coordinate system the map is using.
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.Projection|Projection]]<!-- ThinkGeo.MapSuite.Core.Projection -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== RedTranslation ====
+N/A
-This property gets and sets the amount of red to apply to the image.
+== Return Value ==
-=== Return Value ===
+  * Type:Single
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} Height **
-[[#Public Properties|Go Back]]
-==== RequestDrawingInterval ====
-=== Return Value ===
-^ Return Type ^
-| TimeSpan<!-- System.TimeSpan -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== TextStyle ====
+N/A
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:Single
-| [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+** {{wiki:PublicProperty.gif|}} BackgroundMask **
-[[#Public Properties|Go Back]]
-==== Thickness ====
-Gets or sets the thickness of the ScaleBar. It is an integer value representing the height of the ScaleBar in screen units.
-=== Return Value ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+N/A
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Transparency ====
+N/A
-This property gets and sets the amount of transparency to apply to the image.
+== Return Value ==
-=== Return Value ===
+  * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicProperty.gif|}} Location **
-[[#Public Properties|Go Back]]
-==== UnitFamily ====
+N/A
-Gets or sets the UnitSystem (Imperial/Metric) to be used for the ScaleBar.
+== Remarks ==
-=== Remarks ===
+N/A
-By setting this property, you can control whether to use a metric or imperial measurement system for the ScaleBar.
+== Return Value ==
-=== Return Value ===
+  * Type:[[ThinkGeo.MapSuite.Core.AdornmentLocation|AdornmentLocation]]
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.UnitSystem|UnitSystem]]<!-- ThinkGeo.MapSuite.Core.UnitSystem -->   |
+** {{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|}} RequestDrawingInterval **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:TimeSpan
+** {{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.MapSuite.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|}} DrawingExceptionMode **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
+==== 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|}} RequestedDrawing **
+N/A
+== Remarks ==
+N/A
+Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
-<!-- ThinkGeo.MapSuite.Core.ScaleBarAdornmentLayer -->
+** {{wiki:PublicEvent.gif|}} RequestingDrawing **
-[[#Public Properties|Go Back]]
+N/A
-==== Width ====
+== Remarks ==
-=== Return Value ===
+N/A
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
-[[#Public Properties|Go Back]]
-==== XOffsetInPixel ====
-This property gets and sets the X pixel offset for the AdornmentLayer.
-=== Remarks ===
-This property allows you to specify an X offset. It is useful, when combined with a Y offset, to do things like modify the location of the adornment.
-=== Return Value ===
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+** {{wiki:PublicEvent.gif|}} DrawingProgressChanged **
-[[#Public Properties|Go Back]]
+N/A
-==== YOffsetInPixel ====
+== Remarks ==
-This property gets and sets the Y pixel offset for the AdornmentLayer.
+N/A
-=== Remarks ===
-This property allows you to specify a Y offset. It is useful, when combined with an X offset, to do things like modify the location of the adornment.
-=== Return Value ===
-^ Return Type ^
-| Single<!-- System.Single -->   |
-<!-- ThinkGeo.MapSuite.Core.AdornmentLayer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-==== IsOpenCore ====
-This property returns true if the Layer is open and false if it is not.
-=== Remarks ===
-Various methods on the Layer require that it be in an open state. If one of those methods is called when the state is not open, then the method will throw an exception. To enter the open state, you must call the Layer Open method. The method will raise an exception if the current Layer is already open.
-=== Return Value ===
-^ Return Type ^
-| Boolean<!-- System.Boolean -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicEvent.gif|}} DrawingException **
-[[#Protected Properties|Go Back]]
+N/A
-===== Public Events =====
+== Remarks ==
-==== DrawingAttribution ====
+N/A
-=== Event Arguments ===
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]
-[[#Public Events|Go Back]]
-==== DrawingException ====
-=== Event Arguments ===
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicEvent.gif|}} DrawnException **
-[[#Public Events|Go Back]]
+N/A
-==== DrawingProgressChanged ====
+== Remarks ==
-=== Event Arguments ===
+N/A
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]
-[[#Public Events|Go Back]]
-==== DrawnAttribution ====
-=== Event Arguments ===
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicEvent.gif|}} DrawingAttribution **
-[[#Public Events|Go Back]]
+N/A
-==== DrawnException ====
+== Remarks ==
-=== Event Arguments ===
+N/A
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]
-[[#Public Events|Go Back]]
-==== RequestedDrawing ====
-=== Event Arguments ===
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+** {{wiki:PublicEvent.gif|}} DrawnAttribution **
-[[#Public Events|Go Back]]
+N/A
-==== RequestingDrawing ====
+== Remarks ==
-=== Event Arguments ===
+N/A
-^ Event Arguments ^
-| [[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]<!-- ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs -->   |
-<!-- ThinkGeo.MapSuite.Core.Layer -->
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]
-[[#Public Events|Go Back]]
-__NOTOC__
-[[Category:MapSuiteCore]]
-[[Category:ThinkGeo.MapSuite.Core]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools