supportRouteParametersProperties | @types/arcgis-js-api

Hierarchy

supportRouteParametersProperties

Index

Properties

Optional accumulateAttributes

accumulateAttributes: string[]

The list of network attribute names to be accumulated with the analysis.

Optional apiKey

apiKey: string

An authorization string used to access a resource or service.

Optional attributeParameterValues

attributeParameterValues: RouteParametersAttributeParamValue[]

Each element in the array is an object that describes the parameter values.

Optional directionsLanguage

directionsLanguage: string

The language used when computing directions.

Optional directionsLengthUnits

The length units to use when computing directions.

Optional directionsOutputType

directionsOutputType: "complete" | "complete-no-events" | "instructions-only" | "standard" | "summary-only"

Defines the amount of direction information returned.

Optional directionsStyleName

directionsStyleName: string

The style to be used when returning directions.

Optional directionsTimeAttribute

directionsTimeAttribute: string

The name of network attribute to use for the drive time when computing directions.

Optional doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

If true, avoids network elements restricted by barriers or restrictions specified in restrictionAttributes.

Optional findBestSequence

findBestSequence: boolean

The route can help you find the most efficient path for visiting a given list of stops.

Optional ignoreInvalidLocations

ignoreInvalidLocations: boolean

In routes where a stop is not located on a network or a stop could not be reached, the results will differ depending on the value of this property:

Optional impedanceAttribute

impedanceAttribute: string

The network attribute name to be used as the impedance attribute in the analysis.

Optional outSpatialReference

outSpatialReference: string | SpatialReferenceProperties

The well-known ID of the spatial reference for the geometries returned with the analysis results.

Optional outputGeometryPrecision

outputGeometryPrecision: number

The precision of the output geometry after generalization.

Optional outputGeometryPrecisionUnits

The units of the output geometry precision.

Optional outputLines

outputLines: "none" | "straight" | "true-shape" | "true-shape-with-measure"

The type of output lines to be generated in the result.

Optional pointBarriers

pointBarriers: supportFeatureSetProperties | (supportDataLayerProperties & { type: "layer" })

The set of point barriers loaded as network locations during analysis.

Optional polygonBarriers

polygonBarriers: supportFeatureSetProperties | (supportDataLayerProperties & { type: "layer" })

The set of polygon barriers loaded as network locations during analysis.

Optional polylineBarriers

polylineBarriers: supportFeatureSetProperties | (supportDataLayerProperties & { type: "layer" })

The set of polyline barriers loaded as network locations during analysis.

Optional preserveFirstStop

preserveFirstStop: boolean

If true, keeps the first stop fixed in the sequence even when findBestSequence = true.

Optional preserveLastStop

preserveLastStop: boolean

If true, keeps the last stop fixed in the sequence even when findBestSequence = true.

Optional restrictUTurns

restrictUTurns: "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections"

Specifies how U-Turns should be handled.

Optional restrictionAttributes

restrictionAttributes: string[]

The list of network attribute names to be used as restrictions with the analysis.

Optional returnBarriers

returnBarriers: boolean

If true, barriers are returned with the RouteResult.

Optional returnDirections

returnDirections: boolean

Indicates whether the service should generate driving directions for each route.

Optional returnPolygonBarriers

returnPolygonBarriers: boolean

If true, polygon barriers are returned in the RouteResult.

Optional returnPolylineBarriers

returnPolylineBarriers: boolean

If true, polyline barriers are returned in the RouteResult.

Optional returnRoutes

returnRoutes: boolean

If true, routes are generated and returned in the route property of each RouteResult.

Optional returnStops

returnStops: boolean

If true, stops are returned in the stops property of each RouteResult.

Optional returnZ

returnZ: boolean

If true, z values are returned in the RouteResult.

Optional startTime

startTime: DateProperties

The time the route begins.

Optional startTimeIsUTC

startTimeIsUTC: boolean

If true, the start time will be in UTC format.

Optional stops

stops: supportFeatureSetProperties | (supportDataLayerProperties & { type: "layer" })

The set of stops loaded as network locations during analysis.

Optional travelMode

travelMode: TravelModeProperties

A travel mode represents a means of transportation, such as driving or walking.

Optional useHierarchy

useHierarchy: boolean

If true, the hierarchy attribute for the network should be used in analysis.

Optional useTimeWindows

useTimeWindows: boolean

A useful feature of the route is the ability to constrain stop visits to certain times of day, or "time windows".