AGSManualDisplayFilterDefinition Class Reference

Description

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.

See also

AGSScaleDisplayFilterDefinition

Since

100.13

Inheritance diagram for AGSManualDisplayFilterDefinition:

Instance Methods
(instancetype)	- initWithActiveFilter:availableFilters:

Class Methods
(instancetype)	+ manualDisplayFilterDefinitionWithActiveFilter:availableFilters:

Properties
AGSDisplayFilter *	activeFilter
NSArray< AGSDisplayFilter * > *	availableFilters

Method Documentation

initWithActiveFilter:availableFilters:

- (instancetype) initWithActiveFilter:		(nullable AGSDisplayFilter *)	activeFilter
availableFilters:		(NSArray< AGSDisplayFilter * > *)	availableFilters

Creates a new AGSManualDisplayFilterDefinition object with the specified active and available filters.

Parameters

activeFilter	A display filter from AGSManualDisplayFilterDefinition::availableFilters to apply.
availableFilters	The array of display filters that can be applied.

Since

100.13

manualDisplayFilterDefinitionWithActiveFilter:availableFilters:

+ (instancetype) manualDisplayFilterDefinitionWithActiveFilter:		(nullable AGSDisplayFilter *)	activeFilter
availableFilters:		(NSArray< AGSDisplayFilter * > *)	availableFilters

Creates a new AGSManualDisplayFilterDefinition object with the specified active and available filters.

Parameters

activeFilter	A display filter from AGSManualDisplayFilterDefinition::availableFilters to apply.
availableFilters	The array of display filters that can be applied.

Since

100.13

Property Documentation

activeFilter

- (AGSDisplayFilter*) activeFilter

readwritenonatomicstrong

A display filter from AGSManualDisplayFilterDefinition::availableFilters to apply.

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

Since

100.13

availableFilters

- (NSArray<AGSDisplayFilter *>*) availableFilters

readwritenonatomiccopy

The array of display filters that can be applied.

To enable display filter on a layer, specify an AGSManualDisplayFilterDefinition::activeFilter that is part of this array.

If the specified AGSManualDisplayFilterDefinition::activeFilter does not appear to be applied, check the layer's AGSLayerViewState for an AGSLayerViewStatusWarning as there might be an AGSLayerViewState::error describing that display filter's where clause is not valid.

If the array contains an AGSScaleRangeDisplayFilter object, its AGSScaleRangeDisplayFilter::minScale and AGSScaleRangeDisplayFilter::maxScale are both ignored.

See also

AGSDisplayFilter, AGSScaleRangeDisplayFilter

Since

100.13