BoxZoomHandler

Defined in: src/ui/handler/box_zoom.ts:16

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

• Handler

Methods

disable()

disable(): void

Defined in: src/ui/handler/box_zoom.ts:78

Disables the "box zoom" interaction.

Returns

void

Example

map.boxZoom.disable();

Implementation of

Handler.disable

---

enable()

enable(): void

Defined in: src/ui/handler/box_zoom.ts:65

Enables the "box zoom" interaction.

Returns

void

Example

map.boxZoom.enable();

Implementation of

Handler.enable

---

isActive()

isActive(): boolean

Defined in: src/ui/handler/box_zoom.ts:53

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

Defined in: src/ui/handler/box_zoom.ts:44

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

---

reset()

reset(): void

Defined in: src/ui/handler/box_zoom.ts:152

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