@mapbox/mapbox-gl-style-spec 13.24.0 → 13.25.0

package/expression/index.js

@@ -384,7 +384,7 @@ function getExpectedType(spec: StylePropertySpecification): Type {
 }
 
 function getDefaultValue(spec: StylePropertySpecification): Value {
-    if (spec.type === 'color' && isFunction(spec.default)) {
+    if (spec.type === 'color' && (isFunction(spec.default) || Array.isArray(spec.default))) {
         // Special case for heatmap-color: it uses the 'default:' to define a
         // default color ramp, but createExpression expects a simple value to fall
         // back to in case of runtime errors

package/flow-typed/gl-matrix.js

@@ -19,6 +19,7 @@ declare module "gl-matrix" {
         fromValues(number, number, number): Float32Array,
         length(Vec3): number,
         len(Vec3): number,
+        distance(Vec3, Vec3): number,
         squaredLength(Vec3): number,
         dot(Vec3, Vec3): number,
         equals(Vec3, Vec3): boolean,
@@ -41,7 +42,11 @@ declare module "gl-matrix" {
         lerp<T: Vec3>(T, Vec3, Vec3, number): T,
         transformQuat<T: Vec3>(T, Vec3, Quat): T,
         transformMat3<T: Vec3>(T, Vec3, Mat3): T,
-        transformMat4<T: Vec3>(T, Vec3, Mat4): T
+        transformMat4<T: Vec3>(T, Vec3, Mat4): T,
+        angle(Vec3, Vec3): number;
+        rotateX<T: Vec3>(T, Vec3, Vec3, number): T,
+        rotateY<T: Vec3>(T, Vec3, Vec3, number): T,
+        rotateZ<T: Vec3>(T, Vec3, Vec3, number): T,
     };
 
     declare var vec4: {
@@ -82,6 +87,8 @@ declare module "gl-matrix" {
         rotateX<T: Mat4>(T, Mat4, number): T,
         rotateY<T: Mat4>(T, Mat4, number): T,
         rotateZ<T: Mat4>(T, Mat4, number): T,
+        rotate<T: Mat4>(T, Mat4, number, Vec3): T,
+        fromRotation<T: Mat4>(T, number, Vec3): T,
         translate<T: Mat4>(T, Mat4, Vec3): T,
         invert<T: Mat4>(T, Mat4): T,
         copy<T: Mat4>(T, Mat4): T,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mapbox/mapbox-gl-style-spec",
   "description": "a specification for mapbox gl styles",
-  "version": "13.24.0",
+  "version": "13.25.0",
   "author": "Mapbox",
   "keywords": [
     "mapbox",

package/reference/v8.json

@@ -63,7 +63,7 @@
     },
     "fog": {
       "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."
+      "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."
     },
     "sources": {
       "required": true,
@@ -96,7 +96,7 @@
     },
     "projection": {
       "type": "projection",
-      "doc": "The projection the map should be rendered in. Supported projections are Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Mercator, Natural Earth, and Winkel Tripel. Terrain, fog, sky and CustomLayerInterface are not supported for projections other than mercator.",
+      "doc": "The projection the map should be rendered in. Supported projections are Mercator, Globe, Albers, Equal Earth, Equirectangular (WGS84), Lambert conformal conic, Natural Earth, and Winkel Tripel. Terrain, sky and fog are supported by only Mercator and globe. CustomLayerInterface is not supported outside of Mercator.",
       "example": {
         "name": "albers",
         "center": [-154, 50],
@@ -3816,7 +3816,9 @@
       ],
       "sdk-support": {
         "basic functionality": {
-          "js": "2.3.0"
+          "js": "2.3.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
         }
       }
     },
@@ -3831,17 +3833,121 @@
         ]
       },
       "transition": true,
-      "doc": "The color of the fog. Using opacity is recommended only for smoothly transitioning fog on/off as anything less than 100% opacity results in more tiles loaded and drawn.",
+      "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": {
         "basic functionality": {
-          "js": "2.3.0"
+          "js": "2.3.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
+        }
+      }
+    },
+    "high-color": {
+      "type": "color",
+      "property-type": "data-constant",
+      "default": "#245cdf",
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "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": {
+        "basic functionality": {
+          "js": "2.9.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
+        }
+      }
+    },
+    "space-color": {
+      "type": "color",
+      "property-type": "data-constant",
+
+      "default":
+      [
+        "interpolate",
+        [
+          "linear"
+        ],
+        [
+          "zoom"
+        ],
+        4,
+        "#010b19",
+        7,
+        "#367ab9"
+      ],
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "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": {
+        "basic functionality": {
+          "js": "2.9.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
         }
       }
     },
     "horizon-blend": {
       "type": "number",
       "property-type": "data-constant",
-      "default": 0.1,
+      "default":
+      [
+        "interpolate",
+        [
+          "linear"
+        ],
+        [
+          "zoom"
+        ],
+        4,
+        0.2,
+        7,
+        0.1
+      ],
+      "minimum": 0,
+      "maximum": 1,
+      "expression": {
+        "interpolated": true,
+        "parameters": [
+          "zoom"
+        ]
+      },
+      "transition": true,
+      "doc": "Horizon blend applies a smooth fade from the color of the atmosphere to the color of space. A value of zero leaves a sharp transition from atmosphere to space. Increasing the value blends the color of atmosphere into increasingly high angles of the sky.",
+      "sdk-support": {
+        "basic functionality": {
+          "js": "2.3.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
+        }
+      }
+    },
+    "star-intensity": {
+      "type": "number",
+      "property-type": "data-constant",
+      "default":
+      [
+        "interpolate",
+        [
+          "linear"
+        ],
+        [
+          "zoom"
+        ],
+        5,
+        0.35,
+        6,
+        0
+      ],
       "minimum": 0,
       "maximum": 1,
       "expression": {
@@ -3851,10 +3957,12 @@
         ]
       },
       "transition": true,
-      "doc": "Horizon blend applies a smooth fade from the color of the fog to the color of the sky. A value of zero leaves a sharp transition from fog to sky. Increasing the value blends the color of fog into increasingly high angles of the sky.",
+      "doc": "A value controlling the star intensity where `0` will show no stars and `1` will show stars at their maximum intensity.",
       "sdk-support": {
         "basic functionality": {
-          "js": "2.3.0"
+          "js": "2.9.0",
+          "android": "10.6.0",
+          "ios": "10.6.0"
         }
       }
     }
@@ -3991,6 +4099,9 @@
         },
         "winkelTripel": {
           "doc": "A Winkel Tripel projection."
+        },
+        "globe": {
+          "doc": "A globe projection."
         }
       },
       "default": "mercator",
