Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

aggregateIds

aggregateIds: number[]

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

Read more...

cacheHint

cacheHint: boolean

Indicates if the service should cache the query results.

Read more...

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

declaredClass

declaredClass: string

destroyed

destroyed: boolean

distance

distance: number

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

Read more...

gdbVersion

gdbVersion: string

Specifies the geodatabase version to display for feature service queries.

Read more...

geometry

geometry: Geometry

The geometry to apply to the spatial filter.

Read more...

geometryPrecision

geometryPrecision: number

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

Read more...

groupByFieldsForStatistics

groupByFieldsForStatistics: string[]

having

having: string

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

Read more...

historicMoment

historicMoment: Date

The historic moment to query.

Read more...

initialized

initialized: boolean

maxAllowableOffset

maxAllowableOffset: number

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

Read more...

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

multipatchOption

multipatchOption: string

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

Read more...

num

num: number

The number of features to retrieve.

Read more...

objectIds

objectIds: number[]

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

Read more...

orderByFields

orderByFields: string[]

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

Read more...

outFields

outFields: string[]

Attribute fields to include in the FeatureSet.

Read more...

outSpatialReference

outSpatialReference: SpatialReference

The spatial reference for the returned geometry.

Read more...

outStatistics

outStatistics: StatisticDefinition[]

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

Read more...

parameterValues

parameterValues: QueryParameterValues[]

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

Read more...

pixelSize

pixelSize: Point

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

Read more...

quantizationParameters

quantizationParameters: QueryQuantizationParameters

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

Read more...

rangeValues

rangeValues: QueryRangeValues[]

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

Read more...

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

returnCentroid

returnCentroid: boolean

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

Read more...

returnDistinctValues

returnDistinctValues: boolean

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

Read more...

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

returnGeometry

returnGeometry: boolean

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

Read more...

returnM

returnM: boolean

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

Read more...

returnQueryGeometry

returnQueryGeometry: boolean

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

Read more...

returnZ

returnZ: boolean

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

Read more...

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

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

start

start: number

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

Read more...

text

text: string

Shorthand for a where clause using "like".

Read more...

timeExtent

timeExtent: TimeExtent

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

Read more...

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

where

where: string

A where clause for the query.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): Query
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Query

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Query

  • Parameters

    Returns Query

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

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

    Returns WatchHandle

Generated using TypeDoc