maplibre-gl 2.0.2 → 2.1.0

package/dist/maplibre-gl.d.ts

@@ -1,27 +1,8 @@
-    import type Pbf from 'pbf';
-    export class VectorTileLayer {
-        version?: number;
-        name: string;
-        extent: number;
-        length: number;
-        feature(i: number): VectorTileFeature;
-    }
-    export class VectorTile {
-        constructor(pbf: Pbf);
-        layers: {[_: string]: VectorTileLayer};
-    }
-    export class VectorTileFeature {
-        static types: ['Unknown', 'Point', 'LineString', 'Polygon'];
-        extent: number;
-        type: 1 | 2 | 3;
-        id: number;
-        properties: {[_: string]: string | number | boolean};
-        loadGeometry(): Array<Array<Point>>;
-        toGeoJSON(x: number, y: number, z: number): GeoJSON.Feature;
-    }
-// Generated by dts-bundle-generator v6.1.0
+// Generated by dts-bundle-generator v6.4.0
 
+import Point from '@mapbox/point-geometry';
 import TinySDF from '@mapbox/tiny-sdf';
+import { VectorTileFeature, VectorTileLayer } from '@mapbox/vector-tile';
 import { mat2, mat4 } from 'gl-matrix';
 import { PotpackBox } from 'potpack';
 
