Differences

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

--- thinkgeo.mapsuite.core.backgroundlayer [2015/09/21 01:01]
admin
+++ thinkgeo.mapsuite.core.backgroundlayer [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.BackgroundLayer ======
+{{section>upgrade_map_suite_to_10.0}}
 This class draws the background of the map.
 ===== Inheritance Hierarchy =====
@@ Line 9: / Line 12: @@
 ** {{wiki:PublicMethod.gif|}} BackgroundLayer() **
-This is the default constructor for the class.
+  * //This is the default constructor for the class.//
 == Remarks ==
-This is the default constructor. If you use this constructor, then you need to set the required properties manually.
+  * //This is the default constructor. If you use this constructor, then you need to set the required properties manually.//
 == Parameters ==
 <div newline></div>
 ** {{wiki:PublicMethod.gif|}} BackgroundLayer(GeoBrush) **
-This is a constructor for the class.
+  * //This is a constructor for the class.//
 == Remarks ==
-None
+  * //None//
 == Parameters ==
   * //backgroundBrush//
@@ Line 27: / Line 30: @@
 ==== Protected Constructors ====
 ==== Public Methods ====
-** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]]
+  * Type:Void
   * Description:N/A
 == Parameters ==
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} CloneDeep() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]]
+  * Type:Void
   * Description:N/A
 == Parameters ==
+  * //extentToRefresh//
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} Open() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 62: / Line 69: @@
 == Parameters ==
+  * //extentsToRefresh//
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
+    * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} Close() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 74: / Line 85: @@
 == Parameters ==
+  * //bufferTime//
+    * Type:TimeSpan
+    * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Type:Void
   * Description:N/A
 == Parameters ==
+  * //bufferTime//
+    * Type:TimeSpan
+    * Description:N/A
+  * //bufferTimeType//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
+    * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 98: / Line 121: @@
 == Parameters ==
-  * //canvas//
+  * //extentToRefresh//
-    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
     * Description:N/A
-  * //labelsInAllLayers//
+  * //bufferTime//
-    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
+    * Type:TimeSpan
     * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing() **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 118: / Line 141: @@
 == Parameters ==
+  * //extentToRefresh//
+    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Description:N/A
+  * //bufferTime//
+    * Type:TimeSpan
+    * Description:N/A
+  * //bufferTimeType//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
+    * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape) **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 130: / Line 165: @@
 == Parameters ==
-  * //extentToRefresh//
+  * //extentsToRefresh//
-    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
+    * Description:N/A
+  * //bufferTime//
+    * Type:TimeSpan
     * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>) **
+** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan,RequestDrawingBufferTimeType) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 148: / Line 187: @@
   * //extentsToRefresh//
     * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
+    * Description:N/A
+  * //bufferTime//
+    * Type:TimeSpan
+    * Description:N/A
+  * //bufferTimeType//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestDrawingBufferTimeType|RequestDrawingBufferTimeType]]
     * Description:N/A
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing(TimeSpan) **
+** {{wiki:PublicMethod.gif|}} GetThreadSafetyLevel() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
-  * Type:Void
+  * Type:[[ThinkGeo.MapSuite.Core.ThreadSafetyLevel|ThreadSafetyLevel]]
   * Description:N/A
 == Parameters ==
-  * //bufferTime//
+<div newline></div>
-    * Type:TimeSpan
+** {{wiki:PublicMethod.gif|}} CloneDeep() **
-    * Description:N/A
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.Layer|Layer]]
+  * Description:N/A
+== Parameters ==
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing(RectangleShape,TimeSpan) **
+** {{wiki:PublicMethod.gif|}} Open() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 178: / Line 233: @@
 == Parameters ==
-  * //extentToRefresh//
+<div newline></div>
-    * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+** {{wiki:PublicMethod.gif|}} Close() **
-    * Description:N/A
-  * //bufferTime//
+  * //N/A//
-    * Type:TimeSpan
+== Remarks ==
-    * Description:N/A
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
 <div newline></div>
