Packagecom.esri.aws.services
Classpublic class RouteOptions

Contains the parameters of a route.



Public Properties
 PropertyDefined by
  filterExtent : Envelope
The extent for the map (does not affect the route).
RouteOptions
  hwyPref : int
The preference for using highways.
RouteOptions
  optimizeStops : Boolean
Determines if intermediate waypoints are reordered to optimize for distance.
RouteOptions
  precision : Number
The minimum distance between points on a route in decimal degrees (i.e., it sets the shape generalization of the route).
RouteOptions
  returnExtents : Boolean
Determines if an extent is returned for each segment in the route.
RouteOptions
  routeBarriers : Array
The locations of the route barrier or barriers.
RouteOptions
  routeType : String
The route searching criteria for using either the quickest or shortest route.
RouteOptions
Property detail
filterExtentproperty
public var filterExtent:Envelope

The extent for the map (does not affect the route). It is useful if only part of the route needs to be displayed in a map.

hwyPrefproperty 
public var hwyPref:int

The preference for using highways. Valid values are between "1" and "100". The value of "1" means to avoid highways if possible, and the value of "100" means to use highways as much as possible. If you set the value to "0", hwyPref defaults to the default "80". hwyPref is not used with routeType "shortest".

The default value is 80.

optimizeStopsproperty 
public var optimizeStops:Boolean

Determines if intermediate waypoints are reordered to optimize for distance. Not considered if request contains less than four (4) RouteStop objects.

The default value is false.

precisionproperty 
public var precision:Number

The minimum distance between points on a route in decimal degrees (i.e., it sets the shape generalization of the route). Useful for minimizing the response time. The larger the value, the more generalized the shape (and the faster the response time).

The default value is "0.0" (no generalization)..

returnExtentsproperty 
public var returnExtents:Boolean

Determines if an extent is returned for each segment in the route.

routeBarriersproperty 
public var routeBarriers:Array

The locations of the route barrier or barriers. The route does not pass through any of these points.

routeTypeproperty 
public var routeType:String

The route searching criteria for using either the quickest or shortest route. Valid values are "quickest" or "shortest". When using "shortest", hwyPref is not considered.

The default value is "quickest".