ClassBreak Class

Member Function Documentation

ClassBreak::ClassBreak(const QString &label, const QString &description, double minValue, double maxValue, Esri::ArcGISRuntime::Symbol *symbol, const QList<Esri::ArcGISRuntime::Symbol *> &alternateSymbols, QObject *parent = nullptr)

Creates a new class break object with alternate symbols.

• label - A label for the class break. "0 - 100,000", for example.
• description - A description of the class break. "Cities with a population under 100,000", for example.
• minValue - The minimum value of the range that defines the break.
• maxValue - The maximum value of the range that defines the break.
• symbol - A symbol used to represent elements in the class break.
• alternateSymbols - The alternate symbols for the class break. Only MultilayerSymbol are supported as alternates. Only MultilayerSymbol are supported as alternates.
• parent - The optional parent QObject.

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 symbols for different scales. Alternate symbols are supported only when a class break's primary symbol and other symbols in the alternate symbol list are of type MultilayerSymbol and have SymbolReferenceProperties defining valid min and max scales at which the symbol becomes visible. The renderer will pick only one symbol at a given map scale. If the 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 the symbol's maximum scale. For more information on Scale-based symbol classes and alternate symbols see the following documentation: https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scale-based-symbol-classes.htm.

This function was introduced in Esri::ArcGISRuntime 100.13.

ClassBreak::ClassBreak(const QString &label, const QString &description, double minValue, double maxValue, Esri::ArcGISRuntime::Symbol *symbol, QObject *parent = nullptr)

Constructor that takes a label, description, minValue, maxValue, and symbol, with an optional parent.

ClassBreak::ClassBreak(QObject *parent = nullptr)

Default constructor with an optional parent.

[override virtual] ClassBreak::~ClassBreak()

Destructor.

Esri::ArcGISRuntime::SymbolListModel *ClassBreak::alternateSymbols() const

Returns 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 the symbol becomes visible. The renderer will pick only one symbol at a given map scale. If the 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.

This function was introduced in Esri::ArcGISRuntime 100.13.

Esri::ArcGISRuntime::ClassBreak *ClassBreak::clone(QObject *parent = nullptr) const

Clones the class break to a new instance with an optional parent.

Returns a new instance of the class break.

QString ClassBreak::description() const

Returns the description of the class break.

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

See also setDescription().

[static] Esri::ArcGISRuntime::ClassBreak *ClassBreak::fromJson(const QString &json, QObject *parent = nullptr)

Creates and returns a new class break from the provided json, with an optional parent.

See also JsonSerializable.

QString ClassBreak::label() const

Returns the label for the class break.

"0 - 100000", for example.

See also setLabel().

double ClassBreak::maxValue() const

Returns the maximum value of the range that defines the break.

See also setMaxValue().

double ClassBreak::minValue() const

Returns the minimum value of the range that defines the break.

See also setMinValue().

void ClassBreak::setDescription(const QString &description)

Sets the description of the class break.

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

See also description().

void ClassBreak::setLabel(const QString &label)

Sets the label for the class break.

"0 - 100000", for example.

See also label().

void ClassBreak::setMaxValue(double maxValue)

Sets the maxValue of the range that defines the break.

See also maxValue().

void ClassBreak::setMinValue(double minValue)

Sets the minValue of the range that defines the break.

See also minValue().

void ClassBreak::setSymbol(Esri::ArcGISRuntime::Symbol *symbol)

Sets the symbol used to represent elements in the class break.

See also symbol().

Esri::ArcGISRuntime::Symbol *ClassBreak::symbol() const

Returns the symbol used to represent elements in the class break.

See also setSymbol().

[override virtual] QString ClassBreak::toJson() const

Reimplements: JsonSerializable::toJson() const.

Returns this class break as a JSON representation.

See also JsonSerializable.

[override virtual] QJsonObject ClassBreak::unknownJson() const

Reimplements: JsonSerializable::unknownJson() const.

Gets the unknown JSON of this object.

See also JsonSerializable.

[override virtual] QJsonObject ClassBreak::unsupportedJson() const

Reimplements: JsonSerializable::unsupportedJson() const.

Gets the unsupported JSON of this object.

See also JsonSerializable.

bool ClassBreak::operator==(const Esri::ArcGISRuntime::ClassBreak *other) const

Equivalency operator

Returns true if this object and other equal.