Class EsriQuery

Hierarchy

  • Accessor
  • JSONSupport
    • EsriQuery

Constructors

  • This class defines parameters for executing queries for features from a layer or layer view.

    Read more...

    Parameters

    • Optional properties: QueryProperties

    Returns EsriQuery

Properties

aggregateIds: number[]

An array of Object IDs representing aggregate (i.e.

Read more...

cacheHint: boolean

Indicates if the service should cache the query results.

Default

undefined

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#cacheHint)
datumTransformation: number

Datum transformation used for projecting geometries in the query results when outSpatialReference is different than the layer's spatial reference.

Read more...

declaredClass: string
destroyed: boolean
distance: number

Specifies a search distance from a given geometry in a spatial query.

Read more...

gdbVersion: string

Specifies the geodatabase version to display for feature service queries.

Read more...

geometry: EsriGeometry

The geometry to apply to the spatial filter.

Read more...

geometryPrecision: number

Specifies the number of decimal places for geometries returned by the JSON query operation.

Read more...

groupByFieldsForStatistics: string[]
having: string

A condition used with outStatistics and groupByFieldsForStatistics to limit query results to groups that satisfy the aggregation function(s).

Read more...

historicMoment: Date

The historic moment to query.

Read more...

initialized: boolean
maxAllowableOffset: number

The maximum distance in units of outSpatialReference used for generalizing geometries returned by the query operation.

Read more...

maxRecordCountFactor: number

When set, the maximum number of features returned by the query will equal the maxRecordCount of the service multiplied by this factor.

Default

1

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxRecordCountFactor)
multipatchOption: string

Parameter dictates how the geometry of a multipatch feature will be returned.

Read more...

num: number

The number of features to retrieve.

Read more...

objectIds: number[]

An array of ObjectIDs to be used to query for features in a layer.

Read more...

orderByFields: string[]

One or more field names used to order the query results.

Read more...

outFields: string[]

Attribute fields to include in the FeatureSet.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outFields)
outSpatialReference: EsriSpatialReference

The spatial reference for the returned geometry.

Read more...

outStatistics: StatisticDefinition[]

The definitions for one or more field-based statistics to be calculated.

Read more...

parameterValues: QueryParameterValues[]

Filters features from the layer based on pre-authored parameterized filters.

Read more...

pixelSize: EsriPoint

Specifies the pixel level to be identified on the X and Y axis.

Read more...

quantizationParameters: QueryQuantizationParameters

Used to project the geometry onto a virtual grid, likely representing pixels on the screen.

Read more...

rangeValues: QueryRangeValues[]

Filters features from the layer that are within the specified range values.

Read more...

relationParameter: string

The Dimensionally Extended 9 Intersection Model (DE-9IM) matrix relation (encoded as a string) to query the spatial relationship of the input geometry to the layer's features.

Read more...

returnCentroid: boolean

If true, each feature in the returned FeatureSet will be returned with a centroid.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnCentroid)
returnDistinctValues: boolean

If true then the query returns distinct values based on the field(s) specified in outFields.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnDistinctValues)
returnExceededLimitFeatures: boolean

If true, then all features are returned for each tile request, even if they exceed the maximum record limit per query indicated on the service by maxRecordCount.

Default

true

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnExceededLimitFeatures)
returnGeometry: boolean

If true, each feature in the returned FeatureSet includes the geometry.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry)
returnM: boolean

If true, and returnGeometry is true, then m-values are included in the geometry.

Read more...

returnQueryGeometry: boolean

If true, the query geometry will be returned with the query results.

Default

false

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnQueryGeometry)
returnZ: boolean

If true, and returnGeometry is true, then z-values are included in the geometry.

Read more...

spatialRelationship: "contains" | "intersects" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation"

For spatial queries, this parameter defines the spatial relationship to query features in the layer or layer view against the input geometry.

Default

intersects

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#spatialRelationship)
sqlFormat: "none" | "standard" | "native"

This parameter can be either standard SQL92 standard or it can use the native SQL of the underlying datastore native.

Default

none

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#sqlFormat)
start: number

The zero-based index indicating where to begin retrieving features.

Read more...

text: string

Shorthand for a where clause using "like".

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#text)
timeExtent: TimeExtent

A time extent for a temporal query against time-aware layers.

Read more...

units: "feet" | "miles" | "nautical-miles" | "us-nautical-miles" | "meters" | "kilometers"

The unit for calculating the buffer distance when distance is specified in spatial queries.

Default

null

[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#units)
where: string

A where clause for the query.

Read more...

Methods

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriQuery

  • Type Parameters

    • T

    Parameters

    • handles: IHandle | IHandle[]
    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns boolean

  • Parameters

    • propertyName: string

    Returns void

  • Deprecated

    Since 4.25. Use addHandles(), removeHandles() and hasHandles() instead.

    Parameters

    • handles: IHandle | IHandle[]

    Returns void

  • Type Parameters

    • T

    Parameters

    • Optional groupKey: Exclude<T, IHandle>

    Returns void

  • Type Parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns EsriQuery

  • Parameters

    • props: HashMap<any>

    Returns EsriQuery

  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

  • Parameters

    • json: any

    Returns EsriQuery

Generated using TypeDoc