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

package/reference/v8.json

@@ -105,6 +105,16 @@
       "type": "fog",
       "doc": "A global effect that fades layers and markers based on their distance to the camera. The fog can be used to approximate the effect of atmosphere on distant objects and enhance the depth perception of the map when used with terrain or 3D features. Note: fog is renamed to atmosphere in the Android and iOS SDKs and planned to be changed in GL-JS v.3.0.0."
     },
+    "snow": {
+      "type": "snow",
+      "doc": "Global precipitation particle-based snow. Having snow present in the style forces constant map repaint mode",
+      "experimental": true
+    },
+    "rain": {
+      "type": "rain",
+      "doc": "Global precipitation particle-based rain effect. Having rain present in the style forces constant map repaint mode.",
+      "experimental": true
+    },
     "camera": {
       "type": "camera",
       "doc": "Global setting to control additional camera intrinsics parameters, e.g. projection type (perspective / orthographic)."
@@ -113,6 +123,11 @@
       "type": "colorTheme",
       "doc": "A global modifier for the colors of the style."
     },
+    "indoor": {
+      "type": "indoor",
+      "experimental": true,
+      "doc": "Controls the behaviour of indoor features."
+    },
     "imports": {
       "type": "array",
       "value": "import",
@@ -204,7 +219,7 @@
    "featuresets": {
       "experimental": true,
       "type": "featuresets",
-      "doc": "Defines sets of features for querying, interaction, and feature state manipulation.",
+      "doc": "Defines sets of features for querying, interaction, and state management on the map, referencing individual layers or subsets of layers within the map's style.",
       "example": {
         "poi": {
           "selectors": [
@@ -288,6 +303,11 @@
     "data": {
       "type": "$root",
       "doc": "The inlined style that must correspond to the contents of the specified URL."
+    },
+    "color-theme": {
+      "type": "colorTheme",
+      "optional": true,
+      "doc": "If specified, it overrides the color-theme of the imported style."
     }
   },
   "config": {
@@ -496,6 +516,28 @@
         }
       }
     },
+    "shadow-quality": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 1,
+      "minimum": 0,
+      "maximum": 1,
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "transition": false,
+      "doc": "Determines the quality of the shadows on the map. A value of 1 ensures the highest quality and is the default value.",
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      },
+      "experimental": true
+    },
     "shadow-intensity": {
       "type": "number",
       "property-type": "data-constant",
@@ -1617,6 +1659,35 @@
         "interpolated": false
       },
       "property-type": "constant"
+    },
+    "fill-elevation-reference": {
+      "type": "enum",
+      "doc": "Selects the base of fill-elevation. Some modes might require precomputed elevation data in the tileset.",
+      "values": {
+        "none": {
+          "doc": "Elevated rendering is disabled."
+        },
+        "hd-road-base": {
+          "doc": "Elevate geometry relative to HD roads. Use this mode to describe base polygons of the road networks."
+        },
+        "hd-road-markup": {
+          "doc": "Elevated rendering is enabled. Use this mode to describe additive and stackable features such as 'hatched areas' that should exist only on top of road polygons."
+      }
+      },
+      "default": "none",
+      "experimental": true,
+      "private": true,
+      "transition": false,
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      },
+      "expression": {
+        "interpolated": false
+      },
+      "property-type": "data-constant"
     }
   },
   "layout_circle": {
@@ -1956,7 +2027,7 @@
         },
         "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,
@@ -2020,6 +2091,36 @@
         "interpolated": false
       },
       "property-type": "constant"
+    },
+    "line-width-unit": {
+      "type": "enum",
+      "doc": "Selects the unit of line-width. The same unit is automatically used for line-blur and line-offset. Note: This is an experimental property and might be removed in a future release.",
+      "values": {
+        "pixels": {
+          "doc": "Width is rendered in pixels."
+        },
+        "meters": {
+          "doc": "Width is rendered in meters."
+        }
+      },
+      "default": "pixels",
+      "experimental": true,
+      "private": true,
+      "transition": false,
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.9.0",
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      },
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "property-type": "data-constant"
     }
   },
   "layout_symbol": {
@@ -2134,7 +2235,7 @@
           "doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`."
         },
         "viewport-y": {
-          "doc": "Sorts symbols by their y-position relative to the viewport if `icon-allow-overlap` or `text-allow-overlap` is set to `true` or `icon-ignore-placement` or `text-ignore-placement` is `false`."
+          "doc": "Sorts symbols by their y-position relative to the viewport if any of the following is set to `true`: `icon-allow-overlap`, `text-allow-overlap`, `icon-ignore-placement`, `text-ignore-placement`."
         },
         "source": {
           "doc": "Sorts symbols by `symbol-sort-key` if set. Otherwise, no sorting is applied; symbols are rendered in the same order as the source data."
@@ -2188,6 +2289,36 @@
       },
       "property-type": "data-constant"
     },
