@mapbox/mapbox-gl-style-spec 14.12.0-beta.1 → 14.13.0-beta.1

package/reference/v8.json

@@ -502,6 +502,7 @@
           "zoom"
         ]
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Color of the directional light.",
       "sdk-support": {
@@ -604,6 +605,7 @@
           "zoom"
         ]
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Color of the ambient light.",
       "sdk-support": {
@@ -708,6 +710,7 @@
           "zoom"
         ]
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Color tint for lighting extruded geometries.",
       "sdk-support": {
@@ -834,6 +837,17 @@
       ],
       "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
     },
+    "extra_bounds": {
+      "type": "array",
+      "value": {
+        "type": "array",
+        "value": "number",
+        "length": 4,
+        "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`."
+      },
+      "experimental": true,
+      "doc": "An array of additional discrete geographic regions where tiles are available. When used alongside the `bounds` property, these regions act as an additional filter - Mapbox GL will only request tiles that are both within the `bounds` and any of the regions defined in `extra_bounds`. When used independently (without `bounds`), Mapbox GL will request tiles that fall within any of the regions in `extra_bounds`. This allows for more fine-grained control over tile requests, particularly when dealing with sparse data coverage."
+    },
     "scheme": {
       "type": "enum",
       "values": {
@@ -913,6 +927,17 @@
       ],
       "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
     },
+    "extra_bounds": {
+      "type": "array",
+      "value": {
+        "type": "array",
+        "value": "number",
+        "length": 4,
+        "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`."
+      },
+      "experimental": true,
+      "doc": "An array of additional discrete geographic regions where tiles are available. When used alongside the `bounds` property, these regions act as an additional filter - Mapbox GL will only request tiles that are both within the `bounds` and any of the regions defined in `extra_bounds`. When used independently (without `bounds`), Mapbox GL will request tiles that fall within any of the regions in `extra_bounds`. This allows for more fine-grained control over tile requests, particularly when dealing with sparse data coverage."
+    },
     "minzoom": {
       "type": "number",
       "default": 0,
@@ -994,6 +1019,17 @@
       ],
       "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
     },
+    "extra_bounds": {
+      "type": "array",
+      "value": {
+        "type": "array",
+        "value": "number",
+        "length": 4,
+        "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`."
+      },
+      "experimental": true,
+      "doc": "An array of additional discrete geographic regions where tiles are available. When used alongside the `bounds` property, these regions act as an additional filter - Mapbox GL will only request tiles that are both within the `bounds` and any of the regions defined in `extra_bounds`. When used independently (without `bounds`), Mapbox GL will request tiles that fall within any of the regions in `extra_bounds`. This allows for more fine-grained control over tile requests, particularly when dealing with sparse data coverage."
+    },
     "minzoom": {
       "type": "number",
       "default": 0,
@@ -1076,6 +1112,17 @@
       ],
       "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`. When this property is included in a source, no tiles outside of the given bounds are requested by Mapbox GL."
     },
+    "extra_bounds": {
+      "type": "array",
+      "value": {
+        "type": "array",
+        "value": "number",
+        "length": 4,
+        "doc": "An array containing the longitude and latitude of the southwest and northeast corners of the source's bounding box in the following order: `[sw.lng, sw.lat, ne.lng, ne.lat]`."
+      },
+      "experimental": true,
+      "doc": "An array of additional discrete geographic regions where tiles are available. When used alongside the `bounds` property, these regions act as an additional filter - Mapbox GL will only request tiles that are both within the `bounds` and any of the regions defined in `extra_bounds`. When used independently (without `bounds`), Mapbox GL will request tiles that fall within any of the regions in `extra_bounds`. This allows for more fine-grained control over tile requests, particularly when dealing with sparse data coverage."
+    },
     "minzoom": {
       "type": "number",
       "default": 0,
@@ -1782,11 +1829,13 @@
       "sdk-support": {
         "basic functionality": {
             "android": "11.11.0",
-            "ios": "11.11.0"
+            "ios": "11.11.0",
+            "js": "3.14.0"
         },
         "data-driven styling": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         }
       },
       "expression": {
@@ -1841,7 +1890,8 @@
       "sdk-support": {
         "basic functionality": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         }
       },
       "expression": {
@@ -2002,13 +2052,13 @@
         "parapet": {
           "doc": "Use parapet roof for the procedurally generated buildings."
         },
-        "mansard": {     
+        "mansard": {
           "doc": "Use mansard roof for the procedurally generated buildings."
         },
-        "skillion": {      
+        "skillion": {
           "doc": "Use skillion roof for the procedurally generated buildings."
         },
-        "pyramidal": {    
+        "pyramidal": {
           "doc": "Use pyramidal roof for the procedurally generated buildings."
         }
       },
@@ -4718,6 +4768,18 @@
           }
         }
       },
