Class ViewportPlaces

A class for managing dynamic searched place modules on a TomTom map.

It leverages the SDK search service to maintain place modules that automatically update and stay current as the map viewport changes.

Index

Constructors

Methods

add addPOICategories remove removeAll update

Constructors

constructor

new ViewportPlaces(map: TomTomMap): ViewportPlaces
Creates an instance of ViewportPlaces bound to a TomTom map.
Parameters
- map: TomTomMap
  The TomTom map instance to attach place modules to.
Returns ViewportPlaces

Methods

add

add(options: ViewportPlacesAddOptions): Promise<PlacesModule>
Adds a PlacesModule that displays places based on fuzzy search parameters and automatically updates as the map moves.
Parameters
- options: ViewportPlacesAddOptions
  The options for the place module.
Returns Promise<PlacesModule>
A promise that resolves to the PlacesModule instance managing the module.
Remarks
- Each call to "add" creates a new place module and places it above previously added modules.
- Place modules are rendered bottom-up in the order they are added: the first added module is displayed at the bottom, and later modules are stacked on top of earlier ones.
- The default places module theme is 'base-map' unless overridden in the options.

addPOICategories

addPOICategories(
options: ViewportPlacesAddCommonOptions & { categories: POICategory[] },
): Promise<PlacesModule>
Adds a PlacesModule for specific POI categories that updates automatically as the map moves. The POIs are shown in the same style as the base map.
Parameters
- options: ViewportPlacesAddCommonOptions & { categories: POICategory[] }
  The options for the category-based place module.
Returns Promise<PlacesModule>
A promise that resolves to the PlacesModule instance managing the module.
Remarks
- This is a convenience wrapper over add that configures a category-based search for a PlacesModule.
- Each call creates a new place module that will be stacked on top of previously added modules.

remove

remove(id: string): void
Removes a specific place module by its ID, stopping its updates and clearing the displayed places.
Parameters
- id: string
  The unique identifier of the PlacesModule to remove.
Returns void
Remarks
If the id does not exist, an error is logged into console.

removeAll

removeAll(): void
Removes all registered place modules, stopping their updates and clearing all displayed places.

Returns void

update

update(newOptions: ViewportPlacesOptions): Promise<void>
Updates the search and display options for an existing place module identified by its ID. This will immediately apply the new options and refresh the place module accordingly.
Parameters
- newOptions: ViewportPlacesOptions
  The new options to apply.
Returns Promise<void>
Throws
Error if the place module with the given ID does not exist.