+    "symbol-elevation-reference": {
+      "type": "enum",
+      "doc": "Selects the base of symbol-elevation.",
+      "values": {
+        "sea": {
+          "doc": "Elevate symbols relative to the sea level."
+        },
+        "ground": {
+          "doc": "Elevate symbols relative to the ground's height below them."
+        },
+        "hd-road-markup": {
+          "doc": "Use this mode to enable elevated behavior for features that are rendered on top of 3D road polygons. The feature is currently being developed."
+        }
+      },
+      "default": "ground",
+      "experimental": true,
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      },
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "property-type": "data-constant"
+    },
     "icon-allow-overlap": {
       "type": "boolean",
       "default": false,
@@ -2341,9 +2472,7 @@
       },
       "sdk-support": {
         "basic functionality": {
-          "js": "3.8.0",
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "js": "3.8.0"
         }
       },
       "property-type": "data-constant"
@@ -2855,9 +2984,7 @@
       },
       "sdk-support": {
         "basic functionality": {
-          "js": "3.8.0",
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "js": "3.8.0"
         }
       },
       "property-type": "data-constant"
@@ -3584,6 +3711,61 @@
       "parameters": ["zoom", "feature"]
     }
   },
+  "filter_hillshade": {
+    "type": "boolean",
+    "doc": "Expression which determines whether or not to enable the hillshade layer. Hillshade layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
+    "default": false,
+    "transition": false,
+    "property-type": "data-driven",
+    "expression": {
+      "interpolated": false,
+      "parameters": ["zoom", "feature"]
+    }
+  },
+  "filter_raster": {
+    "type": "boolean",
+    "doc": "Expression which determines whether or not to enable the raster layer. Raster layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
+    "default": false,
+    "transition": false,
+    "property-type": "data-driven",
+    "expression": {
+      "interpolated": false,
+      "parameters": ["zoom", "feature"]
+    }
+  },
+  "filter_raster-particle": {
+    "type": "boolean",
+    "doc": "Expression which determines whether or not to enable the raster particle layer. Raster particle layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
+    "default": false,
+    "transition": false,
+    "property-type": "data-driven",
+    "expression": {
+      "interpolated": false,
+      "parameters": ["zoom", "feature"]
+    }
+  },
+  "filter_clip": {
+    "type": "boolean",
+    "doc": "Expression which determines whether or not to enable the clip layer. Clip layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
+    "default": false,
+    "transition": false,
+    "property-type": "data-driven",
+    "expression": {
+      "interpolated": false,
+      "parameters": ["zoom", "feature"]
+    }
+  },
+  "filter_model": {
+    "type": "boolean",
+    "doc": "Expression which determines whether or not to display a model. Model layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
+    "default": false,
+    "transition": false,
+    "property-type": "data-driven",
+    "expression": {
+      "interpolated": false,
+      "parameters": ["zoom", "feature"]
+    }
+  },
   "filter_line": {
     "type": "boolean",
     "doc": "Expression which determines whether or not to display a Polygon or LineString. Line layer does NOT support dynamic filtering, meaning this expression can NOT use the `[\"pitch\"]` and `[\"distance-from-center\"]` expressions to reference the current state of the view.",
@@ -4139,6 +4321,17 @@
           }
         }
       },
