Differences

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

--- thinkgeo.mapsuite.core.classbreak [2015/08/20 03:08]
127.0.0.1 external edit
+++ 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}}
-<!-- Class -->
 This class represents a single class break.
-=== Remarks ===
+===== Inheritance Hierarchy =====
-Class breaks are used in the ClassBreakStyle. They allow you to display data differently depending on ranges of data in the FeatureSource.
+  *System.Object
+    ***ThinkGeo.MapSuite.Core.ClassBreak**
+===== Members Summary =====
+==== Public Constructors ====
+** {{wiki:PublicMethod.gif|}} ClassBreak() **
-How class breaks work:
+  * //This is the class constructor.//
+== Remarks ==
+  * //If you use this default constructor, then you should set the properties manually.//
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,AreaStyle) **
-You add a number of ClassBreak classes to the ClassBreak collection. The numeric values of the breaks are important and you must place the breaks in numerical order. For example, break 0 must be added before break 100. In each ClassBreak, you specify the style you want to represent that break. Additionally, in the ColumnName property, you specify the name of the column where we will find the data used to compare the breaks. The column name must point to a column that is numeric.
+  * //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.
-When we proceed to draw the style, we look through the ClassBreaks and select the ClassBreak that is where the features column data is greater than and closest to the break value.
+  * //areaStyle//
+    * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
+    * Description:This parameter is the AreaStyle you want to use to represent this break.
-Example:
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,PointStyle) **
-Feature Value = 42
+  * //This is the class constructor.//
+== 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.
-ClassBreak1.Value = 0
+  * //pointStyle//
-ClassBreak2.Value = 20
+    * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
-ClassBreak3.Value = 40
+    * Description:This parameter is the PointStyle you want to use to represent this break.
-ClassBreak4.Value = 60
-In this case, the break closest to the feature value without exceeding it is ClassBreak3(40). If the feature value had been less than zero, nothing would have been drawn. If the feature value were 1000, then ClassBreak4 would draw.
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,LineStyle) **
-If you wanted to represent a value that is less then zero, you could do that as shown in the sample below.
+  * //This is the class constructor.//
+== Remarks ==
+  * //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.
-Feature Value = -1
+  * //lineStyle//
+    * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
+    * Description:This parameter is the LineStyle you want to use to represent this break.
-ClassBreak1.Value = Double.Min
+<div newline></div>
-ClassBreak2.Value = 0
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,TextStyle) **
-ClassBreak3.Value = 20
-ClassBreak4.Value = 40
-In this example, the first class break would be used.
+  * //This is the class constructor.//
-===== Inheritance Hierarchy =====
+== Remarks ==
-*System.Object
+  * //This overload allows you to pass in a break value and a TextStyle to use.//
-**[[ThinkGeo.MapSuite.Core.ClassBreak]]
+== Parameters ==
-===== Members Summary =====
+  * //value//
-==== Public Constructors ====
+    * Type:Double
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+    * Description:The parameter represents the break value.
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak()|ClassBreak]]   |    |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak(Double, AreaStyle)|ClassBreak]]   | Double, [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]   |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak(Double, PointStyle)|ClassBreak]]   | Double, [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]   |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak(Double, LineStyle)|ClassBreak]]   | Double, [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]   |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak(Double, TextStyle)|ClassBreak]]   | Double, [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]   |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreak(Double, Collection<Style>)|ClassBreak]]   | Double, Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>   |    | This is the class constructor.   |
-==== Protected Constructors ====
+  * //textStyle//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+    * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
+    * Description:This parameter is the TextStyle you want to use to represent this break.
-==== Public Methods ====
+<div newline></div>
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ClassBreak(Double,Collection<Style>) **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //This is the class constructor.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //This overload allows you to pass in a break value and a collection of TextStyles to use.//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
+== Parameters ==
+  * //value//
+    * Type:Double
+    * Description:The parameter represents the break value.
-==== Public Properties ====
+  * //customStyles//
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+    * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-| {{wiki:PublicProperty.gif|Public Property}}[[#CustomStyles|CustomStyles]]   | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>   |    | This property gets a collection of custom styles used to draw the class break.   |
+    * Description:This parameter is the TextStyles you want to use to represent this break.
-| {{wiki:PublicProperty.gif|Public Property}}[[#DefaultAreaStyle|DefaultAreaStyle]]   | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]   |    | This property gets and sets the default AreaStyle used to draw the class break.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DefaultLineStyle|DefaultLineStyle]]   | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]   |    | This property gets and sets the default LineStyle used to draw the class break.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DefaultPointStyle|DefaultPointStyle]]   | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]   |    | This property gets and sets the default PointStyle used to draw the class break.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#DefaultTextStyle|DefaultTextStyle]]   | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]   |    | This property gets and sets the default TextStyle used to draw the class break.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#Value|Value]]   | Double   |    | This property get and sets the break value.   |
-==== Protected Properties ====
+<div newline></div>
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+==== Protected Constructors ====
+==== Public Methods ====
+** {{wiki:PublicMethod.gif|}} ToString() **
-==== Public Events ====
+  * //N/A//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
-===== Public Constructors =====
+== Return Value ==
-==== ClassBreak() ====
+  * Type:String
-This is the class constructor.
+  * Description:N/A
-=== Overloads ===
-This is the default constructor.
-=== Remarks ===
-If you use this default constructor, then you should set the properties manually.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== ClassBreak(Double, AreaStyle) ====
+<div newline></div>
-This is the class constructor.
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-=== Overloads ===
-This overload allows you to pass in a break value and an AreaStyle to use.
-=== Remarks ===
-This overload allows you to pass in a break value and an AreaStyle to use.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| value   | Double<!-- System.Double -->   | The parameter represents the break value.   |
-| areaStyle   | [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle -->   | This parameter is the AreaStyle you want to use to represent this break.   |
-[[#Public Constructors|Go Back]]
+  * //N/A//
-==== ClassBreak(Double, PointStyle) ====
+== Remarks ==
-This is the class constructor.
+  * //N/A//
-=== Overloads ===
-This overload allows you to pass in a break value and a Point to use.
-=== Remarks ===
-This overload allows you to pass in a break value and a Point to use.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| value   | Double<!-- System.Double -->   | The parameter represents the break value.   |
-| pointStyle   | [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle -->   | This parameter is the PointStyle you want to use to represent this break.   |
-[[#Public Constructors|Go Back]]
+== Return Value ==
-==== ClassBreak(Double, LineStyle) ====
+  * Type:Boolean
-This is the class constructor.
+  * Description:N/A
-=== Overloads ===
-This overload allows you to pass in a break value and a LineStyle to use.
-=== Remarks ===
-This overload allows you to pass in a break value and a LineStyle to use.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| value   | Double<!-- System.Double -->   | The parameter represents the break value.   |
-| lineStyle   | [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle -->   | This parameter is the LineStyle you want to use to represent this break.   |
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== ClassBreak(Double, TextStyle) ====
+  * //obj//
-This is the class constructor.
+    * Type:Object
-=== Overloads ===
+    * Description:N/A
-This overload allows you to pass in a break value and a TextStyle to use.
-=== Remarks ===
-This overload allows you to pass in a break value and a TextStyle to use.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| value   | Double<!-- System.Double -->   | The parameter represents the break value.   |
-| textStyle   | [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle -->   | This parameter is the TextStyle you want to use to represent this break.   |
-[[#Public Constructors|Go Back]]
+<div newline></div>
-==== ClassBreak(Double, Collection<Style>) ====
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-This is the class constructor.
-=== Overloads ===
-This overload allows you to pass in a break value and a collection of TextStyles to use.
-=== Remarks ===
-This overload allows you to pass in a break value and a collection of TextStyles to use.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| value   | Double<!-- System.Double -->   | The parameter represents the break value.   |
-| customStyles   | Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} -->   | This parameter is the TextStyles you want to use to represent this break.   |
-[[#Public Constructors|Go Back]]
+  * //N/A//
-===== Protected Constructors =====
+== Remarks ==
-===== Public Methods =====
+  * //N/A//
-==== Equals(Object) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Int32
-| obj   | Object<!-- System.Object -->   |    |
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== GetHashCode() ====
+** {{wiki:PublicMethod.gif|}} GetType() **
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Type
-==== GetType() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Protected Methods ====
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-<!-- System.Object -->
+  * //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:Void
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-===== Protected Methods =====
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-==== 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:Object
-==== MemberwiseClone() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+==== Public Properties ====
+** {{wiki:PublicProperty.gif|}} Value **
-<!-- System.Object -->
+This property get and sets the break value.
-[[#Protected Methods|Go Back]]
+== Remarks ==
-===== Public Properties =====
+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.
-==== CustomStyles ====
+== Return Value ==
-This property gets a collection of custom styles used to draw the class break.
+  * Type:Double
-=== 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.
+** {{wiki:PublicProperty.gif|}} DefaultAreaStyle **
-=== Return Value ===
-^ Return Type ^
-| Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.Core.Style} -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
-[[#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 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 ==
+  * Type:[[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]
-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.
+** {{wiki:PublicProperty.gif|}} DefaultLineStyle **
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.AreaStyle|AreaStyle]]<!-- ThinkGeo.MapSuite.Core.AreaStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
-[[#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 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 ==
+  * Type:[[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]
-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.
+** {{wiki:PublicProperty.gif|}} DefaultPointStyle **
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.LineStyle|LineStyle]]<!-- ThinkGeo.MapSuite.Core.LineStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
-[[#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 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 ==
+  * Type:[[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]
-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.
+** {{wiki:PublicProperty.gif|}} DefaultTextStyle **
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.PointStyle|PointStyle]]<!-- ThinkGeo.MapSuite.Core.PointStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
-[[#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 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 ==
+  * Type:[[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]
-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.
+** {{wiki:PublicProperty.gif|}} CustomStyles **
-=== Return Value ===
-^ Return Type ^
-| [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<!-- ThinkGeo.MapSuite.Core.TextStyle -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
+This property gets a collection of custom styles used to draw the class break.
-[[#Public Properties|Go Back]]
+== Remarks ==
-==== Value ====
+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.
-This property get and sets the break value.
+== Return Value ==
-=== Remarks ===
+  * Type:Collection<[[ThinkGeo.MapSuite.Core.Style|Style]]>
-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.
+==== Protected Properties ====
-=== Return Value ===
+==== Public Events ====
-^ Return Type ^
-| Double<!-- System.Double -->   |
-<!-- ThinkGeo.MapSuite.Core.ClassBreak -->
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
-===== Public Events =====
-__NOTOC__
-[[Category:MapSuiteCore]]
-[[Category:ThinkGeo.MapSuite.Core]]
-[[Category:UpdateDocumentation]]

User Tools

Site Tools

Differences

Page Tools