| SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class representing a routing client.
This class is part of the module routing.
| Constructor Summary | |
IWRoutingClient()
Creates a new routing client object. |
|
| Method Summary | |
IWRouteOptions
|
getRouteOptions()
Returns the routing options. |
|
getSerialId()
undocumented |
|
readObject(json)
undocumented |
void
|
route(start, destination, interstations)
Calculates the route between the start and destination coordinates. set, the interstation coordinates will be consider during route calculation. |
void
|
setRouteOptions(routeOptions)
Sets the routing options. |
String
|
toString()
Returns a string representation of this object. |
|
writeObject()
undocumented |
| Event Summary | |
void
|
triggerOnRoute(event)
The onRoute event is fired when the route has been calculated.
Register an event listener with
IWEventManager.addListener(theRouterClient, 'onroute', yourHandlerMethod(event)); to receive the
|
| Constructor Detail |
IWRoutingClient()
| Method Detail |
IWRouteOptions getRouteOptions()
IWRouteOptions the route options
getSerialId()
readObject(json)
json
void route(start, destination, interstations)
IWAddress start - the start address with a geocoded coordinate
IWAddress destination - the destinate address with a geocoded coordinate
IWAddress[] interstations - addresses between the start and destination address (optional)
void
void setRouteOptions(routeOptions)
IWRouteOptions routeOptions
void
String toString()
String
writeObject()
| Event Detail |
void triggerOnRoute(event)
Register an event listener with
IWEventManager.addListener(theRouterClient, 'onroute', yourHandlerMethod(event)); to receive the
IWRoutingEvent.
IWRoutingEvent event - the routing event
void