Skip to content

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

feat: Streamlined rectangle drag-to-filter for map layers (#3402)

Xun Li0eae29ba2d64
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 1d934484c..f17ec6760 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -189,6 +189,7 @@ export const ActionTypes = {
// geo-operations
SET_FEATURES: `${ACTION_PREFIX}SET_FEATURES`,
SET_POLYGON_FILTER_LAYER: `${ACTION_PREFIX}SET_POLYGON_FILTER_LAYER`,
+ SET_POLYGON_FILTER_ALL_LAYERS: `${ACTION_PREFIX}SET_POLYGON_FILTER_ALL_LAYERS`,
DELETE_FEATURE: `${ACTION_PREFIX}DELETE_FEATURE`,
TOGGLE_EDITOR_VISIBILITY: `${ACTION_PREFIX}TOGGLE_EDITOR_VISIBILITY`,
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index c8dd0e45d..070df1034 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -1401,6 +1401,27 @@ export function setPolygonFilterLayer(
};
}
+export type SetPolygonFilterAllLayersUpdaterAction = {
+ feature: Feature;
+};
+/**
+ * Apply the provided feature as a polygon filter to all layers.
+ * @memberof visStateActions
+ * @param feature
+ * @returns action
+ */
+export function setPolygonFilterAllLayers(
+ feature: Feature
+): Merge<
+ SetPolygonFilterAllLayersUpdaterAction,
+ {type: typeof ActionTypes.SET_POLYGON_FILTER_ALL_LAYERS}
+> {
+ return {
+ type: ActionTypes.SET_POLYGON_FILTER_ALL_LAYERS,
+ feature
+ };
+}
+
export type SetSelectedFeatureUpdaterAction = {
feature: Feature | null;
selectionContext?: FeatureSelectionContext;
diff --git a/src/components/src/map-container.tsx b/src/components/src/map-container.tsx
index fc81156b4..ef3e11b0b 100644
--- a/src/components/src/map-container.tsx
+++ b/src/components/src/map-container.tsx
@@ -908,6 +908,7 @@ export default function MapContainerFactory(
editorMenuActive,
onSetFeatures: setFeatures,
setSelectedFeature,
+ onApplyPolygonFilterAll: visStateActions.setPolygonFilterAllLayers,
// @ts-ignore Argument of type 'Readonly<MapContainerProps>' is not assignable to parameter of type 'never'
featureCollection: this.featureCollectionSelector(this.props),
selectedFeatureIndexes: this.selectedFeatureIndexArraySelector(
diff --git a/src/components/src/map/map-draw-panel.tsx b/src/components/src/map/map-draw-panel.tsx
index 5065283dd..92c09f781 100644
--- a/src/components/src/map/map-draw-panel.tsx
+++ b/src/components/src/map/map-draw-panel.tsx
@@ -46,10 +46,12 @@ function MapDrawPanelFactory(
actionIcons = defaultActionIcons
}) => {
const isActive = mapControls?.mapDraw?.active;
- const onToggleMenuPanel = useCallback(
- () => onToggleMapControl('mapDraw'),
- [onToggleMapControl]
- );
+ const onToggleMenuPanel = useCallback(() => {
+ if (!isActive) {
+ onSetEditorMode(EDITOR_MODES.DRAW_RECTANGLE);
+ }
+ onToggleMapControl('mapDraw');
+ }, [isActive, onToggleMapControl, onSetEditorMode]);
if (!mapControls?.mapDraw?.show) {
return null;
}
diff --git a/src/layers/src/editor-layer/draw-rectangle-mode-extended.ts b/src/layers/src/editor-layer/draw-rectangle-mode-extended.ts
new file mode 100644
index 000000000..626219b81
--- /dev/null
+++ b/src/layers/src/editor-layer/draw-rectangle-mode-extended.ts
@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {DrawRectangleMode} from '@deck.gl-community/editable-layers';
+
+/**
+ * Extends DrawRectangleMode to support both click-move-click and
+ * click-drag-release interactions for drawing rectangles.
+ *
+ * The base TwoClickPolygonMode treats these as mutually exclusive via
+ * the `dragToDraw` modeConfig flag. This subclass removes those guards
+ * so both gestures work simultaneously:
+ * - Click → move → click (original two-click behavior)
+ * - Mousedown → drag → mouseup (drag-to-draw behavior)
+ */
+export class DrawRectangleModeExtended extends DrawRectangleMode {
+ handleClick(event, props) {
+ // Always handle clicks (no dragToDraw guard)
+ this.addClickSequence(event);
+ this.checkAndFinishPolygon(props);
+ }
+
+ handleStartDragging(event, _props) {
+ // Always handle drag start (no dragToDraw guard)
+ this.addClickSequence(event);
+ event.cancelPan();
+ }
+
+ handleStopDragging(event, props) {
+ // Always handle drag stop (no dragToDraw guard)
+ this.addClickSequence(event);
+ this.checkAndFinishPolygon(props);
+ }
+}
diff --git a/src/layers/src/editor-layer/editor-layer-utils.ts b/src/layers/src/editor-layer/editor-layer-utils.ts
index 92274a2ee..a543a186e 100644
--- a/src/layers/src/editor-layer/editor-layer-utils.ts
+++ b/src/layers/src/editor-layer/editor-layer-utils.ts
@@ -162,7 +162,12 @@ export function getTooltip(
return null;
}
- return getTooltipObject('Click to start new feature', theme, {
+ const tooltipText =
+ editor.mode === EDITOR_MODES.DRAW_RECTANGLE
+ ? 'Click or drag to draw rectangle'
+ : 'Click to start new feature';
+
+ return getTooltipObject(tooltipText, theme, {
leftOfCursor: closeToLeftEdge,
aboveCursor: closeToBottomEdge
});
diff --git a/src/layers/src/editor-layer/editor-layer.ts b/src/layers/src/editor-layer/editor-layer.ts
index c9310ef91..53d06b6d8 100644
--- a/src/layers/src/editor-layer/editor-layer.ts
+++ b/src/layers/src/editor-layer/editor-layer.ts
@@ -7,7 +7,6 @@ import {
DrawPolygonMode,
TranslateMode,
CompositeMode,
- DrawRectangleMode,
GeoJsonEditMode
} from '@deck.gl-community/editable-layers';
import {PathStyleExtension} from '@deck.gl/extensions';
@@ -19,6 +18,7 @@ import {generateHashId} from '@kepler.gl/common-utils';
import {EDIT_TYPES} from './constants';
import {LINE_STYLE, FEATURE_STYLE, EDIT_HANDLE_STYLE} from './feature-styles';
import {ModifyModeExtended} from './modify-mode-extended';
+import {DrawRectangleModeExtended} from './draw-rectangle-mode-extended';
import {isDrawingActive} from './editor-layer-utils';
const DEFAULT_COMPOSITE_MODE = new CompositeMode([
@@ -31,6 +31,7 @@ export type GetEditorLayerProps = {
editor: Editor;
onSetFeatures: (features: Feature[]) => any;
setSelectedFeature: (feature: Feature | null, selectionContext?: FeatureSelectionContext) => any;
+ onApplyPolygonFilterAll?: (feature: Feature) => any;
viewport: Viewport;
featureCollection: {
type: string;
@@ -55,6 +56,7 @@ export function getEditorLayer({
editor,
onSetFeatures,
setSelectedFeature,
+ onApplyPolygonFilterAll,
featureCollection,
selectedFeatureIndexes,
viewport
@@ -66,7 +68,7 @@ export function getEditorLayer({
// @ts-ignore
if (editorMode === EDITOR_MODES.DRAW_POLYGON) mode = DrawPolygonMode;
// @ts-ignore
- else if (editorMode === EDITOR_MODES.DRAW_RECTANGLE) mode = DrawRectangleMode;
+ else if (editorMode === EDITOR_MODES.DRAW_RECTANGLE) mode = DrawRectangleModeExtended;
}
// @ts-ignore
@@ -100,7 +102,13 @@ export function getEditorLayer({
if (lastFeature.properties) lastFeature.properties.isClosed = true;
lastFeature.id = generateHashId(6);
onSetFeatures(updatedData.features as unknown as Feature[]);
- setSelectedFeature(lastFeature as unknown as Feature);
+
+ const isRectangle = lastFeature.properties?.shape === 'Rectangle';
+ if (isRectangle && onApplyPolygonFilterAll) {
+ onApplyPolygonFilterAll(lastFeature as unknown as Feature);
+ } else {
+ setSelectedFeature(lastFeature as unknown as Feature);
+ }
}
break;
}
diff --git a/src/reducers/src/layer-utils.ts b/src/reducers/src/layer-utils.ts
index 99ef50c61..d6154deeb 100644
--- a/src/reducers/src/layer-utils.ts
+++ b/src/reducers/src/layer-utils.ts
@@ -388,6 +388,7 @@ export type ComputeDeckLayersProps = {
feature: Feature | null,
selectionContext?: FeatureSelectionContext
) => any;
+ onApplyPolygonFilterAll?: (feature: Feature) => any;
featureCollection: {
type: string;
features: Feature[];
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index 2c0bd1801..e8a5e4dee 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -3188,7 +3188,12 @@ export function setFeaturesUpdater(
...state.editor,
// only save none filter features to editor
features: features.filter(f => !getFilterIdInFeature(f)),
- mode: lastFeature && lastFeature.properties?.isClosed ? EDITOR_MODES.EDIT : state.editor.mode
+ mode:
+ lastFeature && lastFeature.properties?.isClosed
+ ? lastFeature.properties?.shape === 'Rectangle'
+ ? state.editor.mode
+ : EDITOR_MODES.EDIT
+ : state.editor.mode
}
};
@@ -3361,6 +3366,42 @@ export function setPolygonFilterLayerUpdater(
});
}
+/**
+ * Apply polygon filter to all visible layers
+ * @memberof visStateUpdaters
+ */
+export function setPolygonFilterAllLayersUpdater(
+ state: VisState,
+ payload: VisStateActions.SetPolygonFilterAllLayersUpdaterAction
+): VisState {
+ const {feature} = payload;
+
+ const newFilter = generatePolygonFilter([], feature);
+ const filterIdx = state.filters.length;
+
+ const newState: VisState = {
+ ...state,
+ filters: [...state.filters, newFilter],
+ editor: {
+ ...state.editor,
+ features: state.editor.features.filter(f => f.id !== feature.id),
+ selectedFeature: newFilter.value,
+ mode: EDITOR_MODES.EDIT
+ }
+ };
+
+ const visibleLayerIds = get(payload, 'visibleLayerIds');
+ const allLayerIds = Array.isArray(visibleLayerIds)
+ ? visibleLayerIds
+ : state.layers.filter(l => l.config.isVisible).map(l => l.id);
+
+ return setFilterUpdater(newState, {
+ idx: filterIdx,
+ prop: 'layerId',
+ value: allLayerIds
+ });
+}
+
/**
* @memberof visStateUpdaters
* @public
diff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.ts
index 7d57f958d..c8603a820 100644
--- a/src/reducers/src/vis-state.ts
+++ b/src/reducers/src/vis-state.ts
@@ -121,6 +121,8 @@ const actionHandler = {
[ActionTypes.SET_POLYGON_FILTER_LAYER]: visStateUpdaters.setPolygonFilterLayerUpdater,
+ [ActionTypes.SET_POLYGON_FILTER_ALL_LAYERS]: visStateUpdaters.setPolygonFilterAllLayersUpdater,
+
[ActionTypes.SET_SELECTED_FEATURE]: visStateUpdaters.setSelectedFeatureUpdater,
[ActionTypes.SET_EDITOR_MODE]: visStateUpdaters.setEditorModeUpdater,