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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -280,57 +280,114 @@ type FogSpecification = {
280
280
  "vertical-range-transition"?: TransitionSpecification;
281
281
  };
282
282
  type SnowSpecification = {
283
+ /**
284
+ * @experimental This property is experimental and subject to change in future versions.
285
+ */
283
286
  "density"?: PropertyValueSpecification<number>;
284
287
  "density-transition"?: TransitionSpecification;
288
+ /**
289
+ * @experimental This property is experimental and subject to change in future versions.
290
+ */
285
291
  "intensity"?: PropertyValueSpecification<number>;
286
292
  "intensity-transition"?: TransitionSpecification;
293
+ /**
294
+ * @experimental This property is experimental and subject to change in future versions.
295
+ */
287
296
  "color"?: PropertyValueSpecification<ColorSpecification>;
288
297
  "color-transition"?: TransitionSpecification;
289
298
  "color-use-theme"?: PropertyValueSpecification<string>;
299
+ /**
300
+ * @experimental This property is experimental and subject to change in future versions.
301
+ */
290
302
  "opacity"?: PropertyValueSpecification<number>;
291
303
  "opacity-transition"?: TransitionSpecification;
304
+ /**
305
+ * @experimental This property is experimental and subject to change in future versions.
306
+ */
292
307
  "vignette"?: PropertyValueSpecification<number>;
293
308
  "vignette-transition"?: TransitionSpecification;
309
+ /**
310
+ * @experimental This property is experimental and subject to change in future versions.
311
+ */
294
312
  "vignette-color"?: PropertyValueSpecification<ColorSpecification>;
295
313
  "vignette-color-transition"?: TransitionSpecification;
296
314
  "vignette-color-use-theme"?: PropertyValueSpecification<string>;
315
+ /**
316
+ * @experimental This property is experimental and subject to change in future versions.
317
+ */
297
318
  "center-thinning"?: PropertyValueSpecification<number>;
298
319
  "center-thinning-transition"?: TransitionSpecification;
320
+ /**
321
+ * @experimental This property is experimental and subject to change in future versions.
322
+ */
299
323
  "direction"?: PropertyValueSpecification<[
300
324
  number,
301
325
  number
302
326
  ]>;
303
327
  "direction-transition"?: TransitionSpecification;
328
+ /**
329
+ * @experimental This property is experimental and subject to change in future versions.
330
+ */
304
331
  "flake-size"?: PropertyValueSpecification<number>;
305
332
  "flake-size-transition"?: TransitionSpecification;
306
333
  };
307
334
  type RainSpecification = {
335
+ /**
336
+ * @experimental This property is experimental and subject to change in future versions.
337
+ */
308
338
  "density"?: PropertyValueSpecification<number>;
309
339
  "density-transition"?: TransitionSpecification;
340
+ /**
341
+ * @experimental This property is experimental and subject to change in future versions.
342
+ */
310
343
  "intensity"?: PropertyValueSpecification<number>;
311
344
  "intensity-transition"?: TransitionSpecification;
345
+ /**
346
+ * @experimental This property is experimental and subject to change in future versions.
347
+ */
312
348
  "color"?: PropertyValueSpecification<ColorSpecification>;
313
349
  "color-transition"?: TransitionSpecification;
314
350
  "color-use-theme"?: PropertyValueSpecification<string>;
351
+ /**
352
+ * @experimental This property is experimental and subject to change in future versions.
353
+ */
315
354
  "opacity"?: PropertyValueSpecification<number>;
316
355
  "opacity-transition"?: TransitionSpecification;
356
+ /**
357
+ * @experimental This property is experimental and subject to change in future versions.
358
+ */
317
359
  "vignette"?: PropertyValueSpecification<number>;
318
360
  "vignette-transition"?: TransitionSpecification;
361
+ /**
362
+ * @experimental This property is experimental and subject to change in future versions.
363
+ */
319
364
  "vignette-color"?: PropertyValueSpecification<ColorSpecification>;
320
365
  "vignette-color-transition"?: TransitionSpecification;
321
366
  "vignette-color-use-theme"?: PropertyValueSpecification<string>;
367
+ /**
368
+ * @experimental This property is experimental and subject to change in future versions.
369
+ */
322
370
  "center-thinning"?: PropertyValueSpecification<number>;
323
371
  "center-thinning-transition"?: TransitionSpecification;
372
+ /**
373
+ * @experimental This property is experimental and subject to change in future versions.
374
+ */
324
375
  "direction"?: PropertyValueSpecification<[
325
376
  number,
326
377
  number
327
378
  ]>;
328
379
  "direction-transition"?: TransitionSpecification;
380
+ /**
381
+ * @experimental This property is experimental and subject to change in future versions.
382
+ */
329
383
  "droplet-size"?: PropertyValueSpecification<[
330
384
  number,
331
385
  number
332
386
  ]>;
333
387
  "droplet-size-transition"?: TransitionSpecification;
388
+ /**
389
+ * @experimental This property is experimental and subject to change in future versions.
390
+ */
334
391
  "distortion-strength"?: PropertyValueSpecification<number>;
335
392
  "distortion-strength-transition"?: TransitionSpecification;
336
393
  };
