HeatStyle¶
Namespace: ThinkGeo.Core
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
Properties¶
PointIntensity¶
Gets or sets the point intensity.
public int PointIntensity { get; set; }
Property Value¶
The point intensity.
Alpha¶
Gets or sets the alpha.
public int Alpha { get; set; }
Property Value¶
The alpha.
IntensityRangeStart¶
Gets or sets the intensity range start.
public double IntensityRangeStart { get; set; }
Property Value¶
The intensity range start.
IntensityRangeEnd¶
Gets or sets the intensity range end.
public double IntensityRangeEnd { get; set; }
Property Value¶
The intensity range end.
IntensityColumnName¶
Gets or sets the name of the intensity column.
public string IntensityColumnName { get; set; }
Property Value¶
The name of the intensity column.
PointRadius¶
Gets or sets the point radius.
public double PointRadius { get; set; }
Property Value¶
The point radius.
PointRadiusUnit¶
Gets or sets the point radius unit.
public DistanceUnit PointRadiusUnit { get; set; }
Property Value¶
The point radius unit.
ColorPalette¶
Gets the color palette.
public Collection<GeoColor> ColorPalette { get; }
Property Value¶
The color palette.
Name¶
This property gets and set the name of the style.
public string Name { get; set; }
Property Value¶
String
This property gets the name of the style.
Remarks:
This name is not used by the system; it is only for the developer. However, it can be used if you generate your own legend.
IsActive¶
This property gets and sets the active status of the style.
public bool IsActive { get; set; }
Property Value¶
Boolean
This property gets the active status of the style.
Remarks:
If the style is not active then it will not draw.
RequiredColumnNames¶
This property gets the collection of fields that are required for the style.
public Collection<string> RequiredColumnNames { get; }
Property Value¶
This property gets the collection of fields that are required for the
style.
Remarks:
This property gets the collection of fields that are required for the style. These are in addition to any other columns you specify in styles that inherit from this one. For example, if you have use a ValueStyle and it requires a column name for the value comparison, then that column does not need to be in this collection. You only use the RequiredColumnNames for columns you need beyond those required by specific inherited styles.
Filters¶
public Collection<string> Filters { get; }
Property Value¶
Constructors¶
HeatStyle()¶
This is the default constructor of the class.
public HeatStyle()
HeatStyle(Int32)¶
This is a constructor for the class.
public HeatStyle(int pointIntensity)
Parameters¶
pointIntensity Int32
The parameter represents the point intensity, the default value is 10.
HeatStyle(Int32, Int32)¶
This is a constructor for the class.
public HeatStyle(int pointIntensity, int alpha)
Parameters¶
pointIntensity Int32
The parameter represents the point intensity, the default value is 10.
alpha Int32
The parameter represents the alpha value of color, the default value is 255.
HeatStyle(Int32, Double, DistanceUnit)¶
This is a constructor for the class.
public HeatStyle(int pointIntensity, double pointRadius, DistanceUnit pointRadiusUnit)
Parameters¶
pointIntensity Int32
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(Int32, Int32, Double, DistanceUnit)¶
This is a constructor for the class.
public HeatStyle(int pointIntensity, int alpha, double pointRadius, DistanceUnit pointRadiusUnit)
Parameters¶
pointIntensity Int32
The parameter represents the point intensity, the default value is 10.
alpha Int32
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(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(Int32, String, Double, Double)¶
This is a constructor for the class.
public HeatStyle(int alpha, string intensityColumnName, double intensityRangeStart, double intensityRangeEnd)
Parameters¶
alpha Int32
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(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.
HeatStyle(Int32, 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 Int32
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(Int32, Int32, 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 Int32
The parameter represents the point intensity, the default value is 10.
alpha Int32
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(Int32, Int32, 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 Int32
The parameter represents the point intensity, the default value is 10.
alpha Int32
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.
Methods¶
DrawCore(IEnumerable<Feature>, GeoCanvas, Collection<SimpleCandidate>, Collection<SimpleCandidate>)¶
This method draws the features on the view you provided.
protected 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 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.