Enable/disable map terrain

This tutorial demonstrates how to programmatically enabling or disabling the 3D terrain map using SDK functions map.enableTerrain() and map.disableTerrain().

The easiest and fastest way to create a map with 3D terrain is through the map options. Check out the tutorial Display a 3D terrain map to learn more about it.

^{Click on the map to enable/disable the map terrain}

1. Copy the following code, paste it into your favorite text editor, and save it as a .html file.

2. Install the npm package.

3. Include the CSS file.

   If you have a bundler that can handle CSS, you can import the CSS or include it with a <link> in the head of the document via the CDN

4. Include the following code in your JavaScript file (Example: app.js).

5. Replace YOUR_MAPTILER_API_KEY_HERE with your actual MapTiler API key.

6. The next is up to you. You can center your map wherever you desire (modifying the starting position) and set an appropriate zoom level (modifying the starting zoom) to match your users’ needs. Additionally, you can change the map’s look (by updating the source URL); choose from a range of visually appealing map styles from our extensive MapTiler standard maps, or create your own to truly differentiate your application.

7. Capture when the user clicks on the map. Add an event handler for the map click event. You will add the code to enable/disable the terrain in this handler.

8. Check whether or not the terrain is enabled.

9. Toggle the map terrain.

10. Exaggerate the terrain. The enableTerrain function by default enables terrain with an exaggeration factor of 1 (actual values). This function also allows you to activate the terrain with a certain exaggeration factor. In this example, we will apply a factor of 1.5 to accentuate the terrain volume.

11. Add an event handler for map terrain events. You will add the code to tilt/untilt the map in this handler.

12. Toggle the map pitch.

Learn more

To change the animate the transition when changing the map pitch check the Animation Options reference. By default is a bezier-curve, but you can define you own function. For example:

Check out the tutorial Display a 3D terrain map

Consult the SDK JS Reference

Related examples

Add hillshading

Example

This example adds raster hillshading to a map by adding the MapTiler Terrain-DEM raster tileset as a raster-dem source with a hillshade layer.

3D terrain map

Example

This tutorial demonstrates how to create a 3D terrain map and display it on a web page using MapTiler Cloud.

Start with AR maps

Example

Getting started with AR maps: The Augmented reality (AR) control adds a button on your map to create a 3D model of the viewport, including 3D terrain and any layer you have put on top. Compatible with WebXR or Apple Quick Look.