On this page

Class TerrainControl

A TerrainControl control contains a button for turning the terrain on and off.

Example

let map = new Map({TerrainControl: false})
    .addControl(new TerrainControl({
        source: "terrain"
    }));

See

Hierarchy (View Summary)

TerrainControl
- TerrainControl

Implements

IControl

Index

Constructors

Properties

Methods

Constructors

constructor

new TerrainControl(options: TerrainSpecification): TerrainControl
Parameters
- options: TerrainSpecification
  the control's options
Returns TerrainControl

Properties

options

options: TerrainSpecification

Methods

onAdd

onAdd(map: MapLibreMap): HTMLElement
Register a control on the map and give it a chance to register event listeners and resources. This method is called by Map.addControl internally.
Parameters
- map: MapLibreMap
  the Map this control will be added to
Returns HTMLElement
The control's container element. This should be created by the control and returned by onAdd without being attached to the DOM: the map will insert the control's element into the DOM as necessary.

Implementation of IControl.onAdd

onRemove

onRemove(): void
Unregister a control on the map and give it a chance to detach event listeners and resources. This method is called by Map.removeControl internally.

Returns void
Implementation of IControl.onRemove

Was this helpful?