Class HeatStyle

Namespace

ThinkGeo.Core

Assembly

ThinkGeo.Core.dll

HeatStyle allows you to better visualize data by making areas of high concentration "hotter" using warmer colors and low density areas visually cooler.

public class HeatStyle : Style

Inheritance

object

Style

HeatStyle

Inherited Members

Style.CloneDeep()

Style.CloneDeepCore()

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

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

Style.DrawWithoutLabeling(IEnumerable<Feature>, GeoCanvas)

Style.DrawWithoutLabelingCore(IEnumerable<Feature>, GeoCanvas)

Style.GetRequiredColumnNames()

Style.DrawSample(GeoCanvas, DrawingRectangleF)

Style.DrawSample(GeoCanvas)

Style.DrawSampleCore(GeoCanvas, DrawingRectangleF)

Style.SaveStyle(string)

Style.SaveStyle(Stream)

Style.LoadStyle(Uri)

Style.LoadStyle(Stream)

Style.Name

Style.IsActive

Style.RequiredColumnNames

Style.Filters

Style.FiltersCore

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

HeatStyle()

This is the default constructor of the class.

public HeatStyle()

HeatStyle(int)

This is a constructor for the class.

public HeatStyle(int pointIntensity)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

HeatStyle(int, double, DistanceUnit)

This is a constructor for the class.

public HeatStyle(int pointIntensity, double pointRadius, DistanceUnit pointRadiusUnit)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

HeatStyle(int, int)

This is a constructor for the class.

public HeatStyle(int pointIntensity, int alpha)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

alpha int

The parameter represents the alpha value of color, the default value is 255.

HeatStyle(int, int, double, DistanceUnit)

This is a constructor for the class.

public HeatStyle(int pointIntensity, int alpha, double pointRadius, DistanceUnit pointRadiusUnit)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

alpha int

The parameter represents the alpha value of color, the default value is 255.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

HeatStyle(int, int, string, double, double, double, DistanceUnit, GeoColor)

This is a constructor for the class.

public HeatStyle(int pointIntensity, int alpha, string intensityColumnName, double intensityRangeStart, double intensityRangeEnd, double pointRadius, DistanceUnit pointRadiusUnit, GeoColor baseColor)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

alpha int

The parameter represents the alpha value of color, the default value is 255.

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

baseColor GeoColor

This parameter is the color on which you want to base the color palette.

HeatStyle(int, int, string, double, double, double, DistanceUnit, GeoColor, GeoColor, ColorWheelDirection)

This is a constructor for the class.

public HeatStyle(int pointIntensity, int alpha, string intensityColumnName, double intensityRangeStart, double intensityRangeEnd, double pointRadius, DistanceUnit pointRadiusUnit, GeoColor fromColor, GeoColor toColor, ColorWheelDirection colorWheelDirection)

Parameters

pointIntensity int

The parameter represents the point intensity, the default value is 10.

alpha int

The parameter represents the alpha value of color, the default value is 255.

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

fromColor GeoColor

This parameter is the from color on which you want to apply the color palette.

toColor GeoColor

This parameter is the to color on which you want to apply the color palette.

colorWheelDirection ColorWheelDirection

The color wheel direction.

HeatStyle(int, string, double, double)

This is a constructor for the class.

public HeatStyle(int alpha, string intensityColumnName, double intensityRangeStart, double intensityRangeEnd)

Parameters

alpha int

The parameter represents the alpha value of color, the default value is 255.

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

HeatStyle(int, string, double, double, double, DistanceUnit)

This is a constructor for the class.

public HeatStyle(int alpha, string intensityColumnName, double intensityRangeStart, double intensityRangeEnd, double pointRadius, DistanceUnit pointRadiusUnit)

Parameters

alpha int

The parameter represents the alpha value of color, the default value is 255.

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

HeatStyle(string, double, double)

This is a constructor for the class.

public HeatStyle(string intensityColumnName, double intensityRangeStart, double intensityRangeEnd)

Parameters

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

HeatStyle(string, double, double, double, DistanceUnit)

This is a constructor for the class.

public HeatStyle(string intensityColumnName, double intensityRangeStart, double intensityRangeEnd, double pointRadius, DistanceUnit pointRadiusUnit)

Parameters

intensityColumnName string

The parameter represents the intensity column name, the default value is empty string.

intensityRangeStart double

The parameter represents the range start of intensity, the default value is 0.

intensityRangeEnd double

The parameter represents the range end of intensity, the default value is 0.

pointRadius double

The parameter represents the point radius, the default value is 50 kilometers.

pointRadiusUnit DistanceUnit

The parameter represents the unit of point radius, the default value is kilometer.

Properties

Alpha

Gets or sets the alpha.

public int Alpha { get; set; }

Property Value

int

The alpha.

ColorPalette

Gets the color palette.

public Collection<GeoColor> ColorPalette { get; }

Property Value

Collection<GeoColor>

The color palette.

IntensityColumnName

Gets or sets the name of the intensity column.

public string IntensityColumnName { get; set; }

Property Value

string

The name of the intensity column.

IntensityRangeEnd

Gets or sets the intensity range end.

public double IntensityRangeEnd { get; set; }

Property Value

double

The intensity range end.

IntensityRangeStart

Gets or sets the intensity range start.

public double IntensityRangeStart { get; set; }

Property Value

double

The intensity range start.

PointIntensity

Gets or sets the point intensity.

public int PointIntensity { get; set; }

Property Value

int

The point intensity.

PointRadius

Gets or sets the point radius.

public double PointRadius { get; set; }

Property Value

double

The point radius.

PointRadiusUnit

Gets or sets the point radius unit.

public DistanceUnit PointRadiusUnit { get; set; }

Property Value

DistanceUnit

The point radius unit.

Methods

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

This method draws the features on the view you provided.

protected override void DrawCore(IEnumerable<Feature> features, GeoCanvas canvas, Collection<SimpleCandidate> labelsInThisLayer, Collection<SimpleCandidate> labelsInAllLayers)

Parameters

features IEnumerable<Feature>

This parameter represents the features you want to draw on the view.

canvas GeoCanvas

This parameter represents the view you want to draw the features on.

labelsInThisLayer Collection<SimpleCandidate>

The labels will be drawn in the current layer only.

labelsInAllLayers Collection<SimpleCandidate>

The labels will be drawn in all layers.

Remarks

This abstract method is called from the concrete public method Draw. In this method, we take the features you passed in and draw them on the view you provided. Each style (based on its properties) may draw each feature differently.


When implementing this abstract 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.

GetRequiredColumnNamesCore()

This method returns the column data for each feature that is required for the style to properly draw.

protected override Collection<string> GetRequiredColumnNamesCore()

Returns

Collection<string>

This method returns a collection of column names that the style needs.

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.