This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.classbreakstyle [2015/09/18 05:38] admin |
thinkgeo.mapsuite.core.classbreakstyle [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.ClassBreakStyle ====== | ====== ThinkGeo.MapSuite.Core.ClassBreakStyle ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents a style based on class break values. | This class represents a style based on class break values. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 9: | Line 12: | ||
** {{wiki:PublicMethod.gif|}} ClassBreakStyle() ** | ** {{wiki:PublicMethod.gif|}} ClassBreakStyle() ** | ||
- | This is the constructor for this class. | + | * //This is the constructor for this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
<div newline></div> | <div newline></div> | ||
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String) ** | ** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String) ** | ||
- | This is the constructor for this class. | + | * //This is the constructor for this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //columnName// | * //columnName// | ||
Line 27: | Line 30: | ||
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion) ** | ** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion) ** | ||
- | This is the constructor for this class. | + | * //This is the constructor for this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //columnName// | * //columnName// | ||
Line 42: | Line 45: | ||
** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion,Collection<ClassBreak>) ** | ** {{wiki:PublicMethod.gif|}} ClassBreakStyle(String,BreakValueInclusion,Collection<ClassBreak>) ** | ||
- | This is the constructor for this class. | + | * //This is the constructor for this class.// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Parameters == | == Parameters == | ||
* //columnName// | * //columnName// | ||
Line 63: | Line 66: | ||
** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 75: | Line 78: | ||
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 103: | Line 106: | ||
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 131: | Line 134: | ||
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 143: | Line 146: | ||
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 163: | Line 166: | ||
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 179: | Line 182: | ||
** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 195: | Line 198: | ||
** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 211: | Line 214: | ||
** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 223: | Line 226: | ||
** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 239: | Line 242: | ||
** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 251: | Line 254: | ||
** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 264: | Line 267: | ||
** {{wiki:ProtectedMethod.gif|}} OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs) ** | ** {{wiki:ProtectedMethod.gif|}} OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 280: | Line 283: | ||
** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) ** | ||
- | This method draws the features on the canvas you provided. | + | * //This method draws the features on the canvas you provided.// |
== Remarks == | == Remarks == | ||
- | This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this 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. | + | * //This overridden method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the canvas you provided. Each style (based on its properties) may draw each feature differently. When overriding this 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 == | ||
Line 308: | Line 311: | ||
** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 328: | Line 331: | ||
** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** | ||
- | This method returns the column data for each feature that is required for the style to properly draw. | + | * //This method returns the column data for each feature that is required for the style to properly draw.// |
== Remarks == | == Remarks == | ||
- | This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. 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. | + | * //This abstract method is called from the concrete public method GetRequiredFieldNames. In this method, we return the column names that are required for the style to draw the feature properly. For example, if you have a style that colors areas blue when a certain column value is over 100, then you need to be sure you include that column name. This will ensure that the column data is returned to you in the feature when it is ready to draw. 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 == | ||
Line 340: | Line 343: | ||
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 352: | Line 355: | ||
** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == | ||
Line 364: | Line 367: | ||
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
- | N/A | + | * //N/A// |
== Remarks == | == Remarks == | ||
- | N/A | + | * //N/A// |
== Return Value == | == Return Value == |