@mapbox/mapbox-gl-style-spec 14.7.0 → 14.8.0-beta.1

package/dist/index.cjs

@@ -250,6 +250,10 @@
   };
   var featureset = {
   	experimental: true,
+  	metadata: {
+  		type: "*",
+  		doc: "Arbitrary properties useful to track with the stylesheet, but do not influence rendering. Properties should be prefixed to avoid collisions, like 'mapbox:'."
+  	},
   	selectors: {
   		type: "array",
   		value: "selector",
@@ -1283,7 +1287,6 @@
   			},
   			clip: {
   				doc: "Layer that removes 3D content from map.",
-  				experimental: true,
   				"sdk-support": {
   					"basic functionality": {
   						js: "3.5.0",
@@ -1824,7 +1827,11 @@
   	"line-z-offset": {
   		type: "number",
   		experimental: true,
-  		doc: "Vertical offset from ground, in meters. Defaults to 0. Not supported for globe projection at the moment.",
+  		doc: "Vertical offset from ground, in meters. Defaults to 0. This is an experimental property with some known issues:\n * Not supported for globe projection at the moment \n * Elevated line discontinuity is possible on tile borders with terrain enabled \n * Rendering artifacts can happen near line joins and line caps depending on the line styling \n * Rendering artifacts relating to `line-opacity` and `line-blur` \n * Elevated line visibility is determined by layer order \n * Z-fighting issues can happen with intersecting elevated lines \n * Elevated lines don't cast shadows",
+  		"default": 0,
+  		requires: [
+  			"line-elevation-reference"
+  		],
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.5.0",
@@ -1847,6 +1854,57 @@
   		},
   		"property-type": "data-driven"
   	},
+  	"line-elevation-reference": {
+  		type: "enum",
+  		doc: "Selects the base of line-elevation. Some modes might require precomputed elevation data in the tileset.",
+  		values: {
+  			none: {
+  				doc: "Elevated rendering is disabled."
+  			},
+  			sea: {
+  				doc: "Elevated rendering is enabled. Use this mode to elevate lines relative to the sea level."
+  			},
+  			ground: {
+  				doc: "Elevated rendering is enabled. Use this mode to elevate lines relative to the ground's height below them."
+  			},
+  			"hd-road-markup": {
+  				doc: "Elevated rendering is enabled. Use this mode to describe additive and stackable features that should exist only on top of road polygons."
+  			}
+  		},
+  		"default": "none",
+  		experimental: true,
+  		transition: false,
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.9.0",
+  				ios: "11.9.0"
+  			}
+  		},
+  		expression: {
+  			interpolated: false
+  		},
+  		"property-type": "data-constant"
+  	},
+  	"line-cross-slope": {
+  		type: "number",
+  		experimental: true,
+  		doc: "Defines the slope of an elevated line. A value of 0 creates a horizontal line. A value of 1 creates a vertical line. Other values are currently not supported. If undefined, the line follows the terrain slope. This is an experimental property with some known issues:\n * Vertical lines don't support line caps \n * `line-join: round` is not supported with this property",
+  		requires: [
+  			"line-z-offset"
+  		],
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.9.0",
+  				ios: "11.9.0"
+  			}
+  		},
+  		expression: {
+  			interpolated: false
+  		},
+  		"property-type": "constant"
+  	},
   	visibility: {
   		type: "enum",
   		values: {
@@ -2178,6 +2236,31 @@
   		},
   		"property-type": "data-driven"
   	},
+  	"icon-size-scale-range": {
+  		type: "array",
+  		value: "number",
+  		length: 2,
+  		"default": [
+  			0.8,
+  			2
+  		],
+  		doc: "Defines the minimum and maximum scaling factors for icon related properties like `icon-size`, `icon-halo-width`, `icon-halo-blur`",
+  		minimum: 0.1,
+  		maximum: 10,
+  		experimental: true,
+  		"private": true,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		},
+  		"property-type": "data-constant"
+  	},
   	"icon-text-fit": {
   		type: "enum",
   		values: {
@@ -2667,6 +2750,31 @@
   		},
   		"property-type": "data-driven"
   	},
+  	"text-size-scale-range": {
+  		type: "array",
+  		value: "number",
+  		length: 2,
+  		"default": [
+  			0.8,
+  			2
+  		],
+  		doc: "Defines the minimum and maximum scaling factors for text related properties like `text-size`, `text-max-width`, `text-halo-width`, `font-size`",
+  		minimum: 0.1,
+  		maximum: 10,
+  		experimental: true,
+  		"private": true,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		},
+  		"property-type": "data-constant"
+  	},
   	"text-max-width": {
   		type: "number",
   		"default": 10,
@@ -4773,6 +4881,360 @@
   		}
   	}
   };
