ThinkGeo Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== ThinkGeo.MapSuite.Core.GradientStyle ======
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 ====
** {{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.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:N/A

  * //upperValue//
    * Type:Double
    * Description:N/A

  * //upperGeoSolidBrush//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:N/A

<div newline></div>
** {{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.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:N/A

  * //upperValue//
    * Type:Double
    * Description:N/A

  * //upperGeoSolidBrush//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:N/A

  * //noDataValue//
    * Type:Double
    * Description:N/A

  * //noDataSolidBrush//
    * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]
    * Description:N/A

<div newline></div>
==== Protected Constructors ====
==== Public Methods ====
** {{wiki:PublicMethod.gif|}} CloneDeep() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //features//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //shapes//
    * Type:IEnumerable<[[ThinkGeo.MapSuite.Core.BaseShape|BaseShape]]>
    * Description:N/A

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetRequiredColumnNames() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Collection<String>
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas,DrawingRectangleF) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} DrawSample(GeoCanvas) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} ToString() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:String
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} Equals(Object) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Boolean
  * Description:N/A

== Parameters ==
  * //obj//
    * Type:Object
    * Description:N/A

<div newline></div>
** {{wiki:PublicMethod.gif|}} GetHashCode() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Int32
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:PublicMethod.gif|}} GetType() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Type
  * Description:N/A

== Parameters ==
<div newline></div>
==== Protected Methods ====
** {{wiki:ProtectedMethod.gif|}} 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<[[ThinkGeo.MapSuite.Core.Feature|Feature]]>
    * Description:This parameter represents the features you want to draw on the canvas.

  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:This parameter represents the canvas you want to draw the features on.

  * //labelsInThisLayer//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in the current layer only.

  * //labelsInAllLayers//
    * Type:Collection<[[ThinkGeo.MapSuite.Core.SimpleCandidate|SimpleCandidate]]>
    * Description:The labels will be drawn in all layers.

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} 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 ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} CloneDeepCore() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.Style|Style]]
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} DrawSampleCore(GeoCanvas,DrawingRectangleF) **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
  * //canvas//
    * Type:[[ThinkGeo.MapSuite.Core.GeoCanvas|GeoCanvas]]
    * Description:N/A

  * //drawingExtent//
    * Type:[[ThinkGeo.MapSuite.Core.DrawingRectangleF|DrawingRectangleF]]
    * Description:N/A

<div newline></div>
** {{wiki:ProtectedMethod.gif|}} Finalize() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Void
  * Description:N/A

== Parameters ==
<div newline></div>
** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **

N/A
== Remarks ==
N/A

== Return Value ==
  * Type:Object
  * Description:N/A

== Parameters ==
<div newline></div>
==== Public Properties ====
** {{wiki:PublicProperty.gif|}} ColumnName **

This property gets and sets the column name used in the style.
== Remarks ==
None.
== Return Value ==
  * Type:String

** {{wiki:PublicProperty.gif|}} LowerValue **

This property gets and sets the lower value used in the style.
== Remarks ==
None.
== Return Value ==
  * Type:Double

** {{wiki:PublicProperty.gif|}} LowerGeoSolidBrush **

This property gets and sets the solid brush that is used for the style's lower value.
== Remarks ==
None.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]

** {{wiki:PublicProperty.gif|}} UpperValue **

This property gets and sets the upper value used in the style.
== Remarks ==
None.
== Return Value ==
  * Type:Double

** {{wiki:PublicProperty.gif|}} UpperGeoSolidBrush **

This property gets and sets the solid brush that is used for the style's upper value.
== Remarks ==
None.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]

** {{wiki:PublicProperty.gif|}} NoDataValue **

This property gets and sets the no data value used in the style.
== Remarks ==
None.
== Return Value ==
  * Type:Double

** {{wiki:PublicProperty.gif|}} NoDataSolidBrush **

This property gets and sets the solid brush that is used for the style's NoDataValue.
== Remarks ==
None.
== Return Value ==
  * Type:[[ThinkGeo.MapSuite.Core.GeoSolidBrush|GeoSolidBrush]]

** {{wiki:PublicProperty.gif|}} Name **

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|}} RequiredColumnNames **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

** {{wiki:PublicProperty.gif|}} Filters **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

==== Protected Properties ====
** {{wiki:ProtectedProperty.gif|}} FiltersCore **

N/A
== Remarks ==
N/A
== Return Value ==
  * Type:Collection<String>

==== Public Events ====
Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo

User Tools

Site Tools

Page Tools

Map Suite UI Controls

MapSuite GIS Services

Free Tools

Professional Services

Support & Learning

About ThinkGeo
