IGetGeographyOptions

Interface

Extends

IEndpointOptions

Properties

Property	Type	Notes
featureLimit Optional	number	Limits the number of features that are returned from the geographyQuery parameter.
featureOffset Optional	number	Starts the results on the number of the records specified.
generalizationLevel Optional	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	string[] \| string	Specify which IDs for the standard geography layers are being queried or searched.
geographyLayers Optional	string[] \| string \| string	Specify which standard geography layers are being queried or searched.
geographyQuery Optional	string	Specify the text to query and search the standard geography layers specified.
langCode Optional	string	Specifies the language you wish to receive your GeoEnrichment results.
optionalCountryDataset Optional	string	Specify a specific dataset within a defined country.
outSR Optional	number	Request the output geometries in a specified spatial reference system.
returnCentroids Optional	boolean	Request the output geometry to return the center point for each feature.
returnGeometry Optional	boolean	Request the output geometries in the response.
returnSubGeographyLayer Optional	boolean	Return all the subgeographic areas that are within a parent geography.
sourceCountry Optional	string	Specify the source country for the search.
subGeographyLayer Optional	string	Return all the subgeographic areas that are within a parent geography.
subGeographyQuery Optional	string	Filter the results of the subgeography features that are returned by a search term.
useFuzzySearch Optional	boolean	Define if text provided in the geographyQuery parameter should utilize fuzzy search logic.
authentication Optional Inherited	IAuthenticationManager	The instance of `IAuthenticationManager` to use to authenticate this request.
credentials Optional Inherited	RequestCredentials	A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
endpoint Optional Inherited	string	Any ArcGIS Geoenrichment service (example: https://geoenrich.arcgis.com/arcgis/rest/services/World/geoenrichmentserver/Geoenrichment )
fetch Optional Inherited	function(input: RequestInfo, init: RequestInit) : Promise<Response>	The implementation of `fetch` to use. Defaults to a global `fetch`.
headers Optional Inherited	[key: string]: any	Additional Headers to pass into the request.
hideToken Optional 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 Optional Inherited	HTTPMethods	The HTTP method to send the request with.
maxUrlLength Optional Inherited	number	If the length of a GET request's URL exceeds `maxUrlLength` the request will use POST instead.
params Optional Inherited	IParams	Additional parameters to pass in the request.
portal Optional 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 Optional Inherited	boolean	Return the raw response

Interface defined in packages/arcgis-rest-demographics/src/getGeography.ts:12