Skip to content

CooperativeGesturesHandler

A CooperativeGestureHandler is a control that adds cooperative gesture info when user tries to zoom in/out.

When the CooperativeGestureHandler blocks a gesture, it will emit a cooperativegestureprevented event.

Example

const map = new Map({
  cooperativeGestures: true
});

See

Example: cooperative gestures

Implements

Methods

isActive()

isActive(): boolean

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

Defined in

src/ui/handler/cooperative_gestures.ts:42

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

Defined in

src/ui/handler/cooperative_gestures.ts:45

Properties

_bypassKey

_bypassKey: "ctrlKey" | "metaKey"

This is the key that will allow to bypass the cooperative gesture protection

Defined in

src/ui/handler/cooperative_gestures.ts:34