IGetGeographyOptions

Interface

Inheritance: IGetGeographyOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes

The instance of ArcGISIdentityManager, ApplicationCredentialsManager or APIKeyManager 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.

endpoint
inherited
string

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

number

Limits the number of features that are returned from the geographyQuery parameter.

number

Starts the results on the number of the records specified.

number

Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.

string[]

Specify which IDs for the standard geography layers are being queried or searched.

string | string[]

Specify which standard geography layers are being queried or searched.

string

Specify the text to query and search the standard geography layers specified.

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.

string

Specifies the language you wish to receive your GeoEnrichment results.

maxUrlLength
inherited
number

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

string

Specify a specific dataset within a defined country.

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 geometry to return the center point for each feature.

boolean

Request the output geometries in the response.

boolean

Return all the subgeographic areas that are within a parent geography.

signal
inherited
AbortSignal

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

string

Specify the source country for the search.

string

Return all the subgeographic areas that are within a parent geography.

string

Filter the results of the subgeography features that are returned by a search term.

boolean

Suppress any ArcGIS REST JS related warnings for this request.

boolean

Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.

authentication

optionalinherited
Interface Property
authentication: string | IAuthenticationManager

The instance of ArcGISIdentityManager, ApplicationCredentialsManager or APIKeyManager 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.

endpoint

optionalinherited
Interface Property
endpoint: string

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

featureLimit

optional
Interface Property
featureLimit: number

Limits the number of features that are returned from the geographyQuery parameter.

featureOffset

optional
Interface Property
featureOffset: number

Starts the results on the number of the records specified.

generalizationLevel

optional
Interface Property
generalizationLevel: number

Integer that specifies the level of generalization or detail in the area representations of the administrative boundary or standard geographic data layers.

geographyIDs

optional
Interface Property
geographyIDs: string[]

Specify which IDs for the standard geography layers are being queried or searched.

geographyLayers

optional
Interface Property
geographyLayers: string | string[]

Specify which standard geography layers are being queried or searched.

geographyQuery

optional
Interface Property
geographyQuery: string

Specify the text to query and search the standard geography layers specified.

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.

langCode

optional
Interface Property
langCode: string

Specifies the language you wish to receive your GeoEnrichment results.

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

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

optionalCountryDataset

optional
Interface Property
optionalCountryDataset: string

Specify a specific dataset within a defined country.

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

returnCentroids

optional
Interface Property
returnCentroids: boolean

Request the output geometry to return the center point for each feature.

returnGeometry

optional
Interface Property
returnGeometry: boolean

Request the output geometries in the response.

returnSubGeographyLayer

optional
Interface Property
returnSubGeographyLayer: boolean

Return all the subgeographic areas that are within a parent geography.

signal

optionalinherited
Interface Property
signal: AbortSignal

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

sourceCountry

optional
Interface Property
sourceCountry: string

Specify the source country for the search.

subGeographyLayer

optional
Interface Property
subGeographyLayer: string

Return all the subgeographic areas that are within a parent geography.

subGeographyQuery

optional
Interface Property
subGeographyQuery: string

Filter the results of the subgeography features that are returned by a search term.

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

useFuzzySearch

optional
Interface Property
useFuzzySearch: boolean

Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.

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