maplibre-gl 3.2.0 → 3.2.1

package/dist/maplibre-gl.d.ts

@@ -3600,7 +3600,14 @@ export declare class Terrain {
 	 */
 	getDEMElevation(tileID: OverscaledTileID, x: number, y: number, extent?: number): number;
 	/**
-	 * get the Elevation for given coordinate in respect of exaggeration.
+	 * Get the elevation for given {@link LngLat} in respect of exaggeration.
+	 * @param lnglat - the location
+	 * @param zoom - the zoom
+	 * @returns the elevation
+	 */
+	getElevationForLngLatZoom(lnglat: LngLat, zoom: number): number;
+	/**
+	 * Get the elevation for given coordinate in respect of exaggeration.
 	 * @param tileID - the tile id
 	 * @param x - between 0 .. EXTENT
 	 * @param y - between 0 .. EXTENT
@@ -3649,6 +3656,7 @@ export declare class Terrain {
 	 * @returns the elevation delta in meters
 	 */
 	getMeshFrameDelta(zoom: number): number;
+	getMinTileElevationForLngLatZoom(lnglat: LngLat, zoom: number): number;
 	/**
 	 * Get the minimum and maximum elevation contained in a tile. This includes any
 	 * exaggeration included in the terrain.
@@ -3661,6 +3669,11 @@ export declare class Terrain {
 		minElevation: number | null;
 		maxElevation: number | null;
 	};
+	_getOverscaledTileIDFromLngLatZoom(lnglat: LngLat, zoom: number): {
+		tileID: OverscaledTileID;
+		mercatorX: number;
+		mercatorY: number;
+	};
 }
 export declare class Transform {
 	tileSize: number;
@@ -3684,7 +3697,6 @@ export declare class Transform {
 		number
 	];
 	cameraToCenterDistance: number;
-	cameraToSeaLevelDistance: number;
 	mercatorMatrix: mat4;
 	projMatrix: mat4;
 	invProjMatrix: mat4;
@@ -3694,7 +3706,6 @@ export declare class Transform {
 	pixelMatrixInverse: mat4;
 	glCoordMatrix: mat4;
 	labelPlaneMatrix: mat4;
-	freezeElevation: boolean;
 	_fov: number;
 	_pitch: number;
 	_zoom: number;
@@ -3715,6 +3726,7 @@ export declare class Transform {
 	_alignedPosMatrixCache: {
 		[_: string]: mat4;
 	};
+	_minEleveationForCurrentTile: number;
 	constructor(minZoom?: number, maxZoom?: number, minPitch?: number, maxPitch?: number, renderWorldCopies?: boolean);
 	clone(): Transform;
 	apply(that: Transform): void;
@@ -3807,18 +3819,6 @@ export declare class Transform {
 	project(lnglat: LngLat): Point;
 	unproject(point: Point): LngLat;
 	get point(): Point;
-	/**
-	 * Updates the center-elevation value unless freezeElevation is activated.
-	 * @param terrain - the terrain
-	 */
-	updateElevation(terrain?: Terrain): void;
-	/**
-	 * get the elevation from terrain for the current zoomlevel.
-	 * @param lnglat - the location
-	 * @param terrain - the terrain
-	 * @returns elevation in meters
-	 */
-	getElevation(lnglat: LngLat, terrain: Terrain): number;
 	/**
 	 * get the camera position in LngLat and altitudes in meter
 	 * @returns An object with lngLat & altitude.
@@ -4240,7 +4240,7 @@ export declare class Program<Us extends UniformBindings> {
 	terrainUniforms: TerrainPreludeUniformsType;
 	binderUniforms: Array<BinderUniform>;
 	failedToCreate: boolean;
-	constructor(context: Context, name: string, source: {
+	constructor(context: Context, source: {
 		fragmentSource: string;
 		vertexSource: string;
 		staticAttributes: Array<string>;
@@ -5698,7 +5698,7 @@ export declare class Hash {
 	/**
 	 * Mobile Safari doesn't allow updating the hash more than 100 times per 30 seconds.
 	 */
-	_updateHash: () => NodeJS.Timeout;
+	_updateHash: () => ReturnType<typeof setTimeout>;
 }
 export interface DragMovementResult {
 	bearingDelta?: number;
@@ -6253,12 +6253,36 @@ declare abstract class Camera extends Evented {
 	_onEaseFrame: (_: number) => void;
 	_onEaseEnd: (easeId?: string) => void;
 	_easeFrameId: TaskID;
+	/**
+	 * @hidden
+	 * holds the geographical coordinate of the target
+	 */
 	_elevationCenter: LngLat;
+	/**
+	 * @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;
+	/**
+	 * @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;
@@ -6283,10 +6307,10 @@ declare 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
@@ -6297,11 +6321,11 @@ declare 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/)
 	 */
@@ -6309,11 +6333,11 @@ declare 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
@@ -6337,14 +6361,10 @@ declare 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
@@ -6356,15 +6376,11 @@ declare 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
@@ -6381,14 +6397,10 @@ declare 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
@@ -6400,14 +6412,10 @@ declare 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
@@ -6430,10 +6438,10 @@ declare 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
@@ -6453,10 +6461,10 @@ declare 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
@@ -6469,31 +6477,31 @@ declare 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;
 	/**
 	 * 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;
 	/**
 	 * 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;
@@ -6501,10 +6509,10 @@ declare 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;
@@ -6517,11 +6525,10 @@ declare 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;
@@ -6567,12 +6574,12 @@ declare 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
@@ -6589,13 +6596,13 @@ declare 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
@@ -6614,18 +6621,11 @@ declare 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
@@ -6662,19 +6662,12 @@ declare 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/)
 	 */
@@ -6691,11 +6684,13 @@ declare 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;
 	/**
 	 * 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.
 	 */
@@ -6711,20 +6706,13 @@ declare 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
@@ -8431,7 +8419,10 @@ export declare class Map extends Camera {
 		number
 	];
 	_terrainDataCallback: (e: MapStyleDataEvent | MapSourceDataEvent) => void;
-	/** image queue throttling handle. To be used later when clean up */
+	/**
+	 * @hidden
+	 * image queue throttling handle. To be used later when clean up
+	 */
 	_imageQueueHandle: number;
 	/**
 	 * The map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.
@@ -8478,12 +8469,15 @@ export declare class Map extends Camera {
 	/**
 	 * Returns a unique number for this map instance which is used for the MapLoadEvent
 	 * to make sure we only fire one event per instantiated map object.
+	 * @hidden
 	 * @returns the uniq map ID
 	 */
 	_getMapId(): number;
 	/**
 	 * Adds an {@link IControl} to the map, calling `control.onAdd(this)`.
 	 *
+	 * An {@link ErrorEvent} will be fired if the image parameter is invald.
+	 *
 	 * @param control - The {@link IControl} to add.
 	 * @param position - position on the map to which the control will be added.
 	 * Valid values are `'top-left'`, `'top-right'`, `'bottom-left'`, and `'bottom-right'`. Defaults to `'top-right'`.
@@ -8499,6 +8493,8 @@ export declare class Map extends Camera {
 	/**
 	 * Removes the control from the map.
 	 *
+	 * An {@link ErrorEvent} will be fired if the image parameter is invald.
+	 *
 	 * @param control - The {@link IControl} to remove.
 	 * @returns `this`
 	 * @example
@@ -8537,6 +8533,8 @@ export declare class Map extends Camera {
 	 * This method must be called after the map's `container` is resized programmatically
 	 * or when the map is shown after being initially hidden with CSS.
 	 *
+	 * Triggers the following events: `movestart`, `move`, `moveend`, and `resize`.
+	 *
 	 * @param eventData - Additional properties to be passed to `movestart`, `move`, `resize`, and `moveend`
 	 * events that get triggered as a result of resize. This can be useful for differentiating the
 	 * source of an event (for example, user-initiated or programmatically-triggered events).
@@ -8549,6 +8547,11 @@ export declare class Map extends Camera {
 	 * ```
 	 */
 	resize(eventData?: any): Map;
+	/**
+	 * Return the map's pixel ratio eventually scaled down to respect maxCanvasSize.
+	 * Internally you should use this and not getPixelRatio().
+	 * @hidden
+	 */
 	_getClampedPixelRatio(width: number, height: number): number;
 	/**
 	 * Returns the map's pixel ratio.
@@ -8617,6 +8620,8 @@ export declare class Map extends Camera {
 	 * if the map is 512px tall it will not be possible to zoom below zoom 0
 	 * no matter what the `minZoom` is set to.
 	 *
+	 * A {@link ErrorEvent} event will be fired if minZoom is out of bounds.
+	 *
 	 * @param minZoom - The minimum zoom level to set (-2 - 24).
 	 * If `null` or `undefined` is provided, the function removes the current minimum zoom (i.e. sets it to -2).
 	 * @returns `this`
@@ -8641,6 +8646,8 @@ export declare class Map extends Camera {
 	 * If the map's current zoom level is higher than the new maximum,
 	 * the map will zoom to the new maximum.
 	 *
+	 * A {@link ErrorEvent} event will be fired if minZoom is out of bounds.
+	 *
 	 * @param maxZoom - The maximum zoom level to set.
 	 * If `null` or `undefined` is provided, the function removes the current maximum zoom (sets it to 22).
 	 * @returns `this`
@@ -8665,6 +8672,8 @@ export declare class Map extends Camera {
 	 * If the map's current pitch is lower than the new minimum,
 	 * the map will pitch to the new minimum.
 	 *
+	 * A {@link ErrorEvent} event will be fired if minPitch is out of bounds.
+	 *
 	 * @param minPitch - The minimum pitch to set (0-85). Values greater than 60 degrees are experimental and may result in rendering issues. If you encounter any, please raise an issue with details in the MapLibre project.
 	 * If `null` or `undefined` is provided, the function removes the current minimum pitch (i.e. sets it to 0).
 	 * @returns `this`
@@ -8681,6 +8690,8 @@ export declare class Map extends Camera {
 	 * If the map's current pitch is higher than the new maximum,
 	 * the map will pitch to the new maximum.
 	 *
+	 * A {@link ErrorEvent} event will be fired if maxPitch is out of bounds.
+	 *
 	 * @param maxPitch - The maximum pitch to set (0-85). Values greater than 60 degrees are experimental and may result in rendering issues. If you encounter any, please raise an issue with details in the MapLibre project.
 	 * If `null` or `undefined` is provided, the function removes the current maximum pitch (sets it to 60).
 	 * @returns `this`
@@ -8800,6 +8811,7 @@ export declare class Map extends Camera {
 		};
 	};
 	/**
+	 * @event
 	 * Adds a listener for events of a specified type, optionally limited to features in a specified style layer.
 	 * See {@link MapEventType} and {@link MapLayerEventType} for a full list of events and their description.
 	 *
@@ -8860,8 +8872,8 @@ export declare class Map extends Camera {
 	 * when the cursor enters a visible portion of the specified layer from outside that layer or outside the map canvas.
 	 * @param layer - The ID of a style layer or a listener if no ID is provided. Event will only be triggered if its location
 	 * is within a visible feature in this layer. The event will have a `features` property containing
-	 * an array of the matching features. If `layerIdOrListener` is not supplied, the event will not have a `features` property.
-	 * Please note that many event types are not compatible with the optional `layerIdOrListener` parameter.
+	 * an array of the matching features. If `layer` is not supplied, the event will not have a `features` property.
+	 * Please note that many event types are not compatible with the optional `layer` parameter.
 	 * @param listener - The function to be called when the event is fired.
 	 * @returns `this`
 	 * @example
@@ -8904,12 +8916,27 @@ export declare class Map extends Camera {
 	 * @see [Create a hover effect](https://maplibre.org/maplibre-gl-js/docs/examples/hover-styles/)
 	 * @see [Create a draggable marker](https://maplibre.org/maplibre-gl-js/docs/examples/drag-a-point/)
 	 */
-	on(type: keyof MapEventType | string, listener: Listener): this;
 	on<T extends keyof MapLayerEventType>(type: T, layer: string, listener: (ev: MapLayerEventType[T] & Object) => void): Map;
+	/**
+	 * Overload of the `on` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The listener callback.
+	 * @returns `this`
+	 */
 	on<T extends keyof MapEventType>(type: T, listener: (ev: MapEventType[T] & Object) => void): this;
 	/**
-	 * Adds a listener that will be called only once to a specified event type occurring on features in a specified style layer.
+	 * Overload of the `on` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The listener callback.
+	 * @returns `this`
+	 */
+	on(type: keyof MapEventType | string, listener: Listener): this;
+	/**
+	 * Adds a listener that will be called only once to a specified event type, optionally limited to features in a specified style layer.
 	 *
+	 * @event
 	 * @param type - The event type to listen for; one of `'mousedown'`, `'mouseup'`, `'click'`, `'dblclick'`,
 	 * `'mousemove'`, `'mouseenter'`, `'mouseleave'`, `'mouseover'`, `'mouseout'`, `'contextmenu'`, `'touchstart'`,
 	 * `'touchend'`, or `'touchcancel'`. `mouseenter` and `mouseover` events are triggered when the cursor enters
@@ -8922,20 +8949,49 @@ export declare class Map extends Camera {
 	 * @param listener - The function to be called when the event is fired.
 	 * @returns `this` if listener is provided, promise otherwise to allow easier usage of async/await
 	 */
-	once(type: keyof MapEventType | string, listener?: Listener): this | Promise<any>;
 	once<T extends keyof MapLayerEventType>(type: T, layer: string, listener?: (ev: MapLayerEventType[T] & Object) => void): this | Promise<MapLayerEventType[T] & Object>;
+	/**
+	 * Overload of the `once` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The listener callback.
+	 * @returns `this`
+	 */
 	once<T extends keyof MapEventType>(type: T, listener?: (ev: MapEventType[T] & Object) => void): this | Promise<any>;
 	/**
-	 * Removes an event listener for layer-specific events previously added with `Map#on`.
+	 * Overload of the `once` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The listener callback.
+	 * @returns `this`
+	 */
+	once(type: keyof MapEventType | string, listener?: Listener): this | Promise<any>;
+	/**
+	 * Removes an event listener for events previously added with `Map#on`.
 	 *
+	 * @event
 	 * @param type - The event type previously used to install the listener.
-	 * @param layerIdOrListener - The layer ID or listener previously used to install the listener.
-	 * @param listener - (optional) The function previously installed as a listener.
+	 * @param layer - The layer ID or listener previously used to install the listener.
+	 * @param listener - The function previously installed as a listener.
 	 * @returns `this`
 	 */
-	off(type: keyof MapEventType | string, listener: Listener): this;
 	off<T extends keyof MapLayerEventType>(type: T, layer: string, listener: (ev: MapLayerEventType[T] & Object) => void): this;
+	/**
+	 * Overload of the `off` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The function previously installed as a listener.
+	 * @returns `this`
+	 */
 	off<T extends keyof MapEventType>(type: T, listener: (ev: MapEventType[T] & Object) => void): this;
+	/**
+	 * Overload of the `off` method that allows to listen to events without specifying a layer.
+	 * @event
+	 * @param type - The type of the event.
+	 * @param listener - The function previously installed as a listener.
+	 * @returns `this`
+	 */
+	off(type: keyof MapEventType | string, listener: Listener): this;
 	/**
 	 * Returns an array of MapGeoJSONFeature objects
 	 * representing visible features that satisfy the query parameters.
@@ -9144,11 +9200,14 @@ export declare class Map extends Camera {
 	/**
 	 * Adds a source to the map's style.
 	 *
+	 * Events triggered:
+	 *
+	 * Triggers the `source.add` event.
+	 *
 	 * @param id - The ID of the source to add. Must not conflict with existing sources.
 	 * @param source - The source object, conforming to the
-	 * MapLibre Style Specification's [source definition](https://maplibre.org/maplibre-style-spec/#sources) or
+	 * MapLibre Style Specification's [source definition](https://maplibre.org/maplibre-style-spec/sources) or
 	 * {@link CanvasSourceSpecification}.
-	 * @event `source.add`
 	 * @returns `this`
 	 * @example
 	 * ```ts
@@ -9181,6 +9240,8 @@ export declare class Map extends Camera {
 	 * Returns a Boolean indicating whether the source is loaded. Returns `true` if the source with
 	 * the given ID in the map's style has no outstanding network requests, otherwise `false`.
 	 *
+	 * A {@link ErrorEvent} event will be fired if there is no source wit the specified ID.
+	 *
 	 * @param id - The ID of the source to be checked.
 	 * @returns A Boolean indicating whether the source is loaded.
 	 * @example
@@ -9191,6 +9252,9 @@ export declare class Map extends Camera {
 	isSourceLoaded(id: string): boolean;
 	/**
 	 * Loads a 3D terrain mesh, based on a "raster-dem" source.
+	 *
+	 * Triggers the `terrain` event.
+	 *
 	 * @param options - Options object.
 	 * @returns `this`
 	 * @example
@@ -9264,11 +9328,12 @@ export declare class Map extends Camera {
 	/**
 	 * Add an image to the style. This image can be displayed on the map like any other icon in the style's
 	 * sprite using the image's ID with
-	 * [`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),
-	 * [`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),
-	 * [`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),
-	 * or [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).
-	 * A {@link ErrorEvent} event will be fired if there is not enough space in the sprite to add this image.
+	 * [`icon-image`](https://maplibre.org/maplibre-style-spec/layers/#layout-symbol-icon-image),
+	 * [`background-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-background-background-pattern),
+	 * [`fill-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-fill-fill-pattern),
+	 * or [`line-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-line-line-pattern).
+	 *
+	 * A {@link ErrorEvent} event will be fired if the image parameter is invalid or there is not enough space in the sprite to add this image.
 	 *
 	 * @param id - The ID of the image.
 	 * @param image - The image as an `HTMLImageElement`, `ImageData`, `ImageBitmap` or object with `width`, `height`, and `data`
@@ -9308,10 +9373,12 @@ export declare class Map extends Camera {
 	/**
 	 * Update an existing image in a style. This image can be displayed on the map like any other icon in the style's
 	 * sprite using the image's ID with
-	 * [`icon-image`](https://maplibre.org/maplibre-style-spec/#layout-symbol-icon-image),
-	 * [`background-pattern`](https://maplibre.org/maplibre-style-spec/#paint-background-background-pattern),
-	 * [`fill-pattern`](https://maplibre.org/maplibre-style-spec/#paint-fill-fill-pattern),
-	 * or [`line-pattern`](https://maplibre.org/maplibre-style-spec/#paint-line-line-pattern).
+	 * [`icon-image`](https://maplibre.org/maplibre-style-spec/layers/#layout-symbol-icon-image),
+	 * [`background-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-background-background-pattern),
+	 * [`fill-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-fill-fill-pattern),
+	 * or [`line-pattern`](https://maplibre.org/maplibre-style-spec/layers/#paint-line-line-pattern).
+	 *
+	 * An {@link ErrorEvent} will be fired if the image parameter is invald.
 	 *
 	 * @param id - The ID of the image.
 	 * @param image - The image as an `HTMLImageElement`, `ImageData`, `ImageBitmap` or object with `width`, `height`, and `data`
@@ -9348,6 +9415,8 @@ export declare class Map extends Camera {
 	 * in the style's original sprite and any images
 	 * that have been added at runtime using {@link Map#addImage}.
 	 *
+	 * An {@link ErrorEvent} will be fired if the image parameter is invald.
+	 *
 	 * @param id - The ID of the image.
 	 *
 	 * @returns A Boolean indicating whether the image exists.
@@ -9406,14 +9475,14 @@ export declare class Map extends Camera {
 	 */
 	listImages(): Array<string>;
 	/**
-	 * Adds a [MapLibre style layer](https://maplibre.org/maplibre-style-spec/#layers)
+	 * Adds a [MapLibre style layer](https://maplibre.org/maplibre-style-spec/layers)
 	 * to the map's style.
 	 *
 	 * A layer defines how data from a specified source will be styled. Read more about layer types
-	 * and available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#layers).
+	 * and available paint and layout properties in the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/layers).
 	 *
 	 * @param layer - The layer to add,
-	 * conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/#layers) or,
+	 * conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/layers) or,
 	 * less commonly, the {@link CustomLayerInterface} specification.
 	 * The MapLibre Style Specification's layer definition is appropriate for most layers.
 	 *
@@ -9506,10 +9575,9 @@ export declare class Map extends Camera {
 	/**
 	 * Removes the layer with the given ID from the map's style.
 	 *
-	 * If no such layer exists, an `error` event is fired.
+	 * An {@link ErrorEvent} will be fired if the image parameter is invald.
 	 *
 	 * @param id - The ID of the layer to remove
-	 * @event `error`
 	 * @returns `this`
 	 *
 	 * @example
@@ -9536,8 +9604,8 @@ export declare class Map extends Camera {
 	getLayer(id: string): StyleLayer;
 	/**
 	 * Sets the zoom extent for the specified style layer. The zoom extent includes the
-	 * [minimum zoom level](https://maplibre.org/maplibre-style-spec/#layer-minzoom)
-	 * and [maximum zoom level](https://maplibre.org/maplibre-style-spec/#layer-maxzoom))
+	 * [minimum zoom level](https://maplibre.org/maplibre-style-spec/layers/#minzoom)
+	 * and [maximum zoom level](https://maplibre.org/maplibre-style-spec/layers/#maxzoom))
 	 * at which the layer will be rendered.
 	 *
 	 * Note: For style layers using vector sources, style layers cannot be rendered at zoom levels lower than the
@@ -9664,12 +9732,11 @@ export declare class Map extends Camera {
 	 */
 	getGlyphs(): string | null;
 	/**
-	 * Adds a sprite to the map's style.
+	 * Adds a sprite to the map's style. Fires the `style` event.
 	 *
 	 * @param id - The ID of the sprite to add. Must not conflict with existing sprites.
 	 * @param url - The URL to load the sprite from
 	 * @param options - Options object.
-	 * @event `style`
 	 * @returns `this`
 	 * @example
 	 * ```ts
@@ -9678,10 +9745,9 @@ export declare class Map extends Camera {
 	 */
 	addSprite(id: string, url: string, options?: StyleSetterOptions): this;
 	/**
-	 * Removes the sprite from the map's style.
+	 * Removes the sprite from the map's style. Fires the `style` event.
 	 *
 	 * @param id - The ID of the sprite to remove. If the sprite is declared as a single URL, the ID must be "default".
-	 * @event `style`
 	 * @returns `this`
 	 * @example
 	 * ```ts
@@ -9714,7 +9780,7 @@ export declare class Map extends Camera {
 	/**
 	 * Sets the any combination of light values.
 	 *
-	 * @param light - Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/#light).
+	 * @param light - Light properties to set. Must conform to the [MapLibre Style Specification](https://maplibre.org/maplibre-style-spec/light).
 	 * @param options - Options object.
 	 * @returns `this`
 	 *
@@ -9894,6 +9960,7 @@ export declare class Map extends Camera {
 	/**
 	 * Update this map's style and sources, and re-render the map.
 	 *
+	 * @hidden
 	 * @param updateStyle - mark the map's style for reprocessing as
 	 * well as its sources
 	 * @returns `this`
@@ -9902,6 +9969,7 @@ export declare class Map extends Camera {
 	/**
 	 * Request that the given callback be executed during the next render
 	 * frame.  Schedule a render frame if one is not already scheduled.
+	 * @hidden
 	 * @returns An id that can be used to cancel the callback
 	 */
 	_requestRenderFrame(callback: () => void): TaskID;
@@ -9914,6 +9982,7 @@ export declare class Map extends Camera {
 	 * - A transition is in progress
 	 *
 	 * @param paintStartTimeStamp - The time when the animation frame began executing.
+	 * @hidden
 	 *
 	 * @returns `this`
 	 */
@@ -11166,19 +11235,6 @@ export declare class RasterTileSource extends Evented implements Source {
 export declare class RasterDEMTileSource extends RasterTileSource implements Source {
 	encoding: "mapbox" | "terrarium";
 	constructor(id: string, options: RasterDEMSourceSpecification, dispatcher: Dispatcher, eventedParent: Evented);
-	serialize(): {
-		type: string;
-		url: string;
-		tileSize: number;
-		tiles: string[];
-		bounds: [
-			number,
-			number,
-			number,
-			number
-		];
-		encoding: "terrarium" | "mapbox";
-	};
 	loadTile(tile: Tile, callback: Callback<void>): void;
 	_getNeighboringTiles(tileID: OverscaledTileID): {};
 	unloadTile(tile: Tile): void;