DisplayFilter Class

  • DisplayFilter
  • class Esri::ArcGISRuntime::DisplayFilter

    Represents a type used for limiting which features are rendered. More...

    Header: #include <DisplayFilter.h>
    Since: Esri::ArcGISRuntime 100.13
    Inherits: Esri::ArcGISRuntime::Object
    Inherited By:


    Public Functions

    DisplayFilter(const QString &name, const QString &whereClause, QObject *parent = nullptr)
    virtual ~DisplayFilter() override
    Esri::ArcGISRuntime::DisplayFilterType displayFilterType() const
    QString filterId() const
    QString name() const
    void setName(const QString &name)
    void setWhereClause(const QString &whereClause)
    QString whereClause() const

    Detailed Description

    Features filtered from the display remain available for query and analysis. Use the display filter when only a subset of features needs to be visible while maintaining access to all features.

    See also ScaleDisplayFilterDefinition::filters and ManualDisplayFilterDefinition::activeFilter.

    Member Function Documentation

    DisplayFilter::DisplayFilter(const QString &name, const QString &whereClause, QObject *parent = nullptr)

    Creates a new DisplayFilter with the specified name and where clause.

    • name - A descriptive name for this display filter.
    • whereClause - A SQL expression that defines which features are rendered.
    • parent - The optional parent QObject.

    [override virtual] DisplayFilter::~DisplayFilter()


    Esri::ArcGISRuntime::DisplayFilterType DisplayFilter::displayFilterType() const

    Returns the object type of this object.

    QString DisplayFilter::filterId() const

    Returns the identifier for this display filter.

    Use a unique name to identify this display filter when used in a webmap as a ManualDisplayFilterDefinition::activeFilter.

    QString DisplayFilter::name() const

    Returns a descriptive name for this display filter.

    See also setName().

    void DisplayFilter::setName(const QString &name)

    Sets the name to name.

    See also name.

    void DisplayFilter::setWhereClause(const QString &whereClause)

    Sets the whereClause to whereClause.

    See also whereClause.

    QString DisplayFilter::whereClause() const

    Returns a SQL expression that defines which features are rendered.

    The where clause string that is used as the whereClause should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

    A where clause that is not valid for the data may result in no features being drawn when this display filter is applied either by ManualDisplayFilterDefinition::activeFilter or by ScaleRangeDisplayFilter::maxScale. Check the layer's LayerViewState for a LayerViewStatus::Warning with an LayerViewState::error describing that the display filter's where clause is invalid.

    See also setWhereClause().

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