-** {{wiki:PublicMethod.gif|}} RequestDrawing(IEnumerable<RectangleShape>,TimeSpan) **
+** {{wiki:PublicMethod.gif|}} GetBoundingBox() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
+== Return Value ==
+  * Type:[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]
+  * Description:N/A
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Draw(GeoCanvas,Collection<SimpleCandidate>) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
 == Return Value ==
@@ Line 198: / Line 269: @@
 == Parameters ==
-  * //extentsToRefresh//
+  * //canvas//
-    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.RectangleShape|RectangleShape]]>
+    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
     * Description:N/A
-  * //bufferTime//
+  * //labelsInAllLayers//
-    * Type:TimeSpan
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
     * Description:N/A
@@ Line 209: / Line 280: @@
 ** {{wiki:PublicMethod.gif|}} ToString() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 221: / Line 292: @@
 ** {{wiki:PublicMethod.gif|}} Equals(Object) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 237: / Line 308: @@
 ** {{wiki:PublicMethod.gif|}} GetHashCode() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 249: / Line 320: @@
 ** {{wiki:PublicMethod.gif|}} GetType() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 262: / Line 333: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawCore(GeoCanvas,Collection<SimpleCandidate>) **
-This method will draw the background layer based on the parameters provided.
+  * //This method will draw the background layer based on the parameters provided.//
 == Remarks ==
-None
+  * //None//
 == Return Value ==
