IGetGeographyOptions
Interface
Properties
Property | Type | Notes |
---|---|---|
string | IAuthenticationManager | The instance of | |
RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. | |
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. | |
{ [key: string]: any } | Additional Headers to pass into the request. | |
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. | |
The HTTP method to send the request with. | ||
string | Specifies the language you wish to receive your GeoEnrichment results. | |
number | If the length of a GET request's URL exceeds | |
string | Specify a specific dataset within a defined country. | |
number | Request the output geometries in a specified spatial reference system. | |
Additional parameters to pass in the request. | ||
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'. | |
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. | |
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. |
credentials
credentials: RequestCredentials
A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
endpoint
endpoint: string
Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
featureLimit
featureLimit: number
Limits the number of features that are returned from the geographyQuery parameter.
featureOffset
featureOffset: number
Starts the results on the number of the records specified.
generalizationLevel
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
geographyIDs: string[]
Specify which IDs for the standard geography layers are being queried or searched.
geographyLayers
geographyLayers: string | string[]
Specify which standard geography layers are being queried or searched.
geographyQuery
geographyQuery: string
Specify the text to query and search the standard geography layers specified.
headers
headers: { [key: string]: any }
Additional Headers to pass into the request.
Type declaration
- [key: string]: any
hideToken
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
httpMethod: HTTPMethods
The HTTP method to send the request with.
langCode
langCode: string
Specifies the language you wish to receive your GeoEnrichment results.
maxUrlLength
maxUrlLength: number
If the length of a GET request's URL exceeds maxUrlLength
the request will use POST instead.
optionalCountryDataset
optionalCountryDataset: string
Specify a specific dataset within a defined country.
outSR
outSR: number
Request the output geometries in a specified spatial reference system.
portal
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'.
returnCentroids
returnCentroids: boolean
Request the output geometry to return the center point for each feature.
returnGeometry
returnGeometry: boolean
Request the output geometries in the response.
returnSubGeographyLayer
returnSubGeographyLayer: boolean
Return all the subgeographic areas that are within a parent geography.
signal
signal: AbortSignal
An AbortSignal object instance; allows you to abort a request and via an AbortController.
sourceCountry
sourceCountry: string
Specify the source country for the search.
subGeographyLayer
subGeographyLayer: string
Return all the subgeographic areas that are within a parent geography.
subGeographyQuery
subGeographyQuery: string
Filter the results of the subgeography features that are returned by a search term.
suppressWarnings
suppressWarnings: boolean
Suppress any ArcGIS REST JS related warnings for this request.
authentication: string | IAuthenticationManager
The instance of
ApiKey
,ArcGISIdentityManager
orApplicationSession
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.