ScrollZoomHandler

Defined in: ui/handler/scroll_zoom.ts:42

The ScrollZoomHandler allows the user to zoom the map by scrolling.

Implements

• Handler

Methods

disable()

disable(): void

Defined in: ui/handler/scroll_zoom.ts:160

Disables the "scroll to zoom" interaction.

Returns

void

Example

map.scrollZoom.disable();

Implementation of

Handler.disable

enable()

enable(options?: boolean | AroundCenterOptions): void

Defined in: ui/handler/scroll_zoom.ts:146

Enables the "scroll to zoom" interaction.

Parameters

Returns

void

Example

map.scrollZoom.enable();
map.scrollZoom.enable({ around: 'center' })

Implementation of

Handler.enable

isActive()

isActive(): boolean

Defined in: ui/handler/scroll_zoom.ts:128

This is used to indicate if the handler is currently active or not. In case a handler is active, it will block other handlers from getting the relevant events. There is an allow list of handlers that can be active at the same time, which is configured when adding a handler.

Returns

boolean

Implementation of

Handler.isActive

isEnabled()

isEnabled(): boolean

Defined in: ui/handler/scroll_zoom.ts:119

Returns a Boolean indicating whether the "scroll to zoom" interaction is enabled.

Returns

boolean

true if the "scroll to zoom" interaction is enabled.

Implementation of

Handler.isEnabled

isZooming()

isZooming(): boolean

Defined in: ui/handler/scroll_zoom.ts:132

Whether the handler is zooming the map apart from the zoom deltas it returns, such as a wheel zoom between a wheel event and its first frame.

Returns

boolean

Implementation of

Handler.isZooming

renderFrame()

renderFrame(): void | HandlerResult

Defined in: ui/handler/scroll_zoom.ts:290

renderFrame is the only non-dom event. It is called during render frames and can be used to smooth camera changes (see scroll handler).

Returns

void | HandlerResult

Implementation of

Handler.renderFrame

reset()

reset(): void

Defined in: ui/handler/scroll_zoom.ts:409

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

setWheelZoomRate()

setWheelZoomRate(wheelZoomRate: number): void

Defined in: ui/handler/scroll_zoom.ts:111

Set the zoom rate of a mouse wheel

Parameters

Returns

void

Example

Slow down zoom of mouse wheel

map.scrollZoom.setWheelZoomRate(1/600);

setZoomRate()

setZoomRate(zoomRate: number): void

Defined in: ui/handler/scroll_zoom.ts:98

Set the zoom rate of a trackpad

Parameters

Returns

void

Example

Speed up trackpad zoom

map.scrollZoom.setZoomRate(1/25);