maplibre-gl 3.2.2 → 3.3.1

package/dist/maplibre-gl.d.ts

@@ -3,7 +3,7 @@
 import Point from '@mapbox/point-geometry';
 import TinySDF from '@mapbox/tiny-sdf';
 import { VectorTileFeature, VectorTileLayer } from '@mapbox/vector-tile';
-import { Color, CompositeExpression, Feature, FeatureFilter, FeatureState, FilterSpecification, Formatted, FormattedSection, GeoJSONSourceSpecification, GlobalProperties, ICanonicalTileID, IMercatorCoordinate, ImageSourceSpecification, InterpolationType, LayerSpecification, LightSpecification, Padding, PromoteIdSpecification, PropertyValueSpecification, RasterDEMSourceSpecification, RasterSourceSpecification, ResolvedImage, SourceExpression, SourceSpecification, SpriteSpecification, StylePropertyExpression, StylePropertySpecification, StyleSpecification, TerrainSpecification, TransitionSpecification, VectorSourceSpecification, VideoSourceSpecification } from '@maplibre/maplibre-gl-style-spec';
+import { Color, CompositeExpression, Feature, FeatureFilter, FeatureState, FilterSpecification, Formatted, FormattedSection, GeoJSONSourceSpecification, GlobalProperties, ICanonicalTileID, IMercatorCoordinate, ImageSourceSpecification, InterpolationType, LayerSpecification, LightSpecification, Padding, PromoteIdSpecification, PropertyValueSpecification, RasterDEMSourceSpecification, RasterSourceSpecification, ResolvedImage, SourceExpression, SourceSpecification, SpriteSpecification, StylePropertyExpression, StylePropertySpecification, StyleSpecification, TerrainSpecification, TransitionSpecification, VariableAnchorOffsetCollection, VectorSourceSpecification, VideoSourceSpecification } from '@maplibre/maplibre-gl-style-spec';
 import { mat2, mat4, vec4 } from 'gl-matrix';
 import KDBush from 'kdbush';
 import { PotpackBox } from 'potpack';
@@ -509,6 +509,7 @@ export declare class Layout<Props> {
 		[K in keyof Props]: PropertyValue<any, PossiblyEvaluatedPropertyValue<any>>;
 	};
 	constructor(properties: Properties<Props>);
+	hasValue<S extends keyof Props>(name: S): boolean;
 	getValue<S extends keyof Props>(name: S): any;
 	setValue<S extends keyof Props>(name: S, value: any): void;
 	serialize(): any;
@@ -791,7 +792,7 @@ export declare class StructArrayLayout2i2ui3ul3ui2f3ub1ul1i48 extends StructArra
 	emplaceBack(v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number): number;
 	emplace(i: number, v0: number, v1: number, v2: number, v3: number, v4: number, v5: number, v6: number, v7: number, v8: number, v9: number, v10: number, v11: number, v12: number, v13: number, v14: number, v15: number, v16: number): number;
 }
