Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface supportRouteParameters

Hierarchy

Index

Properties

accumulateAttributes

accumulateAttributes: string[]

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

Read more...

apiKey

apiKey: string

An authorization string used to access a resource or service.

Read more...

attributeParameterValues

attributeParameterValues: RouteParametersAttributeParamValue[]

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

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

directionsLanguage

directionsLanguage: string

The language used when computing directions.

Read more...

directionsLengthUnits

directionsLengthUnits: "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "decimal-degrees" | "points"

The length units to use when computing directions.

Read more...

directionsOutputType

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

Defines the amount of direction information returned.

Read more...

directionsStyleName

directionsStyleName: string

The style to be used when returning directions.

Read more...

directionsTimeAttribute

directionsTimeAttribute: string

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

Read more...

doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

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

Read more...

findBestSequence

findBestSequence: boolean

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

Read more...

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:

Read more...

impedanceAttribute

impedanceAttribute: string

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

Read more...

initialized

initialized: boolean

outSpatialReference

outSpatialReference: string | SpatialReference

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

Read more...

outputGeometryPrecision

outputGeometryPrecision: number

The precision of the output geometry after generalization.

Read more...

outputGeometryPrecisionUnits

outputGeometryPrecisionUnits: "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "decimal-degrees" | "points"

The units of the output geometry precision.

Read more...

outputLines

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

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

Read more...

pointBarriers

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

Read more...

polygonBarriers

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

Read more...

polylineBarriers

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

Read more...

preserveFirstStop

preserveFirstStop: boolean

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

Read more...

preserveLastStop

preserveLastStop: boolean

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

Read more...

restrictUTurns

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

Specifies how U-Turns should be handled.

Read more...

restrictionAttributes

restrictionAttributes: string[]

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

Read more...

returnBarriers

returnBarriers: boolean

If true, barriers are returned with the RouteResult.

Read more...

returnDirections

returnDirections: boolean

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

Read more...

returnPolygonBarriers

returnPolygonBarriers: boolean

If true, polygon barriers are returned in the RouteResult.

Read more...

returnPolylineBarriers

returnPolylineBarriers: boolean

If true, polyline barriers are returned in the RouteResult.

Read more...

returnRoutes

returnRoutes: boolean

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

Read more...

returnStops

returnStops: boolean

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

Read more...

returnZ

returnZ: boolean

If true, z values are returned in the RouteResult.

Read more...

startTime

startTime: Date

The time the route begins.

Read more...

startTimeIsUTC

startTimeIsUTC: boolean

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

Read more...

stops

The set of stops loaded as network locations during analysis.

Read more...

travelMode

travelMode: TravelMode

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

Read more...

useHierarchy

useHierarchy: boolean

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

Read more...

useTimeWindows

useTimeWindows: boolean

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

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns supportRouteParameters

clone

  • clone(): void
  • Performs a deep clone of the RouteParameters object.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns supportRouteParameters

  • Parameters

    Returns supportRouteParameters

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc