User Tools

Site Tools

Trace:
thinkgeo.mapsuite.core.classbreak

Differences

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

Link to this comparison view

Next revision 		Previous revision
thinkgeo.mapsuite.core.classbreak [2015/08/20 03:08]
127.0.0.1 external edit 		— (current)
Line 1: Line 1:
-====== ThinkGeo.MapSuite.Core.ClassBreak ====== 
- 
- 
- 
-<!-- Class --> 
-This class represents a single class break. 
-=== Remarks === 
-Class breaks are used in the ClassBreakStyle. They allow you to display data differently depending on ranges of data in the FeatureSource. 
- 
-How class breaks work: 
- 
-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. 
- 
-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. 
- 
-Example: 
- 
-Feature Value = 42 
- 
-ClassBreak1.Value = 0 
-ClassBreak2.Value = 20 
-ClassBreak3.Value = 40 
-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. 
- 
-If you wanted to represent a value that is less then zero, you could do that as shown in the sample below. 
- 
-Feature Value = -1 
- 
-ClassBreak1.Value = Double.Min 
-ClassBreak2.Value = 0 
-ClassBreak3.Value = 20 
-ClassBreak4.Value = 40 
- 
-In this example, the first class break would be used. 
-===== Inheritance Hierarchy ===== 
-*System.Object 
-**[[ThinkGeo.MapSuite.Core.ClassBreak]] 
-===== Members Summary ===== 
-==== Public Constructors ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{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 ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
- 
-==== Public Methods ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{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 ==== 
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^ 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​Finalize()|Finalize]] ​  ​| ​   | Object ​  ​| ​   | 
-| {{wiki:​ProtectedMethod.gif|Protected Method}}[[#​MemberwiseClone()|MemberwiseClone]] ​  ​| ​   | Object ​  ​| ​   | 
- 
-==== Public Properties ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
-| {{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. ​  | 
-| {{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 ==== 
-^ Name ^ Return ^ DeclaringType ^ Summary ^ 
- 
-==== Public Events ==== 
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ 
- 
-===== Public Constructors ===== 
-==== ClassBreak() ==== 
-This is the class constructor. 
-=== 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]] 
-==== ClassBreak(Double,​ AreaStyle) ==== 
-This is the class constructor. 
-=== 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]] 
-==== ClassBreak(Double,​ PointStyle) ==== 
-This is the class constructor. 
-=== 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]] 
-==== ClassBreak(Double,​ LineStyle) ==== 
-This is the class constructor. 
-=== 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]] 
-==== ClassBreak(Double,​ TextStyle) ==== 
-This is the class constructor. 
-=== Overloads === 
-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]] 
-==== ClassBreak(Double,​ Collection<​Style>​) ==== 
-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]] 
-===== Protected Constructors ===== 
-===== Public Methods ===== 
-==== Equals(Object) ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Boolean<​!-- System.Boolean --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
-| obj   | Object<​!-- System.Object --> ​  ​| ​   | 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetHashCode() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Int32<​!-- System.Int32 --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== GetType() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Type<!-- System.Type --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-==== ToString() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| String<​!-- System.String --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#Public Methods|Go Back]] 
-===== Protected Methods ===== 
-==== Finalize() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Void<!-- System.Void --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​Protected Methods|Go Back]] 
-==== MemberwiseClone() ==== 
-=== Return Value === 
-^ Return Type ^ Description ^ 
-| Object<​!-- System.Object --> ​  ​| ​   | 
- 
-=== Parameters === 
-^  Name ^  Type ^  Description ^ 
- 
-<!-- System.Object --> 
-[[#​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]]><​!-- 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 === 
-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 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 === 
-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 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 === 
-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 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 === 
-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 Type ^ 
-| [[ThinkGeo.MapSuite.Core.TextStyle|TextStyle]]<​!-- ThinkGeo.MapSuite.Core.TextStyle --> ​  | 
- 
-<!-- ThinkGeo.MapSuite.Core.ClassBreak --> 
-[[#Public Properties|Go Back]] 
-==== Value ==== 
-This property get and sets the break value. 
-=== 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. 
-=== Return Value === 
-^ 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]] 
  
thinkgeo.mapsuite.core.classbreak.1440040128.txt.gz ยท Last modified: 2015/09/17 08:56 (external edit)

Page Tools