+      "to-hsla": {
+        "doc": "Returns a four-element array containing the input color's Hue, Saturation, Luminance and alpha components, in that order.",
+        "group": "Color",
+        "sdk-support": {
+          "basic functionality": {
+            "js": "3.9.0",
+            "android": "11.9.0",
+            "ios": "11.9.0"
+          }
+        }
+      },
       "to-color": {
         "doc": "Converts the input value to a color. If multiple values are provided, each one is evaluated in order until the first successful conversion is obtained. If none of the inputs can be converted, the expression is an error.",
         "group": "Types",
@@ -4327,7 +4520,7 @@
         }
       },
       "line-progress": {
-        "doc": "Returns the progress along a gradient line. Can only be used in the `line-gradient` property.",
+        "doc": "Returns the progress along a gradient line. Can only be used in the `line-gradient` and `line-z-offset` properties.",
         "group": "Feature data",
         "sdk-support": {
           "basic functionality": {
@@ -5073,11 +5266,11 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Snow particles density.",
+      "doc": "Snow particles density. Controls the overall particles number.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
@@ -5097,11 +5290,11 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Snow particles movement factor.",
+      "doc": "Snow particles movement factor. Controls the overall particles movement speed.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
@@ -5122,15 +5315,15 @@
       "doc": "Snow particles color.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
     "opacity": {
       "type": "number",
       "property-type": "data-constant",
-      "default": 1,
+      "default": 0.9,
       "minimum": 0,
       "maximum": 1,
       "experimental": true,
@@ -5146,15 +5339,15 @@
       "doc": "Snow particles opacity.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
     "vignette": {
       "type": "number",
       "property-type": "data-constant",
-      "default": 0,
+      "default": 0.3,
       "minimum": 0,
       "maximum": 1,
       "experimental": true,
@@ -5167,15 +5360,37 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Snow vignette screen-space effect.",
+      "doc": "Snow vignette screen-space effect. Adds snow tint to screen corners",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
-    "centerThinning": {
+    "vignette-color": {
+      "type": "color",
+      "property-type": "data-constant",
+      "default": "#ffffff",
+      "experimental": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
+      },
+      "transition": true,
+      "doc": "Snow vignette screen-space corners tint color.",
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      }
+    },
+    "center-thinning": {
       "type": "number",
       "property-type": "data-constant",
       "default": 1,
@@ -5194,8 +5409,8 @@
       "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"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
@@ -5220,15 +5435,39 @@
         ],
         "relaxZoomRestriction": true
       },
-      "doc": "Main snow particles direction. Heading & pitch",
+      "doc": "Main snow particles direction. Azimuth and polar angles",
       "example": [
         0,
         45
       ],
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      }
+    },
+    "flake-size": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 1,
+      "minimum": 0,
+      "maximum": 5,
+      "experimental": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
+      },
+      "transition": true,
+      "doc": "Snow flake particle size. Correlates with individual particle screen size",
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     }
@@ -5250,11 +5489,11 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Rain particles density.",
+      "doc": "Rain particles density. Controls the overall screen density of the rain.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
@@ -5274,18 +5513,18 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Rain particles movement factor.",
+      "doc": "Rain particles movement factor. Controls the overall rain particles speed",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
     "color": {
       "type": "color",
       "property-type": "data-constant",
-      "default": "#ffffff",
+      "default": "#919191",
       "experimental": true,
       "expression": {
         "interpolated": true,
@@ -5296,18 +5535,18 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "",
+      "doc": "Individual rain particle dorplets color.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
     "opacity": {
       "type": "number",
       "property-type": "data-constant",
-      "default": 1,
+      "default": 0.19,
       "minimum": 0,
       "maximum": 1,
       "experimental": true,
@@ -5323,15 +5562,15 @@
       "doc": "Rain particles opacity.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
     "vignette": {
       "type": "number",
       "property-type": "data-constant",
-      "default": 0,
+      "default": 0.3,
       "minimum": 0,
       "maximum": 1,
       "experimental": true,
@@ -5344,15 +5583,37 @@
         "relaxZoomRestriction": true
       },
       "transition": true,
-      "doc": "Rain vignette screen-space effect.",
+      "doc": "Screen-space vignette rain tinting effect intensity.",
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
-    "centerThinning": {
+    "vignette-color": {
+      "type": "color",
+      "property-type": "data-constant",
+      "default": "#ffffff",
+      "experimental": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
+      },
+      "transition": true,
+      "doc": "Rain vignette screen-space corners tint color.",
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      }
+    },
+    "center-thinning": {
       "type": "number",
       "property-type": "data-constant",
       "default": 1,
@@ -5371,8 +5632,8 @@
       "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"
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     },
@@ -5397,15 +5658,72 @@
         ],
         "relaxZoomRestriction": true
       },
