ManualDisplayFilterDefinition Class

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.

To enable display filter on a layer, specify a filter that is part of availableFilters. If the provided DisplayFilter isn't part of the available filters, the activeFilter property will remain nullptr.

[override virtual noexcept] ManualDisplayFilterDefinition::~ManualDisplayFilterDefinition()

Destructor.

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.