Maps SDK for Web

tt.services.alongRouteSearch

Makes a search request using the TomTom Search API - Along Route Search.

The Search Along Route endpoint allows you to perform a fuzzy search for POIs along a specified route. This search is constrained by specifying the Detour Time limiting measure.

To send the route points, this service will use a POST request with the route encoded as a JSON payload. The minimum number of route points is 2.

Parameters need to be passed to the constructor. The method go performs the actual call.

This service supports batch calls.

You have two ways to make a batch request to the service.

Pass an array of objects, which represents options for each call. In this situation we will decide for you which endpoint to call and we will handle the data retrieval for you.
If you want to explicitly decide which batch mode you want to use, pass an object which will contain the 'batchMode' property set to the correct value (sync, async, or redirect) and batchItems, which will contain an array of objects which represent options for each call. For more information, please refer to batch documentation:

Routing: here.
Search: here.

//Option 1:
tt.services.<service name>([{
  key: <Your API key>,
  ...
}, {
  key: <Your API key>,
  ...
} //... more objects
])
.go()
.then(callback);

//Option 2, explicitly specifying batchMode:
tt.services.<service name>({
 batchMode: 'sync'
 batchItems: [{
  key: <Your API key>,
  ...
  }, {
    key: <Your API key>,
    ...
  } //... more objects
 ]
})
.go()
.then(callback);

Constructor

tt.services.alongRouteSearch([options])

Example

tt.services.alongRouteSearch({
    key: <Your API key>,
    limit: 20,
    maxDetourTime: 120,
    query: 'gas station',
    route: [
        {
            'lat': 37.7524152343544,
            'lon':-122.43576049804686
        },
        {
            'lat': 37.70660472542312,
            'lon':-122.43301391601562
        },
        [37.712059855877314, -122.36434936523438], // Another valid format
    ]
  })
  .go()
  .then(function(response) {
    console.log('SUMMARY:');
    console.table(response.summary);
    console.log('RESULTS:');
    console.table(response.results);
  });

For a list of all available formats for routes, read the documentation for the route option.

Parameters

Name	Description
options Object default:None
options.key Required String default:None	A valid API Key for the requested service. A valid API Key is required to make use of the given service. It can be issued in the Developer Portal.
options.limit Number default:10	The maximum number of elements in the response. The maximum number is 20.
options.maxDetourTime Number default:None	New maximum detour time in seconds. The maximum allowed value is 3600.
options.query String default:None	The query string. This value will be properly encoded during the creation of the request. This option represents the text that will be searched.
options.route Array default:None	Route representation. The following formats are supported: String[] `["4.8,52.3", "4.8,52.3"]` Array[] `[ [4.8,52.3], [4.8,52.3] ]` Object[] `{lon: 4.8, lat: 52.3}` `{lng: 5.8, lat: 53.3}` `{x: 53.3, y: 5.8}` `{longitude: 5.8, latitude: 53.3}` `{lng: Function, lat: Function}` The functions should return a numeric value. Example `function callbackFn(response) { console.log(response); } tomtom.alongRouteSearch({ route:[ { lat: 37.7524152343544, lon:-122.43576049804686 }, { lat: 37.70660472542312, lon:-122.43301391601562 } ] }) .go() .then(callbackFn);`

tt.services.alongRouteSearch

Constructor

tt.services.alongRouteSearch([options])

Example

Parameters

Example

Methods

go( ): Promise

Returns