-      "doc": "Main rain particles direction. Heading & pitch",
+      "doc": "Main rain particles direction. Azimuth and polar angles.",
       "example": [
         0,
         45
       ],
       "sdk-support": {
         "basic functionality": {
-          "android": "11.8.0",
-          "ios": "11.8.0"
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      }
+    },
+    "droplet-size": {
+      "type": "array",
+      "default": [
+        1.0,
+        10.0
+      ],
+      "minimum": 0,
+      "maximum": 20,
+      "length": 2,
+      "value": "number",
+      "property-type": "data-constant",
+      "transition": true,
+      "experimental": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
+      },
+      "doc": "Rain droplet size. x - normal to direction, y - along direction",
+      "example": [
+        0,
+        45
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
+        }
+      }
+    },
+    "distortion-strength": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 0.5,
+      "minimum": 0,
+      "maximum": 1,
+      "experimental": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
+      },
+      "transition": true,
+      "doc": "Rain particles screen-space distortion strength.",
+      "sdk-support": {
+        "basic functionality": {
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       }
     }
@@ -5451,6 +5769,28 @@
       }
     }
   },
+  "indoor": {
+    "floorplanFeaturesetId": {
+      "type": "string",
+      "doc": "An ID of a featureset to be used to query indoor floorplans.",
+      "experimental": true,
+      "transition": false,
+      "property-type": "data-constant",
+      "expression": {
+        "interpolated": false
+      }
+    },
+    "buildingFeaturesetId": {
+      "type": "string",
+      "doc": "An ID of a featureset to be used to add interactivity for building selection.",
+      "experimental": true,
+      "transition": false,
+      "property-type": "data-constant",
+      "expression": {
+        "interpolated": false
+      }
+    }
+  },
   "light": {
     "anchor": {
       "type": "enum",
@@ -6774,7 +7114,8 @@
           "zoom",
           "feature",
           "feature-state",
-          "measure-light"
+          "measure-light",
+          "line-progress"
         ]
       },
       "property-type": "data-driven"
@@ -8367,34 +8708,6 @@
         ]
       },
       "property-type": "data-driven"
-    },
-    "symbol-elevation-reference": {
-      "type": "enum",
-      "doc": "Selects the base of symbol-elevation.",
-      "values": {
-        "sea": {
-          "doc": "Elevate symbols relative to the sea level."
-        },
-        "ground": {
-          "doc": "Elevate symbols relative to the ground's height below them."
-        }
-      },
-      "default": "ground",
-      "experimental": true,
-      "sdk-support": {
-        "basic functionality": {
-          "js": "3.7.0",
-          "android": "11.7.0",
-          "ios": "11.7.0"
-        }
-      },
-      "expression": {
-        "interpolated": false,
-        "parameters": [
-          "zoom"
-        ]
-      },
-      "property-type": "data-constant"
     }
   },
   "paint_raster": {
@@ -9051,7 +9364,7 @@
           "doc": "The background is aligned to the plane of the map."
         },
         "viewport": {
-          "doc": "The background is aligned to the plane of the viewport, covering the whole screen."
+          "doc": "The background is aligned to the plane of the viewport, covering the whole screen. Note: This mode disables the automatic reordering of the layer when terrain or globe projection is used."
         }
       },
       "default": "map",
@@ -9067,6 +9380,7 @@
         "interpolated": false,
         "parameters": []
       },
+      "experimental": true,
       "property-type": "data-constant"
     },
     "background-color": {
@@ -9405,20 +9719,25 @@
       "default": 1,
       "minimum": 0,
       "maximum": 1,
-      "doc": "The opacity of the model layer.",
+      "doc": "The opacity of the model layer. Except for zoom, expressions that are data-driven are not supported if using GeoJSON or vector tile as the model layer source.",
       "transition": true,
       "expression": {
         "interpolated": true,
-        "parameters": ["zoom"]
+        "parameters": ["feature", "feature-state", "zoom"]
       },
       "sdk-support": {
-          "basic functionality": {
+        "basic functionality": {
           "js": "3.0.0",
           "android": "11.0.0",
           "ios": "11.0.0"
+        },
+        "data-driven styling": {
+          "js": "3.9.0",
+          "android": "11.9.0",
+          "ios": "11.9.0"
         }
       },
-      "property-type": "data-constant"
+      "property-type": "data-driven"
     },
     "model-rotation": {
       "type": "array",