ManualDisplayFilterDefinition Class

  • ManualDisplayFilterDefinition
  • class Esri::ArcGISRuntime::ManualDisplayFilterDefinition

    Filter features from the display based on the specified active display filter. More...

    Header: #include <ManualDisplayFilterDefinition.h>
    Since: Esri::ArcGISRuntime 100.13
    Inherits: Esri::ArcGISRuntime::DisplayFilterDefinition

    Public Functions

    ManualDisplayFilterDefinition(Esri::ArcGISRuntime::DisplayFilter *activeFilter, const QList<Esri::ArcGISRuntime::DisplayFilter *> &availableFilters, QObject *parent = nullptr)
    virtual ~ManualDisplayFilterDefinition() override
    Esri::ArcGISRuntime::DisplayFilter *activeFilter() const
    Esri::ArcGISRuntime::DisplayFilterListModel *availableFilters() const
    void setActiveFilter(Esri::ArcGISRuntime::DisplayFilter *activeFilter)

    Detailed Description

    This is useful when making visual comparisons of the data, or filtering out specific pieces of data.

    See also ScaleDisplayFilterDefinition.

    Member Function Documentation

    ManualDisplayFilterDefinition::ManualDisplayFilterDefinition(Esri::ArcGISRuntime::DisplayFilter *activeFilter, const QList<Esri::ArcGISRuntime::DisplayFilter *> &availableFilters, QObject *parent = nullptr)

    Creates a new ManualDisplayFilterDefinition with the specified active and available filters.

    • activeFilter - A display filter from availableFilters to apply.
    • availableFilters - The collection of display filters that can be applied.
    • parent - The optional parent QObject.

    [override virtual] ManualDisplayFilterDefinition::~ManualDisplayFilterDefinition()


    Esri::ArcGISRuntime::DisplayFilter *ManualDisplayFilterDefinition::activeFilter() const

    Returns a display filter from availableFilters to apply.

    To enable display filter on a layer, specify a filter that is part of availableFilters. If no active filter is set, then no display filter is applied.

    See also setActiveFilter().

    Esri::ArcGISRuntime::DisplayFilterListModel *ManualDisplayFilterDefinition::availableFilters() const

    Returns the collection of display filters that can be applied. To enable display filter on a layer, specify a activeFilter that is part of this collection.

    If the specified activeFilter does not appear to be applied, check the layer's LayerViewState for a LayerViewStatus::Warning with a LayerViewState::error describing that the display filter's where clause is invalid.

    If this collection contains a ScaleRangeDisplayFilter, its ScaleRangeDisplayFilter::minScale and ScaleRangeDisplayFilter::maxScale are both ignored.

    See also ScaleRangeDisplayFilter.

    void ManualDisplayFilterDefinition::setActiveFilter(Esri::ArcGISRuntime::DisplayFilter *activeFilter)

    Sets the activeFilter to activeFilter.

    See also activeFilter.

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