ClassBreak QML Type

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.14
Since: Esri.ArcGISRuntime 100.0
Inherits:

Object

Properties

Signals

Methods

  • ClassBreak clone()
  • bool equals(ClassBreak classBreak)

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 valuescountlabelminValuemaxValue
02none-10
1-23one to two02
3-51three to five25
6-104six to ten510

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.


description : string

The description of the class break.

"Cities with a population under 100,000", for example.


json : jsobject

The JSON representation of this object.

This JSON can be used to instantiate the type instance.


label : string

The label for the class break.

"0 - 100,000", for example.


maxValue : double

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.


minValue : double

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.


unknownJson : jsobject

Returns the unknown JSON from the source JSON.

See also JsonSerializable.


unsupportedJson : jsobject

Returns the unsupported data from the source JSON.

See also JsonSerializable.


Signal Documentation

descriptionChanged()

Emitted when the description property changes.

Note: The corresponding handler is onDescriptionChanged.


labelChanged()

Emitted when the label property changes.

Note: The corresponding handler is onLabelChanged.


maxValueChanged()

Emitted when the maxValue property changes.

Note: The corresponding handler is onMaxValueChanged.


minValueChanged()

Emitted when the minValue property changes.

Note: The corresponding handler is onMinValueChanged.


symbolChanged()

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.


Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.