@@ -4007,6 +4118,8 @@
       "length": 2,
       "value": "number",
       "property-type": "data-constant",
+      "minimum": [-180, -90],
+      "maximum": [180, 90],
       "transition": false,
       "doc": "The reference longitude and latitude of the projection. `center` takes the form of [lng, lat]. This property is only configurable for conic projections (Albers and Lambert Conformal Conic). All other projections are centered on [0, 0].",
       "example": [
@@ -4032,6 +4145,8 @@
       "length": 2,
       "value": "number",
       "property-type": "data-constant",
+      "minimum": [-90, -90],
+      "maximum": [90, 90],
       "transition": false,
       "doc":  "The standard parallels of the projection, denoting the desired latitude range with minimal distortion. `parallels` takes the form of [lat0, lat1]. This property is only configurable for conic projections (Albers and Lambert Conformal Conic).",
       "example": [
@@ -4080,6 +4195,9 @@
       },
       "transition": true,
       "doc": "Exaggerates the elevation of the terrain by multiplying the data from the DEM with this value.",
+      "requires": [
+        "source"
+      ],
       "sdk-support": {
         "basic functionality": {
           "js": "2.0.0",
@@ -4876,6 +4994,33 @@
         ]
       },
       "property-type": "color-ramp"
+    },
+    "line-trim-offset": {
+      "type": "array",
+      "value": "number",
+      "doc": "The line part between [trim-start, trim-end] will be marked as transparent to make a route vanishing effect. The line trim-off offset is based on the whole line range [0.0, 1.0].",
+      "length": 2,
+      "default": [0.0, 0.0],
+      "minimum": [0.0, 0.0],
+      "maximum": [1.0, 1.0],
+      "transition": false,
+      "requires": [
+          {
+              "source": "geojson",
+              "has": {
+                  "lineMetrics": true
+              }
+          }
+      ],
+      "sdk-support": {
+        "basic functionality": {
+          "js": "2.9.0",
+          "android": "10.5.0",
+          "ios": "10.5.0",
+          "macos": "10.5.0"
+        }
+      },
+      "property-type": "constant"
     }
   },
   "paint_circle": {

package/types.js

@@ -91,11 +91,14 @@ export type TerrainSpecification = {|
 export type FogSpecification = {|
     "range"?: PropertyValueSpecification<[number, number]>,
     "color"?: PropertyValueSpecification<ColorSpecification>,
-    "horizon-blend"?: PropertyValueSpecification<number>
+    "high-color"?: PropertyValueSpecification<ColorSpecification>,
+    "space-color"?: PropertyValueSpecification<ColorSpecification>,
+    "horizon-blend"?: PropertyValueSpecification<number>,
+    "star-intensity"?: PropertyValueSpecification<number>
 |}
 
 export type ProjectionSpecification = {|
-    "name": "albers" | "equalEarth" | "equirectangular" | "lambertConformalConic" | "mercator" | "naturalEarth" | "winkelTripel",
+    "name": "albers" | "equalEarth" | "equirectangular" | "lambertConformalConic" | "mercator" | "naturalEarth" | "winkelTripel" | "globe",
     "center"?: [number, number],
     "parallels"?: [number, number]
 |}
@@ -229,7 +232,8 @@ export type LineLayerSpecification = {|
         "line-blur"?: DataDrivenPropertyValueSpecification<number>,
         "line-dasharray"?: DataDrivenPropertyValueSpecification<Array<number>>,
         "line-pattern"?: DataDrivenPropertyValueSpecification<ResolvedImageSpecification>,
-        "line-gradient"?: ExpressionSpecification
+        "line-gradient"?: ExpressionSpecification,
+        "line-trim-offset"?: [number, number]
     |}
 |}
 

package/util/color.js

@@ -77,6 +77,11 @@ class Color {
         return `rgba(${Math.round(r)},${Math.round(g)},${Math.round(b)},${a})`;
     }
 
+    /**
+     * Returns an RGBA array of values representing the color, unpremultiplied by A.
+     *
+     * @returns An array of RGBA color values in the range [0, 255].
+     */
     toArray(): [number, number, number, number] {
         const {r, g, b, a} = this;
         return a === 0 ? [0, 0, 0, 0] : [
@@ -86,6 +91,36 @@ class Color {
             a
         ];
     }
+
+    /**
+     * Returns a RGBA array of float values representing the color, unpremultiplied by A.
+     *
+     * @returns An array of RGBA color values in the range [0, 1].
+     */
+    toArray01(): [number, number, number, number] {
+        const {r, g, b, a} = this;
+        return a === 0 ? [0, 0, 0, 0] : [
+            r / a,
+            g / a,
+            b / a,
+            a
+        ];
+    }
+
+    /**
+     * Returns an RGBA array of values representing the color, premultiplied by A.
+     *
+     * @returns An array of RGBA color values in the range [0, 1].
+     */
+    toArray01PremultipliedAlpha(): [number, number, number, number] {
+        const {r, g, b, a} = this;
+        return [
+            r,
+            g,
+            b,
+            a
+        ];
+    }
 }
 
 Color.black = new Color(0, 0, 0, 1);

package/validate/validate_layer.js

@@ -79,7 +79,7 @@ export default function validateLayer(options: Options): Array<ValidationError>
                 errors.push(new ValidationError(key, layer, `layer "${layer.id}" must specify a "source-layer"`));
             } else if (sourceType === 'raster-dem' && type !== 'hillshade') {
                 errors.push(new ValidationError(key, layer.source, 'raster-dem source can only be used with layer type \'hillshade\'.'));
-            } else if (type === 'line' && layer.paint && layer.paint['line-gradient'] &&
+            } else if (type === 'line' && layer.paint && (layer.paint['line-gradient'] || layer.paint['line-trim-offset']) &&
                        (sourceType !== 'geojson' || !source.lineMetrics)) {
                 errors.push(new ValidationError(key, layer, `layer "${layer.id}" specifies a line-gradient, which requires a GeoJSON source with \`lineMetrics\` enabled.`));
             }