@@ -666,11 +723,20 @@ type FillLayerSpecification = {
666
723
  "fill-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>;
667
724
  "fill-emissive-strength"?: PropertyValueSpecification<number>;
668
725
  "fill-emissive-strength-transition"?: TransitionSpecification;
726
+ /**
727
+ * @experimental This property is experimental and subject to change in future versions.
728
+ */
669
729
  "fill-z-offset"?: DataDrivenPropertyValueSpecification<number>;
670
730
  "fill-z-offset-transition"?: TransitionSpecification;
731
+ /**
732
+ * @experimental This property is experimental and subject to change in future versions.
733
+ */
671
734
  "fill-bridge-guard-rail-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
672
735
  "fill-bridge-guard-rail-color-transition"?: TransitionSpecification;
673
736
  "fill-bridge-guard-rail-color-use-theme"?: PropertyValueSpecification<string>;
737
+ /**
738
+ * @experimental This property is experimental and subject to change in future versions.
739
+ */
674
740
  "fill-tunnel-structure-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
675
741
  "fill-tunnel-structure-color-transition"?: TransitionSpecification;
676
742
  "fill-tunnel-structure-color-use-theme"?: PropertyValueSpecification<string>;
@@ -745,6 +811,9 @@ type LineLayerSpecification = {
745
811
  number,
746
812
  number
747
813
  ]>;
814
+ /**
815
+ * @experimental This property is experimental and subject to change in future versions.
816
+ */
748
817
  "line-trim-color"?: PropertyValueSpecification<ColorSpecification>;
749
818
  "line-trim-color-transition"?: TransitionSpecification;
750
819
  "line-trim-color-use-theme"?: PropertyValueSpecification<string>;
@@ -888,6 +957,9 @@ type SymbolLayerSpecification = {
888
957
  "icon-color-contrast"?: ExpressionSpecification;
889
958
  "icon-color-brightness-min"?: ExpressionSpecification;
890
959
  "icon-color-brightness-max"?: ExpressionSpecification;
960
+ /**
961
+ * @experimental This property is experimental and subject to change in future versions.
962
+ */
891
963
  "symbol-z-offset"?: DataDrivenPropertyValueSpecification<number>;
892
964
  "symbol-z-offset-transition"?: TransitionSpecification;
893
965
  };
@@ -1011,23 +1083,50 @@ type FillExtrusionLayerSpecification = {
1011
1083
  "fill-extrusion-ambient-occlusion-intensity-transition"?: TransitionSpecification;
1012
1084
  "fill-extrusion-ambient-occlusion-radius"?: PropertyValueSpecification<number>;
1013
1085
  "fill-extrusion-ambient-occlusion-radius-transition"?: TransitionSpecification;
1086
+ /**
1087
+ * @experimental This property is experimental and subject to change in future versions.
1088
+ */
1014
1089
  "fill-extrusion-ambient-occlusion-wall-radius"?: PropertyValueSpecification<number>;
1015
1090
  "fill-extrusion-ambient-occlusion-wall-radius-transition"?: TransitionSpecification;
1091
+ /**
1092
+ * @experimental This property is experimental and subject to change in future versions.
1093
+ */
1016
1094
  "fill-extrusion-ambient-occlusion-ground-radius"?: PropertyValueSpecification<number>;
1017
1095
  "fill-extrusion-ambient-occlusion-ground-radius-transition"?: TransitionSpecification;
1096
+ /**
1097
+ * @experimental This property is experimental and subject to change in future versions.
1098
+ */
1018
1099
  "fill-extrusion-ambient-occlusion-ground-attenuation"?: PropertyValueSpecification<number>;
1019
1100
  "fill-extrusion-ambient-occlusion-ground-attenuation-transition"?: TransitionSpecification;
1101
+ /**
1102
+ * @experimental This property is experimental and subject to change in future versions.
1103
+ */
1020
1104
  "fill-extrusion-flood-light-color"?: PropertyValueSpecification<ColorSpecification>;
1021
1105
  "fill-extrusion-flood-light-color-transition"?: TransitionSpecification;
1022
1106
  "fill-extrusion-flood-light-color-use-theme"?: PropertyValueSpecification<string>;
1107
+ /**
1108
+ * @experimental This property is experimental and subject to change in future versions.
1109
+ */
1023
1110
  "fill-extrusion-flood-light-intensity"?: PropertyValueSpecification<number>;
1024
1111
  "fill-extrusion-flood-light-intensity-transition"?: TransitionSpecification;
1112
+ /**
1113
+ * @experimental This property is experimental and subject to change in future versions.
1114
+ */
1025
1115
  "fill-extrusion-flood-light-wall-radius"?: DataDrivenPropertyValueSpecification<number>;
1026
1116
  "fill-extrusion-flood-light-wall-radius-transition"?: TransitionSpecification;
1117
+ /**
1118
+ * @experimental This property is experimental and subject to change in future versions.
1119
+ */
1027
1120
  "fill-extrusion-flood-light-ground-radius"?: DataDrivenPropertyValueSpecification<number>;
1028
1121
  "fill-extrusion-flood-light-ground-radius-transition"?: TransitionSpecification;
1122
+ /**
1123
+ * @experimental This property is experimental and subject to change in future versions.
1124
+ */
1029
1125
  "fill-extrusion-flood-light-ground-attenuation"?: PropertyValueSpecification<number>;
1030
1126
  "fill-extrusion-flood-light-ground-attenuation-transition"?: TransitionSpecification;
1127
+ /**
1128
+ * @experimental This property is experimental and subject to change in future versions.
1129
+ */
1031
1130
  "fill-extrusion-vertical-scale"?: PropertyValueSpecification<number>;
1032
1131
  "fill-extrusion-vertical-scale-transition"?: TransitionSpecification;
1033
1132
  /**
@@ -1037,11 +1136,87 @@ type FillExtrusionLayerSpecification = {
1037
1136
  "fill-extrusion-cutoff-fade-range"?: ExpressionSpecification;
1038
1137
  "fill-extrusion-emissive-strength"?: DataDrivenPropertyValueSpecification<number>;
1039
1138
  "fill-extrusion-emissive-strength-transition"?: TransitionSpecification;
1139
+ /**
1140
+ * @experimental This property is experimental and subject to change in future versions.
1141
+ */
1040
1142
  "fill-extrusion-line-width"?: DataDrivenPropertyValueSpecification<number>;
1041
1143
  "fill-extrusion-line-width-transition"?: TransitionSpecification;
1042
1144
  "fill-extrusion-cast-shadows"?: boolean;
1043
1145
  };
1044
1146
  };
