TerrainControl

Defined in: src/ui/control/terrain_control.ts:20

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"
    }));

Implements

• IControl

Constructors

Constructor

new TerrainControl(options: TerrainSpecification): TerrainControl

Defined in: src/ui/control/terrain_control.ts:29

Parameters

Parameter	Type	Description
options	TerrainSpecification	the control's options

Returns

TerrainControl

Methods

onAdd()

onAdd(map: Map): HTMLElement

Defined in: src/ui/control/terrain_control.ts:34

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

Parameter	Type	Description
map	Map	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

Defined in: src/ui/control/terrain_control.ts:48

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