Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface supportServiceAreaParameters

Hierarchy

Index

Properties

accumulateAttributes

accumulateAttributes: string[]

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

Read more...

attributeParameterValues

attributeParameterValues: any[]

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

Read more...

declaredClass

declaredClass: string

defaultBreaks

defaultBreaks: number[]

An array of numbers defining the breaks.

Read more...

destroyed

destroyed: boolean

doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

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

Read more...

excludeSourcesFromPolygons

excludeSourcesFromPolygons: string[]

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

Read more...

facilities

The set of facilities loaded as network locations during analysis.

Read more...

impedanceAttribute

impedanceAttribute: string

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

Read more...

initialized

initialized: boolean

mergeSimilarPolygonRanges

mergeSimilarPolygonRanges: boolean

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

Read more...

outSpatialReference

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

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

Read more...

outputPolygons

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

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

Read more...

overlapLines

overlapLines: boolean

Indicates if the lines should overlap from multiple facilities.

Read more...

overlapPolygons

overlapPolygons: boolean

Indicates if the polygons should overlap from multiple facilities.

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...

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...

returnFacilities

returnFacilities: boolean

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

Read more...

returnPointBarriers

returnPointBarriers: boolean

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

Read more...

returnPolygonBarriers

returnPolygonBarriers: boolean

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

Read more...

returnPolylineBarriers

returnPolylineBarriers: boolean

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

Read more...

splitLinesAtBreaks

splitLinesAtBreaks: boolean

If true, lines will be split at breaks.

Read more...

splitPolygonsAtBreaks

splitPolygonsAtBreaks: boolean

If true, polygons will be split at breaks.

Read more...

timeOfDay

timeOfDay: Date

Local date and time at the facility.

Read more...

travelDirection

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

Options for traveling to or from the facility.

Read more...

travelMode

travelMode: TravelMode

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

Read more...

trimOuterPolygon

trimOuterPolygon: boolean

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

Read more...

trimPolygonDistance

trimPolygonDistance: number

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

Read more...

trimPolygonDistanceUnits

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

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

Read more...

useHierarchy

useHierarchy: boolean

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

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 supportServiceAreaParameters

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

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