Interface TerrainConfig

Enables 3D terrain rendering for this basemap. Default: false.

URL template for the raster-dem tile source (MNT/DTM tiles). Required when enabled is true. Examples:

• "https://tiles.mapterhorn.com/{z}/{x}/{y}.webp"
• "https://s3.amazonaws.com/elevation-tiles-prod/terrarium/{z}/{x}/{y}.png"

Tile encoding format. Default: "terrarium".

Maximum zoom level available for DEM tiles. Default: 15.

Vertical exaggeration factor. Default: 1.5. Recommended range: 1.0–3.0.

What puts the terrain on.

• "basemap" (default): selecting the basemap does, when default3D is true. The camera is then posted to pitch and bearing, and eased back flat when the basemap is left.
• "pitch": the terrain follows the tilt of the camera. It is absent while the map is flat — no elevation tile is requested —, put on once the camera comes to rest tilted to activateFromPitch or more, and removed once it comes to rest under deactivateBelowPitch. Between the two it stays as it was. The decision is taken when a movement ENDS, never during it, and the camera is never moved: default3D, pitch and bearing have no role in this mode, and the profile schema refuses them there.

activation: "pitch" only: tilt, in degrees, from which the terrain is put on. Above 0, at most 85 — and no higher than the map's maxPitch, or the terrain can never show. Default: 12.

activation: "pitch" only: tilt, in degrees, under which the terrain is removed. Must be lower than activateFromPitch: one threshold for both would put the terrain on and off between two movements that end around it. Default: half of activateFromPitch.

When true, the 3D terrain is activated when this basemap is selected, and deactivated when another one is. Without it — and without activation: "pitch", the only other thing that activates a terrain — an enabled terrain is never drawn: no control lets the user turn it on or off. Not read with activation: "pitch". Default: false.

Camera pitch in degrees, posted when the terrain is activated by the selection of the basemap. Not read with activation: "pitch", which never moves the camera. Default: 45.

Camera bearing in degrees, posted when the terrain is activated by the selection of the basemap. Not read with activation: "pitch", which never moves the camera. Default: 0.