Skip to content

Interface

Inheritance: IServiceAreaOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes
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.

barriersIFeatureSet | ILocation | IPoint | [voidvoid][]
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 Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.

facilitiesIFeatureSet | ILocation | IPoint | [voidvoid][]

Specify one or more locations around which service areas are generated.

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
HTTPMethods

The HTTP method to send the request with.

maxUrlLength
inherited
number

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

outputLinesboolean
params
inherited
IParams

Additional parameters to pass in the request.

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

preserveObjectIDboolean
rawResponse
inherited
boolean

Return the raw response

returnBarriersboolean
returnFacilitiesboolean
returnPolygonBarriersboolean
returnPolylineBarriersboolean
signal
inherited
AbortSignal

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

boolean

Suppress any ArcGIS REST JS related warnings for this request.

travelDirection"incidentsToFacilities" | "facilitiesToIncidents"

Specify if the service should return routes.

authentication

optionalinherited
Interface Property

barriers

optional
Interface Property
barriers: IFeatureSet | ILocation | IPoint | [voidvoid][]

credentials

optionalinherited
Interface Property

endpoint

optionalinherited
Interface Property

facilities

Interface Property

headers

optionalinherited
Interface Property

hideToken

optionalinherited
Interface Property

httpMethod

optionalinherited
Interface Property

maxUrlLength

optionalinherited
Interface Property

outputLines

optional
Interface Property
outputLines: boolean

params

optionalinherited
Interface Property

polygonBarriers

optional
Interface Property
polygonBarriers: IFeatureSet

polylineBarriers

optional
Interface Property
polylineBarriers: IFeatureSet

portal

optionalinherited
Interface Property

preserveObjectID

optional
Interface Property
preserveObjectID: boolean

rawResponse

optionalinherited
Interface Property

returnBarriers

optional
Interface Property
returnBarriers: boolean

returnFacilities

optional
Interface Property
returnFacilities: boolean

returnPolygonBarriers

optional
Interface Property
returnPolygonBarriers: boolean

returnPolylineBarriers

optional
Interface Property
returnPolylineBarriers: boolean

signal

optionalinherited
Interface Property

suppressWarnings

optionalinherited
Interface Property

travelDirection

optional
Interface Property

Methods

Hide inherited methods
MethodReturnsNotes
request(url, requestOptions)
inherited
Promise<any>

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

request

optionalinherited
Interface Method
request(urlstring, requestOptionsInternalRequestOptions): Promise<any>

Override the default function for making the request. This is mainly useful for testing purposes (i.e. so you can pass in a spy).

Parameters
ParameterTypeNotes
urlstring
requestOptionsInternalRequestOptions
Returns 
Promise<any>

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