Description

Represents a type used for limiting which features are rendered.

Features filtered from display remain available for query and analysis. Use display filter when only a subset of features needs to be visible while maintaining access to all features.

See also: AGSScaleDisplayFilterDefinition::filters, AGSManualDisplayFilterDefinition::activeFilter

Since: 100.13

Inheritance diagram for AGSDisplayFilter:

Instance Methods
(nullable instancetype)	- initWithName:whereClause:

Class Methods
(nullable instancetype)	+ displayFilterWithName:whereClause:

Properties
NSString *	filterID

NSString *	name

NSString *	whereClause

Method Documentation

◆ displayFilterWithName:whereClause:

+ (nullable instancetype) displayFilterWithName:	(NSString *)	name
whereClause:	(NSString *)	whereClause

Creates a new AGSDisplayFilter object with the specified name and where clause.

Parameters

name	A descriptive name for this display filter.
whereClause	A SQL expression that defines which features are rendered. @discussion If `whereClause` is empty, the result is `nil`.

Since: 100.13

◆ initWithName:whereClause:

- (nullable instancetype) initWithName:	(NSString *)	name
whereClause:	(NSString *)	whereClause

Creates a new AGSDisplayFilter object with the specified name and where clause.

Parameters

name	A descriptive name for this display filter.
whereClause	A SQL expression that defines which features are rendered. @discussion If `whereClause` is empty, the result is `nil`.

Since: 100.13

Property Documentation

◆ filterID

- (NSString*) filterID

readnonatomiccopy

The identifier for this display filter.

Use a unique name to identify this display filter when used in a web map as an AGSManualDisplayFilterDefinition::activeFilter.

Since: 100.13

◆ name

- (NSString*) name

readwritenonatomiccopy

A descriptive name for this display filter.

Since: 100.13

◆ whereClause

- (NSString*) whereClause

readwritenonatomiccopy

A SQL expression that defines which features are rendered.

The where clause string that is used as the where clause that should follow standard SQL syntax similar to what is discussed in the document SQL reference for query expressions used in ArcGIS.

A where clause that is not valid for the data may result in no features being drawn when this display filter is applied either by AGSManualDisplayFilterDefinition::activeFilter or by AGSScaleRangeDisplayFilter::maxScale. Check the layer's AGSLayerViewState for an AGSLayerViewStatusWarning; if there is one, then there might be an AGSLayerViewState::error describing that the display filter's where clause is not valid.

Since: 100.13