thinkgeo.mapsuite.mvcedition.markerclassbreak
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.mvcedition.markerclassbreak [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.mvcedition.markerclassbreak [2017/03/16 21:59] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak ====== | ====== ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak ====== | ||
| + | {{section>upgrade_map_suite_to_10.0}} | ||
| - | |||
| - | <!-- Class --> | ||
| Represents a break with a value and style defined. | Represents a break with a value and style defined. | ||
| - | === Remarks === | + | ===== Inheritance Hierarchy ===== |
| - | Marker class breaks are used in the ClassBreakMarkerStyle. They allow you to display markers differently depending on ranges of data in the FeatureSource. | + | *System.Object |
| + | ***ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak** | ||
| + | ===== Members Summary ===== | ||
| + | ==== Public Constructors ==== | ||
| + | ** {{wiki:PublicMethod.gif|}} MarkerClassBreak() ** | ||
| - | How marker class breaks work: | + | Initialize a new instance of the MarkerClassBreak class. |
| + | == Remarks == | ||
| + | If you use this default constructor, then you should set the properties manually. | ||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| + | ** {{wiki:PublicMethod.gif|}} MarkerClassBreak(Double) ** | ||
| - | 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. | + | Initialize a new instance of the MarkerClassBreak class using the value specified. |
| + | == Remarks == | ||
| + | N/A | ||
| + | == Parameters == | ||
| + | * //value// | ||
| + | * Type:Double | ||
| + | * Description:A double value that is compared to the column value to determine whether to apply the specified style to markers. | ||
| - | 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. | + | <div newline></div> |
| + | ==== Protected Constructors ==== | ||
| + | ==== Public Methods ==== | ||
| + | ** {{wiki:PublicMethod.gif|}} ToString() ** | ||
| - | Example: | + | N/A |
| + | == Remarks == | ||
| + | N/A | ||
| - | Feature Value = 42 | + | == Return Value == |
| + | * Type:String | ||
| + | * Description:N/A | ||
| - | ClassBreak1.Value = 0 | + | == Parameters == |
| - | ClassBreak2.Value = 20 | + | <div newline></div> |
| - | ClassBreak3.Value = 40 | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
| - | 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. | + | N/A |
| + | == Remarks == | ||
| + | N/A | ||
| - | If you wanted to represent a value that is less than zero, you could do that as shown in the sample below. | + | == Return Value == |
| + | * Type:Boolean | ||
| + | * Description:N/A | ||
| - | Feature Value = -1 | + | == Parameters == |
| + | * //obj// | ||
| + | * Type:Object | ||
| + | * Description:N/A | ||
| - | ClassBreak1.Value = Double.Min | + | <div newline></div> |
| - | ClassBreak2.Value = 0 | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
| - | ClassBreak3.Value = 20 | + | |
| - | ClassBreak4.Value = 40 | + | |
| - | In this example, the first marker class break would be used. | + | N/A |
| + | == Remarks == | ||
| + | N/A | ||
| - | Your features should be point-based, such as a cities. | + | == Return Value == |
| - | ===== Inheritance Hierarchy ===== | + | * Type:Int32 |
| - | *System.Object | + | * Description:N/A |
| - | **[[ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak]] | + | |
| - | ===== Members Summary ===== | + | |
| - | ==== Public Constructors ==== | + | |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerClassBreak()|MarkerClassBreak]] | | | Initialize a new instance of the MarkerClassBreak class. | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#MarkerClassBreak(Double)|MarkerClassBreak]] | Double | | Initialize a new instance of the MarkerClassBreak class using the value specified. | | + | |
| - | ==== Protected Constructors ==== | + | == Parameters == |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:PublicMethod.gif|}} GetType() ** | ||
| - | ==== Public Methods ==== | + | N/A |
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]] | Object | Object | | | + | N/A |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]] | | Object | | | + | |
| - | | {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]] | | Object | | | + | |
| + | == Return Value == | ||
| + | * Type:Type | ||
| + | * Description:N/A | ||
| + | |||
| + | == Parameters == | ||
| + | <div newline></div> | ||
| ==== Protected Methods ==== | ==== Protected Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | + | |
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | + | |
| - | ==== Public Properties ==== | + | N/A |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | == Remarks == |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#CustomMarkerStyle|CustomMarkerStyle]] | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] | | Gets or sets the style that could be any type of MarkerStyle. | | + | N/A |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#DefaultMarkerStyle|DefaultMarkerStyle]] | [[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]] | | Gets or sets the style that is applied to the markers if the CustomMarkerStyle is not defined. | | + | |
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#Value|Value]] | Double | | Gets or sets the break value. | | + | |
| - | ==== Protected Properties ==== | + | == Return Value == |
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | + | * Type:Void |
| + | * Description:N/A | ||
| - | ==== Public Events ==== | + | == Parameters == |
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | + | <div newline></div> |
| + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** | ||
| - | ===== Public Constructors ===== | + | N/A |
| - | ==== MarkerClassBreak() ==== | + | == Remarks == |
| - | Initialize a new instance of the MarkerClassBreak class. | + | N/A |
| - | === Overloads === | + | |
| - | Initialize a new instance of the MarkerClassBreak class. | + | |
| - | === Remarks === | + | |
| - | If you use this default constructor, then you should set the properties manually. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | [[#Public Constructors|Go Back]] | + | == Return Value == |
| - | ==== MarkerClassBreak(Double) ==== | + | * Type:Object |
| - | Initialize a new instance of the MarkerClassBreak class using the value specified. | + | * Description:N/A |
| - | === Overloads === | + | |
| - | Initialize a new instance of the MarkerClassBreak class. | + | |
| - | === Parameters === | + | |
| - | ^ Name ^ Type ^ Description ^ | + | |
| - | | value | Double<!-- System.Double --> | A double value that is compared to the column value to determine whether to apply the specified style to markers. | | + | |
| - | [[#Public Constructors|Go Back]] | + | == Parameters == |
| - | ===== Protected Constructors ===== | + | <div newline></div> |
| - | ===== Public Methods ===== | + | ==== Public Properties ==== |
| - | ==== Equals(Object) ==== | + | ** {{wiki:PublicProperty.gif|}} Value ** |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Boolean<!-- System.Boolean --> | | | + | |
| - | === Parameters === | + | Gets or sets the break value. |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| - | | obj | Object<!-- System.Object --> | | | + | N/A |
| + | == Return Value == | ||
| + | * Type:Double | ||
| - | <!-- System.Object --> | + | ** {{wiki:PublicProperty.gif|}} DefaultMarkerStyle ** |
| - | [[#Public Methods|Go Back]] | + | |
| - | ==== GetHashCode() ==== | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ Description ^ | + | |
| - | | Int32<!-- System.Int32 --> | | | + | |
| - | === Parameters === | + | Gets or sets the style that is applied to the markers if the CustomMarkerStyle is not defined. |
| - | ^ Name ^ Type ^ Description ^ | + | == Remarks == |
| + | N/A | ||
| + | == Return Value == | ||
| + | * Type:[[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]] | ||
| - | <!-- System.Object --> | + | ** {{wiki:PublicProperty.gif|}} CustomMarkerStyle ** |
| - | [[#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]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ===== Public Properties ===== | ||
| - | ==== CustomMarkerStyle ==== | ||
| Gets or sets the style that could be any type of MarkerStyle. | Gets or sets the style that could be any type of MarkerStyle. | ||
| - | === Remarks === | + | == Remarks == |
| - | The <strong>CustomMarkerStyle</strong> could be any type of <strong>MarkerStyle</strong>. This style has a higher priority than the <strong>DefaultMarkerStyle</strong>. This means that if you defined both <strong>DefaultMarkerStyle</strong> and <strong>CustomMarkerStyle</strong>, the <strong>CustomMarkerStyle</strong> will be used. | + | The CustomMarkerStyle could be any type of MarkerStyle. This style has a higher priority than the DefaultMarkerStyle. This means that if you defined both DefaultMarkerStyle and CustomMarkerStyle, the CustomMarkerStyle will be used. |
| - | === Return Value === | + | == Return Value == |
| - | ^ Return Type ^ | + | * Type:[[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]] |
| - | | [[ThinkGeo.MapSuite.MvcEdition.MarkerStyle|MarkerStyle]]<!-- ThinkGeo.MapSuite.MvcEdition.MarkerStyle --> | | + | |
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak --> | + | ==== Protected Properties ==== |
| - | [[#Public Properties|Go Back]] | + | ==== Public Events ==== |
| - | ==== DefaultMarkerStyle ==== | + | |
| - | Gets or sets the style that is applied to the markers if the CustomMarkerStyle is not defined. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | [[ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle|PointMarkerStyle]]<!-- ThinkGeo.MapSuite.MvcEdition.PointMarkerStyle --> | | + | |
| - | + | ||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak --> | + | |
| - | [[#Public Properties|Go Back]] | + | |
| - | ==== Value ==== | + | |
| - | Gets or sets the break value. | + | |
| - | === Return Value === | + | |
| - | ^ Return Type ^ | + | |
| - | | Double<!-- System.Double --> | | + | |
| - | + | ||
| - | <!-- ThinkGeo.MapSuite.MvcEdition.MarkerClassBreak --> | + | |
| - | [[#Public Properties|Go Back]] | + | |
| - | ===== Protected Properties ===== | + | |
| - | ===== Public Events ===== | + | |
| - | __NOTOC__ | + | |
| - | [[Category:MvcEdition]] | + | |
| - | [[Category:ThinkGeo.MapSuite.MvcEdition]] | + | |
| - | [[Category:UpdateDocumentation]] | + | |
thinkgeo.mapsuite.mvcedition.markerclassbreak.1440040131.txt.gz · Last modified: 2015/09/21 03:34 (external edit)