Packagecom.afcomponents.umap.types
Classpublic class RouteResults

Object which contains general route information and the collection of Routes.

See also

com.afcomponents.umap.display.routemanager.RouteManager
Route
Maneuver


Public Properties
 PropertyDefined by
  locations : Array
List of route locations.
RouteResults
  message : String
Messages describing any problems with the route.
RouteResults
  resultCode : int
Result code.
RouteResults
  routes : Array
List of routes.
RouteResults
  totalDistance : Number
[read-only] Calculates sum of route distances.
RouteResults
Public Methods
 MethodDefined by
  
RouteResults(resultCode:int = -1, message:String = "", locations:Array = null, routes:Array = null)
RouteResults
  
toLatLngArray():Array
Returns all routes as a LatLng Array.
RouteResults
Property detail
locationsproperty
locations:Array  [read-write]

List of route locations.

Implementation
    public function get locations():Array
    public function set locations(value:Array):void
messageproperty 
message:String  [read-write]

Messages describing any problems with the route.

Implementation
    public function get message():String
    public function set message(value:String):void
resultCodeproperty 
resultCode:int  [read-write]

Result code.

Implementation
    public function get resultCode():int
    public function set resultCode(value:int):void
routesproperty 
routes:Array  [read-write]

List of routes.

Implementation
    public function get routes():Array
    public function set routes(value:Array):void
totalDistanceproperty 
totalDistance:Number  [read-only]

Calculates sum of route distances.

Implementation
    public function get totalDistance():Number
Constructor detail
RouteResults()constructor
public function RouteResults(resultCode:int = -1, message:String = "", locations:Array = null, routes:Array = null)Parameters
resultCode:int (default = -1)
 
message:String (default = "")
 
locations:Array (default = null)
 
routes:Array (default = null)
Method detail
toLatLngArray()method
public function toLatLngArray():Array

Returns all routes as a LatLng Array.

Returns
Array