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.
Response
The response is extended with getTrackingId()
method, which returns the Tracking-ID
associated with the request.
Additionally, the response extends API response by providing toGeoJson()
method, which converts along route search data into
FeatureCollection with Point geometry.
Each point feature represents poi
from the original response. Properties of poi
are mapped into feature properties
Please refer to Difference between API responses and this library's responses section.
In order to make a batch call, pass an object containing the following properties:
- 'key' - valid API Key for the used service
- 'batchMode' - valid options: sync, async, or redirect
- 'waitTimeSeconds' - maximum waiting time for batch download response. This option only works with 'async' and 'redirect' batch modes. Accepts 120 or an integer between 5 and 60.
- 'batchItems' - array of objects with options for each call.
For more information, please refer to the batch documentation: Routing, Search.
tt.services.<service name>({
batchMode: 'sync'
key: <Your API key>,
batchItems: [{
...
}, {
...
} //... more objects
]
}).then(callback);
Constructor
tt.services.alongRouteSearch([options], [additionalOptions])
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
},
[-122.36434936523438, 37.712059855877314], // Another valid format
]
}).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 |
|
additionalOptions
Object default:None |
Additional options to be passed to the service. |
additionalOptions.abortSignal
Object default:None |
Signal created with abortController. Use AbortController to cancel requests in progress. Example
|
options.brandSet
String default:None |
A list of brands divided by commas. This option specifies brands to use for the search. Example
|
options.categorySet
String default:None |
A list of categories codes divided by commas. This option specifies categories codes to use for the search. Those codes can be retrieved by using poiCategories service. Example
|
options.connectorSet
String default:None |
A list of Electrical Vehicle connector types divided by commas. This option specifies connector types, which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station supporting specific connector types. For more info about EV connector names, please refer to Supported Connector Types documentation page. Example
|
options.detourOffset
Boolean default:false |
Parameter which turns on calculation of the distance between the start of the route and the starting point of the detour to a POI.
|
options.fuelSet
String default:None |
A list of Fuel Types divided by commas. This option specifies fuel types, which could be used to restrict the result to the Points Of Interest of specific fuels. If fuelSet is specified, the query can remain empty. Only POIs with a proper fuel type will be returned. Value: A comma-separated list of fuel type identifiers (in any order).
Example
|
options.key
String default:None |
A valid API Key for the requested service. 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.mapcodes
String default:null |
Enables the return of a comma-separted mapcodes list. It can also filter the response to only show selected mapcode types. See Mapcodes in the response. Values: One or more of:
A mapcode represents a specific location, to within a few meters. Every location on Earth can be represented by a mapcode. Mapcodes are designed to be short, easy to recognize, remember, and communicate. Visit the Mapcode project website for more information. Usage examples: Example
|
options.maxDetourTime
Number default:None |
New maximum detour time in seconds. The maximum allowed value is 3600. |
options.maxPowerKW
Number default:None |
A number representing a maximum power rate in kilowatts. An optional parameter which can be used to restrict the result to the availability for connectors with a specific maximum value of power in kilowatts. |
options.minPowerKW
Number default:None |
A number representing a minimum power rate in kilowatts. An optional parameter which can be used to restrict the result to the availability for connectors with a specific minimum value of power in kilowatts. |
options.openingHours
String default:None |
The only available option is 'nextSevenDays'. This option shows the opening hours for the next week, starting with the current day in the local time of the POI. Example
|
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:
Example
|
options.sortBy
String default:'detourTime' |
Parameter which provides possibility to sort returned results.
Values:
|
options.spreadingMode
String default:None |
Enables the spreading of returned results evenly along the route. |
options.timeZone
String default:None |
The only available option is This option is used to indicate the mode in which the timeZone object should be returned. The only available option is iana - mode that shows the IANA ID which allows the user
to determine the current time zone for the POI.
Example
|
options.trackingId
String default:uuid |
Sets value of "Tracking-ID" header. Specifies an identifier for the request. If not set by the user, UUID is generated for each call.
|
options.view
String default:None |
Geopolitical view. Can be one of "Unified", "AR", "IN", "PK", "IL, "MA", "RU", "TR" and "CN". Legend:
|