IQueryDemographicDataOptions

Interface

Inheritance: IQueryDemographicDataOptionsIEndpointOptions

Properties

PropertyTypeNotes
boolean

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

analysisVariables
 optional 
string[]

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

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.

dataCollections
 optional 
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
 optional 
string

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

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.

httpMethod
 optional 

The HTTP method to send the request with.

inSR
 optional 
number

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

maxUrlLength
 optional 
number

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

outSR
 optional 
number

Request the output geometries in a specified spatial reference system

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

rawResponse
 optional 
boolean

Return the raw response

returnGeometry
 optional 
boolean

Request the output geometries in the response

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

suppressWarnings
 optional 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

addDerivativeVariables optional

addDerivativeVariables: boolean

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

analysisVariables optional

analysisVariables: string[]

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

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.

dataCollections optional

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 optional

endpoint: string

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

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.

httpMethod optional

httpMethod: HTTPMethods

The HTTP method to send the request with.

inSR optional

inSR: number

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

maxUrlLength optional

maxUrlLength: number

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

outSR optional

outSR: number

Request the output geometries in a specified spatial reference system

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

rawResponse optional

rawResponse: boolean

Return the raw response

returnGeometry optional

returnGeometry: boolean

Request the output geometries in the response

signal optional

signal: AbortSignal

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

studyAreas

studyAreas: any[]

Defines the area on a map which is being analyzed

suppressWarnings optional

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.