AGSScaleRangeDisplayFilter Class Reference

Description

A display filter that is applied on the layer based on the provided scale range.

See also

AGSScaleDisplayFilterDefinition::filters

Since

100.13

Inheritance diagram for AGSScaleRangeDisplayFilter:

Instance Methods
(nullable instancetype)	- initWithName:whereClause:
(nullable instancetype)	- initWithName:whereClause:minScale:maxScale:

Class Methods
(nullable instancetype)	+ displayFilterWithName:whereClause:
(nullable instancetype)	+ scaleRangeDisplayFilterWithName:whereClause:minScale:maxScale:

Properties
NSString *	filterID
double	maxScale
double	minScale
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

initWithName:whereClause:minScale:maxScale:

- (nullable instancetype) initWithName:		(NSString *)	name
whereClause:		(NSString *)	whereClause
minScale:		(double)	minScale
maxScale:		(double)	maxScale

Creates a new AGSScaleRangeDisplayFilter object with the specified name, where clause, and scale range.

Parameters

name	A descriptive name for this display filter.
whereClause	A SQL expression that defines which features are rendered.
minScale	The minimum scale at which this display filter is applied.
maxScale	The maximum scale at which this display filter is applied. @discussion If whereClause is empty or a maxScale is greater than the minScale, the result is nil.

Since

100.13

scaleRangeDisplayFilterWithName:whereClause:minScale:maxScale:

+ (nullable instancetype) scaleRangeDisplayFilterWithName:		(NSString *)	name
whereClause:		(NSString *)	whereClause
minScale:		(double)	minScale
maxScale:		(double)	maxScale

Creates a new AGSScaleRangeDisplayFilter object with the specified name, where clause, and scale range.

Parameters

name	A descriptive name for this display filter.
whereClause	A SQL expression that defines which features are rendered.
minScale	The minimum scale at which this display filter is applied.
maxScale	The maximum scale at which this display filter is applied. @discussion If whereClause is empty or a maxScale is greater than the minScale, the result is nil.

Since

100.13

Property Documentation

filterID

- (NSString*) filterID

readnonatomiccopyinherited

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

maxScale

- (double) maxScale

readwritenonatomicassign

The maximum scale at which this display filter is applied.

This display filter is only applied when zoomed further out than the maximum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If AGSMapView::scale or AGSViewpoint::targetScale is greater than or equal to this value, the AGSDisplayFilter will be applied. This value should be less than AGSScaleRangeDisplayFilter::minScale. A value of 0 indicates this display filter is applied without an upper limit. The default value is 0.

Since

100.13

minScale

- (double) minScale

readwritenonatomicassign

The minimum scale at which this display filter is applied. This display filter is only applied when zoomed further in than the minimum scale. Set this property to allow current scale of the map to determine when this display filter is applied. If AGSMapView::scale or AGSViewpoint::targetScale is less than or equal to this value, the AGSDisplayFilter will be applied. This value should be greater than AGSScaleRangeDisplayFilter::maxScale. A value of 0 indicates this display filter is applied without a lower limit. The default value is 0.

Since

100.13

name

- (NSString*) name

readwritenonatomiccopyinherited

A descriptive name for this display filter.

Since

100.13

whereClause

- (NSString*) whereClause

readwritenonatomiccopyinherited

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