1147
+ type BuildingLayerSpecification = {
1148
+ "id": string;
1149
+ "type": "building";
1150
+ "metadata"?: unknown;
1151
+ "source": string;
1152
+ "source-layer"?: string;
1153
+ "slot"?: string;
1154
+ "minzoom"?: number;
1155
+ "maxzoom"?: number;
1156
+ "filter"?: FilterSpecification;
1157
+ "layout"?: {
1158
+ "visibility"?: "visible" | "none" | ExpressionSpecification;
1159
+ /**
1160
+ * @experimental This property is experimental and subject to change in future versions.
1161
+ */
1162
+ "building-roof-shape"?: DataDrivenPropertyValueSpecification<"flat" | "hipped" | "gabled" | "parapet" | "mansard" | "skillion" | "pyramidal">;
1163
+ /**
1164
+ * @experimental This property is experimental and subject to change in future versions.
1165
+ */
1166
+ "building-height"?: DataDrivenPropertyValueSpecification<number>;
1167
+ "building-height-transition"?: TransitionSpecification;
1168
+ /**
1169
+ * @experimental This property is experimental and subject to change in future versions.
1170
+ */
1171
+ "building-base"?: DataDrivenPropertyValueSpecification<number>;
1172
+ "building-base-transition"?: TransitionSpecification;
1173
+ };
1174
+ "paint"?: {
1175
+ /**
1176
+ * @experimental This property is experimental and subject to change in future versions.
1177
+ */
1178
+ "building-opacity"?: PropertyValueSpecification<number>;
1179
+ "building-opacity-transition"?: TransitionSpecification;
1180
+ /**
1181
+ * @experimental This property is experimental and subject to change in future versions.
1182
+ */
1183
+ "building-ambient-occlusion-wall-intensity"?: PropertyValueSpecification<number>;
1184
+ "building-ambient-occlusion-wall-intensity-transition"?: TransitionSpecification;
1185
+ /**
1186
+ * @experimental This property is experimental and subject to change in future versions.
1187
+ */
1188
+ "building-ambient-occlusion-ground-intensity"?: PropertyValueSpecification<number>;
1189
+ "building-ambient-occlusion-ground-intensity-transition"?: TransitionSpecification;
1190
+ /**
1191
+ * @experimental This property is experimental and subject to change in future versions.
1192
+ */
1193
+ "building-ambient-occlusion-ground-radius"?: PropertyValueSpecification<number>;
1194
+ "building-ambient-occlusion-ground-radius-transition"?: TransitionSpecification;
1195
+ /**
1196
+ * @experimental This property is experimental and subject to change in future versions.
1197
+ */
1198
+ "building-ambient-occlusion-ground-attenuation"?: PropertyValueSpecification<number>;
1199
+ "building-ambient-occlusion-ground-attenuation-transition"?: TransitionSpecification;
1200
+ /**
1201
+ * @experimental This property is experimental and subject to change in future versions.
1202
+ */
1203
+ "building-vertical-scale"?: PropertyValueSpecification<number>;
1204
+ "building-vertical-scale-transition"?: TransitionSpecification;
1205
+ /**
1206
+ * @experimental This property is experimental and subject to change in future versions.
1207
+ */
1208
+ "building-cast-shadows"?: boolean;
1209
+ /**
1210
+ * @experimental This property is experimental and subject to change in future versions.
1211
+ */
1212
+ "building-color"?: DataDrivenPropertyValueSpecification<ColorSpecification>;
1213
+ "building-color-use-theme"?: PropertyValueSpecification<string>;
1214
+ /**
1215
+ * @experimental This property is experimental and subject to change in future versions.
1216
+ */
1217
+ "building-emissive-strength"?: DataDrivenPropertyValueSpecification<number>;
1218
+ };
1219
+ };
1045
1220
  type RasterLayerSpecification = {
1046
1221
  "id": string;
1047
1222
  "type": "raster";
@@ -1090,6 +1265,9 @@ type RasterLayerSpecification = {
1090
1265
  * @experimental This property is experimental and subject to change in future versions.
1091
1266
  */
1092
1267
  "raster-array-band"?: string;
1268
+ /**
1269
+ * @experimental This property is experimental and subject to change in future versions.
1270
+ */
1093
1271
  "raster-elevation"?: PropertyValueSpecification<number>;
1094
1272
  "raster-elevation-transition"?: TransitionSpecification;
1095
1273
  };
@@ -1310,7 +1488,7 @@ type ClipLayerSpecification = {
1310
1488
  };
1311
1489
  "paint"?: never;
1312
1490
  };
