Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface supportQueryProperties

Hierarchy

  • supportQueryProperties

Index

Properties

Optional aggregateIds

aggregateIds: number[]

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

Read more...

Optional cacheHint

cacheHint: boolean

Indicates if the service should cache the query results.

Read more...

Optional datumTransformation

datumTransformation: number

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

Read more...

Optional distance

distance: number

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

Read more...

Optional gdbVersion

gdbVersion: string

Specifies the geodatabase version to display for feature service queries.

Read more...

Optional geometry

The geometry to apply to the spatial filter.

Read more...

Optional geometryPrecision

geometryPrecision: number

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

Read more...

Optional groupByFieldsForStatistics

groupByFieldsForStatistics: string[]

Optional having

having: string

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

Read more...

Optional historicMoment

historicMoment: DateProperties

The historic moment to query.

Read more...

Optional maxAllowableOffset

maxAllowableOffset: number

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

Read more...

Optional maxRecordCountFactor

maxRecordCountFactor: number

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

Read more...

Optional multipatchOption

multipatchOption: string

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

Read more...

Optional num

num: number

The number of features to retrieve.

Read more...

Optional objectIds

objectIds: number[]

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

Read more...

Optional orderByFields

orderByFields: string[]

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

Read more...

Optional outFields

outFields: string[]

Attribute fields to include in the FeatureSet.

Read more...

Optional outSpatialReference

outSpatialReference: SpatialReferenceProperties

The spatial reference for the returned geometry.

Read more...

Optional outStatistics

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

Read more...

Optional parameterValues

parameterValues: supportQueryParameterValues[]

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

Read more...

Optional pixelSize

pixelSize: PointProperties

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

Read more...

Optional quantizationParameters

quantizationParameters: supportQueryQuantizationParameters

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

Read more...

Optional rangeValues

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

Read more...

Optional relationParameter

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

Optional returnCentroid

returnCentroid: boolean

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

Read more...

Optional returnDistinctValues

returnDistinctValues: boolean

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

Read more...

Optional returnExceededLimitFeatures

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.

Read more...

Optional returnGeometry

returnGeometry: boolean

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

Read more...

Optional returnM

returnM: boolean

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

Read more...

Optional returnQueryGeometry

returnQueryGeometry: boolean

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

Read more...

Optional returnZ

returnZ: boolean

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

Read more...

Optional spatialRelationship

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

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

Read more...

Optional sqlFormat

sqlFormat: "none" | "native" | "standard"

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

Read more...

Optional start

start: number

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

Read more...

Optional text

text: string

Shorthand for a where clause using "like".

Read more...

Optional timeExtent

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

Read more...

Optional units

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

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

Read more...

Optional where

where: string

A where clause for the query.

Read more...

Generated using TypeDoc