Skip to content

Interface

Options for the request() method.

Inheritance: IOriginDestinationMatrixOptionsIEndpointOptions

Properties

Hide inherited properties
PropertyTypeNotes
string | IAuthenticationManager

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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 | [voidvoid] | IPoint | ILocation[]
credentials
inherited
RequestCredentials

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

destinationsIFeatureSet | [voidvoid] | IPoint | ILocation[]

Specify the ending point locations to travel to from the origins.

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.

headers
inherited
{}

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.

originsIFeatureSet | [voidvoid] | IPoint | ILocation[]

Specify the starting points from which to travel to the destinations.

outputType"esriNAODOutputSparseMatrix" | "esriNAODOutputStraightLines" | "esriNAODOutputNoLines"

Specify the type of output returned by the service. Defaults to "esriNAODOutputSparseMatrix".

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

rawResponse
inherited
boolean

Return the raw response

request
inherited
(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).

returnBarriersboolean
returnDestinationsboolean
returnOriginsboolean
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.

authentication

optionalinheritedinherited
Interface Property
authentication: string | IAuthenticationManager

The instance of @esri/arcgis-rest-request!ArcGISIdentityManager , @esri/arcgis-rest-request!ApplicationCredentialsManager or @esri/arcgis-rest-request!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.

barriers

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

credentials

optionalinheritedinherited
Interface Property
credentials: RequestCredentials

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

destinations

Interface Property
destinations: IFeatureSet | [voidvoid] | IPoint | ILocation[]

Specify the ending point locations to travel to from the origins.

endpoint

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

headers

optionalinheritedinherited
Interface Property
headers: {}

Additional Headers to pass into the request.

Type declaration

    hideToken

    optionalinheritedinherited
    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

    optionalinheritedinherited
    Interface Property
    httpMethod: HTTPMethods

    The HTTP method to send the request with.

    maxUrlLength

    optionalinheritedinherited
    Interface Property
    maxUrlLength: number

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

    origins

    Interface Property
    origins: IFeatureSet | [voidvoid] | IPoint | ILocation[]

    Specify the starting points from which to travel to the destinations.

    outputType

    optional
    Interface Property
    outputType: "esriNAODOutputSparseMatrix" | "esriNAODOutputStraightLines" | "esriNAODOutputNoLines"

    Specify the type of output returned by the service. Defaults to "esriNAODOutputSparseMatrix".

    params

    optionalinheritedinherited
    Interface Property
    params: IParams

    Additional parameters to pass in the request.

    polygonBarriers

    optional
    Interface Property
    polygonBarriers: IFeatureSet

    polylineBarriers

    optional
    Interface Property
    polylineBarriers: IFeatureSet

    portal

    optionalinheritedinherited
    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

    optionalinheritedinherited
    Interface Property
    rawResponse: boolean

    Return the raw response

    request

    optionalinheritedinherited
    Interface Property
    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).

    Type declaration

    returnBarriers

    optional
    Interface Property
    returnBarriers: boolean

    returnDestinations

    optional
    Interface Property
    returnDestinations: boolean

    returnOrigins

    optional
    Interface Property
    returnOrigins: boolean

    returnPolygonBarriers

    optional
    Interface Property
    returnPolygonBarriers: boolean

    returnPolylineBarriers

    optional
    Interface Property
    returnPolylineBarriers: boolean

    signal

    optionalinheritedinherited
    Interface Property
    signal: AbortSignal

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

    suppressWarnings

    optionalinheritedinherited
    Interface Property
    suppressWarnings: boolean

    Suppress any ArcGIS REST JS related warnings for this request.

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