Viewport Places Plugin

Lightweight plugin for the TomTom Maps SDK for Javascript that keeps places in sync with the current map viewport by creating and managing "place modules" that refresh as the map moves.

Docs & examples

• Developer guide: https://docs.tomtom.com/maps-sdk-js/guides/plugins/viewport-places
• Example: https://docs.tomtom.com/maps-sdk-js/examples/viewport-places-plugin

Quickstart

Note: SDK plugins @tomtom-org/maps-sdk as a peer dependency — ensure the SDK is installed in your project.

npm install @tomtom-org/maps-sdk maplibre-gl @tomtom-org/maps-sdk-plugin-viewport-places

1. Follow the SDK Project setup or the Map quickstart to create and initialize a TomTomMap.

2. Import and use the plugin (plugin-specific steps only):

import { ViewportPlaces } from '@tomtom-org/maps-sdk-plugin-viewport-places';

// assume `map` is your initialized TomTomMap instance
const viewportPlaces = new ViewportPlaces(map);

await viewportPlaces.add({
  id: 'restaurants',
  searchOptions: { query: 'restaurant', limit: 40 },
  minZoom: 12,
});

Place modules are rendered bottom-up in the order they are added: the first added module appears at the bottom and later modules are stacked on top.

License

See LICENSE.txt.