@mapbox/mapbox-gl-style-spec 14.0.0-beta.2 → 14.0.0-beta.4

package/diff.js

@@ -2,7 +2,7 @@
 
 import isEqual from './util/deep_equal.js';
 
-import type {StyleSpecification, SourceSpecification, LayerSpecification} from './types.js';
+import type {StyleSpecification, ImportSpecification, SourceSpecification, LayerSpecification} from './types.js';
 
 type Sources = { [string]: SourceSpecification };
 
@@ -131,7 +131,17 @@ export const operations: {[_: string]: string} = {
     /*
      *  { command: 'setProjection', args: [projectionProperties] }
      */
-    setProjection: 'setProjection'
+    setProjection: 'setProjection',
+
+    /*
+     *  { command: 'addImport', args: [importProperties] }
+     */
+    addImport: 'addImport',
+
+    /*
+     *  { command: 'removeImport', args: [importId] }
+     */
+    removeImport: 'removeImport'
 };
 
 function addSource(sourceId: string, after: Sources, commands: Array<Command>) {
@@ -335,6 +345,17 @@ function diffLayers(before: Array<LayerSpecification>, after: Array<LayerSpecifi
     }
 }
 
+function diffImports(before: Array<ImportSpecification> = [], after: Array<ImportSpecification> = [], commands: Array<Command>) {
+    // no diff for the imports, must remove then add
+    for (const beforeImport of before) {
+        commands.push({command: operations.removeImport, args: [beforeImport.id]});
+    }
+
+    for (const afterImport of after) {
+        commands.push({command: operations.addImport, args: [afterImport]});
+    }
+}
+
 /**
  * Diff two stylesheet
  *
@@ -445,6 +466,8 @@ export default function diffStyles(before: StyleSpecification, after: StyleSpeci
         // Handle changes to `layers`
         diffLayers(beforeLayers, after.layers, commands);
 
+        // Handle changes to `imports`
+        diffImports(before.imports, after.imports, commands);
     } catch (e) {
         // fall back to setStyle
         console.warn('Unable to compute style diff:', e);

package/dist/index.cjs

@@ -32,7 +32,7 @@
   	center: {
   		type: "array",
   		value: "number",
-  		doc: "Default map center in longitude and latitude.  The style center will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
+  		doc: "Default map center in longitude and latitude. The style center will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
   		example: [
   			-73.9749,
   			40.7736
@@ -40,7 +40,7 @@
   	},
   	zoom: {
   		type: "number",
-  		doc: "Default zoom level.  The style zoom will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
+  		doc: "Default zoom level. The style zoom will be used only if the map has not been positioned by other means (e.g. map options or user interaction).",
   		example: 12.5
   	},
   	bearing: {
@@ -883,13 +883,13 @@
   		doc: "The data type of the image source."
   	},
   	url: {
-  		required: true,
+  		required: false,
   		type: "string",
-  		doc: "URL that points to an image."
+  		doc: "URL that points to an image. If the URL is not specified, the image is expected to be loaded directly during runtime."
   	},
   	coordinates: {
   		required: true,
-  		doc: "Corners of image specified in longitude, latitude pairs.",
+  		doc: "Corners of image specified in longitude, latitude pairs. Note: When using globe projection, the image will be centered at the North or South Pole in the respective hemisphere if the average latitude value exceeds 85 degrees or falls below -85 degrees.",
   		type: "array",
   		length: 4,
   		value: {
@@ -1111,7 +1111,7 @@
   	},
   	filter: {
   		type: "filter",
-  		doc: "An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The `[\"feature-state\", ...]` expression is not supported in filter expressions.  The `[\"pitch\"]` and `[\"distance-from-center\"]` expressions are supported only for filter expressions on the symbol layer."
+  		doc: "An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The `[\"feature-state\", ...]` expression is not supported in filter expressions. The `[\"pitch\"]` and `[\"distance-from-center\"]` expressions are supported only for filter expressions on the symbol layer."
   	},
   	layout: {
   		type: "layout",
@@ -1680,7 +1680,7 @@
   	},
   	"symbol-sort-key": {
   		type: "number",
-  		doc: "Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first.  When `icon-allow-overlap` or `text-allow-overlap` is `false`, features with a lower sort key will have priority during placement. When `icon-allow-overlap` or `text-allow-overlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.",
+  		doc: "Sorts features in ascending order based on this value. Features with lower sort keys are drawn and placed first. When `icon-allow-overlap` or `text-allow-overlap` is `false`, features with a lower sort key will have priority during placement. When `icon-allow-overlap` or `text-allow-overlap` is set to `true`, features with a higher sort key will overlap over features with a lower sort key.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "0.53.0",
@@ -1735,6 +1735,37 @@
   		},
   		"property-type": "data-constant"
   	},
+  	"symbol-z-elevate": {
+  		type: "boolean",
+  		"default": false,
+  		doc: "Position symbol on buildings (both fill extrusions and models) roof tops. In order to have minimal impact on performance, this is supported only when `fill-extrusion-height` is not zoom-dependent and not edited after initial bucket creation. For fading in buildings when zooming in, fill-extrusion-vertical-scale should be used and symbols would raise with building roofs. Symbols are sorted by elevation, except in case when `viewport-y` sorting or `symbol-sort-key` are applied.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		requires: [
+  			{
+  				"symbol-placement": [
+  					"point"
+  				]
+  			},
+  			{
+  				"symbol-z-order": [
+  					"auto"
+  				]
+  			}
+  		],
+  		expression: {
+  			interpolated: false,
+  			parameters: [
+  				"zoom"
+  			]
+  		},
+  		"property-type": "data-constant"
+  	},
   	"icon-allow-overlap": {
   		type: "boolean",
   		"default": false,
@@ -3293,7 +3324,7 @@
   			}
   		},
   		array: {
-  			doc: "Asserts that the input is an array (optionally with a specific item type and length).  If, when the input expression is evaluated, it is not of the asserted type, then this assertion will cause the whole expression to be aborted.",
+  			doc: "Asserts that the input is an array (optionally with a specific item type and length). If, when the input expression is evaluated, it is not of the asserted type, then this assertion will cause the whole expression to be aborted.",
   			group: "Types",
   			"sdk-support": {
   				"basic functionality": {
@@ -3739,7 +3770,7 @@
   			}
   		},
   		properties: {
-  			doc: "Returns the feature properties object.  Note that in some cases, it may be more efficient to use `[\"get\", \"property_name\"]` directly.",
+  			doc: "Returns the feature properties object. Note that in some cases, it may be more efficient to use `[\"get\", \"property_name\"]` directly.",
   			group: "Feature data",
   			"sdk-support": {
   				"basic functionality": {
@@ -3786,7 +3817,7 @@
   			}
   		},
   		zoom: {
-  			doc: "Returns the current zoom level.  Note that in style layout and paint properties, [\"zoom\"] may only appear as the input to a top-level \"step\" or \"interpolate\" expression.",
+  			doc: "Returns the current zoom level. Note that in style layout and paint properties, [\"zoom\"] may only appear as the input to a top-level \"step\" or \"interpolate\" expression.",
   			group: "Camera",
   			"sdk-support": {
   				"basic functionality": {
@@ -4576,6 +4607,34 @@
   				ios: "10.6.0"
   			}
   		}
+  	},
+  	"vertical-range": {
+  		type: "array",
+  		"default": [
+  			0,
+  			0
+  		],
+  		minimum: 0,
+  		length: 2,
+  		value: "number",
+  		"property-type": "data-constant",
+  		transition: true,
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
+  			],
+  			relaxZoomRestriction: true
+  		},
+  		doc: "An array of two number values, specifying the vertical range, measured in meters, over which the fog should gradually fade out. When both parameters are set to zero, the fog will be rendered without any vertical constraints.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		}
   	}
   };
   var camera = {
@@ -5091,7 +5150,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5423,7 +5482,28 @@
   	},
   	"line-gradient": {
   		type: "color",
-  		doc: "Defines a gradient with which to color a line feature. Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.",
+  		doc: "A gradient used to color a line feature at various distances along its length. Defined using a `step` or `interpolate` expression which outputs a color for each corresponding `line-progress` input value. `line-progress` is a percentage of the line feature's total length as measured on the webmercator projected coordinate plane (a `number` between `0` and `1`). Can only be used with GeoJSON sources that specify `\"lineMetrics\": true`.",
+  		example: [
+  			"interpolate",
+  			[
+  				"linear"
+  			],
+  			[
+  				"line-progress"
+  			],
+  			0,
+  			"blue",
+  			0.1,
+  			"royalblue",
+  			0.3,
+  			"cyan",
+  			0.5,
+  			"lime",
+  			0.7,
+  			"yellow",
+  			1,
+  			"red"
+  		],
   		transition: false,
   		requires: [
   			{
@@ -5496,7 +5576,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -5910,7 +5990,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6037,7 +6117,7 @@
   			1,
   			"red"
   		],
-  		doc: "Defines the color of each pixel based on its density value in a heatmap.  Should be an expression that uses `[\"heatmap-density\"]` as input.",
+  		doc: "Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses `[\"heatmap-density\"]` as input.",
   		transition: false,
   		"sdk-support": {
   			"basic functionality": {
@@ -6123,7 +6203,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6151,7 +6231,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -6662,7 +6742,7 @@
   	},
   	"raster-color": {
   		type: "color",
-  		doc: "Defines a color map by which to colorize a raster layer, parameterized by the `[\"raster-value\"]` expression and evaluated at 1024 uniformly spaced steps over the range specified by `raster-color-range`.",
+  		doc: "Defines a color map by which to colorize a raster layer, parameterized by the `[\"raster-value\"]` expression and evaluated at 256 uniformly spaced steps over the range specified by `raster-color-range`.",
   		transition: false,
   		"sdk-support": {
   			"basic functionality": {
@@ -6693,6 +6773,9 @@
   		value: "number",
   		"property-type": "data-constant",
   		transition: true,
+  		requires: [
+  			"raster-color"
+  		],
   		expression: {
   			interpolated: true,
   			parameters: [
@@ -6724,6 +6807,9 @@
   		value: "number",
   		"property-type": "data-constant",
   		transition: true,
+  		requires: [
+  			"raster-color"
+  		],
   		expression: {
   			interpolated: true,
   			parameters: [
@@ -7001,7 +7087,8 @@
   		expression: {
   			interpolated: true,
   			parameters: [
-  				"zoom"
+  				"zoom",
+  				"measure-light"
   			]
   		},
   		"property-type": "data-constant"
@@ -7022,7 +7109,8 @@
   		expression: {
   			interpolated: true,
   			parameters: [
-  				"zoom"
+  				"zoom",
+  				"measure-light"
   			]
   		},
   		"property-type": "data-constant"
@@ -7043,7 +7131,31 @@
   		expression: {
   			interpolated: true,
   			parameters: [
-  				"zoom"
+  				"zoom",
+  				"measure-light"
+  			]
+  		},
+  		"property-type": "data-constant"
+  	},
+  	"hillshade-emissive-strength": {
+  		type: "number",
+  		"default": 0,
+  		minimum: 0,
+  		transition: true,
+  		units: "intensity",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		expression: {
+  			interpolated: true,
+  			parameters: [
+  				"zoom",
+  				"measure-light"
   			]
   		},
   		"property-type": "data-constant"
@@ -7125,7 +7237,7 @@
   		minimum: 0,
   		transition: true,
   		units: "intensity",
-  		doc: "Emission strength",
+  		doc: "Controls the intensity of light emitted on the source features. This property works only with 3D light, i.e. when `lights` root property is defined.",
   		"sdk-support": {
   			"basic functionality": {
   				js: "3.0.0",
@@ -7740,6 +7852,25 @@
   			}
   		},
   		transition: true
+  	},
+  	"model-cutoff-fade-range": {
+  		type: "number",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		doc: "This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.",
+  		transition: false,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		"property-type": "data-constant"
   	}
   };
   var transition = {
@@ -8186,8 +8317,7 @@
   			parameters: [
   				"zoom",
   				"feature",
-  				"feature-state",
-  				"measure-light"
+  				"feature-state"
   			]
   		},
   		"property-type": "data-driven"
@@ -8221,8 +8351,7 @@
   			parameters: [
   				"zoom",
   				"feature",
-  				"feature-state",
-  				"measure-light"
+  				"feature-state"
   			]
   		},
   		"property-type": "data-driven"
@@ -8528,6 +8657,25 @@
   				"zoom"
   			]
   		}
+  	},
+  	"fill-extrusion-cutoff-fade-range": {
+  		type: "number",
+  		"default": 0,
+  		minimum: 0,
+  		maximum: 1,
+  		doc: "This parameter defines the range for the fade-out effect before an automatic content cutoff on pitched map views. The automatic cutoff range is calculated according to the minimum required zoom level of the source and layer. The fade range is expressed in relation to the height of the map view. A value of 1.0 indicates that the content is faded to the same extent as the map's height in pixels, while a value close to zero represents a sharp cutoff. When the value is set to 0.0, the cutoff is completely disabled. Note: The property has no effect on the map if terrain is enabled.",
+  		transition: false,
+  		expression: {
+  			interpolated: false
+  		},
+  		"sdk-support": {
+  			"basic functionality": {
+  				js: "3.0.0",
+  				android: "11.0.0",
+  				ios: "11.0.0"
+  			}
+  		},
+  		"property-type": "data-constant"
   	}
   },
   	paint_line: paint_line,
@@ -18429,7 +18577,15 @@ ${ JSON.stringify(filterExp, null, 2) }
       /*
        *  { command: 'setProjection', args: [projectionProperties] }
        */
-      setProjection: 'setProjection'
+      setProjection: 'setProjection',
+      /*
+       *  { command: 'addImport', args: [importProperties] }
+       */
+      addImport: 'addImport',
+      /*
+       *  { command: 'removeImport', args: [importId] }
+       */
+      removeImport: 'removeImport'
   };
   function addSource(sourceId, after, commands) {
       commands.push({
@@ -18692,6 +18848,21 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
       }
   }
+  function diffImports(before = [], after = [], commands) {
+      // no diff for the imports, must remove then add
+      for (const beforeImport of before) {
+          commands.push({
+              command: operations.removeImport,
+              args: [beforeImport.id]
+          });
+      }
+      for (const afterImport of after) {
+          commands.push({
+              command: operations.addImport,
+              args: [afterImport]
+          });
+      }
+  }
   /**
    * Diff two stylesheet
    *
@@ -18844,6 +19015,8 @@ ${ JSON.stringify(filterExp, null, 2) }
           }
           // Handle changes to `layers`
           diffLayers(beforeLayers, after.layers, commands);
+          // Handle changes to `imports`
+          diffImports(before.imports, after.imports, commands);
       } catch (e) {
           // fall back to setStyle
           console.warn('Unable to compute style diff:', e);