@@ Line 278: / Line 349: @@
     * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
     * Description:This parameter is not used for BackgroundLayers.
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //eventArgs//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
+    * Description:N/A
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Return Value ==
+  * Type:Void
+  * Description:N/A
+== Parameters ==
+  * //eventArgs//
+    * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
+    * Description:N/A
 <div newline></div>
 ** {{wiki:ProtectedMethod.gif|}} GetThreadSafetyLevelCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 294: / Line 397: @@
 ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 306: / Line 409: @@
 ** {{wiki:ProtectedMethod.gif|}} OpenCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 318: / Line 421: @@
 ** {{wiki:ProtectedMethod.gif|}} CloseCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 330: / Line 433: @@
 ** {{wiki:ProtectedMethod.gif|}} GetBoundingBoxCore() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 342: / Line 445: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawException(GeoCanvas,Exception) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 362: / Line 465: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawExceptionCore(GeoCanvas,Exception) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 382: / Line 485: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawingException(DrawingExceptionLayerEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 398: / Line 501: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawnException(DrawnExceptionLayerEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 414: / Line 517: @@
 ** {{wiki:ProtectedMethod.gif|}} DrawAttributionCore(GeoCanvas,String) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 434: / Line 537: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawingAttribution(DrawingAttributionLayerEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 450: / Line 553: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawnAttribution(DrawnAttributionLayerEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 466: / Line 569: @@
 ** {{wiki:ProtectedMethod.gif|}} OnDrawingProgressChanged(DrawingProgressChangedEventArgs) **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 477: / Line 580: @@
   * //e//
     * Type:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]
-    * Description:N/A
-<div newline></div>
-** {{wiki:ProtectedMethod.gif|}} OnRequestedDrawing(RequestedDrawingLayerEventArgs) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //eventArgs//
-    * Type:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
-    * Description:N/A
-<div newline></div>
-** {{wiki:ProtectedMethod.gif|}} OnRequestingDrawing(RequestingDrawingLayerEventArgs) **
-N/A
-== Remarks ==
-N/A
-== Return Value ==
-  * Type:Void
-  * Description:N/A
-== Parameters ==
-  * //eventArgs//
-    * Type:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
     * Description:N/A
@@ Line 514: / Line 585: @@
 ** {{wiki:ProtectedMethod.gif|}} Finalize() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 526: / Line 597: @@
 ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-N/A
+  * //N/A//
 == Remarks ==
-N/A
+  * //N/A//
 == Return Value ==
@@ Line 544: / Line 615: @@
 == Return Value ==
   * Type:[[ThinkGeo.MapSuite.Core.GeoBrush|GeoBrush]]
+** {{wiki:PublicProperty.gif|}} RequestDrawingInterval **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:TimeSpan
 ** {{wiki:PublicProperty.gif|}} IsOpen **
@@ Line 570: / Line 649: @@
 ** {{wiki:PublicProperty.gif|}} Name **
+N/A
+== Remarks ==
+N/A
+== Return Value ==
+  * Type:String
+** {{wiki:PublicProperty.gif|}} Attribution **
 N/A
@@ Line 593: / Line 680: @@
   * Type:Single
-** {{wiki:PublicProperty.gif|}} IsNegative **
+** {{wiki:PublicProperty.gif|}} BlueTranslation **
 N/A
@@ Line 599: / Line 686: @@
 N/A
 == Return Value ==
-  * Type:Boolean
+  * Type:Single
-** {{wiki:PublicProperty.gif|}} IsGrayscale **
+** {{wiki:PublicProperty.gif|}} RedTranslation **
 N/A
@@ Line 607: / Line 694: @@
 N/A
 == Return Value ==
-  * Type:Boolean
+  * Type:Single
-** {{wiki:PublicProperty.gif|}} DrawingExceptionMode **
+** {{wiki:PublicProperty.gif|}} GreenTranslation **
 N/A
@@ Line 615: / Line 702: @@
 N/A
 == Return Value ==
-  * Type:[[ThinkGeo.MapSuite.Core.DrawingExceptionMode|DrawingExceptionMode]]
+  * Type:Single
-** {{wiki:PublicProperty.gif|}} Attribution **
+** {{wiki:PublicProperty.gif|}} KeyColors **
 N/A
@@ Line 623: / Line 710: @@
 N/A
 == Return Value ==
-  * Type:String
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.GeoColor|GeoColor]]>
-** {{wiki:PublicProperty.gif|}} RequestDrawingInterval **
+** {{wiki:PublicProperty.gif|}} IsNegative **
 N/A
@@ Line 631: / Line 718: @@
 N/A
 == Return Value ==
-  * Type:TimeSpan
+  * 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 ====
@@ Line 643: / Line 746: @@
 ==== Public Events ====
-** {{wiki:PublicEvent.gif|}} DrawingException **
+** {{wiki:PublicEvent.gif|}} RequestedDrawing **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
-** {{wiki:PublicEvent.gif|}} DrawingProgressChanged **
+** {{wiki:PublicEvent.gif|}} RequestingDrawing **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
-** {{wiki:PublicEvent.gif|}} DrawnException **
+** {{wiki:PublicEvent.gif|}} DrawingProgressChanged **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingProgressChangedEventArgs|DrawingProgressChangedEventArgs]]
-** {{wiki:PublicEvent.gif|}} DrawingAttribution **
+** {{wiki:PublicEvent.gif|}} DrawingException **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingExceptionLayerEventArgs|DrawingExceptionLayerEventArgs]]
-** {{wiki:PublicEvent.gif|}} DrawnAttribution **
+** {{wiki:PublicEvent.gif|}} DrawnException **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnExceptionLayerEventArgs|DrawnExceptionLayerEventArgs]]
-** {{wiki:PublicEvent.gif|}} RequestedDrawing **
+** {{wiki:PublicEvent.gif|}} DrawingAttribution **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.RequestedDrawingLayerEventArgs|RequestedDrawingLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawingAttributionLayerEventArgs|DrawingAttributionLayerEventArgs]]
-** {{wiki:PublicEvent.gif|}} RequestingDrawing **
+** {{wiki:PublicEvent.gif|}} DrawnAttribution **
 N/A
 == Remarks ==
 N/A
-Event Arguments:[[ThinkGeo.MapSuite.Core.RequestingDrawingLayerEventArgs|RequestingDrawingLayerEventArgs]]
+Event Arguments:[[ThinkGeo.MapSuite.Core.DrawnAttributionLayerEventArgs|DrawnAttributionLayerEventArgs]]

User Tools

Site Tools

Differences

Page Tools