SpatialFilter

Base Type: QueryFilter

The SpatialFilter class is a QueryFilter that includes both spatial and attribute constraints.

Property

Type

Description

FIDSet

FIDSet

An array of unique identifiers.

FilterDefs

FilterDef[]

The FilterDefs property contains the set of FilterDefs objects that will be applied to the query.

FilterGeometry

Geometry

The query geometry used to filter results.

FilterOwnsGeometry

bool

Indicates whether the filter owns the query geometry.

GeometryFieldName

string

The name of the Geometry field to which the filter applies.

OutputSpatialReference

SpatialReference

The spatial reference in which to output geometry for a given field.

PostfixClause

string

A clause that will be appended to the end of the where clause. Most commonly used for clauses like ORDER BY.

PrefixClause

string

A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST. Most commonly used for clauses like DISTINCT or ALL.

Resolution

double

The SpatialResolution provides generalization of shapes returned by a filter. The generalization is performed on the server to minimize network travel. A zero value is default and will result in no generalization. The higher the value, the greater the generalization performed. The value is specified in feature units and generally should be roughly the size of one display pixel (measured in feature units).

SearchOrder

esriSearchOrder

Gets the order in which spatial searches are applied by the RDBMS (ArcSDE). The spatial component of the search should generally be applied before the attribute component. The more spatially restrictive of the two should be used. In the following query, "Find all wells with particulate counts between 1000 and 1200 in within 5 miles of a school", the "esriSearchOrderAttribute" enumerator is more effective. If the filter geometry is the outline of the city of Modesto, California and the attribute query is "street_name = 'Main St.'" then "esriSearchOrderSpatial" should be used, as there are a large number of "Main St." records at a national level.

SpatialReferenceFieldName

string

The name of the SpatialReference field to which the filter applies.

SpatialRel

esriSpatialRelEnum

The spatial relationship checked by the filter.

SpatialRelDescription

string

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or '*'; e.g., TT*FFT***' represents CONTAIN.

SubFields

string

The comma delimited list of field names for the filter.

WhereClause

string

The where clause for the filter.

Remarks

See QueryFilter for information on the inherited properties.

2/28/2020