1313
- type LayerSpecification = FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | RasterLayerSpecification | RasterParticleLayerSpecification | HillshadeLayerSpecification | ModelLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification | SlotLayerSpecification | ClipLayerSpecification;
1491
+ type LayerSpecification = FillLayerSpecification | LineLayerSpecification | SymbolLayerSpecification | CircleLayerSpecification | HeatmapLayerSpecification | FillExtrusionLayerSpecification | BuildingLayerSpecification | RasterLayerSpecification | RasterParticleLayerSpecification | HillshadeLayerSpecification | ModelLayerSpecification | BackgroundLayerSpecification | SkyLayerSpecification | SlotLayerSpecification | ClipLayerSpecification;
1314
1492
  /**
1315
1493
  * Given an array of layers, some of which may contain `ref` properties
1316
1494
  * whose value is the `id` of another property, return a new array where
@@ -1678,12 +1856,12 @@ declare class EvaluationContext {
1678
1856
  [_: string]: Color | null | undefined;
1679
1857
  };
1680
1858
  constructor(scope?: string | null, options?: ConfigOptions | null);
1681
- id(): number | null;
1859
+ id(): string | number | null;
1682
1860
  geometryType(): null | string;
1683
1861
  geometry(): Array<Array<Point>> | null | undefined;
1684
1862
  canonicalID(): null | CanonicalTileID;
1685
1863
  properties(): {
1686
- [key: string]: any;
1864
+ readonly [key: string]: unknown;
1687
1865
  };
1688
1866
  measureLight(_: string): number;
1689
1867
  distanceFromCenter(): number;
@@ -1713,13 +1891,9 @@ type InterpolationType = {
1713
1891
  };
1714
1892
  interface Feature {
1715
1893
  readonly type: 0 | 1 | 2 | 3 | "Unknown" | "Point" | "LineString" | "Polygon";
1716
- readonly id?: number | null;
1717
- readonly properties: {
1718
- [_: string]: any;
1719
- };
1720
- readonly patterns?: {
1721
- [_: string]: string;
1722
- };
1894
+ readonly id?: string | number | null;
1895
+ readonly properties: Record<PropertyKey, unknown>;
1896
+ readonly patterns?: Record<PropertyKey, string>;
1723
1897
  readonly geometry?: Array<Array<Point>>;
1724
1898
  }
1725
1899
  type FeatureState = {