IClosestFacilityOptions

Interface

Inheritance: IClosestFacilityOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes
authentication
 inherited 

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.

IFeatureSet | ILocation | IPoint | [voidvoid][]
credentials
 inherited 
RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

"esriNAUCentimeters" | "esriNAUDecimalDegrees" | "esriNAUDecimeters" | "esriNAUFeet" | "esriNAUInches" | "esriNAUKilometers" | "esriNAUMeters" | "esriNAUMiles" | "esriNAUMillimeters" | "esriNAUNauticalMiles" | "esriNAUPoints" | "esriNAUYards"
"esriDOTComplete" | "esriDOTCompleteNoEvents" | "esriDOTInstructionsOnly" | "esriDOTStandard" | "esriDOTSummaryOnly" | "esriDOTFeatureSets"
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.

IFeatureSet | ILocation | IPoint | [voidvoid][] | { url: string }

Specify one or more locations that are searched for when finding the closest location.

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.

IFeatureSet | ILocation | IPoint | [voidvoid][] | { url: string }

Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.

maxUrlLength
 inherited 
number

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

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

boolean
rawResponse
 inherited 
boolean

Return the raw response

boolean
boolean

Specify if the service should return routes.

boolean
boolean
boolean
boolean
boolean
signal
 inherited 
AbortSignal

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

suppressWarnings
 inherited 
boolean

Suppress any ArcGIS REST JS related warnings for this request.

"incidentsToFacilities" | "facilitiesToIncidents"

authentication

optionalinherited
Interface Property
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.

barriers

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

credentials

optionalinherited
Interface Property
credentials: RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.

directionsLengthUnits

optional
Interface Property
directionsLengthUnits: "esriNAUCentimeters" | "esriNAUDecimalDegrees" | "esriNAUDecimeters" | "esriNAUFeet" | "esriNAUInches" | "esriNAUKilometers" | "esriNAUMeters" | "esriNAUMiles" | "esriNAUMillimeters" | "esriNAUNauticalMiles" | "esriNAUPoints" | "esriNAUYards"

directionsOutputType

optional
Interface Property
directionsOutputType: "esriDOTComplete" | "esriDOTCompleteNoEvents" | "esriDOTInstructionsOnly" | "esriDOTStandard" | "esriDOTSummaryOnly" | "esriDOTFeatureSets"

endpoint

optionalinherited
Interface Property
endpoint: string

Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.

facilities

Interface Property
facilities: IFeatureSet | ILocation | IPoint | [voidvoid][] | { url: string }

Specify one or more locations that are searched for when finding the closest location.

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.

incidents

Interface Property
incidents: IFeatureSet | ILocation | IPoint | [voidvoid][] | { url: string }

Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.

maxUrlLength

optionalinherited
Interface Property
maxUrlLength: number

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

outputLines

optional
Interface Property
outputLines: boolean

params

optionalinherited
Interface Property
params: IParams

Additional parameters to pass in the request.

polygonBarriers

optional
Interface Property
polygonBarriers: IFeatureSet

polylineBarriers

optional
Interface Property
polylineBarriers: IFeatureSet

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

preserveObjectID

optional
Interface Property
preserveObjectID: boolean

rawResponse

optionalinherited
Interface Property
rawResponse: boolean

Return the raw response

returnBarriers

optional
Interface Property
returnBarriers: boolean

returnCFRoutes

Interface Property
returnCFRoutes: boolean

Specify if the service should return routes.

returnDirections

optional
Interface Property
returnDirections: boolean

returnFacilities

optional
Interface Property
returnFacilities: boolean

returnIncidents

optional
Interface Property
returnIncidents: boolean

returnPolygonBarriers

optional
Interface Property
returnPolygonBarriers: boolean

returnPolylineBarriers

optional
Interface Property
returnPolylineBarriers: boolean

signal

optionalinherited
Interface Property
signal: AbortSignal

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

suppressWarnings

optionalinherited
Interface Property
suppressWarnings: boolean

Suppress any ArcGIS REST JS related warnings for this request.

travelDirection

optional
Interface Property
travelDirection: "incidentsToFacilities" | "facilitiesToIncidents"

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