LegendInfo Class

  • LegendInfo
  • class Esri::ArcGISRuntime::LegendInfo

    This object represents a legend item. More...

    Header: #include <LegendInfo.h>
    Since: Esri::ArcGISRuntime 100.0
    Inherits: Esri::ArcGISRuntime::Object

    Public Functions

    virtual ~LegendInfo() override
    QString name() const
    Esri::ArcGISRuntime::Symbol *symbol(QObject *parent = nullptr) const
    bool operator!=(const Esri::ArcGISRuntime::LegendInfo &other) const
    bool operator==(const Esri::ArcGISRuntime::LegendInfo &other) const

    Detailed Description

    You can get this object from the LayerContent::isAutoFetchLegendInfos method of objects that implement the LayerContent interface (e.g. ArcGISSublayer::isAutoFetchLegendInfos).

    Relevant samples:

    • Build a legend: Build a legend for all the operational layers in the map.

    See also LayerContent and LayerContent::isAutoFetchLegendInfos.

    Member Function Documentation

    [override virtual] LegendInfo::~LegendInfo()

    Destructor.

    QString LegendInfo::name() const

    Gets the name of the legend.

    Esri::ArcGISRuntime::Symbol *LegendInfo::symbol(QObject *parent = nullptr) const

    Gets the symbol of the legend with an optional parent.

    [since Esri::ArcGISRuntime 200.2] bool LegendInfo::operator!=(const Esri::ArcGISRuntime::LegendInfo &other) const

    Inequality operator. Returns true if this object and other are not equal.

    This function was introduced in Esri::ArcGISRuntime 200.2.

    See also LegendInfo::operator==.

    [since Esri::ArcGISRuntime 200.1] bool LegendInfo::operator==(const Esri::ArcGISRuntime::LegendInfo &other) const

    Returns a bool that tests if this object is equal to a second LegendInfo object.

    • other - The 2nd legend item to check to see if equal to the 1st legend item.

    This function was introduced in Esri::ArcGISRuntime 200.1.

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