A class break object used to categorize a group of values that fall within a range of values. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- alternateSymbols : SymbolListModel
- description : string
- json : jsobject
- label : string
- maxValue : double
- minValue : double
- symbol : Symbol
- unknownJson : jsobject
- unsupportedJson : jsobject
Signals
Methods
Detailed Description
The ClassBreak is used to categorize a group of values that fall within a range defined by minValue and maxValue properties. A value is determined to be within this range if it is greater than the minValue but less than or equal to the maxValue. When written as an algebraic equation, it would look like (minValue < value <= maxValue).
For example, assume you wanted to create a set of ClassBreak categories based on the following integers (0, 0, 1, 1, 2, 4, 6, 6, 7, 10).
The following table would be helpful in defining the ClassBreak range settings:
| Categorized group of values | count | label | minValue | maxValue |
|---|---|---|---|---|
| 0 | 2 | none | -1 | 0 |
| 1-2 | 3 | one to two | 0 | 2 |
| 3-5 | 1 | three to five | 2 | 5 |
| 6-10 | 4 | six to ten | 5 | 10 |
See also JsonSerializable and ClassBreaksRenderer.
Property Documentation
alternateSymbols : SymbolListModel |
The alternate symbols for the class break's primary symbol.
Symbols in this list must be of type MultilayerSymbol and must have SymbolReferenceProperties set with valid minimum and maximum scales at which the symbol becomes visible. A renderer will pick only one symbol at a given map scale. If a primary symbol's scale range falls within the map's scale, the primary symbol is used. If not, then symbols in the alternate symbols list are iterated through and the first symbol matching the current map scale is picked for rendering. A symbol becomes visible if the map scale is less than or equal to the symbol's minimum scale and greater than symbol's maximum scale.
alternateSymbols can only be set once, and should be set at initialization.
This property was introduced in Esri.ArcGISRuntime 100.13.
The description of the class break.
"Cities with a population under 100,000", for example.
The JSON representation of this object.
This JSON can be used to instantiate the type instance.
The maximum value of the range that defines the break.
A value is in the class break when it is in the range minValue < value <= maxValue.
The minimum value of the range that defines the break.
A value is in the class break when it is in the range minValue < value <= maxValue.
[default] symbol : Symbol |
The symbol used to represent elements in the class break.
Returns the unknown JSON from the source JSON.
See also JsonSerializable.
Returns the unsupported data from the source JSON.
See also JsonSerializable.
Signal Documentation
Emitted when the description property changes.
Note: The corresponding handler is onDescriptionChanged.
Emitted when the label property changes.
Note: The corresponding handler is onLabelChanged.
Emitted when the maxValue property changes.
Note: The corresponding handler is onMaxValueChanged.
Emitted when the minValue property changes.
Note: The corresponding handler is onMinValueChanged.
Emitted when the symbol property changes.
Note: The corresponding handler is onSymbolChanged.
Method Documentation
ClassBreak clone() |
Creates a deep copy of this object.
bool equals(ClassBreak classBreak) |
Compares two class breaks for equality.
Returns whether this instance and the other classBreak are equal.