thinkgeo.mapsuite.portablecore.gradientstyle
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.gradientstyle [2015/09/21 08:10] admin |
thinkgeo.mapsuite.portablecore.gradientstyle [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.Core.GradientStyle ====== | ====== ThinkGeo.MapSuite.Core.GradientStyle ====== | ||
| + | |||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| + | |||
| This gradient style is a new style with the concept of GradientBrush. By specifying the LowerValue and its color, as well as the UpperValue and its color, we can set the color of each feature based on a column value using linear interpolation. | This gradient style is a new style with the concept of GradientBrush. By specifying the LowerValue and its color, as well as the UpperValue and its color, we can set the color of each feature based on a column value using linear interpolation. | ||
| ===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
| Line 9: | Line 12: | ||
| ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush) ** | ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush) ** | ||
| - | This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, and the upperValue and its corresponding SolidBrush. | + | * //This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, and the upperValue and its corresponding SolidBrush.// |
| == Remarks == | == Remarks == | ||
| - | In this constructor, the NoDataValue defaults to -9999 and the NoDataBrush color is transparent. | + | * //In this constructor, the NoDataValue defaults to -9999 and the NoDataBrush color is transparent.// |
| == Parameters == | == Parameters == | ||
| * //columnName// | * //columnName// | ||
| Line 36: | Line 39: | ||
| ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush) ** | ** {{wiki:PublicMethod.gif|}} GradientStyle(String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush) ** | ||
| - | This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, the upperValue and its corresponding SolidBrush, and the NoDataValue and its corresponding SolidBrush. | + | * //This constructor creates a new instance by passing the ColumnName (which it will get the data from) as well as the lowerValue and its corresponding SolidBrush, the upperValue and its corresponding SolidBrush, and the NoDataValue and its corresponding SolidBrush.// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Parameters == | == Parameters == | ||
| * //columnName// | * //columnName// | ||
| Line 73: | Line 76: | ||
| ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ** {{wiki:PublicMethod.gif|}} CloneDeep() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 85: | Line 88: | ||
| ** {{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 113: | Line 116: | ||
| ** {{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 141: | Line 144: | ||
| ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 153: | Line 156: | ||
| ** {{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 173: | Line 176: | ||
| ** {{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 184: | Line 187: | ||
| * //canvas// | * //canvas// | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]] | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //filePathName// | ||
| - | * Type:String | ||
| - | * Description:N/A | ||
| - | |||
| - | <div newline></div> | ||
| - | ** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** | ||
| - | |||
| - | N/A | ||
| - | == Remarks == | ||
| - | N/A | ||
| - | |||
| - | == Return Value == | ||
| - | * Type:Void | ||
| - | * Description:N/A | ||
| - | |||
| - | == Parameters == | ||
| - | * //stream// | ||
| - | * Type:Stream | ||
| * Description:N/A | * Description:N/A | ||
| Line 221: | Line 192: | ||
| ** {{wiki:PublicMethod.gif|}} ToString() ** | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 233: | Line 204: | ||
| ** {{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 249: | Line 220: | ||
| ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 261: | Line 232: | ||
| ** {{wiki:PublicMethod.gif|}} GetType() ** | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 274: | Line 245: | ||
| ** {{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 virtual 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 implementing this virtual 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 virtual 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 implementing this virtual 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 302: | Line 273: | ||
| ** {{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 314: | Line 285: | ||
| ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 326: | Line 297: | ||
| ** {{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 346: | Line 317: | ||
| ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 358: | Line 329: | ||
| ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| Line 371: | Line 342: | ||
| ** {{wiki:PublicProperty.gif|}} ColumnName ** | ** {{wiki:PublicProperty.gif|}} ColumnName ** | ||
| - | This property gets and sets the column name used in the style. | + | * //This property gets and sets the column name used in the style.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 379: | Line 350: | ||
| ** {{wiki:PublicProperty.gif|}} LowerValue ** | ** {{wiki:PublicProperty.gif|}} LowerValue ** | ||
| - | This property gets and sets the lower value used in the style. | + | * //This property gets and sets the lower value used in the style.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 387: | Line 358: | ||
| ** {{wiki:PublicProperty.gif|}} LowerGeoSolidBrush ** | ** {{wiki:PublicProperty.gif|}} LowerGeoSolidBrush ** | ||
| - | This property gets and sets the solid brush that is used for the style's lower value. | + | * //This property gets and sets the solid brush that is used for the style's lower value.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| Line 395: | Line 366: | ||
| ** {{wiki:PublicProperty.gif|}} UpperValue ** | ** {{wiki:PublicProperty.gif|}} UpperValue ** | ||
| - | This property gets and sets the upper value used in the style. | + | * //This property gets and sets the upper value used in the style.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 403: | Line 374: | ||
| ** {{wiki:PublicProperty.gif|}} UpperGeoSolidBrush ** | ** {{wiki:PublicProperty.gif|}} UpperGeoSolidBrush ** | ||
| - | This property gets and sets the solid brush that is used for the style's upper value. | + | * //This property gets and sets the solid brush that is used for the style's upper value.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| Line 411: | Line 382: | ||
| ** {{wiki:PublicProperty.gif|}} NoDataValue ** | ** {{wiki:PublicProperty.gif|}} NoDataValue ** | ||
| - | This property gets and sets the no data value used in the style. | + | * //This property gets and sets the no data value used in the style.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:Double | * Type:Double | ||
| Line 419: | Line 390: | ||
| ** {{wiki:PublicProperty.gif|}} NoDataSolidBrush ** | ** {{wiki:PublicProperty.gif|}} NoDataSolidBrush ** | ||
| - | This property gets and sets the solid brush that is used for the style's NoDataValue. | + | * //This property gets and sets the solid brush that is used for the style's NoDataValue.// |
| == Remarks == | == Remarks == | ||
| - | None. | + | * //None.// |
| == Return Value == | == Return Value == | ||
| * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]] | ||
| Line 427: | Line 398: | ||
| ** {{wiki:PublicProperty.gif|}} Name ** | ** {{wiki:PublicProperty.gif|}} Name ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:String | * Type:String | ||
| Line 435: | Line 406: | ||
| ** {{wiki:PublicProperty.gif|}} IsActive ** | ** {{wiki:PublicProperty.gif|}} IsActive ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Boolean | * Type:Boolean | ||
| Line 443: | Line 414: | ||
| ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 451: | Line 422: | ||
| ** {{wiki:PublicProperty.gif|}} Filters ** | ** {{wiki:PublicProperty.gif|}} Filters ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
| Line 460: | Line 431: | ||
| ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** | ||
| - | N/A | + | * //N/A// |
| == Remarks == | == Remarks == | ||
| - | N/A | + | * //N/A// |
| == Return Value == | == Return Value == | ||
| * Type:Collection<String> | * Type:Collection<String> | ||
thinkgeo.mapsuite.portablecore.gradientstyle.1442823014.txt.gz ยท Last modified: 2015/09/21 08:10 by admin