On this page

Class KeyboardHandler

The KeyboardHandler allows the user to zoom, rotate, and pan the map using the following keyboard shortcuts:

= / +: Increase the zoom level by 1.
Shift-= / Shift-+: Increase the zoom level by 2.
-: Decrease the zoom level by 1.
Shift--: Decrease the zoom level by 2.
Arrow keys: Pan by 100 pixels.
Shift+⇢: Increase the rotation by 15 degrees.
Shift+⇠: Decrease the rotation by 15 degrees.
Shift+⇡: Increase the pitch by 10 degrees.
Shift+⇣: Decrease the pitch by 10 degrees.

Hierarchy (View Summary)

KeyboardHandler
- KeyboardHandler

Implements

Handler

Index

Constructors

Methods

disable disableRotation enable enableRotation isActive isEnabled keydown reset

Constructors

constructor

new KeyboardHandler(map: MapLibreMap): KeyboardHandler
Parameters
- map: MapLibreMap
Returns KeyboardHandler
Internal

Methods

disable

disable(): void
Disables the "keyboard rotate and zoom" interaction.

Returns void
Example
```
map.keyboard.disable();
```
Implementation of Handler.disable

disableRotation

disableRotation(): void
Disables the "keyboard pan/rotate" interaction, leaving the "keyboard zoom" interaction enabled.

Returns void
Example
```
map.keyboard.disableRotation();
```

enable

enable(): void
Enables the "keyboard rotate and zoom" interaction.

Returns void
Example
```
map.keyboard.enable();
```
Implementation of Handler.enable

enableRotation

enableRotation(): void
Enables the "keyboard pan/rotate" interaction.

Returns void
Example
```
map.keyboard.enable();
map.keyboard.enableRotation();
```

isActive

isActive(): boolean
Returns true if the handler is enabled and has detected the start of a zoom/rotate gesture.

Returns boolean
true if the handler is enabled and has detected the start of a zoom/rotate gesture.

Implementation of Handler.isActive

isEnabled

isEnabled(): boolean
Returns a Boolean indicating whether the "keyboard rotate and zoom" interaction is enabled.

Returns boolean
true if the "keyboard rotate and zoom" interaction is enabled.

Implementation of Handler.isEnabled

keydown

keydown(e: KeyboardEvent): { cameraAnimation: (map: MapLibreMap) => void }
Parameters
- e: KeyboardEvent
Returns { cameraAnimation: (map: MapLibreMap) => void }
Implementation of Handler.keydown

reset

reset(): void
reset can be called by the manager at any time and must reset everything to it's original state

Returns void
Implementation of Handler.reset

Was this helpful?