@mapbox/mapbox-gl-style-spec 14.7.1 → 14.8.0

package/reference/v8.json

@@ -204,7 +204,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": [
@@ -1322,7 +1322,6 @@
         },
         "clip": {
           "doc": "Layer that removes 3D content from map.",
-          "experimental": true,
           "sdk-support": {
             "basic functionality": {
               "js": "3.5.0",
@@ -1618,6 +1617,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": {
@@ -1915,7 +1943,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",
@@ -1938,6 +1970,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": {
@@ -2134,6 +2217,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,
@@ -2269,6 +2382,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": {
@@ -2758,6 +2896,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,
@@ -3480,6 +3643,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.",
@@ -4223,7 +4441,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": {
@@ -4952,79 +5170,433 @@
       }
     }
   },
-  "camera": {
-    "camera-projection" : {
-      "doc": "Camera projection describes how 3D world geometry get projected into 2D screen",
-      "type": "enum",
-      "values": {
-        "perspective": {
-          "doc": "linear projection where distant objects appear smaller than closer objects. Lines that are parallel seem to converge towards a vanishing point"
-        },
-        "orthographic": {
-          "doc": "Projection where objects are of the same scale regardless of whether they are far away or near to the camera. Parallel lines remains parallel and there is no vanishing point."
-        }
-      },
-      "transition": true,
+  "snow": {
+    "density": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default": 1,
+      "minimum": 0,
+      "maximum": 1,
+      "experimental": true,
       "expression": {
         "interpolated": true,
         "parameters": [
-          "zoom"
-        ]
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
       },
+      "transition": true,
+      "doc": "Snow particles density.",
       "sdk-support": {
         "basic functionality": {
-          "js": "3.0.0",
-          "android": "11.0.0",
-          "ios": "11.0.0"
+          "android": "11.8.0",
+          "ios": "11.8.0"
         }
-      },
-      "default": "perspective",
-      "property-type": "data-constant"
-    }
-  },
-  "colorTheme": {
-    "data": {
-      "type": "string",
-      "doc": "Expects a base64 encoded PNG image which represents a cube strip LUT. The height of the image cannot exceed 32 pixels and the width must be equal to the height squared.",
-      "transition": false,
-      "property-type": "data-constant",
-      "expression": {
-        "interpolated": false
       }
-    }
-  },
-  "light": {
-    "anchor": {
-      "type": "enum",
-      "default": "viewport",
-      "values": {
-        "map": {
-          "doc": "The position of the light source is aligned to the rotation of the map."
-        },
-        "viewport": {
-          "doc": "The position of the light source is aligned to the rotation of the viewport."
-        }
-      },
+    },
+    "intensity": {
+      "type": "number",
       "property-type": "data-constant",
-      "transition": false,
+      "default": 1,
+      "minimum": 0,
+      "maximum": 1,
+      "experimental": true,
       "expression": {
-        "interpolated": false,
+        "interpolated": true,
         "parameters": [
-          "zoom"
-        ]
+          "zoom",
+          "measure-light"
+        ],
+        "relaxZoomRestriction": true
       },
-      "doc": "Whether extruded geometries are lit relative to the map or viewport.",
-      "example": "map",
+      "transition": true,
+      "doc": "Snow particles movement factor.",
       "sdk-support": {
         "basic functionality": {
-          "js": "0.27.0",
-          "android": "5.1.0",
-          "ios": "3.6.0"
+          "android": "11.8.0",
+          "ios": "11.8.0"
         }
       }
     },
-    "position": {
-      "type": "array",
+    "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.0,
+        90.0
+      ],
+      "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"
+        }
+      }
+    }
+  },
+  "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.0,
+        80.0
+      ],
+      "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"
+        }
+      }
+    }
+  },
+  "camera": {
+    "camera-projection" : {
+      "doc": "Camera projection describes how 3D world geometry get projected into 2D screen",
+      "type": "enum",
+      "values": {
+        "perspective": {
+          "doc": "linear projection where distant objects appear smaller than closer objects. Lines that are parallel seem to converge towards a vanishing point"
+        },
+        "orthographic": {
+          "doc": "Projection where objects are of the same scale regardless of whether they are far away or near to the camera. Parallel lines remains parallel and there is no vanishing point."
+        }
+      },
+      "transition": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "sdk-support": {
+        "basic functionality": {
+          "js": "3.0.0",
+          "android": "11.0.0",
+          "ios": "11.0.0"
+        }
+      },
+      "default": "perspective",
+      "property-type": "data-constant"
+    }
+  },
+  "colorTheme": {
+    "data": {
+      "type": "string",
+      "doc": "Expects a base64 encoded PNG image which represents a cube strip LUT. The height of the image cannot exceed 32 pixels and the width must be equal to the height squared.",
+      "transition": false,
+      "property-type": "data-constant",
+      "expression": {
+        "interpolated": false
+      }
+    }
+  },
+  "light": {
+    "anchor": {
+      "type": "enum",
+      "default": "viewport",
+      "values": {
+        "map": {
+          "doc": "The position of the light source is aligned to the rotation of the map."
+        },
+        "viewport": {
+          "doc": "The position of the light source is aligned to the rotation of the viewport."
+        }
+      },
+      "property-type": "data-constant",
+      "transition": false,
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "doc": "Whether extruded geometries are lit relative to the map or viewport.",
+      "example": "map",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "0.27.0",
+          "android": "5.1.0",
+          "ios": "3.6.0"
+        }
+      }
+    },
+    "position": {
+      "type": "array",
       "default": [
         1.15,
         210,
@@ -5693,6 +6265,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,
@@ -7859,34 +8481,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": {