TwoFingersTouchZoomRotateHandler
The TwoFingersTouchZoomRotateHandler allows the user to zoom and rotate the map by pinching on a touchscreen.
They can zoom with one finger by double tapping and dragging. On the second tap, hold the finger down and drag up or down to zoom in or out.
Methods
disable()
disable():
void
Disables the "pinch to rotate and zoom" interaction.
Returns
void
Example
map.touchZoomRotate.disable();
disableRotation()
disableRotation():
void
Disables the "pinch to rotate" interaction, leaving the "pinch to zoom" interaction enabled.
Returns
void
Example
map.touchZoomRotate.disableRotation();
enable()
enable(
options?:boolean|AroundCenterOptions):void
Enables the "pinch to rotate and zoom" interaction.
Parameters
| Parameter | Type | Description |
|---|---|---|
options? |
boolean | AroundCenterOptions
| Options object. |
Returns
void
Example
map.touchZoomRotate.enable();
map.touchZoomRotate.enable({ around: 'center' });
enableRotation()
enableRotation():
void
Enables the "pinch to rotate" interaction.
Returns
void
Example
map.touchZoomRotate.enable(); map.touchZoomRotate.enableRotation();
isActive()
isActive():
boolean
Returns true if the handler is enabled and has detected the start of a zoom/rotate gesture.
Returns
boolean
true if the handler is active, false otherwise
isEnabled()
isEnabled():
boolean
Returns a Boolean indicating whether the "pinch to rotate and zoom" interaction is enabled.
Returns
boolean
true if the "pinch to rotate and zoom" interaction is enabled.
setZoomRate()
setZoomRate(
zoomRate?:number):void
Sets the zoom rate of touch gestures.
Parameters
| Parameter | Type | Description |
|---|---|---|
zoomRate? | number | 1 The rate used to scale touch movement to a zoom value. Set to undefined to restore the default. |
Returns
void
Example
Slow down touch zoom
map.touchZoomRotate.setZoomRate(0.5);
setZoomThreshold()
setZoomThreshold(
zoomThreshold?:number):void
Sets the threshold before a pinch gesture starts zooming.
Parameters
| Parameter | Type | Description |
|---|---|---|
zoomThreshold? | number | 0.1 The minimum zoom delta before the pinch gesture becomes active. Set to undefined to restore the default. |
Returns
void
Example
Make pinch zoom less sensitive
map.touchZoomRotate.setZoomThreshold(0.3);
© MapLibre contributors
Licensed under the 3-Clause BSD License.
https://maplibre.org/maplibre-gl-js/docs/API/classes/TwoFingersTouchZoomRotateHandler/