Skip to content

HeatStyle

Inheritance Hierarchy

Members Summary

Public Constructors Summary

Name
HeatStyle()
HeatStyle(Int32)
HeatStyle(Int32,Int32)
HeatStyle(Int32,Double,DistanceUnit)
HeatStyle(Int32,Int32,Double,DistanceUnit)
HeatStyle(String,Double,Double)
HeatStyle(Int32,String,Double,Double)
HeatStyle(String,Double,Double,Double,DistanceUnit)
HeatStyle(Int32,String,Double,Double,Double,DistanceUnit)
HeatStyle(Int32,Int32,String,Double,Double,Double,DistanceUnit)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
Alpha Int32 Gets or sets the alpha.
ColorPalette Collection<GeoColor> Gets the color palette.
Filters Collection<String> N/A
IntensityColumnName String Gets or sets the name of the intensity column.
IntensityRangeEnd Double Gets or sets the intensity range end.
IntensityRangeStart Double Gets or sets the intensity range start.
IsActive Boolean N/A
Name String N/A
PointIntensity Int32 Gets or sets the point intensity.
PointRadius Double Gets or sets the point radius.
PointRadiusUnit DistanceUnit Gets or sets the point radius unit.
RequiredColumnNames Collection<String> N/A

Protected Properties Summary

Name Return Type Description
FiltersCore Collection<String> N/A
IsDefault Boolean N/A

Public Methods Summary

Name
CloneDeep()
Draw(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
Draw(IEnumerable<BaseShape>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSample(GeoCanvas,DrawingRectangleF)
DrawSample(GeoCanvas)
Equals(Object)
GetHashCode()
GetRequiredColumnNames()
GetType()
SaveStyle(String)
SaveStyle(Stream)
ToString()

Protected Methods Summary

Name
CloneDeepCore()
DrawCore(IEnumerable<Feature>,GeoCanvas,Collection<SimpleCandidate>,Collection<SimpleCandidate>)
DrawSampleCore(GeoCanvas,DrawingRectangleF)
Finalize()
GetRequiredColumnNamesCore()
MemberwiseClone()

Public Events Summary

Name Event Arguments Description
N/A N/A N/A

Members Detail

Public Constructors

Name
HeatStyle()
HeatStyle(Int32)
HeatStyle(Int32,Int32)
HeatStyle(Int32,Double,DistanceUnit)
HeatStyle(Int32,Int32,Double,DistanceUnit)
HeatStyle(String,Double,Double)
HeatStyle(Int32,String,Double,Double)
HeatStyle(String,Double,Double,Double,DistanceUnit)
HeatStyle(Int32,String,Double,Double,Double,DistanceUnit)
HeatStyle(Int32,Int32,String,Double,Double,Double,DistanceUnit)

Protected Constructors

Public Properties

Alpha

Summary

Gets or sets the alpha.

Remarks

N/A

Return Value

Int32


ColorPalette

Summary

Gets the color palette.

Remarks

N/A

Return Value

Collection<GeoColor>


Filters

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


IntensityColumnName

Summary

Gets or sets the name of the intensity column.

Remarks

N/A

Return Value

String


IntensityRangeEnd

Summary

Gets or sets the intensity range end.

Remarks

N/A

Return Value

Double


IntensityRangeStart

Summary

Gets or sets the intensity range start.

Remarks

N/A

Return Value

Double


IsActive

Summary

N/A

Remarks

N/A

Return Value

Boolean


Name

Summary

N/A

Remarks

N/A

Return Value

String


PointIntensity

Summary

Gets or sets the point intensity.

Remarks

N/A

Return Value

Int32


PointRadius

Summary

Gets or sets the point radius.

Remarks

N/A

Return Value

Double


PointRadiusUnit

Summary

Gets or sets the point radius unit.

Remarks

N/A

Return Value

DistanceUnit


RequiredColumnNames

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


Protected Properties

FiltersCore

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


IsDefault

Summary

N/A

Remarks

N/A

Return Value

Boolean


Public Methods

CloneDeep()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Style N/A

Parameters

Name Type Description
N/A N/A N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
features IEnumerable<Feature> N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

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

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
shapes IEnumerable<BaseShape> N/A
canvas GeoCanvas N/A
labelsInThisLayer Collection<SimpleCandidate> N/A
labelsInAllLayers Collection<SimpleCandidate> N/A

DrawSample(GeoCanvas,DrawingRectangleF)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
drawingExtent DrawingRectangleF N/A

DrawSample(GeoCanvas)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A

Equals(Object)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Boolean N/A

Parameters

Name Type Description
obj Object N/A

GetHashCode()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Int32 N/A

Parameters

Name Type Description
N/A N/A N/A

GetRequiredColumnNames()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Collection<String> N/A

Parameters

Name Type Description
N/A N/A N/A

GetType()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Type N/A

Parameters

Name Type Description
N/A N/A N/A

SaveStyle(String)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
filePathName String N/A

SaveStyle(Stream)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
stream Stream N/A

ToString()

Summary

N/A

Remarks

N/A

Return Value

Type Description
String N/A

Parameters

Name Type Description
N/A N/A N/A

Protected Methods

CloneDeepCore()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Style N/A

Parameters

Name Type Description
N/A N/A N/A

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

Summary

This method draws the features on the view you provided.

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.

Return Value

Type Description
Void None

Parameters

Name Type Description
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.

DrawSampleCore(GeoCanvas,DrawingRectangleF)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
canvas GeoCanvas N/A
drawingExtent DrawingRectangleF N/A

Finalize()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
N/A N/A N/A

GetRequiredColumnNamesCore()

Summary

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 Description
Collection<String> This method returns a collection of column names that the style needs.

Parameters

Name Type Description
N/A N/A N/A

MemberwiseClone()

Summary

N/A

Remarks

N/A

Return Value

Type Description
Object N/A

Parameters

Name Type Description
N/A N/A N/A

Public Events