Skip to content
Guides API

QueryParameters

QueryParameters = object

Defined in: src/ExpoArcgis.types.ts:443

Criteria for a feature query. Mirrors the native QueryParameters.

optional geometry?: Geometry

Defined in: src/ExpoArcgis.types.ts:447

Geometry to test against, with spatialRelationship.


optional maxFeatures?: number

Defined in: src/ExpoArcgis.types.ts:451

Maximum number of features to return.


optional objectIds?: number[]

Defined in: src/ExpoArcgis.types.ts:455

Restrict the query to these object ids.


optional orderBy?: OrderByField[]

Defined in: src/ExpoArcgis.types.ts:457

Sort order of the results (object form with explicit ascending flag).


optional orderByFields?: string[]

Defined in: src/ExpoArcgis.types.ts:463

Sort order of the results as "FIELD [ASC|DESC]" strings, e.g. ['POP DESC', 'NAME ASC']. Parsed into native OrderBy objects; appended after any orderBy entries. Omitting the direction defaults to ascending.


optional outFields?: string[]

Defined in: src/ExpoArcgis.types.ts:472

Restrict which attribute fields are returned, e.g. ['NAME', 'POP']. Pass ['*'] or omit to include all fields (the default). Implemented as a post-query client-side filter on both platforms (the native QueryParameters does not expose per-field selection for queryFeatures).


optional resultOffset?: number

Defined in: src/ExpoArcgis.types.ts:465

Skip this many results (paging).


optional returnGeometry?: boolean

Defined in: src/ExpoArcgis.types.ts:453

Whether to include each feature’s geometry. Defaults to true.


optional spatialRelationship?: SpatialRelationship

Defined in: src/ExpoArcgis.types.ts:449

Spatial relationship for geometry. Defaults to intersects.


optional whereClause?: string

Defined in: src/ExpoArcgis.types.ts:445

SQL where clause (e.g. POP > 1000000).