Maps SDK for Web

Factory function to create instances of the AdditionalData class.

Factory function to create instances of the AlongRouteSearch class.

Factory function to create instances of the CategorySearch class.

Factory function that creates a new instance of the L.ControlPanel widget.

Factory function to create instances of the Copyright class.

Factory function to create instances of the CopyrightCaption class.

Factory function to create instances of the CrossStreetLookupclass.

Factory function that creates a new instance of the L.DistanceMeasurement widget.

Factory function that creates a new instance of the L.Foldable widget.

Factory function to create instances of the FuzzySearch class.

Factory function to create instances of the Geocode class.

Factory function to create instances of the GeometrySearch class.

Returns the global geopolitical view service instance used by all the leaflet maps.

It lets you get and change the geopolitical view used by the entire SDK.

Whenever the setCurrentGeopolView method of this instance is called, all the GeopolViewService instances used by maps will be updated too.

But if you use the setCurrentGeopolView method in a GeopolViewService of a map instance only that instance will be updated.

Returns the global locale service instance used by all the leaflet maps.

It lets you get and change the locale configuration used by the entire SDK.

Whenever the setCurrentLocale method of this instance is called, all the LocaleService instances used by maps will be updated too.

But if you use the setCurrentLocale method in a LocaleService of a map instance only that instance will be updated.

Returns the global unit view service instance used by all the leaflet maps.

It lets you get and change the unit view used by the entire SDK.

Whenever the setCurrentUnit method of this instance is called, all the UnitService instances used by maps will be updated too.

But if you use the setCurrentUnit method in a UnitService of a map instance only that instance will be updated.

Sets a key 'config' object in the security configuration file. When the key's name is omitted, then the default key is set.

tomtom.key('keyValue');  // sets global key
tomtom.key('service/traffic', 'keyValue'); // sets key for traffic service

Factory function to create instances of the LocaleService class.

Factory function that creates a new instance of the L.Location widget.

Factory function to create instances of the LowBandwidthSearch class.

Factory function to create instances of the L.Map class.

Sets a key for the services: map tiles and copyrights. Can also be passed on the map object's initialization with key parameter.

tomtom.mapsKey('keyValue');  // sets maps key

Factory function that creates a new instance of the L.MarkersLayer class.

Factory function to create instances of the MatrixRouting class.

Factory function that creates a new instance of the L.MessageBox class.

Factory function that creates a new instance of the L.TomTomMinimap widget.

Factory function to create instances of the NearbySearch class.

Factory function to create instances of the PoiSearch class.

Factory function to create instances of the Reachable Range Routing class.

Factory function that creates a new instance of the L.ResultsList widget.

Factory function to create instances of the ReverseGeocode class.

Factory function that creates a new instance of the L.RouteInputs widget.

Factory function that creates a new instance of the L.RouteInstructions widget.

Factory function that creates a new instance of the L.RouteOnMap widget.

Factory function that creates a new instance of the L.RouteSummary widget.

Factory function to create instances of the Routing class.

Sets a key for the routing service.

tomtom.routingKey('keyValue');  // sets routing key

Factory function that creates a new instance of the L.SearchBox widget.

Sets a key for search, geocode and reverse geocode services.

tomtom.searchKey('keyValue');  // sets search key

It takes a mapbox global object that have to be used for render the vector maps.

The use of this method is required if you use the version of this SDK version without Mapbox GL JS embedded in it.

The currently supported version of Mapbox GL JS is v0.51.0.

tomtom.setMapbox(mapboxgl); //sets mapboxgl reference

This method sets the content of TomTom-User-Agent header. We are collecting anonymous data for statistics of usage of our services in order to increase quality of our products.

Factory function to create instances of the StaticMapImage class.

Factory function to create instances of the class.

Factory function to create instances of the L.TomTomMarkersLayer class.

Factory function to create instances of the TrafficIncidents class.

Sets a key for traffic flow tiles service. Can also be passed on the map object's initialization as an option of the traffic flow layer.

tomtom.trafficFlowKey('keyValue');  // sets traffic flow key

Factory function to create instances of the TrafficFlowSegmentData class.

Sets a key for the traffic incidents tiles and services. Can also be passed on the map object's initialization as an option of the traffic incidents layer.

tomtom.trafficKey('keyValue');  // sets traffic key

Factory function that creates a new instance of the UnitService class.

Tells the SDK to use HTTP instead of HTTPS (default) for the requests to TomTom Maps APIs.

This configuration can be decided per service call basis with the protocol option.

tomtom.useHttp(true); // all requests will be HTTP now

Tells the SDK to use JSONP instead of JSON (default) for the requests to TomTom Maps APIs.

tomtom.useJsonp(true); // all requests will be JSONP from now on

Sets a key for the vector tiles service. Can also be passed on the map object's initialization with the key parameter or using key method. In cases where default key covers vectors tile service as well setting specific key here is not required.

tomtom.vectorMapsKey('keyValue');  // sets the vector maps key