@@ -579,6 +560,7 @@ export declare type SymbolLayerSpecification = {
 		"symbol-sort-key"?: DataDrivenPropertyValueSpecification<number>;
 		"symbol-z-order"?: PropertyValueSpecification<"auto" | "viewport-y" | "source">;
 		"icon-allow-overlap"?: PropertyValueSpecification<boolean>;
+		"icon-overlap"?: PropertyValueSpecification<"never" | "always" | "cooperative">;
 		"icon-ignore-placement"?: PropertyValueSpecification<boolean>;
 		"icon-optional"?: PropertyValueSpecification<boolean>;
 		"icon-rotation-alignment"?: PropertyValueSpecification<"map" | "viewport" | "auto">;
@@ -623,6 +605,7 @@ export declare type SymbolLayerSpecification = {
 			number
 		]>;
 		"text-allow-overlap"?: PropertyValueSpecification<boolean>;
+		"text-overlap"?: PropertyValueSpecification<"never" | "always" | "cooperative">;
 		"text-ignore-placement"?: PropertyValueSpecification<boolean>;
 		"text-optional"?: PropertyValueSpecification<boolean>;
 		"visibility"?: "visible" | "none";
@@ -802,187 +785,6 @@ export declare class EvaluationParameters {
 	crossFadingFactor(): number;
 	getCrossfadeParameters(): CrossfadeParameters;
 }
-/**
- * A {@link Point} or an array of two numbers representing `x` and `y` screen coordinates in pixels.
- *
- * @typedef {(Point | [number, number])} PointLike
- * @example
- * var p1 = new maplibregl.Point(-77, 38); // a PointLike which is a Point
- * var p2 = [-77, 38]; // a PointLike which is an array of two numbers
- */
-export declare type PointLike = Point | [
-	number,
-	number
-];
-export declare class Point {
-	x: number;
-	y: number;
-	constructor(x: number, y: number);
-	/**
-	 * Clone this point, returning a new point that can be modified
-	 * without affecting the old one.
-	 * @returns {Point} the clone
-	 */
-	clone(): Point;
-	/**
-	 * Add this point's x & y coordinates to another point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	add(p: any): Point;
-	/**
-	 * Subtract this point's x & y coordinates to from point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	sub(p: any): Point;
-	/**
-	 * Multiply this point's x & y coordinates by point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	multByPoint(p: any): Point;
-	/**
-	 * Divide this point's x & y coordinates by point,
-	 * yielding a new point.
-	 * @param {Point} p the other point
-	 * @returns {Point} output point
-	 */
-	divByPoint(p: any): Point;
-	/**
-	 * Multiply this point's x & y coordinates by a factor,
-	 * yielding a new point.
-	 * @param {Point} k factor
-	 * @returns {Point} output point
-	 */
-	mult(k: any): Point;
-	/**
-	 * Divide this point's x & y coordinates by a factor,
-	 * yielding a new point.
-	 * @param {Point} k factor
-	 * @returns {Point} output point
-	 */
-	div(k: any): Point;
-	/**
-	 * Rotate this point around the 0, 0 origin by an angle a,
-	 * given in radians
-	 * @param {Number} a angle to rotate around, in radians
-	 * @returns {Point} output point
-	 */
-	rotate(a: any): Point;
-	/**
-	 * Rotate this point around p point by an angle a,
-	 * given in radians
-	 * @param {Number} a angle to rotate around, in radians
-	 * @param {Point} p Point to rotate around
-	 * @returns {Point} output point
-	 */
-	rotateAround(a: any, p: any): Point;
-	/**
-	 * Multiply this point by a 4x1 transformation matrix
-	 * @param {Array<Number>} m transformation matrix
-	 * @returns {Point} output point
-	 */
-	matMult(m: any): Point;
-	/**
-	 * Calculate this point but as a unit vector from 0, 0, meaning
-	 * that the distance from the resulting point to the 0, 0
-	 * coordinate will be equal to 1 and the angle from the resulting
-	 * point to the 0, 0 coordinate will be the same as before.
-	 * @returns {Point} unit vector point
-	 */
-	unit(): Point;
-	/**
-	 * Compute a perpendicular point, where the new y coordinate
-	 * is the old x coordinate and the new x coordinate is the old y
-	 * coordinate multiplied by -1
-	 * @returns {Point} perpendicular point
-	 */
-	perp(): Point;
-	/**
-	 * Return a version of this point with the x & y coordinates
-	 * rounded to integers.
-	 * @returns {Point} rounded point
-	 */
-	round(): Point;
-	/**
-	 * Return the magitude of this point: this is the Euclidean
-	 * distance from the 0, 0 coordinate to this point's x and y
-	 * coordinates.
-	 * @returns {Number} magnitude
-	 */
-	mag(): number;
-	/**
-	 * Judge whether this point is equal to another point, returning
-	 * true or false.
-	 * @param {Point} other the other point
-	 * @returns {boolean} whether the points are equal
-	 */
-	equals(other: any): boolean;
-	/**
-	 * Calculate the distance from this point to another point
-	 * @param {Point} p the other point
-	 * @returns {Number} distance
-	 */
-	dist(p: any): number;
-	/**
-	 * Calculate the distance from this point to another point,
-	 * without the square root step. Useful if you're comparing
-	 * relative distances.
-	 * @param {Point} p the other point
-	 * @returns {Number} distance
-	 */
-	distSqr(p: any): number;
-	/**
-	 * Get the angle from the 0, 0 coordinate to this point, in radians
-	 * coordinates.
-	 * @returns {Number} angle
-	 */
-	angle(): number;
-	/**
-	 * Get the angle from this point to another point, in radians
-	 * @param {Point} b the other point
-	 * @returns {Number} angle
-	 */
-	angleTo(b: any): number;
-	/**
-	 * Get the angle between this point and another point, in radians
-	 * @param {Point} b the other point
-	 * @returns {Number} angle
-	 */
-	angleWith(b: any): number;
-	angleWithSep(x: any, y: any): number;
-	_matMult(m: any): this;
-	_add(p: any): this;
-	_sub(p: any): this;
-	_mult(k: any): this;
-	_div(k: any): this;
-	_multByPoint(p: any): this;
-	_divByPoint(p: any): this;
-	_unit(): this;
-	_perp(): this;
-	_rotate(angle: any): this;
-	_rotateAround(angle: any, p: any): this;
-	_round(): this;
-	/**
-	 * Construct a point from an array if necessary, otherwise if the input
-	 * is already a Point, or an unknown type, return it unchanged
-	 * @param {Array<Number>|Point|*} a any kind of input value
-	 * @returns {Point} constructed point, or passed-through value.
-	 * @example
-	 * // this
-	 * var point = Point.convert([0, 1]);
-	 * // is equivalent to
-	 * var point = new Point(0, 1);
-	 */
-	static convert(a: PointLike | {
-		x: number;
-		y: number;
-	}): Point;
-}
 export declare class LngLatBounds {
 	_ne: LngLat;
 	_sw: LngLat;
@@ -1285,7 +1087,7 @@ export declare class CanonicalTileID {
 	key: string;
 	constructor(z: number, x: number, y: number);
 	equals(id: CanonicalTileID): boolean;
-	url(urls: Array<string>, scheme?: string | null): string;
+	url(urls: Array<string>, pixelRatio: number, scheme?: string | null): string;
 	getTilePoint(coord: MercatorCoordinate): Point;
 	toString(): string;
 }
@@ -4166,6 +3968,7 @@ export declare type SymbolLayoutProps = {
 	"symbol-sort-key": DataDrivenProperty<number>;
 	"symbol-z-order": DataConstantProperty<"auto" | "viewport-y" | "source">;
 	"icon-allow-overlap": DataConstantProperty<boolean>;
+	"icon-overlap": DataConstantProperty<"never" | "always" | "cooperative">;
 	"icon-ignore-placement": DataConstantProperty<boolean>;
 	"icon-optional": DataConstantProperty<boolean>;
 	"icon-rotation-alignment": DataConstantProperty<"map" | "viewport" | "auto">;
@@ -4210,6 +4013,7 @@ export declare type SymbolLayoutProps = {
 		number
 	]>;
 	"text-allow-overlap": DataConstantProperty<boolean>;
+	"text-overlap": DataConstantProperty<"never" | "always" | "cooperative">;
 	"text-ignore-placement": DataConstantProperty<boolean>;
 	"text-optional": DataConstantProperty<boolean>;
 };
@@ -4220,6 +4024,7 @@ export declare type SymbolLayoutPropsPossiblyEvaluated = {
 	"symbol-sort-key": PossiblyEvaluatedPropertyValue<number>;
 	"symbol-z-order": "auto" | "viewport-y" | "source";
 	"icon-allow-overlap": boolean;
+	"icon-overlap": "never" | "always" | "cooperative";
 	"icon-ignore-placement": boolean;
 	"icon-optional": boolean;
 	"icon-rotation-alignment": "map" | "viewport" | "auto";
@@ -4264,6 +4069,7 @@ export declare type SymbolLayoutPropsPossiblyEvaluated = {
 		number
 	]>;
 	"text-allow-overlap": boolean;
+	"text-overlap": "never" | "always" | "cooperative";
 	"text-ignore-placement": boolean;
 	"text-optional": boolean;
 };
@@ -4327,6 +4133,7 @@ export declare class SymbolStyleLayer extends StyleLayer {
 	_handleOverridablePaintPropertyUpdate<T, R>(name: string, oldValue: PropertyValue<T, R>, newValue: PropertyValue<T, R>): boolean;
 	static hasPaintOverride(layout: PossiblyEvaluated<SymbolLayoutProps, SymbolLayoutPropsPossiblyEvaluated>, propertyName: string): boolean;
 }
+export declare type OverlapMode = "never" | "always" | "cooperative";
 export declare type TypedStyleLayer = CircleStyleLayer | FillStyleLayer | FillExtrusionStyleLayer | HeatmapStyleLayer | HillshadeStyleLayer | LineStyleLayer | SymbolStyleLayer;
 export declare type BucketParameters<Layer extends TypedStyleLayer> = {
 	index: number;
@@ -6289,7 +6096,10 @@ export declare type QueryResult<T> = {
 	x2: number;
 	y2: number;
 };
-export declare class GridIndex<T> {
+export declare type GridKey = {
+	overlapMode?: OverlapMode;
+};
+export declare class GridIndex<T extends GridKey> {
 	circleKeys: Array<T>;
 	boxKeys: Array<T>;
 	boxCells: Array<Array<number>>;
@@ -6312,8 +6122,8 @@ export declare class GridIndex<T> {
 	private _insertCircleCell;
 	private _query;
 	query(x1: number, y1: number, x2: number, y2: number): Array<QueryResult<T>>;
-	hitTest(x1: number, y1: number, x2: number, y2: number, predicate?: (key: T) => boolean): boolean;
-	hitTestCircle(x: number, y: number, radius: number, predicate?: (key: T) => boolean): boolean;
+	hitTest(x1: number, y1: number, x2: number, y2: number, overlapMode: OverlapMode, predicate?: (key: T) => boolean): boolean;
+	hitTestCircle(x: number, y: number, radius: number, overlapMode: OverlapMode, predicate?: (key: T) => boolean): boolean;
 	private _queryCell;
 	private _queryCellCircle;
 	private _forEachCell;
@@ -6326,6 +6136,7 @@ export declare type FeatureKey = {
 	bucketInstanceId: number;
 	featureIndex: number;
 	collisionGroupID: number;
+	overlapMode: OverlapMode;
 };
 export declare class CollisionIndex {
 	grid: GridIndex<FeatureKey>;
@@ -6337,11 +6148,11 @@ export declare class CollisionIndex {
 	gridRightBoundary: number;
 	gridBottomBoundary: number;
 	constructor(transform: Transform, grid?: GridIndex<FeatureKey>, ignoredGrid?: GridIndex<FeatureKey>);
-	placeCollisionBox(collisionBox: SingleCollisionBox, allowOverlap: boolean, textPixelRatio: number, posMatrix: mat4, collisionGroupPredicate?: (key: FeatureKey) => boolean): {
+	placeCollisionBox(collisionBox: SingleCollisionBox, overlapMode: OverlapMode, textPixelRatio: number, posMatrix: mat4, collisionGroupPredicate?: (key: FeatureKey) => boolean): {
 		box: Array<number>;
 		offscreen: boolean;
 	};
-	placeCollisionCircles(allowOverlap: boolean, symbol: any, lineVertexArray: SymbolLineVertexArray, glyphOffsetArray: GlyphOffsetArray, fontSize: number, posMatrix: mat4, labelPlaneMatrix: mat4, labelToScreenMatrix: mat4, showCollisionCircles: boolean, pitchWithMap: boolean, collisionGroupPredicate: (key: FeatureKey) => boolean, circlePixelDiameter: number, textPixelPadding: number): {
+	placeCollisionCircles(overlapMode: OverlapMode, symbol: any, lineVertexArray: SymbolLineVertexArray, glyphOffsetArray: GlyphOffsetArray, fontSize: number, posMatrix: mat4, labelPlaneMatrix: mat4, labelToScreenMatrix: mat4, showCollisionCircles: boolean, pitchWithMap: boolean, collisionGroupPredicate: (key: FeatureKey) => boolean, circlePixelDiameter: number, textPixelPadding: number): {
 		circles: Array<number>;
 		offscreen: boolean;
 		collisionDetected: boolean;
@@ -6354,8 +6165,8 @@ export declare class CollisionIndex {
 	 * @private
 	 */
 	queryRenderedSymbols(viewportQueryGeometry: Array<Point>): {};
-	insertCollisionBox(collisionBox: Array<number>, ignorePlacement: boolean, bucketInstanceId: number, featureIndex: number, collisionGroupID: number): void;
-	insertCollisionCircles(collisionCircles: Array<number>, ignorePlacement: boolean, bucketInstanceId: number, featureIndex: number, collisionGroupID: number): void;
+	insertCollisionBox(collisionBox: Array<number>, overlapMode: OverlapMode, ignorePlacement: boolean, bucketInstanceId: number, featureIndex: number, collisionGroupID: number): void;
+	insertCollisionCircles(collisionCircles: Array<number>, overlapMode: OverlapMode, ignorePlacement: boolean, bucketInstanceId: number, featureIndex: number, collisionGroupID: number): void;
 	projectAndGetPerspectiveRatio(posMatrix: mat4, x: number, y: number): {
 		point: Point;
 		perspectiveRatio: number;
@@ -6400,7 +6211,7 @@ export declare class RetainedQueryData {
 }
 export declare type CollisionGroup = {
 	ID: number;
-	predicate?: any;
+	predicate?: (key: FeatureKey) => boolean;
 };
 export declare class CollisionGroups {
 	collisionGroups: {
@@ -6476,7 +6287,7 @@ export declare class Placement {
 	};
 	constructor(transform: Transform, fadeDuration: number, crossSourceCollisions: boolean, prevPlacement?: Placement);
 	getBucketParts(results: Array<BucketPart>, styleLayer: StyleLayer, tile: Tile, sortAcrossTiles: boolean): void;
-	attemptAnchorPlacement(anchor: TextAnchor, textBox: SingleCollisionBox, width: number, height: number, textBoxScale: number, rotateWithMap: boolean, pitchWithMap: boolean, textPixelRatio: number, posMatrix: mat4, collisionGroup: CollisionGroup, textAllowOverlap: boolean, symbolInstance: SymbolInstance, bucket: SymbolBucket, orientation: number, iconBox?: SingleCollisionBox | null): {
+	attemptAnchorPlacement(anchor: TextAnchor, textBox: SingleCollisionBox, width: number, height: number, textBoxScale: number, rotateWithMap: boolean, pitchWithMap: boolean, textPixelRatio: number, posMatrix: mat4, collisionGroup: CollisionGroup, textOverlapMode: OverlapMode, symbolInstance: SymbolInstance, bucket: SymbolBucket, orientation: number, iconBox?: SingleCollisionBox | null): {
 		shift: Point;
 		placedGlyphBoxes: {
 			box: Array<number>;
@@ -6840,6 +6651,7 @@ export declare class Painter {
 	emptyProgramConfiguration: ProgramConfiguration;
 	width: number;
 	height: number;
+	pixelRatio: number;
 	tileExtentBuffer: VertexBuffer;
 	tileExtentSegments: SegmentVector;
 	debugBuffer: VertexBuffer;
@@ -6879,7 +6691,7 @@ export declare class Painter {
 	debugOverlayTexture: Texture;
 	debugOverlayCanvas: HTMLCanvasElement;
 	constructor(gl: WebGLRenderingContext, transform: Transform);
-	resize(width: number, height: number): void;
+	resize(width: number, height: number, pixelRatio: number): void;
 	setup(): void;
 	clearStencil(): void;
 	_renderTileClippingMasks(layer: StyleLayer, tileIDs: Array<OverscaledTileID>): void;
@@ -7193,6 +7005,18 @@ export declare class TaskQueue {
 	run(timeStamp?: number): void;
 	clear(): void;
 }
+/**
+ * A [Point](https://github.com/mapbox/point-geometry) or an array of two numbers representing `x` and `y` screen coordinates in pixels.
+ *
+ * @typedef {(Point | [number, number])} PointLike
+ * @example
+ * var p1 = new Point(-77, 38); // a PointLike which is a Point
+ * var p2 = [-77, 38]; // a PointLike which is an array of two numbers
+ */
+export declare type PointLike = Point | [
+	number,
+	number
+];
 export declare type RequireAtLeastOne<T> = {
 	[K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
@@ -7614,7 +7438,7 @@ declare abstract class Camera extends Evented {
 	 * @memberof Map#
 	 * @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 {Object} [options] Options supports all properties from {@link AnimationOptions} and {@link CameraOptions} in addition to the fields below.
+	 * @param {FitBoundsOptions} [options] Options supports all properties from {@link AnimationOptions} and {@link CameraOptions} in addition to the fields below.
 	 * @param {number | PaddingOptions} [options.padding] The amount of padding in pixels to add to the given bounds.
 	 * @param {boolean} [options.linear=false] If `true`, the map transitions using
 	 *     {@link Map#easeTo}. If `false`, the map transitions using {@link Map#flyTo}. See
@@ -7741,7 +7565,7 @@ declare abstract class Camera extends Evented {
 	 * unless 'options' includes `essential: true`.
 	 *
 	 * @memberof Map#
-	 * @param {Object} options Options describing the destination and animation of the transition.
+	 * @param {FlyToOptions} options Options describing the destination and animation of the transition.
 	 *     Accepts {@link CameraOptions}, {@link AnimationOptions},
 	 *     and the following additional options.
 	 * @param {number} [options.curve=1.42] The zooming "curve" that will occur along the
@@ -8443,6 +8267,7 @@ export declare type MapOptions = {
 	localIdeographFontFamily?: string;
 	style: StyleSpecification | string;
 	pitchWithRotate?: boolean;
+	pixelRatio?: number;
 };
 export declare type Complete<T> = {
 	[P in keyof Required<T>]: Pick<T, P> extends Required<Pick<T, P>> ? T[P] : (T[P] | undefined);
@@ -8492,6 +8317,7 @@ export declare class Map extends Camera {
 	_locale: any;
 	_removed: boolean;
 	_clickTolerance: number;
+	_pixelRatio: number;
 	/**
 	 * The map's {@link ScrollZoomHandler}, which implements zooming in and out with a scroll wheel or trackpad.
 	 * Find more details and examples using `scrollZoom` in the {@link ScrollZoomHandler} section.
@@ -8595,6 +8421,18 @@ export declare class Map extends Camera {
 	 * if (mapDiv.style.visibility === true) map.resize();
 	 */
 	resize(eventData?: any): this;
+	/**
+	 * Returns the map's pixel ratio.
+	 * @returns {number} The pixel ratio.
+	 */
+	getPixelRatio(): number;
+	/**
+	 * Sets the map's pixel ratio. This allows to override `devicePixelRatio`.
+	 * After this call, the canvas' `width` attribute will be `container.clientWidth * pixelRatio`
+	 * and its height attribute will be `container.clientHeight * pixelRatio`.
+	 * @param pixelRatio {number} The pixel ratio.
+	 */
+	setPixelRatio(pixelRatio: number): void;
 	/**
 	 * Returns the map's geographical bounds. When the bearing or pitch is non-zero, the visible region is not
 	 * an axis-aligned rectangle, and the result is the smallest bounds that encompasses the visible region.
@@ -8738,11 +8576,11 @@ export declare class Map extends Camera {
 	 */
 	setRenderWorldCopies(renderWorldCopies?: boolean | null): this;
 	/**
-	 * Returns a {@link Point} representing pixel coordinates, relative to the map's `container`,
+	 * Returns a [Point](https://github.com/mapbox/point-geometry) representing pixel coordinates, relative to the map's `container`,
 	 * that correspond to the specified geographical location.
 	 *
 	 * @param {LngLatLike} lnglat The geographical location to project.
-	 * @returns {Point} The {@link Point} corresponding to `lnglat`, relative to the map's `container`.
+	 * @returns {Point} The [Point](https://github.com/mapbox/point-geometry) corresponding to `lnglat`, relative to the map's `container`.
 	 * @example
 	 * var coordinate = [-122.420679, 37.772537];
 	 * var point = map.project(coordinate);
@@ -9792,7 +9630,7 @@ export declare class Map extends Camera {
 	getCanvas(): HTMLCanvasElement;
 	_containerDimensions(): number[];
 	_setupContainer(): void;
-	_resizeCanvas(width: number, height: number): void;
+	_resizeCanvas(width: number, height: number, pixelRatio: number): void;
 	_setupPainter(): void;
 	_contextLost(event: any): void;
 	_contextRestored(event: any): void;