====== ThinkGeo.MapSuite.Styles.GradientStyle ====== ===== Inheritance Hierarchy ===== *System.Object *ThinkGeo.MapSuite.Styles.Style ***ThinkGeo.MapSuite.Styles.GradientStyle** ===== Members Summary ===== ==== Public Constructors ==== ** {{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.// == 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:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] * Description:N/A * //upperValue// * Type:Double * Description:N/A * //upperGeoSolidBrush// * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] * Description:N/A
** {{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.// == Remarks == * //N/A// == Parameters == * //columnName// * Type:String * Description:N/A * //lowerValue// * Type:Double * Description:N/A * //lowerGeoSolidBrush// * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] * Description:N/A * //upperValue// * Type:Double * Description:N/A * //upperGeoSolidBrush// * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] * Description:N/A * //noDataValue// * Type:Double * Description:N/A * //noDataSolidBrush// * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] * Description:N/A
==== Protected Constructors ==== ==== Public Methods ==== ** {{wiki:PublicMethod.gif|}} CloneDeep() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Styles.Style|Style]] * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable,GeoCanvas,Collection,Collection) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //features// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.Feature|Feature]]> * Description:N/A * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInThisLayer// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable,GeoCanvas,Collection,Collection) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //shapes// * Type:IEnumerable<[[ThinkGeo.MapSuite.Shapes.BaseShape|BaseShape]]> * Description:N/A * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //labelsInThisLayer// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:N/A * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:N/A
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //drawingExtent// * Type:[[ThinkGeo.MapSuite.Shapes.DrawingRectangleF|DrawingRectangleF]] * Description:N/A
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A
** {{wiki:PublicMethod.gif|}} SaveStyle(String) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //filePathName// * Type:String * Description:N/A
** {{wiki:PublicMethod.gif|}} SaveStyle(Stream) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //stream// * Type:Stream * Description:N/A
** {{wiki:PublicMethod.gif|}} ToString() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} Equals(Object) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean * Description:N/A == Parameters == * //obj// * Type:Object * Description:N/A
** {{wiki:PublicMethod.gif|}} GetHashCode() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Int32 * Description:N/A == Parameters ==
** {{wiki:PublicMethod.gif|}} GetType() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Type * Description:N/A == Parameters ==
===== Protected Methods ===== ** {{wiki:ProtectedMethod.gif|}} DrawCore(IEnumerable,GeoCanvas,Collection,Collection) ** * //N/A// == 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<[[ThinkGeo.MapSuite.Shapes.Feature|Feature]]> * Description:This parameter represents the features you want to draw on the canvas. * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:This parameter represents the canvas you want to draw the features on. * //labelsInThisLayer// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:The labels will be drawn in the current layer only. * //labelsInAllLayers// * Type:Collection<[[ThinkGeo.MapSuite.Styles.SimpleCandidate|SimpleCandidate]]> * Description:The labels will be drawn in all layers.
** {{wiki:ProtectedMethod.gif|}} GetRequiredColumnNamesCore() ** * //N/A// == 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 * Description:This method returns a collection of column names that the style needs. == Parameters ==
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:[[ThinkGeo.MapSuite.Styles.Style|Style]] * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters == * //canvas// * Type:[[ThinkGeo.MapSuite.Drawing.GeoCanvas|GeoCanvas]] * Description:N/A * //drawingExtent// * Type:[[ThinkGeo.MapSuite.Shapes.DrawingRectangleF|DrawingRectangleF]] * Description:N/A
** {{wiki:ProtectedMethod.gif|}} Finalize() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Void * Description:N/A == Parameters ==
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Object * Description:N/A == Parameters ==
==== Public Properties ==== ** {{wiki:PublicProperty.gif|}} ColumnName ** * //N/A// == Remarks == * //None.// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} LowerValue ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} LowerGeoSolidBrush ** * //N/A// == Remarks == * //None.// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] ** {{wiki:PublicProperty.gif|}} UpperValue ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} UpperGeoSolidBrush ** * //N/A// == Remarks == * //None.// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] ** {{wiki:PublicProperty.gif|}} NoDataValue ** * //N/A// == Remarks == * //None.// == Return Value == * Type:Double ** {{wiki:PublicProperty.gif|}} NoDataSolidBrush ** * //N/A// == Remarks == * //None.// == Return Value == * Type:[[ThinkGeo.MapSuite.Drawing.GeoSolidBrush|GeoSolidBrush]] ** {{wiki:PublicProperty.gif|}} Name ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} StyleClass ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:String ** {{wiki:PublicProperty.gif|}} IsActive ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} IsDefault ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Boolean ** {{wiki:PublicProperty.gif|}} RequiredColumnNames ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection ** {{wiki:PublicProperty.gif|}} Filters ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection ==== Protected Properties ==== ** {{wiki:ProtectedProperty.gif|}} FiltersCore ** * //N/A// == Remarks == * //N/A// == Return Value == * Type:Collection ==== Public Events ====