maplibre-gl 3.2.0 → 3.2.1

package/src/ui/camera.ts

@@ -262,19 +262,36 @@ export abstract class Camera extends Evented {
     _onEaseEnd: (easeId?: string) => void;
     _easeFrameId: TaskID;
 
-    // holds the geographical coordinate of the target
+    /**
+     * @hidden
+     * holds the geographical coordinate of the target
+     */
     _elevationCenter: LngLat;
-    // holds the targ altitude value, = center elevation of the target.
-    // This value may changes during flight, because new terrain-tiles loads during flight.
+    /**
+     * @hidden
+     * holds the targ altitude value, = center elevation of the target.
+     * This value may changes during flight, because new terrain-tiles loads during flight.
+     */
     _elevationTarget: number;
-    // holds the start altitude value, = center elevation before animation begins
-    // this value will recalculated during flight in respect of changing _elevationTarget values,
-    // so the linear interpolation between start and target keeps smooth and without jumps.
+    /**
+     * @hidden
+     * holds the start altitude value, = center elevation before animation begins
+     * this value will recalculated during flight in respect of changing _elevationTarget values,
+     * so the linear interpolation between start and target keeps smooth and without jumps.
+     */
     _elevationStart: number;
-
-    /** Used to track accumulated changes during continuous interaction */
+    /**
+     * @hidden
+     * Saves the current state of the elevation freeze - this is used during map movement to prevent "rocky" camera movement.
+     */
+    _elevationFreeze: boolean;
+    /**
+     * @hidden
+     * Used to track accumulated changes during continuous interaction
+     */
     _requestedCameraState?: Transform;
-    /** A callback used to defer camera updates or apply arbitrary constraints.
+    /**
+     * A callback used to defer camera updates or apply arbitrary constraints.
      * If specified, this Camera instance can be used as a stateless component in React etc.
      */
     transformCameraUpdate: CameraUpdateTransformFunction | null;
@@ -313,10 +330,10 @@ export abstract class Camera extends Evented {
     /**
      * Sets the map's geographical centerpoint. Equivalent to `jumpTo({center: center})`.
      *
+     * Triggers the following events: `movestart` and `moveend`.
+     *
      * @param center - The centerpoint to set.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * ```ts
@@ -330,11 +347,11 @@ export abstract class Camera extends Evented {
     /**
      * Pans the map by the specified offset.
      *
+     * Triggers the following events: `movestart` and `moveend`.
+     *
      * @param offset - `x` and `y` coordinates by which to pan the map.
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @see [Navigate the map with game-like controls](https://maplibre.org/maplibre-gl-js/docs/examples/game-controls/)
      */
@@ -346,11 +363,11 @@ export abstract class Camera extends Evented {
     /**
      * Pans the map to the specified location with an animated transition.
      *
+     * Triggers the following events: `movestart` and `moveend`.
+     *
      * @param lnglat - The location to pan the map to.
      * @param options - Options describing the destination and animation of the transition.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * ```ts
@@ -380,14 +397,10 @@ export abstract class Camera extends Evented {
     /**
      * Sets the map's zoom level. Equivalent to `jumpTo({zoom: zoom})`.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, and `zoomend`.
+     *
      * @param zoom - The zoom level to set (0-20).
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `move`
-     * @event `zoom`
-     * @event `moveend`
-     * @event `zoomend`
      * @returns `this`
      * @example
      * Zoom to the zoom level 5 without an animated transition
@@ -403,15 +416,11 @@ export abstract class Camera extends Evented {
     /**
      * Zooms the map to the specified zoom level, with an animated transition.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, and `zoomend`.
+     *
      * @param zoom - The zoom level to transition to.
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `move`
-     * @event `zoom`
-     * @event `moveend`
-     * @event `zoomend`
      * @returns `this`
      * @example
      * ```ts
@@ -433,14 +442,10 @@ export abstract class Camera extends Evented {
     /**
      * Increases the map's zoom level by 1.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, and `zoomend`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `move`
-     * @event `zoom`
-     * @event `moveend`
-     * @event `zoomend`
      * @returns `this`
      * @example
      * Zoom the map in one level with a custom animation duration
@@ -456,14 +461,10 @@ export abstract class Camera extends Evented {
     /**
      * Decreases the map's zoom level by 1.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, and `zoomend`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `move`
-     * @event `zoom`
-     * @event `moveend`
-     * @event `zoomend`
      * @returns `this`
      * @example
      * Zoom the map out one level with a custom animation offset
@@ -491,10 +492,10 @@ export abstract class Camera extends Evented {
      *
      * Equivalent to `jumpTo({bearing: bearing})`.
      *
+     * Triggers the following events: `movestart`, `moveend`, and `rotate`.
+     *
      * @param bearing - The desired bearing.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * Rotate the map to 90 degrees
@@ -519,10 +520,10 @@ export abstract class Camera extends Evented {
      *
      * Equivalent to `jumpTo({padding: padding})`.
      *
+     * Triggers the following events: `movestart` and `moveend`.
+     *
      * @param padding - The desired padding.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * Sets a left padding of 300px, and a top padding of 50px
@@ -539,11 +540,11 @@ export abstract class Camera extends Evented {
      * Rotates the map to the specified bearing, with an animated transition. The bearing is the compass direction
      * that is "up"; for example, a bearing of 90° orients the map so that east is up.
      *
+     * Triggers the following events: `movestart`, `moveend`, and `rotate`.
+     *
      * @param bearing - The desired bearing.
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      */
     rotateTo(bearing: number, options?: AnimationOptions, eventData?: any): this {
@@ -555,10 +556,10 @@ export abstract class Camera extends Evented {
     /**
      * Rotates the map so that north is up (0° bearing), with an animated transition.
      *
+     * Triggers the following events: `movestart`, `moveend`, and `rotate`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      */
     resetNorth(options?: AnimationOptions, eventData?: any): this {
@@ -569,10 +570,10 @@ export abstract class Camera extends Evented {
     /**
      * Rotates and pitches the map so that north is up (0° bearing) and pitch is 0°, with an animated transition.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `pitchstart`, `pitch`, `pitchend`, and `rotate`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      */
     resetNorthPitch(options?: AnimationOptions, eventData?: any): this {
@@ -588,10 +589,10 @@ export abstract class Camera extends Evented {
      * Snaps the map so that north is up (0° bearing), if the current bearing is close enough to it (i.e. within the
      * `bearingSnap` threshold).
      *
+     * Triggers the following events: `movestart`, `moveend`, and `rotate`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      */
     snapToNorth(options?: AnimationOptions, eventData?: any): this {
@@ -611,11 +612,10 @@ export abstract class Camera extends Evented {
     /**
      * Sets the map's pitch (tilt). Equivalent to `jumpTo({pitch: pitch})`.
      *
+     * Triggers the following events: `movestart`, `moveend`, `pitchstart`, and `pitchend`.
+     *
      * @param pitch - The pitch to set, measured in degrees away from the plane of the screen (0-60).
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `pitchstart`
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      */
     setPitch(pitch: number, eventData?: any): this {
@@ -738,12 +738,12 @@ export abstract class Camera extends Evented {
      * Pans and zooms the map to contain its visible area within the specified geographical bounds.
      * This function will also reset the map's bearing to 0 if bearing is nonzero.
      *
+     * Triggers the following events: `movestart` and `moveend`.
+     *
      * @param bounds - Center these bounds in the viewport and use the highest
      * zoom level up to and including `Map#getMaxZoom()` that fits them in the viewport.
      * @param options- Options supports all properties from {@link AnimationOptions} and {@link CameraOptions} in addition to the fields below.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * ```ts
@@ -766,13 +766,13 @@ export abstract class Camera extends Evented {
      * once the map is rotated to the specified bearing. To zoom without rotating,
      * pass in the current map bearing.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, `zoomend` and `rotate`.
+     *
      * @param p0 - First point on screen, in pixel coordinates
      * @param p1 - Second point on screen, in pixel coordinates
      * @param bearing - Desired map bearing at end of animation, in degrees
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `moveend`
      * @returns `this`
      * @example
      * ```ts
@@ -813,18 +813,11 @@ export abstract class Camera extends Evented {
      * an animated transition. The map will retain its current values for any
      * details not specified in `options`.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, `zoomend`, `pitchstart`,
+     * `pitch`, `pitchend`, and `rotate`.
+     *
      * @param options - Options object
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `pitchstart`
-     * @event `rotate`
-     * @event `move`
-     * @event `zoom`
-     * @event `pitch`
-     * @event `moveend`
-     * @event `zoomend`
-     * @event `pitchend`
      * @returns `this`
      * @example
      * ```ts
@@ -940,19 +933,12 @@ export abstract class Camera extends Evented {
      * the `reduced motion` accessibility feature enabled in their operating system,
      * unless `options` includes `essential: true`.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, `zoomend`, `pitchstart`,
+     * `pitch`, `pitchend`, and `rotate`.
+     *
      * @param options - Options describing the destination and animation of the transition.
      * Accepts {@link CameraOptions} and {@link AnimationOptions}.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `pitchstart`
-     * @event `rotate`
-     * @event `move`
-     * @event `zoom`
-     * @event `pitch`
-     * @event `moveend`
-     * @event `zoomend`
-     * @event `pitchend`
      * @returns `this`
      * @see [Navigate the map with game-like controls](https://maplibre.org/maplibre-gl-js/docs/examples/game-controls/)
      */
@@ -1076,12 +1062,13 @@ export abstract class Camera extends Evented {
     _prepareElevation(center: LngLat) {
         this._elevationCenter = center;
         this._elevationStart = this.transform.elevation;
-        this._elevationTarget = this.transform.getElevation(center, this.terrain);
-        this.transform.freezeElevation = true;
+        this._elevationTarget = this.terrain.getElevationForLngLatZoom(center, this.transform.tileZoom);
+        this._elevationFreeze = true;
     }
 
     _updateElevation(k: number) {
-        const elevation = this.transform.getElevation(this._elevationCenter, this.terrain);
+        this.transform._minEleveationForCurrentTile = this.terrain.getMinTileElevationForLngLatZoom(this._elevationCenter, this.transform.tileZoom);
+        const elevation = this.terrain.getElevationForLngLatZoom(this._elevationCenter, this.transform.tileZoom);
         // target terrain updated during flight, slowly move camera to new height
         if (k < 1 && elevation !== this._elevationTarget) {
             const pitch1 = this._elevationTarget - this._elevationStart;
@@ -1093,7 +1080,7 @@ export abstract class Camera extends Evented {
     }
 
     _finalizeElevation() {
-        this.transform.freezeElevation = false;
+        this._elevationFreeze = false;
         this.transform.recalculateZoom(this.terrain);
     }
 
@@ -1102,6 +1089,7 @@ export abstract class Camera extends Evented {
      * If `transformCameraUpdate` is specified, a copy of the current transform is created to track the accumulated changes.
      * This underlying transform represents the "desired state" proposed by input handlers / animations / UI controls.
      * It may differ from the state used for rendering (`this.transform`).
+     * @hidden
      * @returns Transform to apply changes to
      */
     _getTransformForUpdate(): Transform {
@@ -1115,6 +1103,7 @@ export abstract class Camera extends Evented {
 
     /**
      * Called after the camera is done being manipulated.
+     * @hidden
      * @param tr - the requested camera end state
      * Call `transformCameraUpdate` if present, and then apply the "approved" changes.
      */
@@ -1188,20 +1177,13 @@ export abstract class Camera extends Evented {
      * if the user has the `reduced motion` accessibility feature enabled in their operating system,
      * unless 'options' includes `essential: true`.
      *
+     * Triggers the following events: `movestart`, `move`, `moveend`, `zoomstart`, `zoom`, `zoomend`, `pitchstart`,
+     * `pitch`, `pitchend`, and `rotate`.
+     *
      * @param options - Options describing the destination and animation of the transition.
      * Accepts {@link CameraOptions}, {@link AnimationOptions},
      * and the following additional options.
      * @param eventData - Additional properties to be added to event objects of events triggered by this method.
-     * @event `movestart`
-     * @event `zoomstart`
-     * @event `pitchstart`
-     * @event `move`
-     * @event `zoom`
-     * @event `rotate`
-     * @event `pitch`
-     * @event `moveend`
-     * @event `zoomend`
-     * @event `pitchend`
      * @returns `this`
      * @example
      * ```ts
@@ -1482,9 +1464,9 @@ export abstract class Camera extends Evented {
         if (!this.terrain) {
             return null;
         }
-        const elevation = this.transform.getElevation(LngLat.convert(lngLatLike), this.terrain);
+        const elevation = this.terrain.getElevationForLngLatZoom(LngLat.convert(lngLatLike), this.transform.tileZoom);
         /**
-         * Different zoomlevels with different terrain-tiles the elvation-values are not the same.
+         * Different zoomlevels with different terrain-tiles the elevation-values are not the same.
          * map.transform.elevation variable with the center-altitude.
          * In maplibre the proj-matrix is translated by this value in negative z-direction.
          * So we need to add this value to the elevation to get the correct value.

package/src/ui/handler_manager.ts

@@ -504,10 +504,10 @@ export class HandlerManager {
                 (combinedEventsInProgress.drag || combinedEventsInProgress.zoom)) {
                 // When starting to drag or move, flag it and register moveend to clear flagging
                 this._terrainMovement = true;
-                tr.freezeElevation = true;
+                this._map._elevationFreeze = true;
                 tr.setLocationAtPoint(loc, around);
                 this._map.once('moveend', () => {
-                    tr.freezeElevation = false;
+                    this._map._elevationFreeze = false;
                     this._terrainMovement = false;
                     tr.recalculateZoom(map.terrain);
                 });

package/src/ui/hash.ts

@@ -133,6 +133,5 @@ export class Hash {
     /**
      * Mobile Safari doesn't allow updating the hash more than 100 times per 30 seconds.
      */
-    _updateHash = throttle(this._updateHashUnthrottled, 30 * 1000 / 100);
-
+    _updateHash: () => ReturnType<typeof setTimeout> = throttle(this._updateHashUnthrottled, 30 * 1000 / 100);
 }

package/src/ui/map.test.ts

@@ -2625,15 +2625,20 @@ describe('Map', () => {
         });
     });
 
+    describe('cooperativeGestures option', () => {
+        test('cooperativeGesture container element is hidden from a11y tree', () => {
+            const map = createMap({cooperativeGestures: true});
+
+            expect(map.getContainer().querySelector('.maplibregl-cooperative-gesture-screen').getAttribute('aria-hidden')).toBeTruthy();
+        });
+    });
+
     describe('getCameraTargetElevation', () => {
         test('Elevation is zero without terrain, and matches any given terrain', () => {
             const map = createMap();
             expect(map.getCameraTargetElevation()).toBe(0);
 
-            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 2000);
-
             const terrainStub = {} as Terrain;
-            terrainStub.getElevation = mockedGetElevation;
             map.terrain = terrainStub;
 
             const transform = new Transform(0, 22, 0, 60, true);
@@ -2641,7 +2646,7 @@ describe('Map', () => {
             transform.center = new LngLat(10.0, 50.0);
             transform.zoom = 14;
             transform.resize(512, 512);
-            transform.updateElevation(map.terrain);
+            transform.elevation = 2000;
             map.transform = transform;
 
             expect(map.getCameraTargetElevation()).toBe(2000);
@@ -2653,10 +2658,10 @@ describe('Map', () => {
         test('pitch 90 with terrain', () => {
             const map = createMap();
 
-            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200);
+            const mockedGetElevation = jest.fn((_lngLat: LngLat, _zoom: number) => 111200);
 
             const terrainStub = {} as Terrain;
-            terrainStub.getElevation = mockedGetElevation;
+            terrainStub.getElevationForLngLatZoom = mockedGetElevation;
             map.terrain = terrainStub;
 
             // distance between lng x and lng x+1 is 111.2km at same lat
@@ -2670,10 +2675,10 @@ describe('Map', () => {
         test('pitch 153.435 with terrain', () => {
             const map = createMap();
 
-            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200 * 3);
+            const mockedGetElevation = jest.fn((_lngLat: LngLat, _zoom: number) => 111200 * 3);
 
             const terrainStub = {} as Terrain;
-            terrainStub.getElevation = mockedGetElevation;
+            terrainStub.getElevationForLngLatZoom = mockedGetElevation;
             map.terrain = terrainStub;
             // distance between lng x and lng x+1 is 111.2km at same lat
             // (elevation difference of cam and center) / 2 = grounddistance =>
@@ -2687,10 +2692,10 @@ describe('Map', () => {
         test('pitch 63 with terrain', () => {
             const map = createMap();
 
-            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 111200 / 2);
+            const mockedGetElevation = jest.fn((_lngLat: LngLat, _zoom: number) => 111200 / 2);
 
             const terrainStub = {} as Terrain;
-            terrainStub.getElevation = mockedGetElevation;
+            terrainStub.getElevationForLngLatZoom = mockedGetElevation;
             map.terrain = terrainStub;
 
             // distance between lng x and lng x+1 is 111.2km at same lat
@@ -2705,10 +2710,10 @@ describe('Map', () => {
         test('zoom distance 1000', () => {
             const map = createMap();
 
-            const mockedGetElevation = jest.fn((_tileID: OverscaledTileID, _x: number, _y: number, _extent?: number) => 1000);
+            const mockedGetElevation = jest.fn((_lngLat: LngLat, _zoom: number) => 1000);
 
             const terrainStub = {} as Terrain;
-            terrainStub.getElevation = mockedGetElevation;
+            terrainStub.getElevationForLngLatZoom = mockedGetElevation;
             map.terrain = terrainStub;
 
             const expectedZoom = Math.log2(map.transform.cameraToCenterDistance / mercatorZfromAltitude(1000, 0) / map.transform.tileSize);