TomTom Maps for JavaScript
    Preparing search index...

    Class Landmarks3D

    Renders TomTom Orbis 3D Landmarks (high-detail building meshes) on a TomTomMap.

    The plugin streams GLB tiles from the Orbis 3D Landmarks API (Private Preview), renders them with Three.js via a MapLibre custom layer, filters overlapping extruded basemap buildings out of the style, and keeps everything restored across map style changes.

    Requires an API key with Orbis 3D Landmarks entitlements and a map style that shows extruded 3D buildings for the exclusion filter and inherited mode to have an effect.

    import { Landmarks3D } from '@tomtom-org/maps-sdk-plugin-landmarks-3d';

    // assume `map` is your initialized TomTomMap instance
    const landmarks = new Landmarks3D(map);

    await landmarks.setDisplayMode('inherited');
    Index

    Constructors

    constructor

    Accessors

    layer

    Methods

    getDisplayMode isVisible setDisplayMode setVisible

    Constructors

    • Creates the plugin bound to a TomTom map and starts rendering landmarks as soon as the map is ready.

      Parameters

      • map: TomTomMap

        The TomTom map instance to render landmarks on.

      • Optionaloptions: Landmarks3DOptions

        Optional configuration.

      Returns Landmarks3D

    Accessors

    • get layer(): ModelsLayer

      The underlying MapLibre custom layer, for advanced use beyond this facade.

      Returns ModelsLayer

    Methods

    • Whether the landmarks are currently visible.

      Returns boolean

    • Changes how landmarks are rendered relative to the base map.

      Parameters

      Returns Promise<void>

      A promise that resolves once the mode has been applied.

    • Shows or hides the landmarks layer.

      Parameters

      • visible: boolean

        true to show landmarks, false to hide them.

      Returns Promise<void>

      A promise that resolves once the visibility has been applied.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods