IQueryFeaturesOptions

Interface

feature query request options. See REST Documentation for more information.

Inheritance: IQueryFeaturesOptionsISharedQueryOptions

Properties

Hide inherited properties
PropertyTypeNotes

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials
inherited
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

number
"json" | "geojson" | "pbf"

Response format. Defaults to "json" NOTE: for "pbf" you must also supply rawResponse: trueand parse the response yourself using response.arrayBuffer()

string
geometry
inherited
number
geometryType
inherited
string
headers
inherited
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
inherited
boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

number
httpMethod
inherited

The HTTP method to send the request with.

number
maxUrlLength
inherited
number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

"xyFootprint"
number[]
string
string[] | "*"

Attribute fields to include in the response. Defaults to "*"

params
inherited

Additional parameters to pass in the request.

portal
inherited
string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

any
rawResponse
inherited
boolean

Return the raw response

string
number
number
"none" | "standard" | "tile"
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
""
boolean
signal
inherited
AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

spatialRel
inherited
"none" | "standard" | "native"
boolean

Suppress any ArcGIS REST JS related warnings for this request.

number | number[]
url
inherited
string

Layer service url.

where
inherited
string

A where clause for the query. Defaults to "1=1"

authentication

optionalinherited
Interface Property
authentication: string | IAuthenticationManager

The instance of ApiKey, ArcGISIdentityManager or ApplicationSession to use to authenticate this request. A token may also be passed directly as a string however using the built in authentication managers is encouraged.

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

distance

optional
Interface Property
distance: number

f

optional
Interface Property
f: "json" | "geojson" | "pbf"

Response format. Defaults to "json" NOTE: for "pbf" you must also supply rawResponse: trueand parse the response yourself using response.arrayBuffer()

gdbVersion

optional
Interface Property
gdbVersion: string

geometry

optionalinherited
Interface Property
geometry: IGeometry

geometryPrecision

optional
Interface Property
geometryPrecision: number

geometryType

optionalinherited
Interface Property

groupByFieldsForStatistics

optional
Interface Property
groupByFieldsForStatistics: string

headers

optionalinherited
Interface Property
headers: { [key: string]: any }

Additional Headers to pass into the request.

Type declaration
  • [key: string]: any

hideToken

optionalinherited
Interface Property
hideToken: boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.

historicMoment

optional
Interface Property
historicMoment: number

httpMethod

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

inSR

optional
Interface Property
inSR: string | ISpatialReference

maxAllowableOffset

optional
Interface Property
maxAllowableOffset: number

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.

multipatchOption

optional
Interface Property
multipatchOption: "xyFootprint"

objectIds

optional
Interface Property
objectIds: number[]

orderByFields

optional
Interface Property
orderByFields: string

outFields

optional
Interface Property
outFields: string[] | "*"

Attribute fields to include in the response. Defaults to "*"

outSR

optional
Interface Property
outSR: string | ISpatialReference

outStatistics

optional
Interface Property
outStatistics: IStatisticDefinition[]

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

portal

optionalinherited
Interface Property
portal: string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.

quantizationParameters

optional
Interface Property
quantizationParameters: any

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

relationParam

optional
Interface Property
relationParam: string

resultOffset

optional
Interface Property
resultOffset: number

resultRecordCount

optional
Interface Property
resultRecordCount: number

resultType

optional
Interface Property
resultType: "none" | "standard" | "tile"

returnCentroid

optional
Interface Property
returnCentroid: boolean

returnCountOnly

optional
Interface Property
returnCountOnly: boolean

returnDistinctValues

optional
Interface Property
returnDistinctValues: boolean

returnExceededLimitFeatures

optional
Interface Property
returnExceededLimitFeatures: boolean

returnExtentOnly

optional
Interface Property
returnExtentOnly: boolean

returnGeometry

optional
Interface Property
returnGeometry: boolean

returnIdsOnly

optional
Interface Property
returnIdsOnly: boolean

returnM

optional
Interface Property
returnM: boolean

returnTrueCurves

optional
Interface Property
returnTrueCurves: ""

returnZ

optional
Interface Property
returnZ: boolean

signal

optionalinherited
Interface Property
signal: AbortSignal

An AbortSignal object instance; allows you to abort a request and via an AbortController.

spatialRel

optionalinherited
Interface Property

sqlFormat

optional
Interface Property
sqlFormat: "none" | "standard" | "native"

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

time

optional
Interface Property
time: number | number[]

units

optional
Interface Property
units: Units

url

inherited
Interface Property
url: string

Layer service url.

where

optionalinherited
Interface Property
where: string

A where clause for the query. Defaults to "1=1"

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.