originDestinationMatrix
FunctionoriginDestinationMatrix(requestOptions: IOriginDestinationMatrixOptions): Promise<IOriginDestinationMatrixResponse>
Used to create an origin-destination (OD) cost matrix from multiple origins to multiple destinations. See the REST Documentation for more information.
import { originDestinationMatrix } from '@esri/arcgis-rest-routing';
originDestinationMatrix({
origins: [
[-90.404302, 38.600621],
[-90.364293, 38.620427],
],
destinations: [
[-90.444716, 38.635501],
[-90.311919, 38.633523],
[-90.451147, 38.581107]
],
authentication
})
.then(response) // => { ... }
Parameters
Parameter | Type | Notes |
---|---|---|
request | IOriginDestinationMatrixOptions | Options to pass through to the routing service. |
Returns
Promise<IOriginDestinationMatrixResponse>
A Promise that will resolve with travel time and/or distance for each origin-destination pair. It returns either odLines or odCostMatrix for this information depending on the outputType you specify.