CooperativeGesturesHandler

Defined in: ui/handler/cooperative_gestures.ts:29

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

Extends

• Evented<MapEventType>

Implements

• Handler

Methods

fire()

Call Signature

fire(event: ErrorEvent | MapStyleImageMissingEvent | MapLibreEvent<unknown> | MapSourceDataEvent | MapMovementEvent | MapContextEvent | MapStyleDataEvent | MapStyleLoadEvent | MapBoxZoomEvent | MapTouchEvent | MapMouseEvent | MapWheelEvent | MapTerrainEvent | MapLibreEvent<TouchEvent | WheelEvent> & object | MapProjectionEvent): this

Defined in: util/evented.ts:156

Calls every listener registered for the event's type.

Parameters

Returns

this

Inherited from

Evented.fire

Call Signature

fire(type: keyof MapEventType, properties?: object): this

Defined in: util/evented.ts:162

Compatibility with the (type: string, properties: Object) signature from previous versions. See https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Parameters

Returns

this

Inherited from

Evented.fire

isActive()

isActive(): boolean

Defined in: ui/handler/cooperative_gestures.ts:52

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

listens()

listens(type: keyof MapEventType): boolean

Defined in: util/evented.ts:206

Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.

Parameters

Returns

boolean

true if there is at least one registered listener for specified event type, false otherwise

Inherited from

Evented.listens

off()

off<T extends keyof MapEventType>(type: T, listener: (event: MapEventType[T]) => void): this

Defined in: util/evented.ts:117

Removes a previously registered event listener.

Type Parameters

Parameters

Returns

this

Inherited from

Evented.off

on()

on<T extends keyof MapEventType>(type: T, listener: (event: MapEventType[T]) => void): Subscription

Defined in: util/evented.ts:100

Adds a listener to a specified event type.

Type Parameters

Parameters

Returns

Subscription

Inherited from

Evented.on

once()

Call Signature

once<T extends keyof MapEventType>(type: T): Promise<MapEventType[T]>

Defined in: util/evented.ts:132

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Parameters

Returns

Promise<MapEventType[T]>

a promise that resolves with the event

Inherited from

Evented.once

Call Signature

once<T extends keyof MapEventType>(type: T, listener: (event: MapEventType[T]) => void): this

Defined in: util/evented.ts:142

Adds a listener that will be called only once to a specified event type.

The listener will be called first time the event fires after the listener is registered.

Type Parameters

Parameters

Returns

this

this when a listener is provided

Inherited from

Evented.once

reset()

reset(): void

Defined in: ui/handler/cooperative_gestures.ts:55

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

setEventedParent()

setEventedParent(parent?: Evented<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

Defined in: util/evented.ts:217

Bubble all events fired by this instance of Evented to this parent instance of Evented.

Parameters

Returns

this

Inherited from

Evented.setEventedParent

Properties

_bypassKey

_bypassKey: "ctrlKey" | "metaKey"

Defined in: ui/handler/cooperative_gestures.ts:37

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