User Tools

Site Tools


thinkgeo.mapsuite.mvcedition.classbreakmarkerstyle

This is an old revision of the document!


ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle

<!– Class –> This class represents a style based on class break values.

Remarks

The <strong>ClassBreakMarkerStyle</strong> allows you to change the appearance of markers based on their data values. It is often useful for you to display markers differently based on ranges of numeric values. For example, you may have a city ShapeFile that has the populations of each city as part of its data. You may then want to mark cities differently based on their population. The ClassBreakMarkerStyle allows you to do this.

How marker class breaks work:

You add a number of MarkerClassBreak objects to the ClassBreaks collection. The numeric values of the breaks are important and you must place the breaks in numerical order. For example, break 0 must be added before break 100. In each ClassBreak, you specify the marker styles that will be applied to markers. Also, in the ClassBreakMarkerStyle.ColumnName property, you specify the name of the column where we will find the data used to compare the breaks. The column needs to be a numeric type.

When we proceed to draw the style, we look through the ClassBreaks and select the ClassBreak that is where the features column data is greater than and closest to the break value.

Example:

Feature Value = 42

ClassBreak1.Value = 0 ClassBreak2.Value = 20 ClassBreak3.Value = 40 ClassBreak4.Value = 60

In this case, the break closest to the feature value without exceeding it is ClassBreak3(40). If the feature value had been less than zero, nothing would have been drawn. If the feature value were 1000, then ClassBreak4 would draw.

If you wanted to represent a value that is less than zero, you could do that as shown in the sample below.

Feature Value = -1

ClassBreak1.Value = Double.Min ClassBreak2.Value = 0 ClassBreak3.Value = 20 ClassBreak4.Value = 40

In this example, the first marker class break would be used.

Your features should be point-based, such as a cities.

Inheritance Hierarchy

Members Summary

Public Constructors

Name Parameters DeclaringType Summary
Public MethodClassBreakMarkerStyle Initialize a new instance of the ClassBreakMarkerStyle class.
Public MethodClassBreakMarkerStyle String Initialize a new instance of the ClassBreakMarkerStyle class with the columnName specified.
Public MethodClassBreakMarkerStyle String, BreakValueInclusion Initialize a new instance of the ClassBreakMarkerStyle class with the columnName and breakValueInclusion specified.
Public MethodClassBreakMarkerStyle String, BreakValueInclusion, Collection<MarkerClassBreak> Initialize a new instance of the ClassBreakMarkerStyle class with the columnName and breakValueInclusion specified.

Protected Constructors

Name Parameters DeclaringType Summary

Public Methods

Name Parameters DeclaringType Summary
Public MethodEquals Object Object
Public MethodGetHashCode Object
Public MethodGetMarkers IEnumerable<Feature> MarkerStyle(overriden) Returns a collection of markers that are created by the styles defined on the classbreaks.
Public MethodGetType Object
Public MethodToString Object

Protected Methods

Name Parameters DeclaringType Summary
Protected MethodFinalize Object
Protected MethodGetContextMenusCore MarkerStyle(overriden) Gets a collection of context menus that are associated with the MarkerStyle.
Protected MethodMemberwiseClone Object

Public Properties

Name Return DeclaringType Summary
Public PropertyBreakValueInclusion BreakValueInclusion Gets or sets the value that indicates whether or not to include the break value when comparing the break.
Public PropertyClassBreaks Collection<MarkerClassBreak> Gets a collection of class breaks whose values are compared with the column value to determine which ClassBreakStyles are applied to the markers.
Public PropertyColumnName String Gets or sets a column name whose value is used to compare and select the break.

Protected Properties

Name Return DeclaringType Summary

Public Events

Name Event Arguments DeclaringType Summary

Public Constructors

ClassBreakMarkerStyle()

Initialize a new instance of the ClassBreakMarkerStyle class.

Overloads

Initialize a new instance of the ClassBreakMarkerStyle class.

Parameters

Name Type Description

Go Back

ClassBreakMarkerStyle(String)

Initialize a new instance of the ClassBreakMarkerStyle class with the columnName specified.

