ClassBreak

A class break object used to categorize a group of values that fall within a range of values. The ClassBreak is used to categorize a group of values that fall within a range defined by ClassBreak.minValue and ClassBreak.maxValue properties. A value is determined to be within this range if it is greater than the ClassBreak.minValue but less than or equal to the ClassBreak.maxValue. When written as an algebraic equation, it would look like (ClassBreak.minValue< value <= ClassBreak.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

Since

200.1.0

Constructors

Link copied to clipboard
constructor(description: String = "", label: String = "", minValue: Double = Double.NaN, maxValue: Double = Double.NaN, symbol: Symbol? = null, alternateSymbols: Iterable<Symbol> = emptyList())

Creates a new class break object with alternate symbols. A class break can have alternate symbols to the primary symbol. Alternate symbols allow you to tailor the visualization of class break at different scales by selecting different symbol for different scales. Alternate symbols are supported only when class break's primary symbol and other symbols in alternate symbol list are of type MultilayerSymbol and have SymbolReferenceProperties defining valid min max scales at which the symbol becomes visible. Renderer will pick only one symbol at a given map scale. If primary symbol's scale range falls within the map's scale, primary symbol is used. If not, then symbols in alternate symbols list are iterated through and 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 symbol's minimum scale and greater than symbol's maximum scale. For more information about Scale-based symbol classes and alternate symbols, see https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scale-based-symbol-classes.htm.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The alternate symbols for the class break's primary symbol. Symbols in this list should be of type MultilayerSymbol and must have SymbolReferenceProperties set with valid minimum and maximum scale at which symbol becomes visible. Renderer will pick only one symbol at a given map scale. If primary symbol's scale range falls within the map's scale, primary symbol is used. If not, then symbols in alternate symbols list are iterated through and 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 symbol's minimum scale and greater than symbol's maximum scale.

Link copied to clipboard

A description of the class break. "Cities with a population under 100,000", for example.

Link copied to clipboard

A label for the class break. "0 - 100000", for example.

Link copied to clipboard

The maximum value of the range that defines the break.

Link copied to clipboard

The minimum value of the range that defines the break.

Link copied to clipboard

A symbol used to represent elements in the class break.

Functions

Link copied to clipboard

Clones the ClassBreak.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int

Inherited functions

Link copied to clipboard
open override fun toJson(): String

Convert an object to JSON string.