@mapbox/mapbox-gl-style-spec 14.30.0 → 14.31.0-rc.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapbox/mapbox-gl-style-spec",
-  "version": "14.30.0",
+  "version": "14.31.0-rc.1",
   "description": "a specification for mapbox gl styles",
   "author": "Mapbox",
   "license": "SEE LICENSE IN LICENSE.txt",

package/reference/v8.json

@@ -1647,6 +1647,14 @@
             }
           }
         },
+        "placement-group": {
+          "doc": "Marks a placement priority group relative to other layers, going from lower to higher priority. Symbols from groups with higher priorities will be placed first",
+          "sdk-support": {
+            "basic functionality": {}
+          },
+          "private": true,
+          "experimental": true
+        },
         "clip": {
           "doc": "Layer that removes 3D content from map.",
           "sdk-support": {
@@ -1667,7 +1675,7 @@
     },
     "source": {
       "type": "string",
-      "doc": "Name of a source description to be used for this layer. Required for all layer types except `background` and `slot`."
+      "doc": "Name of a source description to be used for this layer. Required for all layer types except `background`, `slot`, and `placement-group`."
     },
     "source-layer": {
       "type": "string",
@@ -10316,6 +10324,56 @@
         ]
       },
       "property-type": "data-driven"
+    },
+    "placement-priority": {
+      "type": "number",
+      "doc": "In-group placement priority. Higher values are placed first within the symbol's placement group.",
+      "default": 0,
+      "minimum": 0,
+      "transition": false,
+      "appearance": true,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom",
+          "pitch",
+          "feature",
+          "feature-state",
+          "measure-light",
+          "distance-from-center"
+        ]
+      },
+      "property-type": "data-driven",
+      "sdk-support": {
+        "basic functionality": {},
+        "data-driven styling": {}
+      },
+      "private": true,
+      "experimental": true
+    },
+    "placement-group": {
+      "type": "string",
+      "doc": "Assigns this symbol layer to the specified placement-group layer, placing its symbols as if they were drawn within that group. When unset, the layer's symbols use an implicitly created placement group located at the same position as the symbol layer.",
+      "transition": false,
+      "appearance": true,
+      "expression": {
+        "interpolated": false,
+        "parameters": [
+          "zoom",
+          "pitch",
+          "feature",
+          "feature-state",
+          "measure-light",
+          "distance-from-center"
+        ]
+      },
+      "property-type": "data-driven",
+      "sdk-support": {
+        "basic functionality": {},
+        "data-driven styling": {}
+      },
+      "private": true,
+      "experimental": true
     }
   },
   "paint_raster": {
@@ -10709,21 +10767,6 @@
         "interpolated": false
       },
       "property-type": "data-constant"
-    },
-    "raster-allow-draping": {
-      "type": "boolean",
-      "default": true,
-      "experimental": true,
-      "doc": "Whether the raster layer is allowed to drape over terrain and globe. When disabled, the layer is rendered after all draped layers, which can change its position in the layer order. Disabling draping has a performance cost, since the terrain/globe geometry must be rendered again for each such layer.",
-      "transition": false,
-      "property-type": "data-constant",
-      "sdk-support": {
-        "basic functionality": {
-          "js": "3.28.0",
-          "android": "11.28.0",
-          "ios": "11.28.0"
-        }
-      }
     }
   },
   "paint_raster-particle": {

package/types.ts

@@ -904,7 +904,15 @@ export type SymbolLayerSpecification = {
         "icon-color-brightness-min"?: number | ExpressionSpecification,
         "icon-color-brightness-max"?: number | ExpressionSpecification,
         "symbol-z-offset"?: DataDrivenPropertyValueSpecification<number>,
-        "symbol-z-offset-transition"?: TransitionSpecification
+        "symbol-z-offset-transition"?: TransitionSpecification,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "placement-priority"?: DataDrivenPropertyValueSpecification<number>,
+        /**
+         * @experimental This property is experimental and subject to change in future versions.
+         */
+        "placement-group"?: DataDrivenPropertyValueSpecification<string>
     },
     "appearances"?: Array<AppearanceSpecification>
 };
@@ -1262,11 +1270,7 @@ export type RasterLayerSpecification = {
         /**
          * @experimental This property is experimental and subject to change in future versions.
          */
-        "raster-elevation-reference"?: "sea" | "ground" | ExpressionSpecification,
-        /**
-         * @experimental This property is experimental and subject to change in future versions.
-         */
-        "raster-allow-draping"?: boolean
+        "raster-elevation-reference"?: "sea" | "ground" | ExpressionSpecification
     },
     "appearances"?: Array<AppearanceSpecification>
 };
@@ -1524,6 +1528,21 @@ export type SlotLayerSpecification = {
     "paint"?: never
 };
 
+export type PlacementGroupLayerSpecification = {
+    "id": string,
+    "type": "placement-group",
+    "metadata"?: unknown,
+    "source"?: never,
+    "source-layer"?: never,
+    "slot"?: string,
+    "minzoom"?: never,
+    "maxzoom"?: never,
+    "filter"?: never,
+    "appearances"?: Array<AppearanceSpecification>,
+    "layout"?: never,
+    "paint"?: never
+};
+
 export type ClipLayerSpecification = {
     "id": string,
     "type": "clip",
@@ -1563,6 +1582,7 @@ export type LayerSpecification =
     | BackgroundLayerSpecification
     | SkyLayerSpecification
     | SlotLayerSpecification
+    | PlacementGroupLayerSpecification
     | ClipLayerSpecification;
 
 export type LayoutSpecification = UnionToIntersection<NonNullable<LayerSpecification['layout']>>;
@@ -1668,6 +1688,11 @@ export type SkyLayer = SkyLayerSpecification;
  */
 export type SlotLayer = SlotLayerSpecification;
 
+/**
+ * @deprecated Use `PlacementGroupLayerSpecification` instead.
+ */
+export type PlacementGroupLayer = PlacementGroupLayerSpecification;
+
 /**
  * @deprecated Use `ClipLayerSpecification` instead.
  */

package/validate/validate_layer.ts

@@ -72,7 +72,7 @@ export default function validateLayer(options: LayerValidatorOptions): Validatio
         } else {
             type = unbundle(parent.type) as string;
         }
-    } else if (!(type === 'background' || type === 'sky' || type === 'slot')) {
+    } else if (!(type === 'background' || type === 'sky' || type === 'slot' || type === 'placement-group')) {
         if (!layer.source) {
             errors.push(new ValidationError(key, layer, 'missing required property "source"'));
         } else if (!isString(layer.source)) {