Class: IWNavigationClient

IWNavigationClient

A navigation client is used to request navigation instructions from a server.

This class is part of the module navigation.


new IWNavigationClient()

Creates a new navigation client.

Methods


getNavigationInstructions(start, destination, locationHistory, options)

Request navigation instructions for the specified coordinates. This is an asynchronous operation which will trigger an oninstructionsload event.

Options:

Property Description Type Default
routeType SPEED, LENGTH, or ECONOMY String SPEED
vehicleProfile the name of the vehicle profile to use String types_fast.txt
avoidHighway avoid highways boolean false
avoidFerry avoid ferries boolean false
avoidHighway avoid highways boolean false
avoidResident avoid residential roads boolean false
Parameters:
Name Type Description
start IWCoordinate the coordinate of the start
destination IWCoordinate the coordinate of the destination
locationHistory
options Object an object with attributes as defined above
Returns:
Type
void