Differences

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

--- thinkgeo.mapsuite.core.classbreak [2015/09/17 10:26]
admin
+++ thinkgeo.mapsuite.core.classbreak [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.ClassBreak ======
+{{section>upgrade_map_suite_to_10.0}}
 This class represents a single class break.
 ===== Inheritance Hierarchy =====
@@ Line 5: / Line 8: @@
     ***ThinkGeo.MapSuite.Core.ClassBreak**
 ===== Members Summary =====
-=== Public Constructors ===
+==== Public Constructors ====
-<div class_table>
+** {{wiki:PublicMethod.gif|}} ClassBreak() **
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak()|ClassBreak]]**
-  * **Parameters**:N/A
-  * **DeclaringType**:N/A
-  * **Summary**:This is the class constructor.
-</div>
-<div class_table>
+  * //This is the class constructor.//
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak(Double,AreaStyle)|ClassBreak]]**
+== Remarks ==
-  * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * //If you use this default constructor, then you should set the properties manually.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the class constructor.
+<div newline></div>
-</div>
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,AreaStyle) **
-<div class_table>
+  * //This is the class constructor.//
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak(Double,PointStyle)|ClassBreak]]**
+== Remarks ==
-  * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+  * //This overload allows you to pass in a break value and an AreaStyle to use.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the class constructor.
+  * //value//
-</div>
+    * Type:Double
+    * Description:The parameter represents the break value.
-<div class_table>
+  * //areaStyle//
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak(Double,LineStyle)|ClassBreak]]**
+    * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
-  * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+    * Description:This parameter is the AreaStyle you want to use to represent this break.
-  * **DeclaringType**:N/A
-  * **Summary**:This is the class constructor.
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak(Double,TextStyle)|ClassBreak]]**
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,PointStyle) **
-  * **Parameters**:Double,[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **DeclaringType**:N/A
-  * **Summary**:This is the class constructor.
-</div>
-<div class_table>
+  * //This is the class constructor.//
-**{{wiki:PublicMethod.gif|}}[[#ClassBreak(Double,Collection<Style>)|ClassBreak]]**
+== Remarks ==
-  * **Parameters**:Double,Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+  * //This overload allows you to pass in a break value and a Point to use.//
-  * **DeclaringType**:N/A
+== Parameters ==
-  * **Summary**:This is the class constructor.
+  * //value//
-</div>
+    * Type:Double
+    * Description:The parameter represents the break value.
-=== Protected Constructors ===
+  * //pointStyle//
-=== Public Methods ===
+    * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
-<div class_table>
+    * Description:This parameter is the PointStyle you want to use to represent this break.
-**{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]**
-  * **Parameters**:Object
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+<div newline></div>
-**{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]**
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,LineStyle) **
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is the class constructor.//
-**{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //This overload allows you to pass in a break value and a LineStyle to use.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //value//
-</div>
+    * Type:Double
+    * Description:The parameter represents the break value.
-<div class_table>
+  * //lineStyle//
-**{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]**
+    * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
-  * **Parameters**:N/A
+    * Description:This parameter is the LineStyle you want to use to represent this break.
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-=== Protected Methods ===
+<div newline></div>
-<div class_table>
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,TextStyle) **
-**{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]**
-  * **Parameters**:N/A
-  * **DeclaringType**:Object
-  * **Summary**:N/A
-</div>
-<div class_table>
+  * //This is the class constructor.//
-**{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]**
+== Remarks ==
-  * **Parameters**:N/A
+  * //This overload allows you to pass in a break value and a TextStyle to use.//
-  * **DeclaringType**:Object
+== Parameters ==
-  * **Summary**:N/A
+  * //value//
-</div>
+    * Type:Double
+    * Description:The parameter represents the break value.
-=== Public Properties ===
+  * //textStyle//
-**{{wiki:PublicProperty.gif|}}[[#CustomStyles|CustomStyles]]**
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-  * **Return**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+    * Description:This parameter is the TextStyle you want to use to represent this break.
-  * **Summary**:This property gets a collection of custom styles used to draw the class break.
-**{{wiki:PublicProperty.gif|}}[[#DefaultAreaStyle|DefaultAreaStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,Collection<Style>) **
-  * **Summary**:This property gets and sets the default AreaStyle used to draw the class break.
-**{{wiki:PublicProperty.gif|}}[[#DefaultLineStyle|DefaultLineStyle]]**
+  * //This is the class constructor.//
-  * **Return**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+== Remarks ==
-  * **Summary**:This property gets and sets the default LineStyle used to draw the class break.
+  * //This overload allows you to pass in a break value and a collection of TextStyles to use.//
+== Parameters ==
+  * //value//
+    * Type:Double
+    * Description:The parameter represents the break value.
-**{{wiki:PublicProperty.gif|}}[[#DefaultPointStyle|DefaultPointStyle]]**
+  * //customStyles//
-  * **Return**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-  * **Summary**:This property gets and sets the default PointStyle used to draw the class break.
+    * Description:This parameter is the TextStyles you want to use to represent this break.
-**{{wiki:PublicProperty.gif|}}[[#DefaultTextStyle|DefaultTextStyle]]**
+<div newline></div>
-  * **Return**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+==== Protected Constructors ====
-  * **Summary**:This property gets and sets the default TextStyle used to draw the class break.
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} ToString() **
-**{{wiki:PublicProperty.gif|}}[[#Value|Value]]**
+  * //N/A//
-  * **Return**:Double
+== Remarks ==
-  * **Summary**:This property get and sets the break value.
+  * //N/A//
-=== Protected Properties ===
+== Return Value ==
-=== Public Events ===
+  * Type:String
-===== Public Constructors =====
+  * Description:N/A
-=== ClassBreak() ===
-This is the class constructor.
-==== Remarks ====
-If you use this default constructor, then you should set the properties manually.
-==== Parameters ====
-[[#Public Constructors|Go Back]]
-=== ClassBreak(Double,AreaStyle) ===
-This is the class constructor.
-==== Remarks ====
-This overload allows you to pass in a break value and an AreaStyle to use.
-==== Parameters ====
-**value**
-  * **Type**:Double
-  * **Description:The parameter represents the break value.
-**areaStyle**
+== Parameters ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+<div newline></div>
-  * **Description:This parameter is the AreaStyle you want to use to represent this break.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== ClassBreak(Double,PointStyle) ===
+== Remarks ==
-This is the class constructor.
+  * //N/A//
-==== Remarks ====
-This overload allows you to pass in a break value and a Point to use.
-==== Parameters ====
-**value**
-  * **Type**:Double
-  * **Description:The parameter represents the break value.
-**pointStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+  * Type:Boolean
-  * **Description:This parameter is the PointStyle you want to use to represent this break.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== ClassBreak(Double,LineStyle) ===
+  * //obj//
-This is the class constructor.
+    * Type:Object
-==== Remarks ====
+    * Description:N/A
-This overload allows you to pass in a break value and a LineStyle to use.
-==== Parameters ====
-**value**
-  * **Type**:Double
-  * **Description:The parameter represents the break value.
-**lineStyle**
+<div newline></div>
-  * **Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-  * **Description:This parameter is the LineStyle you want to use to represent this break.
-[[#Public Constructors|Go Back]]
+  * //N/A//
-=== ClassBreak(Double,TextStyle) ===
+== Remarks ==
-This is the class constructor.
+  * //N/A//
-==== Remarks ====
-This overload allows you to pass in a break value and a TextStyle to use.
-==== Parameters ====
-**value**
-  * **Type**:Double
-  * **Description:The parameter represents the break value.
-**textStyle**
+== Return Value ==
-  * **Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:Int32
-  * **Description:This parameter is the TextStyle you want to use to represent this break.
+  * Description:N/A
-[[#Public Constructors|Go Back]]
+== Parameters ==
-=== ClassBreak(Double,Collection<Style>) ===
+<div newline></div>
-This is the class constructor.
+** {{wiki:PublicMethod.gif|}} GetType() **
-==== Remarks ====
-This overload allows you to pass in a break value and a collection of TextStyles to use.
-==== Parameters ====
-**value**
-  * **Type**:Double
-  * **Description:The parameter represents the break value.
-**customStyles**
+  * //N/A//
-  * **Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
+== Remarks ==
-  * **Description:This parameter is the TextStyles you want to use to represent this break.
+  * //N/A//
-[[#Public Constructors|Go Back]]
+== Return Value ==
-===== Protected Constructors =====
+  * Type:Type
-===== Public Methods =====
+  * Description:N/A
-=== Equals(Object) ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Boolean
+<div newline></div>
-  * **Description**:N/A
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-==== Parameters ====
+  * //N/A//
-**obj**
+== Remarks ==
-  * **Type**:Object
+  * //N/A//
-  * **Description**:N/A
-[[#Public Methods|Go Back]]
+== Return Value ==
-=== GetHashCode() ===
+  * Type:Void
-N/A
+  * Description:N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Parameters ==
-  * **Return Type**:Int32
+<div newline></div>
-  * **Description**:N/A
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== Parameters ====
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-=== GetType() ===
+  * //N/A//
-N/A
-==== Remarks ====
-N/A
-**Return Value**
+== Return Value ==
-  * **Return Type**:Type
+  * Type:Object
-  * **Description**:N/A
+  * Description:N/A
-==== Parameters ====
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-=== ToString() ===
+==== Public Properties ====
-N/A
+** {{wiki:PublicProperty.gif|}} Value **
-==== Remarks ====
-N/A
-**Return Value**
+This property get and sets the break value.
-  * **Return Type**:String
+== Remarks ==
-  * **Description**:N/A
+This value determines where the break is in the ClassBreakStyle. Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works.
+== Return Value ==
+  * Type:Double
-==== Parameters ====
+** {{wiki:PublicProperty.gif|}} DefaultAreaStyle **
-[[#Public Methods|Go Back]]
-===== Protected Methods =====
-=== Finalize() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Void
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-=== MemberwiseClone() ===
-N/A
-==== Remarks ====
-N/A
-**Return Value**
-  * **Return Type**:Object
-  * **Description**:N/A
-==== Parameters ====
-[[#Protected Methods|Go Back]]
-===== Public Properties =====
-=== CustomStyles ===
-This property gets a collection of custom styles used to draw the class break.
-==== Remarks ====
-If you set these styles, then when the data for a feature is within the current break it will use this style to draw. If you do not wish to use the default style properties, then you can use this collection to specify any types of styles you want to use.
-==== Return Value ====
-**Return Type**:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-[[#Public Properties|Go Back]]
-=== DefaultAreaStyle ===
 This property gets and sets the default AreaStyle used to draw the class break.
-==== Remarks ====
+== Remarks ==
 If you set this style, then when the data for a feature is within the current break it will use this style to draw. If you use the default styles, then you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultLineStyle **
-[[#Public Properties|Go Back]]
-=== DefaultLineStyle ===
 This property gets and sets the default LineStyle used to draw the class break.
-==== Remarks ====
+== Remarks ==
 If you set this style, then when the data for a feature is within the current break it will use this style to draw. If you use the default styles, then you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultPointStyle **
-[[#Public Properties|Go Back]]
-=== DefaultPointStyle ===
 This property gets and sets the default PointStyle used to draw the class break.
-==== Remarks ====
+== Remarks ==
 If you set this style, then when the data for a feature is within the current break it will use this style to draw. If you use the default styles, then you should only use one. The one you use should match your feature data. For example, if your features are lines, then you should use the DefaultLineStyle.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
+** {{wiki:PublicProperty.gif|}} DefaultTextStyle **
-[[#Public Properties|Go Back]]
-=== DefaultTextStyle ===
 This property gets and sets the default TextStyle used to draw the class break.
-==== Remarks ====
+== Remarks ==
 If you set this style, then when the data for a feature is within the current break it will use this style to draw. If you use the default styles, then you should only use one. The one you use should match your feature data. For example, if your features are lines then you should use the DefaultLineStyle.
-==== Return Value ====
+== Return Value ==
-**Return Type**:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-[[#Public Properties|Go Back]]
+** {{wiki:PublicProperty.gif|}} CustomStyles **
-=== Value ===
-This property get and sets the break value.
+This property gets a collection of custom styles used to draw the class break.
-==== Remarks ====
+== Remarks ==
-This value determines where the break is in the ClassBreakStyle. Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works.
+If you set these styles, then when the data for a feature is within the current break it will use this style to draw. If you do not wish to use the default style properties, then you can use this collection to specify any types of styles you want to use.
-==== Return Value ====
+== Return Value ==
-**Return Type**:Double
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-[[#Public Properties|Go Back]]
+==== Protected Properties ====
-===== Protected Properties =====
+==== Public Events ====
-===== Public Events =====

User Tools

Site Tools

Differences

Page Tools