Package com.esri.arcgisruntime.layers

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

Modifier and Type	Method	Description
DisplayFilter	getActiveFilter()	Gets a display filter from getAvailableFilters() 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 from getAvailableFilters() to apply.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 of availableFilters. If the provided DisplayFilter 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 from getAvailableFilters() 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 from getAvailableFilters() 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 from ManualDisplayFilterDefinition.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 specified getActiveFilter() does not appear to be applied, check the layer's LayerViewState for a LayerViewStatus.WARNING, as there might be a LayerViewState.getError() describing that display filter's where clause is not valid. Note that should collection contain a ScaleRangeDisplayFilter, its ScaleRangeDisplayFilter.getMinScale() and ScaleRangeDisplayFilter.getMaxScale() are both ignored.

Returns:

the collection of display filters that can be applied

Since:

100.13.0

See Also:

DisplayFilter, ScaleRangeDisplayFilter