Class ManualDisplayFilterDefinition
- java.lang.Object
-
- com.esri.arcgisruntime.layers.DisplayFilterDefinition
-
- com.esri.arcgisruntime.layers.ManualDisplayFilterDefinition
-
public final class ManualDisplayFilterDefinition extends DisplayFilterDefinition
Filter features from the display based on the specified active display filter.This is useful when making visual comparisons of the data, or filtering out specific pieces of data.
- Since:
- 100.13.0
- See Also:
ScaleDisplayFilterDefinition
-
-
Constructor Summary
Constructors Constructor Description ManualDisplayFilterDefinition(DisplayFilter activeFilter, java.lang.Iterable<DisplayFilter> availableFilters)
Creates a new ManualDisplayFilterDefinition with the specified active and available filters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DisplayFilter
getActiveFilter()
Gets a display filter fromgetAvailableFilters()
to apply.java.util.List<DisplayFilter>
getAvailableFilters()
Gets the collection of display filters that can be applied.void
setActiveFilter(DisplayFilter activeFilter)
Sets a display filter fromgetAvailableFilters()
to apply.
-
-
-
Constructor Detail
-
ManualDisplayFilterDefinition
public ManualDisplayFilterDefinition(DisplayFilter activeFilter, java.lang.Iterable<DisplayFilter> availableFilters)
Creates a new ManualDisplayFilterDefinition with the specified active and available filters.- Parameters:
activeFilter
- a display filter to apply. To enable display filter on a layer, specify a filter that is part ofavailableFilters
. If the providedDisplayFilter
isn't part of the available filters,getActiveFilter()
} will remain null.activeFilter
may be null.availableFilters
- the collection of display filters that can be applied- Throws:
java.lang.IllegalArgumentException
- if availableFilters is null- Since:
- 100.13.0
-
-
Method Detail
-
getActiveFilter
public DisplayFilter getActiveFilter()
Gets a display filter fromgetAvailableFilters()
to apply.To enable display filter on a layer, specify a filter that is part of
ManualDisplayFilterDefinition.getAvailableFilters()
. If no active filter is set, then no display filter is applied.- Returns:
- a display filter from
ManualDisplayFilterDefinition.getAvailableFilters()
to apply. Returns null if none. - Since:
- 100.13.0
-
setActiveFilter
public void setActiveFilter(DisplayFilter activeFilter)
Sets a display filter fromgetAvailableFilters()
to apply.To enable display filter on a layer, specify a filter that is part of
getAvailableFilters()
. If no active filter is set, then no display filter is applied.- Parameters:
activeFilter
- a display filter fromManualDisplayFilterDefinition.setAvailableFilters()
to apply.- Since:
- 100.13.0
-
getAvailableFilters
public java.util.List<DisplayFilter> getAvailableFilters()
Gets the collection of display filters that can be applied.To enable display filter on a layer, use
setActiveFilter(DisplayFilter)
to specify a display filter that is part of this collection. If the specifiedgetActiveFilter()
does not appear to be applied, check the layer'sLayerViewState
for aLayerViewStatus.WARNING
, as there might be aLayerViewState.getError()
describing that display filter's where clause is not valid. Note that should collection contain aScaleRangeDisplayFilter
, itsScaleRangeDisplayFilter.getMinScale()
andScaleRangeDisplayFilter.getMaxScale()
are both ignored.- Returns:
- the collection of display filters that can be applied
- Since:
- 100.13.0
- See Also:
DisplayFilter
,ScaleRangeDisplayFilter
-
-