| Package | com.esri.ags.tasks.supportClasses |
| Class | public class RouteParameters |
| Inheritance | RouteParameters Object |
| Since : | ArcGIS API for Flex 1.2 |
Note: RouteParameters, and other routing related classes, were added in version 1.2 and requires ArcGIS Server 9.3.1 or above and a "route" layer. A "route" layer is a layer of type "esriNAServerRouteLayer", for example, http://tasks.arcgisonline.com/ArcGIS/rest/services/NetworkAnalysis/ESRI_Route_EU/NAServer/Route.
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 stops.
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. | RouteParameters | ||
| attributeParameterValues : Array
A set of attribute parameter values that can be parameterized to determine which network elements can be used by a vehicle. | RouteParameters | ||
| directionsLanguage : String
The language to be used when computing directions. | RouteParameters | ||
| directionsLengthUnits : String
The length units to use when computing directions. | RouteParameters | ||
| directionsTimeAttribute : String
The name of network attribute to use for the drive time when computing directions. | RouteParameters | ||
| doNotLocateOnRestrictedElements : Boolean = false
If true, avoid network elements restricted by barriers or due to restrictions specified in restrictionAttributes. | RouteParameters | ||
| findBestSequence : Boolean
If true, the solver will optimize the order of the stops in the route (while taking into account preserveFirstStop and preserveLastStop if they were set to true). | RouteParameters | ||
| ignoreInvalidLocations : Boolean
When false, the solve operation will fail if at least one of the stops specified cannot be located or reached. | RouteParameters | ||
| impedanceAttribute : String
The network attribute name to be used as the impedance attribute in analysis. | RouteParameters | ||
| outputGeometryPrecision : Number
The precision of the output geometry after generalization. | RouteParameters | ||
| outputGeometryPrecisionUnits : String
The units of the output geometry precision. | RouteParameters | ||
| outputLines : String
The type of output lines to be generated in the result. | RouteParameters | ||
| outSpatialReference : SpatialReference
The well-known ID of the spatial reference for the geometries returned with the analysis results. | RouteParameters | ||
| pointBarriers : Object
The set of point barrier loaded as network locations during analysis. | RouteParameters | ||
| polygonBarriers : Object
The set of polygon barrier loaded as network locations during analysis. | RouteParameters | ||
| polylineBarriers : Object
The set of polyline barrier loaded as network locations during analysis. | RouteParameters | ||
| preserveFirstStop : Boolean
If true, the solver should keep the first stop fixed in the sequence (even when findBestSequence is true). | RouteParameters | ||
| preserveLastStop : Boolean
If true, the solver should keep the last stop fixed in the sequence (even when findBestSequence is true). | RouteParameters | ||
| restrictionAttributes : Array
The list of network attribute names to be used as restrictions with the analysis. | RouteParameters | ||
| restrictUTurns : String
Specifies how U-turns should be handled. | RouteParameters | ||
| returnDirections : Boolean = false
If true, directions will be generated and returned in the directions
property of each RouteResult of the RouteSolveResult. | RouteParameters | ||
| returnPointBarriers : Boolean = false
If true, point barriers will be returned in the pointBarriers property of RouteSolveResult. | RouteParameters | ||
| returnPolygonBarriers : Boolean = false
If true, polygon barriers will be returned in the polygonBarriers property of RouteSolveResult. | RouteParameters | ||
| returnPolylineBarriers : Boolean = false
If true, polyline barriers will be returned in the polylineBarriers property of RouteSolveResult. | RouteParameters | ||
| returnRoutes : Boolean = true
If true, routes will be generated and returned in the route property of each RouteResult of the RouteSolveResult. | RouteParameters | ||
| returnStops : Boolean = false
If true, stops will be returned in the stops property of RouteSolveResult. | RouteParameters | ||
| startTime : Date
The time the route begins. | RouteParameters | ||
| stops : Object
The set of stops loaded as network locations during analysis. | RouteParameters | ||
| useHierarchy : Boolean
If true, the hierarchy attribute for the network should be used in analysis. | RouteParameters | ||
| useTimeWindows : Boolean
If true, the solver should consider time windows. | RouteParameters | ||
| 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.
| 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 = falseIf true, avoid network elements restricted by barriers or due to restrictions specified in restrictionAttributes.
The default value is false.
| findBestSequence | property |
findBestSequence:BooleanIf true, the solver will optimize the order of the stops in the route (while taking into account preserveFirstStop and preserveLastStop if they were set to true). The default is as defined in the specific routing network layer used in your RouteTask.
public function get findBestSequence():Boolean public function set findBestSequence(value:Boolean):void| ignoreInvalidLocations | property |
ignoreInvalidLocations:BooleanWhen false, the solve operation will fail if at least one of the stops specified cannot be located or reached. If true, invalid locations are ignored and route(s) will be returned as long as there are at least two valid stops that have been connected by a route. If multiple routes are processed in a single request a valid result will be returned as long as least one route is built. The list of routes that cannot be solved is included in RouteSolveResult.messages property.
public function get ignoreInvalidLocations():Boolean public function set ignoreInvalidLocations(value:Boolean):void| 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
| 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.
Note: this property was known in version 1.x as "barriers".
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.
Note: polyline and polygon barriers require ArcGIS Server 10.0 or above (only point barriers was supported earlier).
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.
Note: polyline and polygon barriers require ArcGIS Server 10.0 or above (only point barriers was supported earlier).
See also
| preserveFirstStop | property |
preserveFirstStop:BooleanIf true, the solver should keep the first stop fixed in the sequence (even when findBestSequence is true). Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.
public function get preserveFirstStop():Boolean public function set preserveFirstStop(value:Boolean):void| preserveLastStop | property |
preserveLastStop:BooleanIf true, the solver should keep the last stop fixed in the sequence (even when findBestSequence is true). Only applicable if findBestSequence is true. The default is as defined in the specific routing network layer used in your RouteTask.
public function get preserveLastStop():Boolean public function set preserveLastStop(value:Boolean):void| 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
| returnPointBarriers | property |
public var returnPointBarriers:Boolean = falseIf true, point barriers will be returned in the pointBarriers property of RouteSolveResult.
Note: this property was known in version 1.x as "returnBarriers".
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 RouteSolveResult.
Note: polyline and polygon barriers require ArcGIS Server 10.0 or above (only point barriers was supported earlier).
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 RouteSolveResult.
Note: polyline and polygon barriers require ArcGIS Server 10.0 or above (only point barriers was supported earlier).
The default value is false.
See also
| returnRoutes | property |
public var returnRoutes:Boolean = trueIf true, routes will be generated and returned in the route property of each RouteResult of the RouteSolveResult.
The default value is true.
See also
| returnStops | property |
public var returnStops:Boolean = falseIf true, stops will be returned in the stops property of RouteSolveResult.
The default value is false.
See also
| startTime | property |
public var startTime:DateThe time the route begins. If not specified, the solver will not start the route at a particular time. The time should be specified as a numeric value representing the milliseconds since midnight January 1, 1970. It can be a negative number.You can also specify a value of none to indicate that a start time should not be used.
| stops | property |
public var stops:ObjectThe set of stops loaded as network locations during analysis. Can be either an instance of DataLayer or FeatureSet.
To do batch routing (solving multiple routes at once), add route names to each of your stops.
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 RouteTask.
public function get useHierarchy():Boolean public function set useHierarchy(value:Boolean):void| useTimeWindows | property |
useTimeWindows:BooleanIf true, the solver should consider time windows. The default is as defined in the specific routing network layer used in your RouteTask.
public function get useTimeWindows():Boolean public function set useTimeWindows(value:Boolean):void
<esri:RouteParameters id="routeParams" stops="{stops}"/>
<esri:RouteParameters id="routeParams"
stops="{stopsFS}"
returnRoutes="false"
returnDirections="true"
directionsLengthUnits="esriMiles"
outSpatialReference="{myMap.spatialReference}"/>