Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface supportClosestFacilityParameters

Hierarchy

Index

Properties

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.

Read more...

attributeParameterValues

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

Read more...

declaredClass

declaredClass: string

defaultCutoff

defaultCutoff: number

The cutoff value used to determine when to stop traversing.

Read more...

defaultTargetFacilityCount

defaultTargetFacilityCount: number

The number of facilities to find.

Read more...

destroyed

destroyed: boolean

directionsLanguage

directionsLanguage: string

The language used when generating driving directions.

Read more...

directionsLengthUnits

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

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

Read more...

doNotLocateOnRestrictedElements

doNotLocateOnRestrictedElements: boolean

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

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

incidents

The set of incidents loaded as network locations during analysis.

Read more...

initialized

initialized: boolean

outSpatialReference

outSpatialReference: string | SpatialReference

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

Read more...

outputGeometryPrecision

outputGeometryPrecision: number

The output geometry precision.

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

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

returnDirections

returnDirections: boolean

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

Read more...

returnFacilities

returnFacilities: boolean

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

Read more...

returnIncidents

returnIncidents: boolean

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

Read more...

returnPointBarriers

returnPointBarriers: boolean

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

Read more...

returnPolygonBarriers

returnPolygonBarriers: boolean

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

Read more...

returnPolylineBarriers

returnPolylineBarriers: boolean

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

Read more...

returnRoutes

returnRoutes: boolean

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

Read more...

timeOfDay

timeOfDay: Date

The arrival or departure date and time.

Read more...

timeOfDayUsage

timeOfDayUsage: "start" | "end"

Defines the way the timeOfDay value is used.

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

useHierarchy

useHierarchy: boolean

If true, the hierarchy attribute for the network will be used in 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 supportClosestFacilityParameters

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