Skip to content

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

[chore] applyFilterConfig action (#2872)

Igor Dykhtae633177eff1b
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 4d3b05d56..aefd4cca5 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -45,6 +45,7 @@ export const ActionTypes = {
CREATE_OR_UPDATE_FILTER: `${ACTION_PREFIX}CREATE_OR_UPDATE_FILTER`,
CREATE_NEW_DATASET_SUCCESS: `${ACTION_PREFIX}CREATE_NEW_DATASET_SUCCESS`,
ADD_LAYER: `${ACTION_PREFIX}ADD_LAYER`,
+ APPLY_FILTER_CONFIG: `${ACTION_PREFIX}APPLY_FILTER_CONFIG`,
APPLY_LAYER_CONFIG: `${ACTION_PREFIX}APPLY_LAYER_CONFIG`,
DUPLICATE_LAYER: `${ACTION_PREFIX}DUPLICATE_LAYER`,
INTERACTION_CONFIG_CHANGE: `${ACTION_PREFIX}INTERACTION_CONFIG_CHANGE`,
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index 44c85f1e5..3238b347a 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -325,6 +325,29 @@ export function interactionConfigChange(
};
}
+export type ApplyFilterConfigUpdaterAction = {
+ filterId: string;
+ newFilter: Filter;
+};
+
+/**
+ * Update filter config
+ * @param filterId - id of the filter to be updated
+ * @param newFilter - new filter config
+ * @returns action
+ * @public
+ */
+export function applyFilterConfig(
+ filterId: string,
+ newFilter: Filter
+): Merge<ApplyFilterConfigUpdaterAction, {type: typeof ActionTypes.APPLY_FILTER_CONFIG}> {
+ return {
+ type: ActionTypes.APPLY_FILTER_CONFIG,
+ filterId,
+ newFilter
+ };
+}
+
export type SetFilterUpdaterAction = {
idx: number;
prop: string | string[];
diff --git a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
index 18f347151..606f11543 100644
--- a/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
+++ b/src/components/src/side-panel/filter-panel/filter-panel-header.tsx
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project
-import React, {ComponentType} from 'react';
+import React, {ComponentType, useMemo} from 'react';
import styled from 'styled-components';
import classnames from 'classnames';
import PanelHeaderActionFactory from '../../side-panel/panel-header-action';
@@ -42,6 +42,12 @@ export type FilterPanelHeaderProps = {
datasets: KeplerTable[];
filter: Filter;
removeFilter: () => void;
+ actionItems?: {
+ key: string;
+ tooltip: string;
+ onClick: () => void;
+ icon: React.ElementType;
+ }[];
actionIcons?: {
delete: ComponentType;
};
@@ -64,23 +70,41 @@ function FilterPanelHeaderFactory(
datasets,
filter,
removeFilter,
+ actionItems,
actionIcons = defaultActionIcons
- }: FilterPanelHeaderProps) => (
- <StyledFilterHeader
- className={classnames('filter-panel__header', className)}
- $labelRCGColorValues={datasets.map((d: KeplerTable) => d.color)}
- >
- <StyledChildrenContainer>{children}</StyledChildrenContainer>
- <PanelHeaderAction
- id={filter.id}
- tooltip="tooltip.delete"
- tooltipType="error"
- onClick={removeFilter}
- hoverColor={'errorColor'}
- IconComponent={actionIcons.delete}
- />
- </StyledFilterHeader>
- );
+ }: FilterPanelHeaderProps) => {
+ const items = useMemo(
+ () =>
+ actionItems ?? [
+ {
+ key: 'delete',
+ tooltip: 'tooltip.delete',
+ onClick: removeFilter,
+ icon: actionIcons.delete
+ }
+ ],
+ [removeFilter, actionIcons, actionItems]
+ );
+ return (
+ <StyledFilterHeader
+ className={classnames('filter-panel__header', className)}
+ $labelRCGColorValues={datasets.map((d: KeplerTable) => d.color)}
+ >
+ <StyledChildrenContainer>{children}</StyledChildrenContainer>
+ {items.map(item => (
+ <PanelHeaderAction
+ key={item.key}
+ id={filter.id}
+ tooltip={item.tooltip}
+ tooltipType="error"
+ onClick={item.onClick}
+ hoverColor={'errorColor'}
+ IconComponent={item.icon}
+ />
+ ))}
+ </StyledFilterHeader>
+ );
+ };
return FilterPanelHeader;
}
diff --git a/src/reducers/src/vis-state-merger.ts b/src/reducers/src/vis-state-merger.ts
index 6afcc97ba..e30da01c0 100644
--- a/src/reducers/src/vis-state-merger.ts
+++ b/src/reducers/src/vis-state-merger.ts
@@ -29,7 +29,8 @@ import {
Effect as EffectType,
ParsedEffect,
LayerColumns,
- LayerColumn
+ LayerColumn,
+ ParsedFilter
} from '@kepler.gl/types';
import {KeplerTable, Datasets, assignGpuChannels, resetFilterGpuMode} from '@kepler.gl/table';
@@ -193,6 +194,17 @@ export function createLayerFromConfig(state: VisState, layerConfig: any): Layer
return newLayer;
}
+/**
+ * Get loaded filter from state
+ */
+export function serializeFilter(
+ newFilter: Filter,
+ schema: KeplerGLSchemaClass
+): ParsedFilter | undefined {
+ const serializedVisState = serializeVisState({filters: [newFilter]}, schema);
+ return serializedVisState?.filters?.[0];
+}
+
/**
* Get loaded layer from state
*/
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 8c9fb3cfc..de6292704 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -38,6 +38,7 @@ import {
loadFilesSuccess,
loadNextFile,
nextFileBatch,
+ setFilter,
processFileContent,
fitBounds as fitMapBounds,
toggleLayerForMap
@@ -102,6 +103,7 @@ import {
VIS_STATE_MERGERS,
createLayerFromConfig,
parseLayerConfig,
+ serializeFilter,
serializeLayer,
serializeVisState,
validateLayerWithData
@@ -1071,6 +1073,37 @@ export function setFilterAnimationWindowUpdater<S extends VisState>(
return setTimeFilterTimelineModeUpdater(newState, {id, mode: newSyncTimelineMode});
}
+export function applyFilterConfigUpdater(
+ state: VisState,
+ action: VisStateActions.ApplyFilterConfigUpdaterAction
+): VisState {
+ const {filterId, newFilter} = action;
+ const oldFilter = state.filters.find(f => f.id === filterId);
+ if (!oldFilter) {
+ return state;
+ }
+
+ // Serialize the filters to only compare the saved properties
+ const serializedOldFilter = serializeFilter(oldFilter, state.schema) ?? {config: {}};
+ const serializedNewFilter = serializeFilter(newFilter, state.schema);
+ if (!serializedNewFilter || isEqual(serializedOldFilter, serializedNewFilter)) {
+ return state;
+ }
+
+ // If there are any changes to the filter, apply them
+ const changed = pickChangedProps(serializedOldFilter, serializedNewFilter);
+ delete changed['id']; // id should not be changed
+
+ const filterIndex = state.filters.findIndex(f => f.id === filterId);
+ if (filterIndex < 0) {
+ return state;
+ }
+ return setFilterUpdater(
+ state,
+ setFilter(filterIndex, Object.keys(changed), Object.values(changed))
+ );
+}
+
/**
* Update filter property
* @memberof visStateUpdaters
diff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.ts
index 3064880b3..c2e521674 100644
--- a/src/reducers/src/vis-state.ts
+++ b/src/reducers/src/vis-state.ts
@@ -16,6 +16,8 @@ const actionHandler = {
[ActionTypes.ADD_LAYER]: visStateUpdaters.addLayerUpdater,
+ [ActionTypes.APPLY_FILTER_CONFIG]: visStateUpdaters.applyFilterConfigUpdater,
+
[ActionTypes.APPLY_LAYER_CONFIG]: visStateUpdaters.applyLayerConfigUpdater,
[ActionTypes.DUPLICATE_LAYER]: visStateUpdaters.duplicateLayerUpdater,
diff --git a/src/schemas/src/vis-state-schema.ts b/src/schemas/src/vis-state-schema.ts
index 345afb161..9e977babe 100644
--- a/src/schemas/src/vis-state-schema.ts
+++ b/src/schemas/src/vis-state-schema.ts
@@ -856,7 +856,8 @@ export const filterPropsV1 = {
enabled: null,
- invertTrendColor: null
+ invertTrendColor: null,
+ timezone: null
};
export const propertiesV0 = {