Maps SDK for Web
tt.services.geocode
Allows requests to be made using the TomTom's Search API - Geocode.
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 geocode 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.geocode([options], [additionalOptions])
Example
function callbackFn(result) {
console.log(result);
};
tt.services.geocode({
key: <Your API Key>,
query: 'Amsterdam, The Netherlands'
}).then(callbackFn);
Parameters
Name | Description |
---|---|
options
Object default:None |
Options to be passed to the geocode call, or an array of such option objects to perform a batch request. |
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.bestResult
Boolean default:false |
Defines whether the geocode service should return the best result.
It makes the service instances to return only one result, the best match result. This option overwrites both limit and offset parameters. It changes the response from an array to a single result. |
options.boundingBox
Maps.LngLatBounds | Number[] | Object[] | String default:None |
Bounding box area in one of the supported formats.
The bounding box is a limited area within the search results. If it is omitted then the whole world will be taken into consideration. In case the area specified exceeds the world boundaries, the following actions will be taken depending on which side was exceeded:
|
options.center
Object | Number[] | String[] | String default:None |
Longitude and latitude data in one of the supported formats.
This option represents a geographic coordinate. The supported formats are listed below:
|
options.countrySet
String default:None |
Comma separated list of country codes (e.g.: FR,ES)
This option is a list of country codes used to limit the search request to those specific political limits. |
options.entityTypeSet
String | String[] default:None |
A comma-separated string or an array.
List of entity types which can be used to restrict the result to the Geography result of a specific entity type. If entityTypeSet is specified, only a Geography result with a proper entity type will be returned. Available values:
Example
|
options.extendedPostalCodesFor
String default:None |
A comma-separated list of index types or "None" for no indexes.
Indexes for which extended postal codes should be included in the results. By default, extended postal codes are available for all indexes except geographies because extended postal code lists for geographies can be quite long, so they have to be explicitly requested when needed. Availability is region-dependent. The available indexes are:
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.language
String default:null |
Language code that decides in which language the results
should be returned.
The value should correspond to one of the supported IETF language codes. The list is available here. The code is case insensitive. |
options.limit
Number default:10 |
The maximum number of responses that will be returned.
Represents the maximum number of responses that will be returned per request. The maximum value is 100. |
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:
* Local
* International
* Alternative
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.offset
Number default:None |
A positive integer value.
Use this option if you want to apply an offset to the results returned by the Search API service. It makes use of the ofs parameter which allows paginated results when used with the limit option. The maximum value is 1900. |
options.protocol
"http" | "https" default:"https" |
The protocol type to be used in the calls.
Represents the type of protocol used to perform a service call. |
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.radius
Number default:None |
A positive integer value in meters.
This option specifies the search radius in meters using the coordinates given to the center
option as origin.
|
options.timeZone
String default:None |
The only available option is iana .
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.typeahead
Boolean default:false |
Enables or disables the option.
If this option is enabled, the query will be interpreted as a partial input and the search will enter predictive mode. |
options.view
String default:None |
Geopolitical view.
Can be one of "Unified", "AR", "IN", "PK", "IL, "MA", "RU", "TR" and "CN". Legend:
|