promoteId: geojson support, better flow typing, v8 docs

mapbox · mourner · Dec 2, 2019 · Nov 18, 2019 · Nov 18, 2019 · Nov 27, 2019
commit 8271bd0a52d965dc8d3fd4d38537235f62515afc
diff --git a/build/generate-flow-typed-style-spec.js b/build/generate-flow-typed-style-spec.js
@@ -122,6 +122,8 @@ export type FormattedSpecification = string;
 
 export type ResolvedImageSpecification = string;
 
+export type PromoteIdSpecification = {[string]: string} | string;
+
 export type FilterSpecification =
     | ['has', string]
     | ['!has', string]

diff --git a/debug/featurestate.html b/debug/featurestate.html
@@ -48,11 +48,7 @@
 
     function resetFeatureState() {
         if (selectedCounty) {
-            map.setFeatureState({
-                source: 'counties',
-                sourceLayer: 'original',
-                id: selectedCounty
-            }, {hover: false});
+            map.setFeatureState({source: 'counties', sourceLayer: 'original', id: selectedCounty}, {hover: false});
             selectedCounty = null;
         }
     }
@@ -62,17 +58,12 @@
     });
 
     map.on("mousemove", "counties", (e) => {
-        for (const feature of e.features) {
-            if (selectedCounty !== feature.properties.COUNTY) {
-                resetFeatureState();
-                selectedCounty = feature.properties.COUNTY;
-            }
+        const feature = e.features[0];
 
-            map.setFeatureState({
-                source: 'counties',
-                sourceLayer: 'original',
-                id: selectedCounty
-            }, {hover: true});
+        if (selectedCounty !== feature.id) {
+            resetFeatureState();
+            map.setFeatureState({source: 'counties', sourceLayer: 'original', id: feature.id}, {hover: true});
+            selectedCounty = feature.id;
         }
     });
 });

diff --git a/src/data/feature_index.js b/src/data/feature_index.js
@@ -20,7 +20,7 @@ import {polygonIntersectsBox} from '../util/intersection_tests';
 import type StyleLayer from '../style/style_layer';
 import type {FeatureFilter} from '../style-spec/feature_filter';
 import type Transform from '../geo/transform';
-import type {FilterSpecification} from '../style-spec/types';
+import type {FilterSpecification, PromoteIdSpecification} from '../style-spec/types';
 
 import {FeatureIndexArray} from './array_types';
 
