On this page

Class TwoFingersTouchPitchHandler

The TwoFingersTouchPitchHandler allows the user to pitch the map by dragging up and down with two fingers.

Hierarchy (View Summary)

TwoFingersTouchHandler
- TwoFingersTouchPitchHandler
  - TwoFingersTouchPitchHandler

Index

Constructors

Methods

disable enable gestureBeginsVertically isActive isEnabled reset touchcancel touchend touchmove touchstart

Constructors

constructor

new TwoFingersTouchPitchHandler(map: MapLibreMap): TwoFingersTouchPitchHandler
Parameters
- map: MapLibreMap
Returns TwoFingersTouchPitchHandler
Overrides TwoFingersTouchHandler.constructor

Methods

disable

disable(): void
Disables the "drag to pitch" interaction.

Returns void
Example
```
map.touchPitch.disable();
```
Inherited from TwoFingersTouchHandler.disable

enable

enable(options?: boolean | AroundCenterOptions | null): void
Enables the "drag to pitch" interaction.
Parameters
- Optionaloptions: boolean | AroundCenterOptions | null
Returns void
Example
```
map.touchPitch.enable();
```
Inherited from TwoFingersTouchHandler.enable

gestureBeginsVertically

gestureBeginsVertically(
    vectorA: Point,
    vectorB: Point,
    timeStamp: number,
): boolean | undefined
Parameters
- vectorA: Point
- vectorB: Point
- timeStamp: number
Returns boolean | undefined

isActive

isActive(): boolean
Returns a Boolean indicating whether the "drag to pitch" interaction is active, i.e. currently being used.

Returns boolean
true if the "drag to pitch" interaction is active.

Inherited from TwoFingersTouchHandler.isActive

isEnabled

isEnabled(): boolean
Returns a Boolean indicating whether the "drag to pitch" interaction is enabled.

Returns boolean
true if the "drag to pitch" interaction is enabled.

Inherited from TwoFingersTouchHandler.isEnabled

reset

reset(): void
reset can be called by the manager at any time and must reset everything to it's original state

Returns void
Overrides TwoFingersTouchHandler.reset

touchcancel

touchcancel(): void
Returns void
Inherited from TwoFingersTouchHandler.touchcancel

touchend

touchend(e: TouchEvent, points: Point[], mapTouches: Touch[]): void
Parameters
- e: TouchEvent
- points: Point[]
- mapTouches: Touch[]
Returns void
Inherited from TwoFingersTouchHandler.touchend

touchmove

touchmove(
    e: TouchEvent,
    points: Point[],
    mapTouches: Touch[],
): void | HandlerResult
Parameters
- e: TouchEvent
- points: Point[]
- mapTouches: Touch[]
Returns void | HandlerResult
Inherited from TwoFingersTouchHandler.touchmove

touchstart

touchstart(e: TouchEvent, points: Point[], mapTouches: Touch[]): void
Parameters
- e: TouchEvent
- points: Point[]
- mapTouches: Touch[]
Returns void
Overrides TwoFingersTouchHandler.touchstart

Was this helpful?