Type Alias TomTomMapParams

Type Declaration

• Optionalattribution?: AttributionOptions

  Where the map's attribution ("copyright") for its data sources sits, your own credits in it, and whether a backdrop sits behind it.

  The map always shows the TomTom and OpenStreetMap credits as logos, by default in the bottom-right corner over a soft backdrop. Move them to another corner, change their distance to the map edges, add credits of your own, or drop the backdrop.

  The attribution is a licensing requirement, so no option turns it off: wherever you place it, keep it visible, readable and uncovered.

  Example

  // Logos in the top-left, 16px from both edges
  attribution: { position: 'top-left', padding: 16 }
  
  // Logos in the default corner, clear of a 64px bottom bar of your own
  attribution: { padding: { horizontal: 12, vertical: 72 } }
  
  // Your own data's credit, after TomTom's
  attribution: { credits: ['Weather data by Open-Meteo.com'] }
  Copy

  See

  AttributionOptions

• Optionalevents?: MapEventsConfig

  How user events are detected and timed, and which cursors they show, for every module. Change it later with TomTomMap.updateEventsConfig.

  Example

  events: { paddingBoxPx: 10, longHoverDelayOnStillMapMS: 500, hoverGracePeriodMS: 1000 }
  Copy

• mapLibre: MapLibreOptions

  The MapLibre options for the map, such as viewport settings, interaction controls and rendering options.

  Example

  mapLibre: {
    container: 'map',
    center: [4.9041, 52.3676],
    zoom: 12,
    pitch: 45,
    bearing: -17.6,
    maxZoom: 18,
    minZoom: 8
  }
  Copy

• OptionalregisterMapLibreWorker?: boolean

  Whether the map starts MapLibre's web worker from the copy your bundler builds out of your own maplibre-gl, served from your app's origin. Vite 8, and vite build on Vite 7, then render the map with no worker setup; the Vite 7 dev server needs the SDK excluded from optimizeDeps, as the project-setup guide shows.

  MapLibre keeps its own worker lookup if you already called its setWorkerUrl, if MapLibre loads unbundled (from a CDN or an import map), and under bundlers that build classic workers or none, as webpack does by default and Rollup and esbuild do. Next.js with Turbopack emits neither the worker nor maplibre-gl-shared.mjs, which the worker imports beside itself. Copy both from maplibre-gl/dist/ into one public/ directory and call setWorkerUrl before creating the map. Pass false to keep MapLibre's lookup in every case.

  Default

  true
  Copy

• Optionalstyle?: StyleInput

  The map style to load.

  Default

  'streetLight'
  Copy

  Example

  // Use dark theme
  style: 'streetDark'
  
  // Custom configuration
  style: {
    type: 'standard',
    id: 'streetLight',
    include: ['trafficFlow']
  }
  Copy

• OptionaltransformRequest?: MapRequestTransform

  Holds or rewrites each request the map makes, after the SDK's own transform. Use it to wait for your proxy session before the map fetches anything, or to point tile URLs at a cache of your own.

  It stays in place when TomTomMap.setLanguage or TomTomMap.setGeopoliticalView changes the requests the SDK builds. MapRequestTransform describes what it gets and returns.

  Remarks

  • It runs for every request MapLibre makes, every tile included, so keep it fast. The Landmarks3D plugin fetches its models with fetch, so they don't pass through it.
  • With an apiKey, the URL carries it as key=. Keep that URL out of your logs.
  • When it throws or its promise rejects, that request fails.

  Example

  new TomTomMap({
    transformRequest: async (request) => {
      await ensureSession();
      return request;
    },
    mapLibre: { container: 'map' }
  });
  Copy