thinkgeo.mapsuite.mvcedition.classbreakmarkerstyle
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.classbreakmarkerstyle [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== 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 ===== | ||
| - | *System.Object | ||
| - | **[[ThinkGeo.MapSuite.MvcEdition.MarkerStyle]] | ||
| - | ***[[ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakMarkerStyle()|ClassBreakMarkerStyle]] | | | Initialize a new instance of the ClassBreakMarkerStyle class. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakMarkerStyle(String)|ClassBreakMarkerStyle]] | String | | Initialize a new instance of the ClassBreakMarkerStyle class with the columnName specified. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakMarkerStyle(String, BreakValueInclusion)|ClassBreakMarkerStyle]] | String, [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]] | | Initialize a new instance of the ClassBreakMarkerStyle class with the columnName and breakValueInclusion specified. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ClassBreakMarkerStyle(String, BreakValueInclusion, Collection<MarkerClassBreak>)|ClassBreakMarkerStyle]] | String, [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]], Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak|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 ^ | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetMarkers(IEnumerable<Feature>)|GetMarkers]] | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]> | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]](overriden) | Returns a collection of markers that are created by the styles defined on the classbreaks. | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | ||
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | ||
| - | |||
| - | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#GetContextMenusCore()|GetContextMenusCore]] | | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]](overriden) | Gets a collection of context menus that are associated with the MarkerStyle. | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#BreakValueInclusion|BreakValueInclusion]] | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]] | | Gets or sets the value that indicates whether or not to include the break value when comparing the break. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ClassBreaks|ClassBreaks]] | Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak|MarkerClassBreak]]> | | Gets a collection of class breaks whose values are compared with the column value to determine which ClassBreakStyles are applied to the markers. | | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#ColumnName|ColumnName]] | 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 ^ | ||
| - | |||
| - | [[#Public Constructors|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. | | ||
| - | |||
| - | [[#Public Constructors|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 | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | A value that indicates whether or not to include the break value when comparing the break. | | ||
| - | |||
| - | [[#Public Constructors|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 | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | A value that indicates whether or not to include the break value when comparing the break. | | ||
| - | | classBreaks | Collection<[[ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak|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. | | ||
| - | |||
| - | [[#Public Constructors|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 --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|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<[[ThinkGeo.MapSuite.MvcEdition.Marker|Marker]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.Marker} --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | features | IEnumerable<[[ThinkGeo.MapSuite.Core.Feature|Feature]]><!-- System.Collections.Generic.IEnumerable{ThinkGeo.MapSuite.Core.Feature} --> | A collection of features that the markers are created from. | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle(overriden) --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== GetContextMenusCore() ==== | ||
| - | Gets a collection of context menus that are associated with the MarkerStyle. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | [[ThinkGeo.MapSuite.MvcEdition.GeoKeyedCollection|GeoKeyedCollection]]<[[ThinkGeo.MapSuite.MvcEdition.ContextMenu|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) --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|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 ^ | ||
| - | | [[ThinkGeo.MapSuite.Core.BreakValueInclusion|BreakValueInclusion]]<!-- ThinkGeo.MapSuite.Core.BreakValueInclusion --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle --> | ||
| - | [[#Public Properties|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<[[ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak|MarkerClassBreak]]><!-- System.Collections.ObjectModel.Collection{ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.ClassBreakMarkerStyle --> | ||
| - | [[#Public Properties|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 --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MvcEdition]] | ||
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.mvcedition.classbreakmarkerstyle.1440040131.txt.gz ยท Last modified: 2015/09/21 03:32 (external edit)
