IQueryDemographicDataOptions

Interface

Inheritance: IQueryDemographicDataOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes
boolean

Specify an array of string values that describe what derivative variables to include in the output

string[]

Specify a subset of variables to be returned from one or more Data Collections

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.

string[]

A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.

endpoint
inherited
string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )

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.

httpMethod
inherited

The HTTP method to send the request with.

number

Define the input geometries in the studyAreas parameter in a specified spatial reference system

maxUrlLength
inherited
number

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

number

Request the output geometries in a specified spatial reference system

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

rawResponse
inherited
boolean

Return the raw response

boolean

Request the output geometries in the response

signal
inherited
AbortSignal

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

any[]

Defines the area on a map which is being analyzed

boolean

Suppress any ArcGIS REST JS related warnings for this request.

addDerivativeVariables

optional
Interface Property
addDerivativeVariables: boolean

Specify an array of string values that describe what derivative variables to include in the output

analysisVariables

optional
Interface Property
analysisVariables: string[]

Specify a subset of variables to be returned from one or more Data Collections

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.

dataCollections

optional
Interface Property
dataCollections: string[]

A Data Collection is a preassembled list of attributes that will be used to enrich the input features. Enrichment attributes can describe various types of information such as demographic characteristics and geographic context of the locations or areas submitted as input features in studyAreas.

endpoint

optionalinherited
Interface Property
endpoint: string

Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )

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.

httpMethod

optionalinherited
Interface Property
httpMethod: HTTPMethods

The HTTP method to send the request with.

inSR

optional
Interface Property
inSR: number

Define the input geometries in the studyAreas parameter in a specified spatial reference system

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

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

outSR

optional
Interface Property
outSR: number

Request the output geometries in a specified spatial reference system

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

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

returnGeometry

optional
Interface Property
returnGeometry: boolean

Request the output geometries in the response

signal

optionalinherited
Interface Property
signal: AbortSignal

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

studyAreas

Interface Property
studyAreas: any[]

Defines the area on a map which is being analyzed

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

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