@@ -46,15 +46,15 @@ class FeatureIndex {
     grid: Grid;
     grid3D: Grid;
     featureIndexArray: FeatureIndexArray;
-    promoteId: ?{[string]: string} | string;
+    promoteId: ?PromoteIdSpecification;
 
     rawTileData: ArrayBuffer;
     bucketLayerIDs: Array<Array<string>>;
 
     vtLayers: {[string]: VectorTileLayer};
     sourceLayerCoder: DictionaryCoder;
 
-    constructor(tileID: OverscaledTileID, promoteId?: ?{[string]: string} | string) {
+    constructor(tileID: OverscaledTileID, promoteId?: ?PromoteIdSpecification) {
         this.tileID = tileID;
         this.x = tileID.canonical.x;
         this.y = tileID.canonical.y;

diff --git a/src/source/geojson_source.js b/src/source/geojson_source.js
@@ -14,7 +14,7 @@ import type Tile from './tile';
 import type Actor from '../util/actor';
 import type {Callback} from '../types/callback';
 import type {GeoJSON, GeoJSONFeature} from '@mapbox/geojson-types';
-import type {GeoJSONSourceSpecification} from '../style-spec/types';
+import type {GeoJSONSourceSpecification, PromoteIdSpecification} from '../style-spec/types';
 
 /**
  * A source containing GeoJSON.
@@ -69,6 +69,7 @@ class GeoJSONSource extends Evented implements Source {
     maxzoom: number;
     tileSize: number;
     attribution: string;
+    promoteId: ?PromoteIdSpecification;
 
     isTileClipped: boolean;
     reparseOverscaled: boolean;
@@ -114,6 +115,7 @@ class GeoJSONSource extends Evented implements Source {
         if (options.maxzoom !== undefined) this.maxzoom = options.maxzoom;
         if (options.type) this.type = options.type;
         if (options.attribution) this.attribution = options.attribution;
+        this.promoteId = options.promoteId;
 
         const scale = EXTENT / this.tileSize;
 
@@ -295,7 +297,8 @@ class GeoJSONSource extends Evented implements Source {
             tileSize: this.tileSize,
             source: this.id,
             pixelRatio: browser.devicePixelRatio,
-            showCollisionBoxes: this.map.showCollisionBoxes
+            showCollisionBoxes: this.map.showCollisionBoxes,
+            promoteId: this.promoteId
         };
 
         tile.request = this.actor.send(message, params, (err, data) => {

diff --git a/src/source/vector_tile_source.js b/src/source/vector_tile_source.js
@@ -18,7 +18,7 @@ import type Dispatcher from '../util/dispatcher';
 import type Tile from './tile';
 import type {Callback} from '../types/callback';
 import type {Cancelable} from '../types/cancelable';
-import type {VectorSourceSpecification} from '../style-spec/types';
+import type {VectorSourceSpecification, PromoteIdSpecification} from '../style-spec/types';
 
 class VectorTileSource extends Evented implements Source {
     type: 'vector';
@@ -28,7 +28,7 @@ class VectorTileSource extends Evented implements Source {
     url: string;
     scheme: string;
     tileSize: number;
-    promoteId: ?{[string]: string};
+    promoteId: ?PromoteIdSpecification;
 
     _options: VectorSourceSpecification;
     _collectResourceTiming: boolean;

diff --git a/src/source/worker_source.js b/src/source/worker_source.js
@@ -11,6 +11,7 @@ import type {CollisionBoxArray} from '../data/array_types';
 import type DEMData from '../data/dem_data';
 import type {StyleGlyph} from '../style/style_glyph';
 import type {StyleImage} from '../style/style_image';
+import type {PromoteIdSpecification} from '../style-spec/types';
 
 export type TileParameters = {
     source: string,
@@ -23,7 +24,7 @@ export type WorkerTileParameters = TileParameters & {
     zoom: number,
     maxZoom: number,
     tileSize: number,
-    promoteId: ?{[string]: string} | string,
+    promoteId: ?PromoteIdSpecification,
     pixelRatio: number,
     showCollisionBoxes: boolean,
     collectResourceTiming?: boolean,

diff --git a/src/source/worker_tile.js b/src/source/worker_tile.js
@@ -26,6 +26,7 @@ import type {
     WorkerTileParameters,
     WorkerTileCallback,
 } from '../source/worker_source';
+import type {PromoteIdSpecification} from '../style-spec/types';
 
 class WorkerTile {
     tileID: OverscaledTileID;
@@ -34,7 +35,7 @@ class WorkerTile {
     pixelRatio: number;
     tileSize: number;
     source: string;
-    promoteId: ?{[string]: string} | string;
+    promoteId: ?PromoteIdSpecification;
     overscaling: number;
     showCollisionBoxes: boolean;
     collectResourceTiming: boolean;

diff --git a/src/style-spec/reference/v8.json b/src/style-spec/reference/v8.json
@@ -317,6 +317,10 @@
       "default": "mapbox",
       "doc": "The encoding used by this source. Mapbox Terrain RGB is used by default"
     },
+    "promoteId": {
+      "type": "promoteId",
+      "doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{<sourceLayer>: <propertyName>}`."
+    },
     "*": {
       "type": "*",
       "doc": "Other keys to configure the data source."
@@ -383,9 +387,13 @@
       "doc": "Whether to calculate line distance metrics. This is required for line layers that specify `line-gradient` values."
     },
     "generateId": {
-        "type": "boolean",
-        "default": false,
-        "doc": "Whether to generate ids for the geojson features. When enabled, the `feature.id` property will be auto assigned based on its index in the `features` array, over-writing any previous values."
+      "type": "boolean",
+      "default": false,
+      "doc": "Whether to generate ids for the geojson features. When enabled, the `feature.id` property will be auto assigned based on its index in the `features` array, over-writing any previous values."
+    },
+    "promoteId": {
+      "type": "promoteId",
+      "doc": "A property to use as a feature id (for feature state). Either a property name, or an object of the form `{<sourceLayer>: <propertyName>}`."
     }
   },
   "source_video": {

diff --git a/src/style-spec/types.js b/src/style-spec/types.js
@@ -8,6 +8,8 @@ export type FormattedSpecification = string;
 
 export type ResolvedImageSpecification = string;
 
+export type PromoteIdSpecification = {[string]: string} | string;
+
 export type FilterSpecification =
     | ['has', string]
     | ['!has', string]
@@ -110,7 +112,8 @@ export type RasterDEMSourceSpecification = {
     "maxzoom"?: number,
     "tileSize"?: number,
     "attribution"?: string,
-    "encoding"?: "terrarium" | "mapbox"
+    "encoding"?: "terrarium" | "mapbox",
+    "promoteId"?: PromoteIdSpecification
 }
 
 export type GeoJSONSourceSpecification = {|
@@ -125,7 +128,8 @@ export type GeoJSONSourceSpecification = {|
     "clusterMaxZoom"?: number,
     "clusterProperties"?: mixed,
     "lineMetrics"?: boolean,
-    "generateId"?: boolean
+    "generateId"?: boolean,
+    "promoteId"?: PromoteIdSpecification
 |}
 
 export type VideoSourceSpecification = {|