Skip to content
GuidesToolkitAPI

QueryParameters

QueryParameters = object

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:450

Criteria for a feature query. Mirrors the native QueryParameters.

Properties

Section titled “Properties”

geometry?

Section titled “geometry?”

optional geometry?: Geometry

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:454

Geometry to test against, with spatialRelationship.

maxFeatures?

Section titled “maxFeatures?”

optional maxFeatures?: number

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:458

Maximum number of features to return.

objectIds?

Section titled “objectIds?”

optional objectIds?: number[]

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:462

Restrict the query to these object ids.

orderBy?

Section titled “orderBy?”

optional orderBy?: OrderByField[]

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:464

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

orderByFields?

Section titled “orderByFields?”

optional orderByFields?: string[]

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:470

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.

outFields?

Section titled “outFields?”

optional outFields?: string[]

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:479

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).

resultOffset?

Section titled “resultOffset?”

optional resultOffset?: number

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:472

Skip this many results (paging).

returnGeometry?

Section titled “returnGeometry?”

optional returnGeometry?: boolean

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:460

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

spatialRelationship?

Section titled “spatialRelationship?”

optional spatialRelationship?: SpatialRelationship

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:456

Spatial relationship for geometry. Defaults to intersects.

whereClause?

Section titled “whereClause?”

optional whereClause?: string

Defined in: packages/expo-arcgis/src/ExpoArcgis.types.ts:452

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