ServiceAreaParametersProperties | @types/arcgis-js-api

Hierarchy

ServiceAreaParametersProperties

Index

Properties

Optional accumulateAttributes

accumulateAttributes: string[]

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

Optional attributeParameterValues

attributeParameterValues: any[]

A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle.

Optional defaultBreaks

defaultBreaks: number[]

An array of numbers defining the breaks.

Optional doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

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

Optional excludeSourcesFromPolygons

excludeSourcesFromPolygons: string[]

An array of network source names to NOT use when generating polygons.

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 mergeSimilarPolygonRanges

mergeSimilarPolygonRanges: boolean

If true, similar ranges will be merged in the resulting polygons.

Optional outSpatialReference

outSpatialReference: 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" | "true-shape" | "true-shape-with-measure"

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

Optional outputPolygons

outputPolygons: "none" | "simplified" | "detailed"

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

Optional overlapLines

overlapLines: boolean

Indicates if the lines should overlap from multiple facilities.

Optional overlapPolygons

overlapPolygons: boolean

Indicates if the polygons should overlap from multiple facilities.

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 returnFacilities

returnFacilities: boolean

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

Optional returnPointBarriers

returnPointBarriers: boolean

If true, point barriers will be returned in the pointBarriers property of the analysis results.

Optional returnPolygonBarriers

returnPolygonBarriers: boolean

If true, polygon barriers will be returned in the polygonBarriers property of the analysis results.

Optional returnPolylineBarriers

returnPolylineBarriers: boolean

If true, polyline barriers will be returned in the polylineBarriers property of the analysis results.

Optional splitLinesAtBreaks

splitLinesAtBreaks: boolean

If true, lines will be split at breaks.

Optional splitPolygonsAtBreaks

splitPolygonsAtBreaks: boolean

If true, polygons will be split at breaks.

Optional timeOfDay

timeOfDay: DateProperties

Local date and time at the facility.

Optional travelDirection

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

Options for traveling to or from the facility.

Optional travelMode

travelMode: TravelModeProperties

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

Optional trimOuterPolygon

trimOuterPolygon: boolean

If true, the outermost polygon (at the maximum break value) will be trimmed.

Optional trimPolygonDistance

trimPolygonDistance: number

If polygons are being trimmed, provides the distance to trim.

Optional trimPolygonDistanceUnits

If polygons are being trimmed, specifies the units of trimPolygonDistance.

Optional useHierarchy

useHierarchy: boolean

When true, the hierarchy attributes for the network will be used in the analysis.