feat(tileset): Add WidgetTilesetSource#extractTileFeatures() (#71)

CartoDB · Jan 15, 2025 · 9affa4f · 9affa4f
1 parent c070abd
commit 9affa4f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 7 deletions.
diff --git a/examples/03-tileset/app.ts b/examples/03-tileset/app.ts
@@ -84,7 +84,8 @@ function updateLayers() {
     onViewportLoad: (tiles) => {
       const viewport = new WebMercatorViewport(viewState);
       const spatialFilter = createViewportSpatialFilter(viewport.getBounds())!;
-      data.widgetSource.loadTiles({tiles, spatialFilter});
+      data.widgetSource.loadTiles(tiles);
+      data.widgetSource.extractTileFeatures({spatialFilter});
       updateWidgets();
     },
   });

diff --git a/examples/04-tileset-h3/app.ts b/examples/04-tileset-h3/app.ts
@@ -84,7 +84,8 @@ function updateLayers() {
     onViewportLoad: (tiles) => {
       const viewport = new WebMercatorViewport(viewState);
       const spatialFilter = createViewportSpatialFilter(viewport.getBounds())!;
-      data.widgetSource.loadTiles({tiles, spatialFilter});
+      data.widgetSource.loadTiles(tiles);
+      data.widgetSource.extractTileFeatures({spatialFilter});
       updateWidgets();
     },
   });

diff --git a/src/widget-sources/widget-tileset-source.ts b/src/widget-sources/widget-tileset-source.ts
@@ -76,6 +76,7 @@ export type WidgetTilesetSourceResult = {widgetSource: WidgetTilesetSource};
  * ```
  */
 export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps> {
+  private _tiles: Tile[] = [];
   private _features: FeatureData[] = [];
 
   protected override getModelSource(owner: string): ModelSource {
@@ -86,14 +87,24 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     };
   }
 
-  /** Loads features as a list of tiles (typically provided by deck.gl). */
-  loadTiles({
-    tiles,
+  /**
+   * Loads features as a list of tiles (typically provided by deck.gl).
+   * After tiles are loaded, {@link extractTileFeatures} must be called
+   * before computing statistics on the tiles.
+   */
+  loadTiles(tiles: unknown[]) {
+    this._tiles = tiles as Tile[];
+  }
+
+  /**
+   * Extracts feature data from tiles previously loaded with {@link loadTiles}.
+   * Must be called before computing statistics on tiles.
+   */
+  extractTileFeatures({
     spatialFilter,
     uniqueIdProperty,
     options,
   }: {
-    tiles: Tile[];
     spatialFilter: SpatialFilter;
     // TODO(cleanup): As an optional property, 'uniqueIdProperty' will be easy to forget.
     // Would it be better to configure it on the source function, rather than separately
@@ -102,7 +113,7 @@ export class WidgetTilesetSource extends WidgetSource<WidgetTilesetSourceProps>
     options?: TileFeatureExtractOptions;
   }) {
     this._features = tileFeatures({
-      tiles,
+      tiles: this._tiles,
       options,
       spatialFilter,
       uniqueIdProperty,