On this page

Class BoxZoomHandler

The BoxZoomHandler allows the user to zoom the map to fit within a bounding box. The bounding box is defined by clicking and holding shift while dragging the cursor.

Hierarchy (View Summary)

BoxZoomHandler
- BoxZoomHandler

Implements

Handler

Index

Constructors

Methods

disable enable isActive isEnabled keydown mousedown mousemoveWindow mouseupWindow reset

Constructors

constructor

new BoxZoomHandler(
    map: MapLibreMap,
    options: {
        boxZoom?: boolean | BoxZoomHandlerOptions;
        clickTolerance: number;
    },
): BoxZoomHandler
Parameters
- map: MapLibreMap
- options: { boxZoom?: boolean | BoxZoomHandlerOptions; clickTolerance: number }
Returns BoxZoomHandler
Internal

Methods

disable

disable(): void
Disables the "box zoom" interaction.

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

enable

enable(): void
Enables the "box zoom" interaction.

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

isActive

isActive(): boolean
Returns a Boolean indicating whether the "box zoom" interaction is active, i.e. currently being used.

Returns boolean
true if the "box zoom" interaction is active.

Implementation of Handler.isActive

isEnabled

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

Returns boolean
true if the "box zoom" interaction is enabled.

Implementation of Handler.isEnabled

keydown

keydown(e: KeyboardEvent): void
Parameters
- e: KeyboardEvent
Returns void
Implementation of Handler.keydown

mousedown

mousedown(e: MouseEvent, point: Point): void
Parameters
- e: MouseEvent
- point: Point
Returns void
Implementation of Handler.mousedown

mousemoveWindow

mousemoveWindow(e: MouseEvent, point: Point): void
Parameters
- e: MouseEvent
- point: Point
Returns void
Implementation of Handler.mousemoveWindow

mouseupWindow

mouseupWindow(
e: MouseEvent,
point: Point,
): { cameraAnimation: (map: any) => any }
Parameters
- e: MouseEvent
- point: Point
Returns { cameraAnimation: (map: any) => any }
Implementation of Handler.mouseupWindow

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?