Skip to content

Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.

[feat] add deck.gl onFilteredItemsChange callback to DeckGl overlays (#2691)

Igor Dykhta1c0ef9a9f4b4
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 875393883..16b80b8c4 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -142,6 +142,7 @@ export const ActionTypes = {
ADD_NOTIFICATION: `${ACTION_PREFIX}ADD_NOTIFICATION`,
REMOVE_NOTIFICATION: `${ACTION_PREFIX}REMOVE_NOTIFICATION`,
SET_LOCALE: `${ACTION_PREFIX}SET_LOCALE`,
+ LAYER_FILTERED_ITEMS_CHANGE: `${ACTION_PREFIX}LAYER_FILTERED_ITEMS_CHANGE`,
TOGGLE_PANEL_LIST_VIEW: `${ACTION_PREFIX}TOGGLE_PANEL_LIST_VIEW`,
// uiState > export image
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index 648fb9ac6..04e08777b 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -1528,6 +1528,32 @@ export function setFilterAnimationTimeConfig(
};
}
+export type LayerFilteredItemsChangeAction = {
+ event: {
+ id: string;
+ count: number;
+ };
+ layer: Layer;
+};
+
+/**
+ * deck.gl layer gpu filter callback
+ * @memberof visStateActions
+ * @param layer
+ * @param event
+ * @return action
+ */
+export function layerFilteredItemsChange(
+ layer: LayerFilteredItemsChangeAction['layer'],
+ event: LayerFilteredItemsChangeAction['event']
+): Merge<LayerFilteredItemsChangeAction, {type: typeof ActionTypes.LAYER_FILTERED_ITEMS_CHANGE}> {
+ return {
+ type: ActionTypes.LAYER_FILTERED_ITEMS_CHANGE,
+ layer,
+ event
+ };
+}
+
/**
* This declaration is needed to group actions in docs
*/
diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsx
index 6d1357341..c7011d65f 100644
--- a/src/components/src/map-container.tsx
+++ b/src/components/src/map-container.tsx
@@ -471,6 +471,10 @@ export default function MapContainerFactory(
} as Partial<LayerBaseConfig>);
};
+ _onLayerFilteredItemsChange = (idx, event) => {
+ this.props.visStateActions.layerFilteredItemsChange(this.props.visState.layers[idx], event);
+ };
+
_handleMapToggleLayer = layerId => {
const {index: mapIndex = 0, visStateActions} = this.props;
visStateActions.toggleLayerForMap(mapIndex, layerId);
@@ -754,7 +758,8 @@ export default function MapContainerFactory(
},
{
onLayerHover: this._onLayerHover,
- onSetLayerDomain: this._onLayerSetDomain
+ onSetLayerDomain: this._onLayerSetDomain,
+ onFilteredItemsChange: this._onLayerFilteredItemsChange
},
deckGlProps
);
diff --git a/src/layers/src/aggregation-layer.ts b/src/layers/src/aggregation-layer.ts
index 4c5796289..ca3b0f852 100644
--- a/src/layers/src/aggregation-layer.ts
+++ b/src/layers/src/aggregation-layer.ts
@@ -175,6 +175,11 @@ export default class AggregationLayer extends Layer {
return object;
}
+ getFilteredItemCount() {
+ // gpu filter not supported
+ return null;
+ }
+
/**
* Aggregation layer handles visual channel aggregation inside deck.gl layer
*/
diff --git a/src/layers/src/base-layer.ts b/src/layers/src/base-layer.ts
index 0ec6bff8a..3873d3c69 100644
--- a/src/layers/src/base-layer.ts
+++ b/src/layers/src/base-layer.ts
@@ -183,7 +183,11 @@ export const LAYER_ID_LENGTH = 6;
const MAX_SAMPLE_SIZE = 5000;
const defaultDomain: [number, number] = [0, 1];
-const dataFilterExtension = new DataFilterExtension({filterSize: MAX_GPU_FILTERS});
+const dataFilterExtension = new DataFilterExtension({
+ filterSize: MAX_GPU_FILTERS,
+ // @ts-expect-error not typed
+ countItems: true
+});
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const defaultDataAccessor = dc => d => d;
@@ -233,6 +237,9 @@ class Layer {
isValid: boolean;
errorMessage: string | null;
+ filteredItemCount: {
+ [deckLayerId: string]: number;
+ };
constructor(props: BaseLayerConstructorProps) {
this.id = props.id || generateHashId(LAYER_ID_LENGTH);
@@ -257,6 +264,8 @@ class Layer {
// false indicates that the layer caused an error, and was disabled
this.isValid = true;
this.errorMessage = null;
+ // item count
+ this.filteredItemCount = {};
}
get layerIcon(): React.ElementType {
@@ -664,6 +673,14 @@ class Layer {
return dataContainer.row(object.index);
}
+ getFilteredItemCount(): number | null {
+ // use first layer
+ if (Object.keys(this.filteredItemCount).length) {
+ const firstLayer = Object.keys(this.filteredItemCount)[0];
+ return this.filteredItemCount[firstLayer];
+ }
+ return null;
+ }
/**
* When change layer type, try to copy over layer configs as much as possible
* @param configToCopy - config to copy over
@@ -1187,6 +1204,9 @@ class Layer {
if (triggerChanged && (triggerChanged.getMeta || triggerChanged.getData)) {
this.updateLayerMeta(dataContainer, getPosition);
+
+ // reset filteredItemCount
+ this.filteredItemCount = {};
}
let data = [];
@@ -1378,11 +1398,13 @@ class Layer {
idx,
gpuFilter,
mapState,
+ layerCallbacks,
visible
}: {
idx: number;
gpuFilter: GpuFilter;
mapState: MapState;
+ layerCallbacks: any;
visible: boolean;
}) {
return {
@@ -1399,6 +1421,7 @@ class Layer {
// data filtering
extensions: [dataFilterExtension],
filterRange: gpuFilter ? gpuFilter.filterRange : undefined,
+ onFilteredItemsChange: gpuFilter ? layerCallbacks?.onFilteredItemsChange : undefined,
// layer should be visible and if splitMap, shown in to one of panel
visible: this.config.isVisible && visible
diff --git a/src/layers/src/geojson-layer/geojson-layer.ts b/src/layers/src/geojson-layer/geojson-layer.ts
index d117d3319..9f26887fe 100644
--- a/src/layers/src/geojson-layer/geojson-layer.ts
+++ b/src/layers/src/geojson-layer/geojson-layer.ts
@@ -429,6 +429,24 @@ export default class GeoJsonLayer extends Layer {
return null;
}
+ getFilteredItemCount() {
+ // return -polygons-fill or -polygons-stroke
+ // + -linestrings
+ // + -points-circle
+ if (Object.keys(this.filteredItemCount).length) {
+ const polygonCount =
+ this.filteredItemCount[`${this.id}-polygons-fill`] ||
+ this.filteredItemCount[`${this.id}-polygons-stroke`] ||
+ 0;
+ const linestringCount = this.filteredItemCount[`${this.id}-linestrings`] || 0;
+ const pointCount = this.filteredItemCount[`${this.id}-points-circle`] || 0;
+
+ return polygonCount + linestringCount + pointCount;
+ }
+
+ return null;
+ }
+
calculateDataAttribute(dataset: KeplerTable) {
const {dataContainer, filteredIndex} = dataset;
if (dataContainer instanceof ArrowDataContainer) {
diff --git a/src/layers/src/icon-layer/icon-layer.ts b/src/layers/src/icon-layer/icon-layer.ts
index 58412a258..855b03bb0 100644
--- a/src/layers/src/icon-layer/icon-layer.ts
+++ b/src/layers/src/icon-layer/icon-layer.ts
@@ -263,6 +263,18 @@ export default class IconLayer extends Layer {
return {props};
}
+ getFilteredItemCount() {
+ // use total
+ if (Object.keys(this.filteredItemCount).length) {
+ return Object.values(this.filteredItemCount).reduce(
+ (total, curr) => (Number.isFinite(curr) ? total + curr : total),
+ 0
+ );
+ }
+
+ return null;
+ }
+
calculateDataAttribute({dataContainer, filteredIndex}: KeplerTable, getPosition) {
const getIcon = this.getIconAccessor(dataContainer);
const data: IconLayerData[] = [];
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 0571447c5..8ff36012c 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -343,6 +343,13 @@ export function bindLayerCallbacks(layerCallbacks: LayerCallbacks = {}, idx: num
export type LayerCallbacks = {
onLayerHover?: (idx: number, value: any) => void;
onSetLayerDomain?: (idx: number, value: any) => void;
+ onFilteredItemsChange?: (
+ idx: number,
+ event: {
+ id: string;
+ count: number;
+ }
+ ) => void;
};
// eslint-disable-next-line complexity
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 04afb0e28..689cc3d4b 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -3033,6 +3033,7 @@ function checkTimeConfigArgs(config) {
return accu;
}, {});
}
+
/**
* Update editor
*/
@@ -3047,6 +3048,36 @@ export function setLayerAnimationTimeConfigUpdater(
return pick_('animationConfig')(merge_(updates))(state);
}
+/**
+ * Update editor
+ */
+export function layerFilteredItemsChangeUpdater<S extends VisState>(
+ state: S,
+ action: VisStateActions.LayerFilteredItemsChangeAction
+): S {
+ const {event, layer} = action;
+ const {id: deckglLayerId, count} = event;
+ if (!layer) {
+ Console.warn(`layerFilteredItems layer doesnt exists`);
+ return state;
+ }
+ if (layer.filteredItemCount?.[deckglLayerId] === count) {
+ return state;
+ }
+
+ layer.filteredItemCount = {
+ ...layer.filteredItemCount,
+ [deckglLayerId]: count
+ };
+
+ const nextState = {
+ ...state,
+ layers: swap_(layer)(state.layers)
+ };
+
+ return nextState;
+}
+
// Find dataId from a saved visState property:
// layers, filters, interactions, layerBlending, overlayBlending, splitMaps, animationConfig, editor
// replace it with another dataId
diff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.ts
index 9d8bfa3e4..95fad029b 100644
--- a/src/reducers/src/vis-state.ts
+++ b/src/reducers/src/vis-state.ts
@@ -140,6 +140,8 @@ const actionHandler = {
[ActionTypes.SET_LAYER_ANIMATION_TIME_CONFIG]:
visStateUpdaters.setLayerAnimationTimeConfigUpdater,
+ [ActionTypes.LAYER_FILTERED_ITEMS_CHANGE]: visStateUpdaters.layerFilteredItemsChangeUpdater,
+
[ActionTypes.ADD_EFFECT]: visStateUpdaters.addEffectUpdater,
[ActionTypes.REORDER_EFFECT]: visStateUpdaters.reorderEffectUpdater,
diff --git a/src/utils/src/plot.ts b/src/utils/src/plot.ts
index 023b611f7..acbc8d993 100644
--- a/src/utils/src/plot.ts
+++ b/src/utils/src/plot.ts
@@ -85,9 +85,7 @@ export function histogramFromDomain(
numBins: number,
valueAccessor?: (d: unknown) => number
): Bin[] {
- const getBins = d3Histogram()
- .thresholds(ticks(domain[0], domain[1], numBins))
- .domain(domain);
+ const getBins = d3Histogram().thresholds(ticks(domain[0], domain[1], numBins)).domain(domain);
if (valueAccessor) {
getBins.value(valueAccessor);
}
@@ -201,6 +199,9 @@ export function runGpuFilterForPlot(dataset, filter) {
function getSkipIndexes(dataset, filter) {
// array of gpu filter names
+ if (!filter) {
+ return [];
+ }
const gpuFilters = Object.values(dataset.gpuFilter.filterValueUpdateTriggers) as ({
name: string;
} | null)[];
diff --git a/test/helpers/layer-utils.js b/test/helpers/layer-utils.js
index ead7075c1..b6e8b17cc 100644
--- a/test/helpers/layer-utils.js
+++ b/test/helpers/layer-utils.js
@@ -176,6 +176,7 @@ export function testRenderLayerCases(t, LayerClass, testCases) {
getGpuFilterProps([], layer.config.dataId, tc.datasets[layer.config.dataId].fields),
interactionConfig: INITIAL_VIS_STATE.interactionConfig,
visible: true,
+ layerCallbacks: {},
...(tc.renderArgs || {})
});
diff --git a/test/node/reducers/vis-state-test.js b/test/node/reducers/vis-state-test.js
index e89a666ff..9616469fa 100644
--- a/test/node/reducers/vis-state-test.js
+++ b/test/node/reducers/vis-state-test.js
@@ -3419,6 +3419,7 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {
const oldState = CloneDeep(StateWFilters.visState);
const expectedState = {
+ ...oldState,
layers: [oldState.layers[1]],
filters: [oldState.filters[1]],
layerData: [oldState.layerData[1]],
@@ -3430,6 +3431,7 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {
effectOrder: [],
interactionConfig: {
+ ...oldState.interactionConfig,
tooltip: {
id: 'tooltip',
label: 'interactions.tooltip',
@@ -3462,38 +3464,8 @@ test('#visStateReducer -> REMOVE_DATASET w filter and layer', t => {
]
}
}
- },
- brush: oldState.interactionConfig.brush,
- coordinate: oldState.interactionConfig.coordinate,
- geocoder: oldState.interactionConfig.geocoder
- },
- editingDataset: oldState.editingDataset,
- layerBlending: oldState.layerBlending,
- overlayBlending: oldState.overlayBlending,
- hoverInfo: oldState.hoverInfo,
- clicked: oldState.clicked,
- mousePos: oldState.mousePos,
- maxDefaultTooltips: oldState.maxDefaultTooltips,
- splitMaps: oldState.splitMaps,
- layerClasses: oldState.layerClasses,
- animationConfig: oldState.animationConfig,
- initialState: oldState.initialState,
- layerToBeMerged: [],
- filterToBeMerged: [],
- interactionToBeMerged: {},
- splitMapsToBeMerged: [],
- editor: oldState.editor,
- mapInfo: {
- title: '',
- description: ''
- },
- fileLoading: oldState.fileLoading,
- fileLoadingProgress: oldState.fileLoadingProgress,
- loaders: oldState.loaders,
- loadOptions: oldState.loadOptions,
- mergers: oldState.mergers,
- schema: oldState.schema,
- isMergingDatasets: {}
+ }
+ }
};
const newReducer = reducer(oldState, VisStateActions.removeDataset(testCsvDataId));
@@ -3695,6 +3667,7 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {
const oldState = StateWSplitMaps.visState;
const expectedState = {
+ ...oldState,
layers: [oldState.layers[0]],
layerData: [oldState.layerData[0]],
layerOrder: [oldState.layers[0].id],
@@ -3705,6 +3678,7 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {
effects: [],
effectOrder: [],
interactionConfig: {
+ ...oldState.interactionConfig,
tooltip: {
id: 'tooltip',
label: 'interactions.tooltip',
@@ -3737,38 +3711,9 @@ test('#visStateReducer -> SPLIT_MAP: REMOVE_DATASET', t => {
]
}
}
- },
- brush: oldState.interactionConfig.brush,
- coordinate: oldState.interactionConfig.coordinate,
- geocoder: oldState.interactionConfig.geocoder
- },
- splitMaps: [{layers: {'point-0': false}}, {layers: {'point-0': true}}],
- editingDataset: oldState.editingDataset,
- layerBlending: oldState.layerBlending,
- overlayBlending: oldState.overlayBlending,
- hoverInfo: oldState.hoverInfo,
- clicked: oldState.clicked,
- mousePos: oldState.mousePos,
- maxDefaultTooltips: oldState.maxDefaultTooltips,
- layerClasses: oldState.layerClasses,
- animationConfig: DEFAULT_ANIMATION_CONFIG,
- initialState: oldState.initialState,
- layerToBeMerged: [],
- filterToBeMerged: [],
- interactionToBeMerged: {},
- splitMapsToBeMerged: [],
- editor: oldState.editor,
- mapInfo: {
- title: '',
- description: ''
+ }
},
- fileLoading: oldState.fileLoading,
- fileLoadingProgress: oldState.fileLoadingProgress,
- loaders: oldState.loaders,
- loadOptions: oldState.loadOptions,
- schema: oldState.schema,
- mergers: oldState.mergers,
- isMergingDatasets: {}
+ splitMaps: [{layers: {'point-0': false}}, {layers: {'point-0': true}}]
};
const newReducer = reducer(oldState, VisStateActions.removeDataset(testGeoJsonDataId));
@@ -5761,6 +5706,23 @@ test('#visStateReducer -> setFilterAnimationTimeConfig', t => {
t.end();
});
+test('#visStateReducer -> layerFilteredItemsChange', t => {
+ const mockEvent = {
+ id: 'point-layer-1',
+ count: 100
+ };
+ const layer = StateWFiles.visState.layers[0];
+ const nextState = reducer(
+ StateWFiles.visState,
+ VisStateActions.layerFilteredItemsChange(layer, mockEvent)
+ );
+ const expected = {'point-layer-1': 100};
+
+ t.deepEqual(layer.filteredItemCount, expected, 'should set filteredItemCount on layer');
+
+ t.end();
+});
+
test('VisStateUpdater -> prepareStateForDatasetReplace', t => {
const oldTooltipConfigFields =
StateWFilters.visState.interactionConfig.tooltip.config.fieldsToShow;