Class MapstractionRouter

Object
   |
   +--MapstractionRouter

class MapstractionRouter

Defined in mapstraction-route.js

Field Detail

api

Object api

callback

Object callback

error_callback

Object error_callback

geocoders

Object geocoders

routers

Object routers

svn_revision_string

Object svn_revision_string

MapstractionRouter

MapstractionRouter(<Function> callback, <String> api, <Function> error_callback)

MapstractionRouter instantiates a router with some API choice

Parameters:
callback - The function to call when a route request returns (function(waypoints, route))
api - The API to use, currently only 'mapquest' is supported
error_callback - The optional function to call when a route request fails

addAPI

void addAPI(api, options)

Internal function to actually set the router specific parameters

route

void route(<Array> addresses)

Performs a routing and then calls the specified callback function with the waypoints and route

Parameters:
addresses - The array of address objects to use for the waypoints of the route

route_callback

void route_callback(response, mapstraction_router)

Default handler for route request completion

route_error

void route_error(response)

Default Route error function

routePoints

void routePoints(points)

Performs a routing and then calls the specified callback function with the waypoints and route

Parameters:
addresses - The array of point/location objects to use for the route

swap

void swap(<String> api)

Change the Routing API to use

Parameters:
api - The API to swap to