Packagecom.afcomponents.umap.interfaces
Interfacepublic interface IRouteService extends flash.events.IEventDispatcher
ImplementorsBingRouteService, CloudMadeService, DefaultRouteService, MapQuestService

Defines a routing service class which works with the RouteManager class. Consider extending the DefaultRouteService as an abstract interface implementation.

See also

com.afcomponents.umap.display.routemanager.DefaultRouteService
com.afcomponents.umap.display.routemanager.RouteManager


Public Properties
 PropertyDefined by
  routeResults : RouteResults
[read-only] Returns route results obtained by previous doRoute operation.
IRouteService
Public Methods
 MethodDefined by
  
dispose():void
Releases all the resources accuired by the service.
IRouteService
  
doRoute(locations:Array, options:Object = null):Boolean
Request a route between 2 or more locations.
IRouteService
Property detail
routeResultsproperty
routeResults:RouteResults  [read-only]

Returns route results obtained by previous doRoute operation.

Implementation
    public function get routeResults():RouteResults
Method detail
dispose()method
public function dispose():void

Releases all the resources accuired by the service.

doRoute()method 
public function doRoute(locations:Array, options:Object = null):Boolean

Request a route between 2 or more locations. Locations can be specified as Objects which can be processed by a concrete service. Additional options should be sepcified in the second parameter in a common to service format.

Parameters
locations:Array — Array of 2 or more locations.
 
options:Object (default = null) — Additonal options in a known to service format.

Returns
Boolean — A value of true if a request has been accepted, and is being processed; false if it is not.

See also