Overloads

Initialize a new instance of the ClassBreakMarkerStyle class.

Parameters

Name Type Description
columnName String<!– System.String –> The column name in the feature whose value is used to compare and select the break.

Go Back

ClassBreakMarkerStyle(String, BreakValueInclusion)

Initialize a new instance of the ClassBreakMarkerStyle class with the columnName and breakValueInclusion specified.

Overloads

Initialize a new instance of the ClassBreakMarkerStyle class.

Parameters

Name Type Description
columnName String<!– System.String –> The column name in the feature whose value is used to compare and select the break.
breakValueInclusion BreakValueInclusion<!– ThinkGeo.MapSuite.Core.BreakValueInclusion –> A value that indicates whether or not to include the break value when comparing the break.

Go Back

ClassBreakMarkerStyle(String, BreakValueInclusion, Collection<MarkerClassBreak>)

Initialize a new instance of the ClassBreakMarkerStyle class with the columnName and breakValueInclusion specified.

Overloads

Initialize a new instance of the ClassBreakMarkerStyle class.

Parameters

Name Type Description
columnName String<!– System.String –> The column name in the feature whose value is used to compare and select the break.
breakValueInclusion BreakValueInclusion<!– ThinkGeo.MapSuite.Core.BreakValueInclusion –> A value that indicates whether or not to include the break value when comparing the break.
classBreaks Collection<MarkerClassBreak><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak} –> A collection of class breaks whose values are compared with the column value to determine which classbreak styles are applied to the markers.

Go Back

Protected Constructors

Public Methods

Equals(Object)

Return Value

Return Type Description
Boolean<!– System.Boolean –>

Parameters

Name Type Description
obj Object<!– System.Object –>

<!– System.Object –> Go Back

GetHashCode()

Return Value

Return Type Description
Int32<!– System.Int32 –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetMarkers(IEnumerable<Feature>)

Returns a collection of markers that are created by the styles defined on the classbreaks.

Return Value

Return Type Description
Collection<Marker><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.Marker} –>

Parameters

Name Type Description
features IEnumerable<Feature><!– System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} –> A collection of features that the markers are created from.

<!– ThinkGeo.MapSuite.MvcEdition.MarkerStyle(overriden) –> Go Back

GetType()

Return Value

Return Type Description
Type<!– System.Type –>

Parameters

Name Type Description

<!– System.Object –> Go Back

ToString()

Return Value

Return Type Description
String<!– System.String –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Protected Methods

Finalize()

Return Value

Return Type Description
Void<!– System.Void –>

Parameters

Name Type Description

<!– System.Object –> Go Back

GetContextMenusCore()

Gets a collection of context menus that are associated with the MarkerStyle.

Return Value

Return Type Description
GeoKeyedCollection<ContextMenu><!– ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection{ThinkGeo.MapSuite.MvcEdition.ContextMenu} –> A collection of context menus that are associated with the MarkerStyle.

Parameters

Name Type Description

<!– ThinkGeo.MapSuite.MvcEdition.MarkerStyle(overriden) –> Go Back

MemberwiseClone()

Return Value

Return Type Description
Object<!– System.Object –>

Parameters

Name Type Description

<!– System.Object –> Go Back

Public Properties

BreakValueInclusion

Gets or sets the value that indicates whether or not to include the break value when comparing the break.

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

Return Type
BreakValueInclusion<!– ThinkGeo.MapSuite.Core.BreakValueInclusion –>

<!– ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle –> Go Back

ClassBreaks

Gets a collection of class breaks whose values are compared with the column value to determine which ClassBreakStyles are applied to the markers.

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

Return Type
Collection<MarkerClassBreak><!– System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak} –>

<!– ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle –> Go Back

ColumnName

Gets or sets a column name whose value is used to compare and select the break.

Remarks

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

Return Value

Return Type
String<!– System.String –>

<!– ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle –> Go Back

Protected Properties

Public Events

thinkgeo.mapsuite.mvcedition.classbreakmarkerstyle.1440040131.txt.gz · Last modified: 2015/09/21 03:32 (external edit)