Skip to content

ClassBreakStyle

Inheritance Hierarchy

  • Object
  • Style
    • ClassBreakStyle

Members Summary

Public Constructors Summary

Name
ClassBreakStyle()
ClassBreakStyle(String)
ClassBreakStyle(String,BreakValueInclusion)
ClassBreakStyle(String,BreakValueInclusion,Collection<ClassBreak>)

Protected Constructors Summary

Name
N/A

Public Properties Summary

Name Return Type Description
BreakValueInclusion BreakValueInclusion This property gets and sets the value of if the break values are included in the break calculation.
ClassBreaks Collection<ClassBreak> This property gets the collection of class breaks.
ColumnName String This property gets and sets the column name in the FeatureSource where the data will be found for each feature.
DrawingOrder ClassBreakDrawingOrder N/A
Filters Collection<String> N/A
IsActive Boolean N/A
Name String N/A
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()
OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs)

Public Events Summary

Name Event Arguments Description
GottenFeatureValue GottenFeatureValueClassBreakStyleEventArgs N/A

Members Detail

Public Constructors

Name
ClassBreakStyle()
ClassBreakStyle(String)
ClassBreakStyle(String,BreakValueInclusion)
ClassBreakStyle(String,BreakValueInclusion,Collection<ClassBreak>)

Protected Constructors

Public Properties

BreakValueInclusion

Summary

This property gets and sets the value of if the break values are included in the break calculation.

Remarks

Example: If you have a class break value set to 100 and the break value is included, then 100 is included for this break. If you set the value to excluded, then 100 would match with the break below 100 instead. Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works.

Return Value

BreakValueInclusion


ClassBreaks

Summary

This property gets the collection of class breaks.

Remarks

The class breaks determine which style to use, based on the break values. Please see the ClassBreakStyle class remarks for a full description of how the ClassBreakStyle works.

Return Value

Collection<ClassBreak>


ColumnName

Summary

This property gets and sets the column name in the FeatureSource where the data will be found for each feature.

Remarks

You use this property to set the name of the column where the numeric data is stored for your features.

Return Value

String


DrawingOrder

Summary

N/A

Remarks

N/A

Return Value

ClassBreakDrawingOrder


Filters

Summary

N/A

Remarks

N/A

Return Value

Collection<String>


IsActive

Summary

N/A

Remarks

N/A

Return Value

Boolean


Name

Summary

N/A

Remarks

N/A

Return Value

String


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 overridden 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 overriding this 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 the column names that it 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

OnGottenFeatureValue(GottenFeatureValueClassBreakStyleEventArgs)

Summary

N/A

Remarks

N/A

Return Value

Type Description
Void N/A

Parameters

Name Type Description
e GottenFeatureValueClassBreakStyleEventArgs N/A

Public Events

GottenFeatureValue

N/A

Remarks

N/A

Event Arguments

GottenFeatureValueClassBreakStyleEventArgs