+  var snow = {
+  	density: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Snow particles density.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	intensity: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Snow particles movement factor.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	color: {
+  		type: "color",
+  		"property-type": "data-constant",
+  		"default": "#ffffff",
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Snow particles color.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	opacity: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Snow particles opacity.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	vignette: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Snow vignette screen-space effect.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	centerThinning: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Thinning factor of snow particles from center. 0 - no thinning. 1 - maximal central area thinning.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	direction: {
+  		type: "array",
+  		"default": [
+  			0,
+  			90
+  		],
+  		minimum: 0,
+  		maximum: 360,
+  		length: 2,
+  		value: "number",
+  		"property-type": "data-constant",
+  		transition: true,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		doc: "Main snow particles direction. Heading & pitch",
+  		example: [
+  			0,
+  			45
+  		],
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	}
+  };
+  var rain = {
+  	density: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Rain particles density.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	intensity: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Rain particles movement factor.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	color: {
+  		type: "color",
+  		"property-type": "data-constant",
+  		"default": "#ffffff",
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	opacity: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Rain particles opacity.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	vignette: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Rain vignette screen-space effect.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	centerThinning: {
+  		type: "number",
+  		"property-type": "data-constant",
+  		"default": 1,
+  		minimum: 0,
+  		maximum: 1,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		transition: true,
+  		doc: "Thinning factor of rain particles from center. 0 - no thinning. 1 - maximal central area thinning.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	},
+  	direction: {
+  		type: "array",
+  		"default": [
+  			0,
+  			80
+  		],
+  		minimum: 0,
+  		maximum: 360,
+  		length: 2,
+  		value: "number",
+  		"property-type": "data-constant",
+  		transition: true,
+  		experimental: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		doc: "Main rain particles direction. Heading & pitch",
+  		example: [
+  			0,
+  			45
+  		],
+  		"sdk-support": {
+  			"basic functionality": {
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		}
+  	}
+  };
   var camera = {
   	"camera-projection": {
   		doc: "Camera projection describes how 3D world geometry get projected into 2D screen",
@@ -8691,6 +9153,8 @@
   	expression: expression$1,
   	expression_name: expression_name,
   	fog: fog,
+  	snow: snow,
+  	rain: rain,
   	camera: camera,
   	colorTheme: colorTheme,
   	light: light,
@@ -8896,6 +9360,56 @@
   		},
   		"property-type": "data-driven"
   	},
+  	"fill-extrusion-height-alignment": {
+  		type: "enum",
+  		experimental: true,
+  		values: {
+  			terrain: {
+  				doc: "The fill extrusion height follows terrain slope."
+  			},
+  			flat: {
+  				doc: "The fill extrusion height is flat over terrain."
+  			}
+  		},
+  		doc: "Controls the behavior of fill extrusion height over terrain",
+  		"default": "flat",
+  		requires: [
+  			"fill-extrusion-height"
+  		],
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		},
+  		"property-type": "data-constant"
+  	},
+  	"fill-extrusion-base-alignment": {
+  		type: "enum",
+  		experimental: true,
+  		values: {
+  			terrain: {
+  				doc: "The fill extrusion base follows terrain slope."
+  			},
+  			flat: {
+  				doc: "The fill extrusion base is flat over terrain."
+  			}
+  		},
+  		doc: "Controls the behavior of fill extrusion base over terrain",
+  		"default": "terrain",
+  		requires: [
+  			"fill-extrusion-base"
+  		],
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.8.0",
+  				android: "11.8.0",
+  				ios: "11.8.0"
+  			}
+  		},
+  		"property-type": "data-constant"
+  	},
   	"fill-extrusion-vertical-gradient": {
   		type: "boolean",
   		"default": true,
@@ -14598,13 +15112,21 @@
           if (index < 0) {
               throw new RuntimeError(`Array index out of bounds: ${ index } < 0.`);
           }
-          if (index >= array2.length) {
+          if (index > array2.length - 1) {
               throw new RuntimeError(`Array index out of bounds: ${ index } > ${ array2.length - 1 }.`);
           }
-          if (index !== Math.floor(index)) {
-              throw new RuntimeError(`Array index must be an integer, but found ${ index } instead.`);
+          if (index === Math.floor(index)) {
+              return array2[index];
+          }
+          const lowerIndex = Math.floor(index);
+          const upperIndex = Math.ceil(index);
+          const lowerValue = array2[lowerIndex];
+          const upperValue = array2[upperIndex];
+          if (typeof lowerValue !== 'number' || typeof upperValue !== 'number') {
+              throw new RuntimeError(`Cannot interpolate between non-number values at index ${ index }.`);
           }
-          return array2[index];
+          const fraction = index - lowerIndex;
+          return lowerValue * (1 - fraction) + upperValue * fraction;
       }
       eachChild(fn) {
           fn(this.index);