TomTom Maps SDK for JavaScript

Examples | Documentation | API Reference

TomTom Maps SDK for JavaScript is a JavaScript library for building applications using TomTom location maps and services.

It leverages the power of MapLibre GL JS and GeoJSON to seamlessly integrate TomTom maps and services with convenient out-of-the-box support, while staying highly customizable and extensible.

⚠️ Public Preview Notice

We have released some capabilities in the Maps SDK under Public Preview to collect feedback from the community.

• While our goal is to keep the design of the interface stable, breaking changes will occur, particularly in the earlier versions.
• The versions will follow a 0.MAJOR.MINOR pattern for the time being.
• Stay tuned with our release CHANGELOG.md files.

🚀 Getting Started using npm

npm i @tomtom-org/maps-sdk

Additionally:

• If you use the map: npm i maplibre-gl

📚 Documentation & Examples

Explore comprehensive guides and interactive examples to get the most out of Maps SDK JS:

🚀 Interactive Examples

• Live Examples - Try the SDK in your browser

📖 Documentation

• Getting Started Guide - Introduction and key features
• Project Setup - Step-by-step setup instructions
• How the SDK Works - Architecture and concepts

📋 API Reference

• API Reference - Complete API documentation

📝 Latest Updates

• Release Notes - What's new and breaking changes

🌍 Where can you run it on?

• web: display and configure a map, search for places, plan routes, and easily display and interact with them, including your own data
• nodejs: (reverse)geocode locations, (re)calculate routes, and more, to enrich data before saving or returning it
• React Native: leverage the power of TomTom location services from a single codebase

📦 Bundles

• Map: MapLibre-powered library for readily styled, service-compatible and interactive TomTom Maps
  • MapLibre is an open source peer dependency so your application can also use it directly
• Services: Functions with GeoJSON services for TomTom location APIs
  • Compatible with web, nodejs and React Native applications
• Core: shared configuration, types and utilities
  • Facilitates seamless integration between map and services

🗺️ Map

The SDK Map bundle is built on top of MapLibre GL JS, and shares it as a dependency with your app.
You can both use the TomTom and MapLibre SDKs together at any time.

✨ Feature highlights

Readily available, yet highly customizable interactive TomTom Maps:

• in different styles: light, dark, b&w, satellite
• with configurable POIs and Live Traffic
• seamlessly integrable with TomTom Services
• with places, routes and geometries from TomTom services or your own data

🚀 Getting Started with Map

Using npm

The SDK Map uses MapLibre GL JS as peer dependency. Therefore, you need to also have it installed in your project.
The TomTom SDK is tested against the latest stable release of MapLibre GL.

npm i @tomtom-org/maps-sdk maplibre-gl

Code imports from the SDK Map Bundle will come from @tomtom-org/maps-sdk/map

🔧 Services

The SDK Services bundle integrates the TomTom location APIs into comprehensive GeoJSON services.
The services can be integrated in web, nodejs and React Native apps.
The compatibility of both inputs and outputs with GeoJSON helps with further integration with geospatial tools.

✨ Feature highlights

• Search (fuzzy search, geometry search)
• Geocoding and Reverse Geocoding
• Geometry Data
• Routing with EV support
• EV Charging Stations Availability

🚀 Getting Started with Services

Using npm

npm i @tomtom-org/maps-sdk

Code imports from the SDK Map Bundle will come from @tomtom-org/maps-sdk/services

⚙️ Core

The SDK Core is a set of utilities and TypeScript types which are common to both Map and Services.`

✨ Feature highlights

• Common configuration
• Common types (such as outputs from Services which can be used as inputs to the Map)
• Utilities (such as distance/duration formatting and bounding box calculations)

🔧 Using the Core Bundle

If you use Map and/or Services, there is no need to install any further packages.
Code imports from the SDK Core Bundle will come from @tomtom-org/maps-sdk/core