IQueryFeaturesOptions

Interface

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

Inheritance: IQueryFeaturesOptionsISharedQueryOptions

Properties

PropertyTypeNotes
authentication
 optional 

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
 optional 
RequestCredentials

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

distance
 optional 
number
f
 optional 
"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 
string
geometry
 optional 
geometryPrecision
 optional 
number
geometryType
 optional 
string
headers
 optional 
{ [key: string]: any }

Additional Headers to pass into the request.

hideToken
 optional 
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 
number
httpMethod
 optional 

The HTTP method to send the request with.

inSR
 optional 
maxAllowableOffset
 optional 
number
maxUrlLength
 optional 
number

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

multipatchOption
 optional 
"xyFootprint"
objectIds
 optional 
number[]
orderByFields
 optional 
string
outFields
 optional 
string[] | "*"

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

outSR
 optional 
outStatistics
 optional 
params
 optional 

Additional parameters to pass in the request.

portal
 optional 
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
 optional 
boolean

Return the raw response

relationParam
 optional 
string
resultOffset
 optional 
number
resultRecordCount
 optional 
number
resultType
 optional 
"none" | "standard" | "tile"
returnCentroid
 optional 
boolean
returnCountOnly
 optional 
boolean
boolean
boolean
returnExtentOnly
 optional 
boolean
returnGeometry
 optional 
boolean
returnIdsOnly
 optional 
boolean
returnM
 optional 
boolean
returnTrueCurves
 optional 
""
returnZ
 optional 
boolean
signal
 optional 
AbortSignal

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

spatialRel
 optional 
sqlFormat
 optional 
"none" | "standard" | "native"
suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

time
 optional 
number | number[]
units
 optional 
string

Layer service url.

where
 optional 
string

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

authentication optional

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 optional

credentials: RequestCredentials

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

distance optional

distance: number

f optional

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

gdbVersion: string

geometry optional

geometry: IGeometry

geometryPrecision optional

geometryPrecision: number

geometryType optional

geometryType: GeometryType

groupByFieldsForStatistics optional

groupByFieldsForStatistics: string

headers optional

headers: { [key: string]: any }

Additional Headers to pass into the request.

hideToken optional

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

historicMoment: number

httpMethod optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

inSR optional

inSR: string | ISpatialReference

maxAllowableOffset optional

maxAllowableOffset: number

maxUrlLength optional

maxUrlLength: number

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

multipatchOption optional

multipatchOption: "xyFootprint"

objectIds optional

objectIds: number[]

orderByFields optional

orderByFields: string

outFields optional

outFields: string[] | "*"

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

outSR optional

outSR: string | ISpatialReference

outStatistics optional

outStatistics: IStatisticDefinition[]

params optional

params: IParams

Additional parameters to pass in the request.

portal optional

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

quantizationParameters: any

rawResponse optional

rawResponse: boolean

Return the raw response

relationParam optional

relationParam: string

resultOffset optional

resultOffset: number

resultRecordCount optional

resultRecordCount: number

resultType optional

resultType: "none" | "standard" | "tile"

returnCentroid optional

returnCentroid: boolean

returnCountOnly optional

returnCountOnly: boolean

returnDistinctValues optional

returnDistinctValues: boolean

returnExceededLimitFeatures optional

returnExceededLimitFeatures: boolean

returnExtentOnly optional

returnExtentOnly: boolean

returnGeometry optional

returnGeometry: boolean

returnIdsOnly optional

returnIdsOnly: boolean

returnM optional

returnM: boolean

returnTrueCurves optional

returnTrueCurves: ""

returnZ optional

returnZ: boolean

signal optional

signal: AbortSignal

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

spatialRel optional

sqlFormat optional

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

suppressWarnings optional

suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

time optional

time: number | number[]

units optional

units: Units

url

url: string

Layer service url.

where optional

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.