-export declare class StructArrayLayout8i15ui1ul4f68 extends StructArray {
+export declare class StructArrayLayout8i15ui1ul2f2ui64 extends StructArray {
 	uint8: Uint8Array;
 	int16: Int16Array;
 	uint16: Uint16Array;
@@ -808,6 +809,14 @@ export declare class StructArrayLayout1f4 extends StructArray {
 	emplaceBack(v0: number): number;
 	emplace(i: number, v0: number): number;
 }
+export declare class StructArrayLayout1ui2f12 extends StructArray {
+	uint8: Uint8Array;
+	uint16: Uint16Array;
+	float32: Float32Array;
+	_refreshViews(): void;
+	emplaceBack(v0: number, v1: number, v2: number): number;
+	emplace(i: number, v0: number, v1: number, v2: number): number;
+}
 export declare class StructArrayLayout1ul2ui8 extends StructArray {
 	uint8: Uint8Array;
 	uint32: Uint32Array;
@@ -908,12 +917,12 @@ export declare class SymbolInstanceStruct extends Struct {
 	get crossTileID(): number;
 	set crossTileID(x: number);
 	get textBoxScale(): number;
-	get textOffset0(): number;
-	get textOffset1(): number;
 	get collisionCircleDiameter(): number;
+	get textAnchorOffsetStartIndex(): number;
+	get textAnchorOffsetEndIndex(): number;
 }
 export type SymbolInstance = SymbolInstanceStruct;
-export declare class SymbolInstanceArray extends StructArrayLayout8i15ui1ul4f68 {
+export declare class SymbolInstanceArray extends StructArrayLayout8i15ui1ul2f2ui64 {
 	/**
 	 * Return the SymbolInstanceStruct at the given location in the array.
 	 * @param index The index of the element.
@@ -928,6 +937,20 @@ export declare class SymbolLineVertexArray extends StructArrayLayout3i6 {
 	gety(index: number): number;
 	gettileUnitDistanceFromAnchor(index: number): number;
 }
+export declare class TextAnchorOffsetStruct extends Struct {
+	_structArray: TextAnchorOffsetArray;
+	get textAnchor(): number;
+	get textOffset0(): number;
+	get textOffset1(): number;
+}
+export type TextAnchorOffset = TextAnchorOffsetStruct;
+export declare class TextAnchorOffsetArray extends StructArrayLayout1ui2f12 {
+	/**
+	 * Return the TextAnchorOffsetStruct at the given location in the array.
+	 * @param index The index of the element.
+	 */
+	get(index: number): TextAnchorOffsetStruct;
+}
 export declare class FeatureIndexStruct extends Struct {
 	_structArray: FeatureIndexArray;
 	get featureIndex(): number;
@@ -2779,6 +2802,7 @@ export type SymbolLayoutProps = {
 	"text-justify": DataDrivenProperty<"auto" | "left" | "center" | "right">;
 	"text-radial-offset": DataDrivenProperty<number>;
 	"text-variable-anchor": DataConstantProperty<Array<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">>;
+	"text-variable-anchor-offset": DataDrivenProperty<VariableAnchorOffsetCollection>;
 	"text-anchor": DataDrivenProperty<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">;
 	"text-max-angle": DataConstantProperty<number>;
 	"text-writing-mode": DataConstantProperty<Array<"horizontal" | "vertical">>;
@@ -2835,6 +2859,7 @@ export type SymbolLayoutPropsPossiblyEvaluated = {
 	"text-justify": PossiblyEvaluatedPropertyValue<"auto" | "left" | "center" | "right">;
 	"text-radial-offset": PossiblyEvaluatedPropertyValue<number>;
 	"text-variable-anchor": Array<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">;
+	"text-variable-anchor-offset": PossiblyEvaluatedPropertyValue<VariableAnchorOffsetCollection>;
 	"text-anchor": PossiblyEvaluatedPropertyValue<"center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right">;
 	"text-max-angle": number;
 	"text-writing-mode": Array<"horizontal" | "vertical">;
@@ -3058,6 +3083,7 @@ export declare class SymbolBucket implements Bucket {
 	lineVertexArray: SymbolLineVertexArray;
 	features: Array<SymbolFeature>;
 	symbolInstances: SymbolInstanceArray;
+	textAnchorOffsets: TextAnchorOffsetArray;
 	collisionArrays: Array<CollisionArrays>;
 	sortKeyRanges: Array<SortKeyRange>;
 	pixelRatio: number;
@@ -5127,7 +5153,18 @@ export declare class CollisionIndex {
 	isInsideGrid(x1: number, y1: number, x2: number, y2: number): boolean;
 	getViewportMatrix(): mat4;
 }
-export type TextAnchor = "center" | "left" | "right" | "top" | "bottom" | "top-left" | "top-right" | "bottom-left" | "bottom-right";
+declare enum TextAnchorEnum {
+	"center" = 1,
+	"left" = 2,
+	"right" = 3,
+	"top" = 4,
+	"bottom" = 5,
+	"top-left" = 6,
+	"top-right" = 7,
+	"bottom-left" = 8,
+	"bottom-right" = 9
+}
+export type TextAnchor = keyof typeof TextAnchorEnum;
 export declare class OpacityState {
 	opacity: number;
 	placed: boolean;
@@ -5240,7 +5277,7 @@ export declare class Placement {
 	};
 	constructor(transform: Transform, terrain: Terrain, 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, textOverlapMode: OverlapMode, symbolInstance: SymbolInstance, bucket: SymbolBucket, orientation: number, iconBox?: SingleCollisionBox | null, getElevation?: (x: number, y: number) => number): {
+	attemptAnchorPlacement(textAnchorOffset: TextAnchorOffset, 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, getElevation?: (x: number, y: number) => number): {
 		shift: Point;
 		placedGlyphBoxes: {
 			box: Array<number>;
@@ -5451,6 +5488,13 @@ export type StyleSwapOptions = {
 	 */
 	transformStyle?: TransformStyleFunction;
 };
+/**
+ * Specifies a layer to be added to a {@link Style}. In addition to a standard {@link LayerSpecification}
+ * or a {@link CustomLayerInterface}, a {@link LayerSpecification} with an embedded {@link SourceSpecification} can also be provided.
+ */
+export type AddLayerObject = LayerSpecification | (Omit<LayerSpecification, "source"> & {
+	source: SourceSpecification;
+}) | CustomLayerInterface;
 export declare class Style extends Evented {
 	map: Map;
 	stylesheet: StyleSpecification;
@@ -5577,7 +5621,7 @@ export declare class Style extends Evented {
 	 * @param options - Style setter options.
 	 * @returns `this`.
 	 */
-	addLayer(layerObject: LayerSpecification | CustomLayerInterface, before?: string, options?: StyleSetterOptions): this;
+	addLayer(layerObject: AddLayerObject, before?: string, options?: StyleSetterOptions): this;
 	/**
 	 * Moves a layer to a different z-position. The layer will be inserted before the layer with
 	 * ID `before`, or appended if `before` is omitted.
@@ -5600,7 +5644,7 @@ export declare class Style extends Evented {
 	 * @param id - id of the desired layer
 	 * @returns a layer, if one with the given `id` exists
 	 */
-	getLayer(id: string): StyleLayer;
+	getLayer(id: string): StyleLayer | undefined;
 	/**
 	 * checks if a specific layer is present within the style.
 	 *
@@ -9280,7 +9324,7 @@ export declare class Map extends Camera {
 	 * map.setTerrain({ source: 'terrain' });
 	 * ```
 	 */
-	setTerrain(options: TerrainSpecification): this;
+	setTerrain(options: TerrainSpecification | null): this;
 	/**
 	 * Get the terrain-options if terrain is loaded
 	 * @returns the TerrainSpecification passed to setTerrain
@@ -9289,7 +9333,7 @@ export declare class Map extends Camera {
 	 * map.getTerrain(); // { source: 'terrain' };
 	 * ```
 	 */
-	getTerrain(): TerrainSpecification;
+	getTerrain(): TerrainSpecification | null;
 	/**
 	 * Returns a Boolean indicating whether all tiles in the viewport from all sources on
 	 * the style are loaded.
@@ -9501,7 +9545,7 @@ export declare class Map extends Camera {
 	 *
 	 * @param layer - The layer to add,
 	 * conforming to either the MapLibre Style Specification's [layer definition](https://maplibre.org/maplibre-style-spec/layers) or,
-	 * less commonly, the {@link CustomLayerInterface} specification.
+	 * less commonly, the {@link CustomLayerInterface} specification. Can also be a layer definition with an embedded source definition.
 	 * The MapLibre Style Specification's layer definition is appropriate for most layers.
 	 *
 	 * @param beforeId - The ID of an existing layer to insert the new layer before,
@@ -9573,9 +9617,7 @@ export declare class Map extends Camera {
 	 * @see [Add a vector tile source](https://maplibre.org/maplibre-gl-js/docs/examples/vector-source/)
 	 * @see [Add a WMS source](https://maplibre.org/maplibre-gl-js/docs/examples/wms/)
 	 */
-	addLayer(layer: (LayerSpecification & {
-		source?: string | SourceSpecification;
-	}) | CustomLayerInterface, beforeId?: string): this;
+	addLayer(layer: AddLayerObject, beforeId?: string): this;
 	/**
 	 * Moves a layer to a different z-position.
 	 *
@@ -9619,7 +9661,7 @@ export declare class Map extends Camera {
 	 * @see [Filter symbols by toggling a list](https://maplibre.org/maplibre-gl-js/docs/examples/filter-markers/)
 	 * @see [Filter symbols by text input](https://maplibre.org/maplibre-gl-js/docs/examples/filter-markers-by-input/)
 	 */
-	getLayer(id: string): StyleLayer;
+	getLayer(id: string): StyleLayer | undefined;
 	/**
 	 * Sets the zoom extent for the specified style layer. The zoom extent includes the
 	 * [minimum zoom level](https://maplibre.org/maplibre-style-spec/layers/#minzoom)