| Package | com.esri.ags.tasks.supportClasses |
| Class | public class ClosestFacilityParameters |
| Inheritance | ClosestFacilityParameters  Object |
| Since : | ArcGIS API for Flex 2.0 |
Note: ClosestFacilityParameters, and other closest facility related classes, requires ArcGIS Server 10.0 or above and a "closest facility" layer. A "closest facility" layer is a layer of type "esriNAServerClosestFacilityLayer".
If you don't specify any barriers, the server will use the predefined barriers from the server. To use neither the predefined barriers, nor any user-defined ones, set the pointBarriers, polylineBarriers and polygonBarriers to empty arrays. The same applies to facilities and incidents.
See also
| Property | Defined By | ||
|---|---|---|---|
| accumulateAttributes : Array
The list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. | ClosestFacilityParameters | ||
| attributeParameterValues : Array
A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. | ClosestFacilityParameters | ||
| defaultCutoff : Number
The default cutoff value to stop traversing. | ClosestFacilityParameters | ||
| defaultTargetFacilityCount : int
The default number of facilities to find. | ClosestFacilityParameters | ||
| directionsLanguage : String
The language to be used when computing directions. | ClosestFacilityParameters | ||
| directionsLengthUnits : String
The length units to use when computing directions. | ClosestFacilityParameters | ||
| directionsTimeAttribute : String
The name of network attribute to use for the drive time when computing directions. | ClosestFacilityParameters | ||
| doNotLocateOnRestrictedElements : Boolean = false
If true, avoid network elements restricted by barriers or due to restrictions specified in restrictionAttributes. | ClosestFacilityParameters | ||
| facilities : Object
The set of facilities loaded as network locations during analysis. | ClosestFacilityParameters | ||
| impedanceAttribute : String
The network attribute name to be used as the impedance attribute in analysis. | ClosestFacilityParameters | ||
| incidents : Object
The set of incidents loaded as network locations during analysis. | ClosestFacilityParameters | ||
| outputGeometryPrecision : Number
The precision of the output geometry after generalization. | ClosestFacilityParameters | ||
| outputGeometryPrecisionUnits : String
The units of the output geometry precision. | ClosestFacilityParameters | ||
| outputLines : String
The type of output lines to be generated in the result. | ClosestFacilityParameters | ||
| outSpatialReference : SpatialReference
The well-known ID of the spatial reference for the geometries returned with the analysis results. | ClosestFacilityParameters | ||
| pointBarriers : Object
The set of point barrier loaded as network locations during analysis. | ClosestFacilityParameters | ||
| polygonBarriers : Object
The set of polygon barrier loaded as network locations during analysis. | ClosestFacilityParameters | ||
| polylineBarriers : Object
The set of polyline barrier loaded as network locations during analysis. | ClosestFacilityParameters | ||
| restrictionAttributes : Array
The list of network attribute names to be used as restrictions with the analysis. | ClosestFacilityParameters | ||
| restrictUTurns : String
Specifies how U-turns should be handled. | ClosestFacilityParameters | ||
| returnDirections : Boolean = false
If true, directions will be generated and returned in the directions
property of each RouteResult of the RouteSolveResult. | ClosestFacilityParameters | ||
| returnFacilities : Boolean = false
If true, facilities will be returned with the analysis results. | ClosestFacilityParameters | ||
| returnIncidents : Boolean = false
If true, incidents will be returned with the analysis results. | ClosestFacilityParameters | ||
| returnPointBarriers : Boolean = false
If true, barriers will be returned in the barriers property of ClosestFacilitySolveResult. | ClosestFacilityParameters | ||
| returnPolygonBarriers : Boolean = false
If true, polygon barriers will be returned in the polygonBarriers property of ClosestFacilitySolveResult. | ClosestFacilityParameters | ||
| returnPolylineBarriers : Boolean = false
If true, polyline barriers will be returned in the polylineBarriers property of ClosestFacilitySolveResult. | ClosestFacilityParameters | ||
| returnRoutes : Boolean = true
If true, closest facility routes will be generated and returned in the route property of each ClosestFacilityResult of the ClosestFacilitySolveResult. | ClosestFacilityParameters | ||
| travelDirection : String
Options for traveling to or from the facility. | ClosestFacilityParameters | ||
| useHierarchy : Boolean
If true, the hierarchy attribute for the network should be used in analysis. | ClosestFacilityParameters | ||
| accumulateAttributes | property |
public var accumulateAttributes:ArrayThe list of network attribute names to be accumulated with the analysis, i.e., which attributes should be returned as part of the response. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost".
See also
| attributeParameterValues | property |
public var attributeParameterValues:ArrayA set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. The parameter holding a vehicle charactersitic is compared to a value coming from a descriptor attribute to determine whether or not a network element is traversible. For example, a parameterized restriction attribute can compare the height of your vehicle with a descriptor attribute that holds the clearance under overpasses through tunnels. If the vehicles height is greater than the clearance, the edge is restricted. Parameterized cost attributes that can reference other cost attributes and scale them, can also be used. This is useful when inclement weather like ice, fog or heavy rain, descends on the study area and hinders normal flow of traffic. By having a parameter already outfitted on a cost attribute, travel-time expectations and traversible network paths can be adjusted with respect to changes in traffic speeds.
See also
| defaultCutoff | property |
public var defaultCutoff:NumberThe default cutoff value to stop traversing.
| defaultTargetFacilityCount | property |
public var defaultTargetFacilityCount:intThe default number of facilities to find.
| directionsLanguage | property |
public var directionsLanguage:StringThe language to be used when computing directions. The default is as defined in the specific routing network layer used in your RouteTask. By default, NAServer gets installed with en_US only - it is up to the server administrator to add additional languages.
| directionsLengthUnits | property |
public var directionsLengthUnits:StringThe length units to use when computing directions. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriFeet", "esriKilometers", "esriMeters", "esriMiles", "esriNauticalMiles" and "esriYards".
| directionsTimeAttribute | property |
public var directionsTimeAttribute:StringThe name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer used in your RouteTask.
| doNotLocateOnRestrictedElements | property |
public var doNotLocateOnRestrictedElements:Boolean = false| Since : | ArcGIS API for Flex 2.1 |
If true, avoid network elements restricted by barriers or due to restrictions specified in restrictionAttributes.
The default value is false.
| facilities | property |
public var facilities:ObjectThe set of facilities loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
See also
| impedanceAttribute | property |
public var impedanceAttribute:StringThe network attribute name to be used as the impedance attribute in analysis. The default is as defined in the specific routing network layer used in your RouteTask. You can specify any attributes names listed in the Service Directory under "Network Dataset -> Network Attributes" as "Usage Type: esriNAUTCost". You can also specify a value of "none" to indicate that no network attributes should be used for impedance. If you specify an empty string, it will use the default of the service.
For example, set impedanceAttribute="Time" for quickest route and impedanceAttribute="Length" for shortest drive. Assuming the service has those two esriNAUTCost attributes.
See also
| incidents | property |
public var incidents:ObjectThe set of incidents loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
See also
| outputGeometryPrecision | property |
public var outputGeometryPrecision:NumberThe precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter - generalization is performed according to IPolycurve.Generalize.
| outputGeometryPrecisionUnits | property |
public var outputGeometryPrecisionUnits:StringThe units of the output geometry precision.
The default value is esriUnknownUnits.
| outputLines | property |
public var outputLines:StringThe type of output lines to be generated in the result. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriNAOutputLineNone" (no line at all), "esriNAOutputLineStraight" (a straight line from start to end) and "esriNAOutputLineTrueShape".
See also
| outSpatialReference | property |
public var outSpatialReference:SpatialReferenceThe well-known ID of the spatial reference for the geometries returned with the analysis results. If outSR is not specified, the geometries are returned in the spatial reference of the map.
| pointBarriers | property |
public var pointBarriers:ObjectThe set of point barrier loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
See also
| polygonBarriers | property |
public var polygonBarriers:ObjectThe set of polygon barrier loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
See also
| polylineBarriers | property |
public var polylineBarriers:ObjectThe set of polyline barrier loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
See also
| restrictionAttributes | property |
public var restrictionAttributes:ArrayThe list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are listed in the Service Directory under "Network Dataset -> Network Attributes". You can also specify a value of "none" to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service.
myRouteParams.restrictionAttributes = ["OneWay"];
myRouteParams.restrictionAttributes = ["none"];| restrictUTurns | property |
public var restrictUTurns:StringSpecifies how U-turns should be handled. The default is as defined in the specific routing network layer used in your RouteTask. Possible values are "esriNFSBAllowBacktrack", "esriNFSBAtDeadEndsOnly", "esriNFSBNoBacktrack" and "esriNFSBAtDeadEndsAndIntersections".
See also
| returnDirections | property |
public var returnDirections:Boolean = falseIf true, directions will be generated and returned in the directions property of each RouteResult of the RouteSolveResult.
The default value is false.
See also
| returnFacilities | property |
public var returnFacilities:Boolean = falseIf true, facilities will be returned with the analysis results.
The default value is false.
| returnIncidents | property |
public var returnIncidents:Boolean = falseIf true, incidents will be returned with the analysis results.
The default value is false.
| returnPointBarriers | property |
public var returnPointBarriers:Boolean = falseIf true, barriers will be returned in the barriers property of ClosestFacilitySolveResult.
The default value is false.
See also
| returnPolygonBarriers | property |
public var returnPolygonBarriers:Boolean = falseIf true, polygon barriers will be returned in the polygonBarriers property of ClosestFacilitySolveResult.
The default value is false.
See also
| returnPolylineBarriers | property |
public var returnPolylineBarriers:Boolean = falseIf true, polyline barriers will be returned in the polylineBarriers property of ClosestFacilitySolveResult.
The default value is false.
See also
| returnRoutes | property |
public var returnRoutes:Boolean = trueIf true, closest facility routes will be generated and returned in the route property of each ClosestFacilityResult of the ClosestFacilitySolveResult.
The default value is true.
See also
| travelDirection | property |
public var travelDirection:StringOptions for traveling to or from the facility. The default is defined in the network layer.
See also
| useHierarchy | property |
useHierarchy:BooleanIf true, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer used in your ClosestFacilityTask.
public function get useHierarchy():Boolean public function set useHierarchy(value:Boolean):void
<esri:ClosestFacilityParameters id="closestFacilityParameters" facilities="{myFacilities}"/>
<esri:ClosestFacilityParameters id="closestFacilityParams"
facilities="{incidentsFS}"
facilities="{facilitiesFS}"
returnIncidents="false"
returnDirections="true"
directionsLengthUnits="esriMiles"
outSpatialReference="{myMap.spatialReference}"/>