Skip to content

NavigationControl

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

new NavigationControl()

new NavigationControl(options?: NavigationControlOptions): NavigationControl

Parameters

Parameter Type Description
options? NavigationControlOptions the control's options

Returns

NavigationControl

Defined in

src/ui/control/navigation_control.ts:60

Methods

onAdd()

onAdd(map: Map): 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

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

Defined in

src/ui/control/navigation_control.ts:104


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

Defined in

src/ui/control/navigation_control.ts:125