Atlaslog
Atlaslog / MapLibre GL JS / API / NavigationControl
MapLibre GL JS · API reference

NavigationControl

Quick answer

Defined in: ui/control/navigation_control.ts:51

Last verified 2026-11-03 · MapLibre GL JS 4.x · Cite this page
Runnable examplesChinese noteAll API topics

NavigationControl

Defined in: ui/control/navigation_control.ts:51

A NavigationControl control contains zoom buttons and a compass.

Example

let nav = new NavigationControl();
map.addControl(nav, 'top-left');

See

Display map navigation controls

Implements

Constructors

Constructor

new NavigationControl(options?: NavigationControlOptions): NavigationControl

Defined in: ui/control/navigation_control.ts:64

Parameters

Parameter Type Description
options? NavigationControlOptions the control's options

Returns

NavigationControl

Methods

onAdd()

onAdd(map: Map): HTMLElement

Defined in: ui/control/navigation_control.ts:120

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: ui/control/navigation_control.ts:144

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

TutorialsAPI index
English reference text adapted from the official MapLibre GL JS documentation, © MapLibre contributors, licensed under BSD-3-Clause.
Original page: https://maplibre.org/maplibre-gl-js/docs/API/classes/NavigationControl/ · Chinese note: /maplibre/api/navigation-control.html
Cite this page

Atlaslog (2026). NavigationControl. https://www.jingweizhi.com/en/maplibre/api/navigation-control.html (accessed 2026-11-03).