User Tools

Site Tools


thinkgeo.mapsuite.core.gradientstyle

This is an old revision of the document!


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

GradientStyle

  • Parameters:String,Double,GeoSolidBrush,Double,GeoSolidBrush
  • DeclaringType:N/A
  • Summary: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.

GradientStyle

  • Parameters:String,Double,GeoSolidBrush,Double,GeoSolidBrush,Double,GeoSolidBrush
  • DeclaringType:N/A
  • Summary: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.

Protected Constructors

Public Methods

CloneDeep

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

Draw

Draw

DrawSample

DrawSample

Equals

  • Parameters:Object
  • DeclaringType:Object
  • Summary:N/A

GetHashCode

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetRequiredColumnNames

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

GetType

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

SaveStyle

  • Parameters:String
  • DeclaringType:Style
  • Summary:N/A

SaveStyle

  • Parameters:Stream
  • DeclaringType:Style
  • Summary:N/A

ToString

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Protected Methods

CloneDeepCore

  • Parameters:N/A
  • DeclaringType:Style
  • Summary:N/A

DrawCore

DrawSampleCore

Finalize

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

GetRequiredColumnNamesCore

  • Parameters:N/A
  • DeclaringType:N/A
  • Summary:This method returns the column data for each feature that is required for the style to properly draw.

MemberwiseClone

  • Parameters:N/A
  • DeclaringType:Object
  • Summary:N/A

Public Properties

ColumnName

  • Return:String
  • Summary:This property gets and sets the column name used in the style.

Filters

  • Return:Collection<String>
  • Summary:N/A

IsActive

  • Return:Boolean
  • Summary:N/A

LowerGeoSolidBrush

  • Summary:This property gets and sets the solid brush that is used for the style's lower value.

LowerValue

  • Return:Double
  • Summary:This property gets and sets the lower value used in the style.

Name

  • Return:String
  • Summary:N/A

NoDataSolidBrush

  • Summary:This property gets and sets the solid brush that is used for the style's NoDataValue.

NoDataValue

  • Return:Double
  • Summary:This property gets and sets the no data value used in the style.

RequiredColumnNames

  • Return:Collection<String>
  • Summary:N/A

UpperGeoSolidBrush

  • Summary:This property gets and sets the solid brush that is used for the style's upper value.

UpperValue

  • Return:Double
  • Summary:This property gets and sets the upper value used in the style.

Protected Properties

FiltersCore

  • Return:Collection<String>
  • Summary:N/A

Public Events

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

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

upperGeoSolidBrush

  • Description:N/A Go Back === 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

Go Back

Protected Constructors

Public Methods

CloneDeep()

N/A

Remarks

N/A

Return Value

  • Return Type:Style
  • Description:N/A

Parameters

Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

features

  • Type:IEnumerable<Feature>
  • Description:N/A

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

shapes

  • Type:IEnumerable<BaseShape>
  • Description:N/A

canvas

labelsInThisLayer

labelsInAllLayers

Go Back

DrawSample(GeoCanvas,DrawingRectangleF)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

drawingExtent

Go Back

DrawSample(GeoCanvas)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

Go Back

Equals(Object)

N/A

Remarks

N/A

Return Value

  • Return Type:Boolean
  • Description:N/A

Parameters

obj

  • Type:Object
  • Description:N/A

Go Back

GetHashCode()

N/A

Remarks

N/A

Return Value

  • Return Type:Int32
  • Description:N/A

Parameters

GetRequiredColumnNames()

N/A

Remarks

N/A

Return Value

  • Return Type:Collection<String>
  • Description:N/A

Parameters

GetType()

N/A

Remarks

N/A

Return Value

  • Return Type:Type
  • Description:N/A

Parameters

SaveStyle(String)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

filePathName

  • Type:String
  • Description:N/A

Go Back

SaveStyle(Stream)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

stream

  • Type:Stream
  • Description:N/A

Go Back

ToString()

N/A

Remarks

N/A

Return Value

  • Return Type:String
  • Description:N/A

Parameters

Protected Methods

CloneDeepCore()

N/A

Remarks

N/A

Return Value

  • Return Type:Style
  • Description:N/A

Parameters

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

  • Return 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.

Go Back

DrawSampleCore(GeoCanvas,DrawingRectangleF)

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

canvas

drawingExtent

Go Back

Finalize()

N/A

Remarks

N/A

Return Value

  • Return Type:Void
  • Description:N/A

Parameters

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

  • Return Type:Collection<String>
  • Description:This method returns a collection of column names that the style needs.

Parameters

MemberwiseClone()

N/A

Remarks

N/A

Return Value

  • Return 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

Return Type:String

Go Back

Filters

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

IsActive

N/A

Remarks

N/A

Return Value

Return Type:Boolean

Go Back

LowerGeoSolidBrush

This property gets and sets the solid brush that is used for the style's lower value.

Remarks

None.

Return Value

Return Type:GeoSolidBrush

Go Back

LowerValue

This property gets and sets the lower value used in the style.

Remarks

None.

Return Value

Return Type:Double

Go Back

Name

N/A

Remarks

N/A

Return Value

Return Type:String

Go Back

NoDataSolidBrush

This property gets and sets the solid brush that is used for the style's NoDataValue.

Remarks

None.

Return Value

Return Type:GeoSolidBrush

Go Back

NoDataValue

This property gets and sets the no data value used in the style.

Remarks

None.

Return Value

Return Type:Double

Go Back

RequiredColumnNames

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

UpperGeoSolidBrush

This property gets and sets the solid brush that is used for the style's upper value.

Remarks

None.

Return Value

Return Type:GeoSolidBrush

Go Back

UpperValue

This property gets and sets the upper value used in the style.

Remarks

None.

Return Value

Return Type:Double

Go Back

Protected Properties

FiltersCore

N/A

Remarks

N/A

Return Value

Return Type:Collection<String>

Go Back

Public Events

thinkgeo.mapsuite.core.gradientstyle.1442485870.txt.gz · Last modified: 2015/09/17 10:31 by admin