Skip to content

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.

Implements

Methods

disable()

disable(): void

Disables the "box zoom" interaction.

Returns

void

Implementation of

Handler.disable

Example

map.boxZoom.disable();

Source

src/ui/handler/box_zoom.ts:78

enable()

enable(): void

Enables the "box zoom" interaction.

Returns

void

Implementation of

Handler.enable

Example

map.boxZoom.enable();

Source

src/ui/handler/box_zoom.ts:65

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

Source

src/ui/handler/box_zoom.ts:53

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

Source

src/ui/handler/box_zoom.ts:44