IClosestFacilityOptions

Interface

Inheritance: IClosestFacilityOptionsIEndpointOptions

Properties

PropertyTypeNotes
barriers
 optional 
IFeatureSet | IPoint | ILocation | [voidvoid][]
"esriNAUCentimeters" | "esriNAUDecimalDegrees" | "esriNAUDecimeters" | "esriNAUFeet" | "esriNAUInches" | "esriNAUKilometers" | "esriNAUMeters" | "esriNAUMiles" | "esriNAUMillimeters" | "esriNAUNauticalMiles" | "esriNAUPoints" | "esriNAUYards"
"esriDOTComplete" | "esriDOTCompleteNoEvents" | "esriDOTInstructionsOnly" | "esriDOTStandard" | "esriDOTSummaryOnly" | "esriDOTFeatureSets"
endpoint
 optional 
string

Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.

IFeatureSet | IPoint | ILocation | [voidvoid][]

Specify one or more locations that are searched for when finding the closest location.

IFeatureSet | IPoint | ILocation | [voidvoid][]

Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.

outputLines
 optional 
boolean
polygonBarriers
 optional 
polylineBarriers
 optional 
preserveObjectID
 optional 
boolean
returnBarriers
 optional 
boolean
boolean

Specify if the service should return routes.

returnDirections
 optional 
boolean
returnFacilities
 optional 
boolean
returnIncidents
 optional 
boolean
boolean
boolean
travelDirection
 optional 
"incidentsToFacilities" | "facilitiesToIncidents"

barriers optional

barriers: IFeatureSet | IPoint | ILocation | [voidvoid][]

directionsLengthUnits optional

directionsLengthUnits: "esriNAUCentimeters" | "esriNAUDecimalDegrees" | "esriNAUDecimeters" | "esriNAUFeet" | "esriNAUInches" | "esriNAUKilometers" | "esriNAUMeters" | "esriNAUMiles" | "esriNAUMillimeters" | "esriNAUNauticalMiles" | "esriNAUPoints" | "esriNAUYards"

directionsOutputType optional

directionsOutputType: "esriDOTComplete" | "esriDOTCompleteNoEvents" | "esriDOTInstructionsOnly" | "esriDOTStandard" | "esriDOTSummaryOnly" | "esriDOTFeatureSets"

endpoint optional

endpoint: string

Any ArcGIS Routing service (example: https://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Network/USA/NAServer/Route/ ) to use for the routing service request.

facilities

facilities: IFeatureSet | IPoint | ILocation | [voidvoid][]

Specify one or more locations that are searched for when finding the closest location.

incidents

incidents: IFeatureSet | IPoint | ILocation | [voidvoid][]

Specify one or more locations from which the service searches for the nearby locations. These locations are referred to as incidents.

outputLines optional

outputLines: boolean

polygonBarriers optional

polygonBarriers: IFeatureSet

polylineBarriers optional

polylineBarriers: IFeatureSet

preserveObjectID optional

preserveObjectID: boolean

returnBarriers optional

returnBarriers: boolean

returnCFRoutes

returnCFRoutes: boolean

Specify if the service should return routes.

returnDirections optional

returnDirections: boolean

returnFacilities optional

returnFacilities: boolean

returnIncidents optional

returnIncidents: boolean

returnPolygonBarriers optional

returnPolygonBarriers: boolean

returnPolylineBarriers optional

returnPolylineBarriers: boolean

travelDirection optional

travelDirection: "incidentsToFacilities" | "facilitiesToIncidents"

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.