ClosestFacilityParametersProperties

Hierarchy

ClosestFacilityParametersProperties

Index

Properties

Optional accumulateAttributes

accumulateAttributes: string[]

The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response.

Optional attributeParameterValues

attributeParameterValues: ClosestFacilityParametersAttributeParameterValues[]

An array of attribute parameter values that determine which network elements can be used by a vehicle.

Optional defaultCutoff

defaultCutoff: number

The cutoff value used to determine when to stop traversing.

Optional defaultTargetFacilityCount

defaultTargetFacilityCount: number

The number of facilities to find.

Optional directionsLanguage

directionsLanguage: string

The language used when generating driving directions.

Optional directionsLengthUnits

The length units used when computing driving 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 the attribute field that contains the drive time values.

Optional doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

When true, restricted network elements should be considered when finding network locations.

Optional facilities

facilities: FeatureSet | DataLayer

The set of facilities loaded as network locations during analysis.

Optional impedanceAttribute

impedanceAttribute: string

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

Optional incidents

incidents: FeatureSet | DataLayer

The set of incidents loaded as network locations during analysis.

Optional outSpatialReference

outSpatialReference: string | SpatialReferenceProperties

The well-known id of the spatial reference or the spatial reference object for the geometries returned with the analysis results.

Optional outputGeometryPrecision

outputGeometryPrecision: number

The output geometry precision.

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: FeatureSet | DataLayer

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

Optional polygonBarriers

polygonBarriers: FeatureSet | DataLayer

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

Optional polylineBarriers

polylineBarriers: FeatureSet | DataLayer

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

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 returnDirections

returnDirections: boolean

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

Optional returnFacilities

returnFacilities: boolean

If true, facilities will be returned with the analysis results.

Optional returnIncidents

returnIncidents: boolean

If true, incidents will be returned with the analysis results.

Optional returnPointBarriers

returnPointBarriers: boolean

If true, point barriers will be returned in the barriers property of the ClosestFacilitySolveResult.

Optional returnPolygonBarriers

returnPolygonBarriers: boolean

If true, polygon barriers will be returned in the barriers property of the ClosestFacilitySolveResult.

Optional returnPolylineBarriers

returnPolylineBarriers: boolean

If true, polyline barriers will be returned in the barriers property of the ClosestFacilitySolveResult.

Optional returnRoutes

returnRoutes: boolean

When true, closest facility routes will be generated and returned in the route property of each ClosestFacilitySolveResult.

Optional timeOfDay

timeOfDay: DateProperties

The arrival or departure date and time.

Optional timeOfDayUsage

timeOfDayUsage: "start" | "end"

Defines the way the timeOfDay value is used.

Optional travelDirection

travelDirection: "from-facility" | "to-facility"

Options for traveling to or from the facility.

Optional travelMode

travelMode: any

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 will be used in analysis.