+      "worldview": {
+        "doc": "Returns the current worldview being used.",
+        "group": "Lookup",
+        "experimental": true,
+        "sdk-support": {
+          "basic functionality": {
+            "js": "3.13.0",
+	          "android": "11.13.0",
+	          "ios": "11.13.0"
+          }
+        }
+      },
       "id": {
         "doc": "Returns the feature's id, if it has one.",
         "group": "Feature data",
@@ -5346,6 +5408,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the atmosphere region immediately below the horizon and within the `range` and above the horizon and within `horizon-blend`. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.",
       "sdk-support": {
@@ -5368,6 +5431,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the atmosphere region above the horizon, `high-color` extends further above the horizon than the `color` property and its spread can be controlled with `horizon-blend`. The opacity can be set to `0` to remove the high atmosphere color contribution.",
       "sdk-support": {
@@ -5381,7 +5445,6 @@
     "space-color": {
       "type": "color",
       "property-type": "data-constant",
-
       "default":
       [
         "interpolate",
@@ -5404,6 +5467,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the region above the horizon and after the end of the `horizon-blend` contribution. The opacity can be set to `0` to have a transparent background.",
       "sdk-support": {
@@ -5586,6 +5650,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Snow particles color.",
       "sdk-support": {
@@ -5667,6 +5732,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Snow vignette screen-space corners tint color.",
       "sdk-support": {
@@ -5842,6 +5908,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Individual rain particle dorplets color.",
       "sdk-support": {
@@ -5939,6 +6006,7 @@
         ],
         "relaxZoomRestriction": true
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Rain vignette screen-space corners tint color.",
       "sdk-support": {
@@ -6202,6 +6270,7 @@
           "zoom"
         ]
       },
+      "use-theme": true,
       "transition": true,
       "doc": "Color tint for lighting extruded geometries.",
       "sdk-support": {
@@ -6438,6 +6507,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The color of the filled part of this layer. This color can be specified as `rgba` with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.",
+      "use-theme": true,
       "transition": true,
       "requires": [
         {
@@ -6470,6 +6540,7 @@
     "fill-outline-color": {
       "type": "color",
       "doc": "The outline color of the fill. Matches the value of `fill-color` if unspecified.",
+      "use-theme": true,
       "transition": true,
       "requires": [
         {
@@ -6583,6 +6654,31 @@
       },
       "property-type": "data-driven"
     },
+    "fill-pattern-cross-fade": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 0.0,
+      "minimum": 0,
+      "maximum": 1,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ]
+      },
+      "requires": [
+        "line-pattern"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.12.0",
+          "android": "11.14.0",
+          "ios": "11.14.0"
+        }
+      },
+      "doc": "Controls the transition progress between the image variants of fill-pattern. Zero means the first variant is used, one is the second, and in between they are blended together. Both images should be the same size and have the same type (either raster or vector)."
+    },
     "fill-emissive-strength": {
       "type": "number",
       "default": 0,
@@ -6639,15 +6735,18 @@
       "doc": "The color of bridge guard rail.",
       "experimental": true,
       "private": true,
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         },
         "data-driven styling": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         }
       },
       "expression": {
@@ -6664,17 +6763,20 @@
       "type": "color",
       "default": "rgba(241, 236, 225, 255)",
       "doc": "The color of tunnel structures (tunnel entrance and tunnel walls).",
+      "use-theme": true,
       "transition": true,
       "experimental": true,
       "private": true,
       "sdk-support": {
         "basic functionality": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         },
         "data-driven styling": {
           "android": "11.11.0",
-          "ios": "11.11.0"
+          "ios": "11.11.0",
+          "js": "3.14.0"
         }
       },
       "expression": {
@@ -6715,6 +6817,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root `light` settings. If this color is specified as `rgba` with an alpha component, the alpha component will be ignored; use `fill-extrusion-opacity` to set layer opacity.",
+      "use-theme": true,
       "transition": true,
       "requires": [
         {
@@ -6825,6 +6928,31 @@
       },
       "property-type": "data-driven"
     },
+    "fill-extrusion-pattern-cross-fade": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 0.0,
+      "minimum": 0,
+      "maximum": 1,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ]
+      },
+      "requires": [
+        "line-pattern"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.12.0",
+          "android": "11.14.0",
+          "ios": "11.14.0"
+        }
+      },
+      "doc": "Controls the transition progress between the image variants of fill-extrusion-pattern. Zero means the first variant is used, one is the second, and in between they are blended together. Both images should be the same size and have the same type (either raster or vector)."
+    },
     "fill-extrusion-height": {
       "type": "number",
       "default": 0,
@@ -7088,6 +7216,7 @@
       "requires": [
         "lights"
       ],
+      "use-theme": true,
       "transition": true,
       "expression": {
         "interpolated": true,
@@ -7508,6 +7637,8 @@
       "doc": "Color buildings. This can be styled using different building parts (e.g. windows, wall, roof, etc.). This won't be used if `building-roof-shape` has a value `flat`.",
       "experimental": true,
       "private": true,
+      "use-theme": true,
+      "transition": false,
       "sdk-support": {
         "basic functionality": {
         },
@@ -7582,6 +7713,7 @@
       "type": "color",
       "doc": "The color with which the line will be drawn.",
       "default": "#000000",
+      "use-theme": true,
       "transition": true,
       "requires": [
         {
@@ -7843,6 +7975,31 @@
       },
       "property-type": "data-driven"
     },
+    "line-pattern-cross-fade": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 0.0,
+      "minimum": 0,
+      "maximum": 1,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ]
+      },
+      "requires": [
+        "line-pattern"
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.12.0",
+          "android": "11.14.0",
+          "ios": "11.14.0"
+        }
+      },
+      "doc": "Controls the transition progress between the image variants of line-pattern. Zero means the first variant is used, one is the second, and in between they are blended together. Both images should be the same size and have the same type (either raster or vector)."
+    },
     "line-gradient": {
       "type": "color",
       "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`.",
@@ -7863,6 +8020,7 @@
         1,
         "red"
       ],
+      "use-theme": true,
       "transition": false,
       "requires": [
         {
@@ -7957,6 +8115,7 @@
       "doc": "The color to be used for rendering the trimmed line section that is defined by the `line-trim-offset` property.",
       "experimental": true,
       "default": "transparent",
+      "use-theme": true,
       "transition": true,
       "requires": [
         "line-trim-offset",
@@ -8043,6 +8202,7 @@
       "private": true,
       "doc": "The color of the line border. If line-border-width is greater than zero and the alpha value of this color is 0 (default), the color for the border will be selected automatically based on the line color.",
       "default": "rgba(0, 0, 0, 0)",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -8124,6 +8284,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The fill color of the circle.",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -8350,6 +8511,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The stroke color of the circle.",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -8536,6 +8698,7 @@
         "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.",
+      "use-theme": true,
       "transition": false,
       "sdk-support": {
         "basic functionality": {
@@ -8710,6 +8873,7 @@
     "icon-color": {
       "type": "color",
       "default": "#000000",
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the icon. This can only be used with [SDF icons](/help/troubleshooting/using-recolorable-images-in-mapbox-maps/).",
       "requires": [
@@ -8741,6 +8905,7 @@
     "icon-halo-color": {
       "type": "color",
       "default": "rgba(0, 0, 0, 0)",
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the icon's halo. Icon halos can only be used with [SDF icons](/help/troubleshooting/using-recolorable-images-in-mapbox-maps/).",
       "requires": [
@@ -8897,7 +9062,7 @@
     },
     "icon-image-cross-fade": {
       "type": "number",
-      "property-type": "data-driven",
+      "property-type": "data-constant",
       "default": 0.0,
       "minimum": 0,
       "maximum": 1,
@@ -8905,8 +9070,6 @@
         "interpolated": true,
         "parameters": [
           "zoom",
-          "feature",
-          "feature-state",
           "measure-light"
         ]
       },
@@ -8918,15 +9081,9 @@
           "js": "3.0.0",
           "android": "11.0.0",
           "ios": "11.0.0"
-        },
-        "data-driven styling": {
-          "js": "3.0.0",
-          "android": "11.0.0",
-          "ios": "11.0.0"
         }
       },
-      "doc": "Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together.",
-      "transition": true
+      "doc": "Controls the transition progress between the image variants of icon-image. Zero means the first variant is used, one is the second, and in between they are blended together. . Both images should be the same size and have the same type (either raster or vector)."
     },
     "text-opacity": {
       "type": "number",
@@ -8998,6 +9155,7 @@
       "type": "color",
       "doc": "The color with which the text will be drawn.",
       "default": "#000000",
+      "use-theme": true,
       "transition": true,
       "overridable": true,
       "requires": [
@@ -9029,6 +9187,7 @@
     "text-halo-color": {
       "type": "color",
       "default": "rgba(0, 0, 0, 0)",
+      "use-theme": true,
       "transition": true,
       "doc": "The color of the text's halo, which helps it stand out from backgrounds.",
       "requires": [
@@ -9314,6 +9473,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 256 uniformly spaced steps over the range specified by `raster-color-range`.",
+      "use-theme": true,
       "transition": false,
       "sdk-support": {
         "basic functionality": {
@@ -9658,6 +9818,7 @@
     "raster-particle-color": {
       "type": "color",
       "doc": "Defines a color map by which to colorize a raster particle layer, parameterized by the `[\"raster-particle-speed\"]` expression and evaluated at 256 uniformly spaced steps over the range specified by `raster-particle-max-speed`.",
+      "use-theme": true,
       "transition": false,
       "sdk-support": {
         "basic functionality": {
@@ -9848,6 +10009,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The shading color of areas that face away from the light source.",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -9869,6 +10031,7 @@
       "type": "color",
       "default": "#FFFFFF",
       "doc": "The shading color of areas that faces towards the light source.",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -9890,6 +10053,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The shading color used to accentuate rugged terrain like sharp cliffs and gorges.",
+      "use-theme": true,
       "transition": true,
       "sdk-support": {
         "basic functionality": {
@@ -9965,6 +10129,7 @@
       "type": "color",
       "default": "#000000",
       "doc": "The color with which the background will be drawn.",
+      "use-theme": true,
       "transition": true,
       "requires": [
         {
@@ -10208,6 +10373,7 @@
         "white"
       ],
       "doc": "Defines a radial color gradient with which to color the sky. The color values can be interpolated with an expression using `sky-radial-progress`. The range [0, 1] for the interpolant covers a radial distance (in degrees) of [0, `sky-gradient-radius`] centered at the position specified by `sky-gradient-center`.",
+      "use-theme": true,
       "transition": false,
       "requires": [
         {
@@ -10234,6 +10400,7 @@
       "type": "color",
       "default": "white",
       "doc": "A color applied to the atmosphere sun halo. The alpha channel describes how strongly the sun halo is represented in an atmosphere sky layer.",
+      "use-theme": true,
       "transition": false,
       "requires": [
         {
@@ -10253,6 +10420,7 @@
       "type": "color",
       "default": "white",
       "doc": "A color used to tweak the main atmospheric scattering coefficients. Using white applies the default coefficients giving the natural blue color to the atmosphere. This color affects how heavily the corresponding wavelength is represented during scattering. The alpha channel describes the density of the atmosphere, with 1 maximum density and 0 no density.",
+      "use-theme": true,
       "transition": false,
       "requires": [
         {
@@ -10415,6 +10583,7 @@
           "ios": "11.0.0"
         }
       },
+      "use-theme": true,
       "transition": true
     },
     "model-color-mix-intensity": {
@@ -10673,5 +10842,24 @@
       "type": "*",
       "doc": "A feature property name to use as the ID, or an expression to evaluate as the ID for feature state."
     }
+  },
+  "$doc": {
+    "transition": {
+      "type": "transition",
+      "doc": "Controls how a property transitions to a new value. Overrides the style's root `transition` for this property."
+    },
+    "use-theme": {
+      "type": "enum",
+      "doc": "Controls whether the associated color property is affected by the global color theme. When set to \"none\", the color theme is ignored for this property. When set to \"default\", the color theme is applied.",
+      "values": {
+        "default": {
+          "doc": "The color theme is applied to this property (default behavior)."
+        },
+        "none": {
+          "doc": "The color theme is ignored for this property."
+        }
+      },
+      "default": "default"
+    }
   }
 }