Table of Contents
ThinkGeo.MapSuite.Core.GradientStyle
Note: The page was created before Map Suite 10. Map Suite 10.0 organized many classes into new namespaces and assemblies as well as had a few minor breaks in compatibility. The majority of previously built code should work without modification assuming the new namespaces are added. For guidance on upgrading your existing code, please check out MapSuite 10 Upgrade Guide.
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
- System.Object
- ThinkGeo.MapSuite.Core.Style
- ThinkGeo.MapSuite.Core.GradientStyle
Members Summary
Public Constructors
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.
Remarks
- In this constructor, the NoDataValue defaults to -9999 and the NoDataBrush color is transparent.
Parameters
- columnName
- Type:String
- Description:N/A
- lowerValue
- Type:Double
- Description:N/A
- lowerGeoSolidBrush
- Type:GeoSolidBrush
- Description:N/A
- upperValue
- Type:Double
- Description:N/A
- upperGeoSolidBrush
- Type:GeoSolidBrush
- Description:N/A
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.
Remarks
- N/A
Parameters
- columnName
- Type:String
- Description:N/A
- lowerValue
- Type:Double
- Description:N/A
- lowerGeoSolidBrush
- Type:GeoSolidBrush
- Description:N/A
- upperValue
- Type:Double
- Description:N/A
- upperGeoSolidBrush
- Type:GeoSolidBrush
- Description:N/A
- noDataValue
- Type:Double
- Description:N/A
- noDataSolidBrush
- Type:GeoSolidBrush
- Description:N/A
Protected Constructors
Public Methods
CloneDeep()
- N/A
Remarks
- N/A
Return Value
- Type:Style
- Description:N/A
Parameters
Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- features
- Type:IEnumerable<Feature>
- Description:N/A
- canvas
- Type:GeoCanvas
- Description:N/A
- labelsInThisLayer
- Type:Collection<SimpleCandidate>
- Description:N/A
- labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:N/A
Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- shapes
- Type:IEnumerable<BaseShape>
- Description:N/A
- canvas
- Type:GeoCanvas
- Description:N/A
- labelsInThisLayer
- Type:Collection<SimpleCandidate>
- Description:N/A
- labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:N/A
GetRequiredColumnNames()
- N/A
Remarks
- N/A
Return Value
- Type:Collection<String>
- Description:N/A
Parameters
DrawSample(GeoCanvas,DrawingRectangleF)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- drawingExtent
- Type:DrawingRectangleF
- Description:N/A
DrawSample(GeoCanvas)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
Remarks
- N/A
Return Value
- Type:String
- Description:N/A
Parameters
Equals(Object)
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
- Description:N/A
Parameters
- obj
- Type:Object
- Description:N/A
GetHashCode()
- N/A
Remarks
- N/A
Return Value
- Type:Int32
- Description:N/A
Parameters
GetType()
- N/A
Remarks
- N/A
Return Value
- Type:Type
- Description:N/A
Parameters
Protected Methods
DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
- This method draws the features on the canvas you provided.
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.
Return Value
- Type:Void
- Description:None
Parameters
- features
- Type:IEnumerable<Feature>
- Description:This parameter represents the features you want to draw on the canvas.
- canvas
- Type:GeoCanvas
- Description:This parameter represents the canvas you want to draw the features on.
- labelsInThisLayer
- Type:Collection<SimpleCandidate>
- Description:The labels will be drawn in the current layer only.
- labelsInAllLayers
- Type:Collection<SimpleCandidate>
- Description:The labels will be drawn in all layers.
GetRequiredColumnNamesCore()
- This method returns the column data for each feature that is required for the style to properly draw.
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.
Return Value
- Type:Collection<String>
- Description:This method returns a collection of column names that the style needs.
Parameters
CloneDeepCore()
- N/A
Remarks
- N/A
Return Value
- Type:Style
- Description:N/A
Parameters
DrawSampleCore(GeoCanvas,DrawingRectangleF)
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
- canvas
- Type:GeoCanvas
- Description:N/A
- drawingExtent
- Type:DrawingRectangleF
- Description:N/A
Finalize()
- N/A
Remarks
- N/A
Return Value
- Type:Void
- Description:N/A
Parameters
MemberwiseClone()
- N/A
Remarks
- N/A
Return Value
- Type:Object
- Description:N/A
Parameters
Public Properties
ColumnName
- This property gets and sets the column name used in the style.
Remarks
- None.
Return Value
- Type:String
LowerValue
- This property gets and sets the lower value used in the style.
Remarks
- None.
Return Value
- Type:Double
LowerGeoSolidBrush
- This property gets and sets the solid brush that is used for the style's lower value.
Remarks
- None.
Return Value
Remarks
- None.
Return Value
- Type:Double
UpperGeoSolidBrush
- This property gets and sets the solid brush that is used for the style's upper value.
Remarks
- None.
Return Value
Remarks
- None.
Return Value
- Type:Double
NoDataSolidBrush
- This property gets and sets the solid brush that is used for the style's NoDataValue.
Remarks
- None.
Return Value
Remarks
- N/A
Return Value
- Type:String
IsActive
- N/A
Remarks
- N/A
Return Value
- Type:Boolean
RequiredColumnNames
- N/A
Remarks
- N/A
Return Value
- Type:Collection<String>
Filters
- N/A
Remarks
- N/A
Return Value
- Type:Collection<String>
Protected Properties
FiltersCore
- N/A
Remarks
- N/A
Return Value
- Type:Collection<String>