Maps SDK for Web
tt.services.matrixRouting
Matrix Routing service implementation using using the TomTom Routing API - Matrix Routing.
The Routing API Matrix Routing service allows the calculation of a matrix of route summaries for a set of routes which are defined with origin and destination locations.
For every given origin this service calculates the cost of routing from that origin to every given destination. The set of origins and the set of destinations can be thought of as the column and row headers of a table, and each cell in the table contains the costs of routing from the origin to the destination for that cell.
The following costs are computed for each route:
- Travel times
- Distances
Parameters need to be passed to the constructor. The method go performs the actual call.
If you want to explicitly decide which batch mode you want to use, add a property 'batchMode' with its value set to one of the properties: sync, async, or redirect.
For more information, please refer to the Matrix Routing documentation here.
Constructor
tt.services.matrixRouting([options])
Example
var origins = [
{ point: { latitude: 51.63685, longitude: 19.4171 } },
{ point: { latitude: 51.63685, longitude: 19 } }
];
var destinations = [
{ point: { latitude: 52.23498, longitude: 21.00849 } },
{ point: { latitude: 52.63685, longitude: 18 } }
];
function callbackFn(routeGeoJson) {
console.log(routeGeoJson);
}
tt.services.matrixRouting({
key: <Your API key>,
origins: origins,
destinations: destinations,
traffic: true
})
.go()
.then(callbackFn);
Methods
go( ): Promise
Executes a predefined asynchronous task using the current configuration.
Returns