SymbolReferenceProperties Class

  • SymbolReferenceProperties
  • class Esri::ArcGISRuntime::SymbolReferenceProperties

    Symbol properties that change how symbols behave when attached to a renderer. More...

    Header: #include <SymbolReferenceProperties.h>
    Since: Esri::ArcGISRuntime 100.13
    Inherits: Esri::ArcGISRuntime::Object

    This class was introduced in Esri::ArcGISRuntime 100.13.

    Public Functions

    SymbolReferenceProperties(double minScale, double maxScale, QObject *parent = nullptr)
    SymbolReferenceProperties(QObject *parent = nullptr)
    virtual ~SymbolReferenceProperties() override
    double maxScale() const
    double minScale() const
    void setMaxScale(double maxScale)
    void setMinScale(double minScale)

    Detailed Description

    SymbolReferenceProperties contains conditional properties that are not used directly by the symbol, but rather by the renderer to change how a symbol is visualized based on the state of the view and the data. For example, minScale and maxScale will be used by class breaks and unique value renderers to determine if a symbol break or unique value is visible at a certain scale. Additional symbols can be assigned as alternate symbols for the renderers. This allows the map author to control which symbol is displayed at certain scales.

    Member Function Documentation

    SymbolReferenceProperties::SymbolReferenceProperties(double minScale, double maxScale, QObject *parent = nullptr)

    Creates a symbol reference properties object with minimum and maximum scales.

    • minScale - Scale at which the symbol starts rendering.
    • maxScale - Scale at which the symbol stops rendering.
    • parent - The optional parent QObject.

    Minimum and maximum scales are used in the context of alternate symbols.

    SymbolReferenceProperties::SymbolReferenceProperties(QObject *parent = nullptr)

    creates a SymbolReferenceProperties object

    • parent - The optional parent QObject.

    [override virtual] SymbolReferenceProperties::~SymbolReferenceProperties()

    Destructor.

    double SymbolReferenceProperties::maxScale() const

    Returns the maximum scale at which the symbol will be visible.

    This is the scale at which the symbol starts rendering. The default value is 0.

    See also setMaxScale().

    double SymbolReferenceProperties::minScale() const

    Returns the minimum scale at which the symbol will be visible.

    This is the scale at which the symbol stops rendering. The default value is 0.

    See also setMinScale().

    void SymbolReferenceProperties::setMaxScale(double maxScale)

    Sets the maxScale to maxScale.

    See also maxScale.

    void SymbolReferenceProperties::setMinScale(double minScale)

    Sets the minScale to minScale.

    See also minScale.

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