ClassBreak Class
A class break definition for use with a class breaks renderer. More...
| Header: | #include <ClassBreak> |
| Since: | Esri::ArcGISRuntime 100.0 |
| Inherits: | Esri::ArcGISRuntime::Object and Esri::ArcGISRuntime::JsonSerializable |
This class was introduced in Esri::ArcGISRuntime 100.0.
Public Functions
| ClassBreak(const QString &label, const QString &description, double minValue, double maxValue, Esri::ArcGISRuntime::Symbol *symbol, QObject *parent = nullptr) | |
| ClassBreak(QObject *parent = nullptr) | |
| virtual | ~ClassBreak() override |
| Esri::ArcGISRuntime::ClassBreak * | clone(QObject *parent = nullptr) const |
| QString | description() const |
| QString | label() const |
| double | maxValue() const |
| double | minValue() const |
| void | setDescription(const QString &description) |
| void | setLabel(const QString &label) |
| void | setMaxValue(double maxValue) |
| void | setMinValue(double minValue) |
| void | setSymbol(Esri::ArcGISRuntime::Symbol *symbol) |
| Esri::ArcGISRuntime::Symbol * | symbol() const |
| bool | operator==(const Esri::ArcGISRuntime::ClassBreak *other) const |
Reimplemented Public Functions
| virtual QString | toJson() const override |
| virtual QJsonObject | unknownJson() const override |
| virtual QJsonObject | unsupportedJson() const override |
Static Public Members
| Esri::ArcGISRuntime::ClassBreak * | fromJson(const QString &json, QObject *parent = nullptr) |
Detailed Description
A class break corresponds to a range of values for an attribute field. A list of class break instances are maintained in the ClassBreakListModel. When the class breaks renderer is used to display a layer, the symbol used for a feature is determined by the value in a selected attribute. When the value falls within a class break, the corresponding symbol and label display.
Class breaks contain this information: Value, range, name, and description, as well as the label and symbol to display for features that contain attribute values within this class break.
See also ClassBreaksRenderer.
Member Function Documentation
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::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.