Skip to content

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

feat: rename, delete, and filter a column from the data table (#3801)

Igor Dykhtaece93742a281
diff --git a/src/actions/src/action-types.ts b/src/actions/src/action-types.ts
index 39545ceff..6af6fed98 100644
--- a/src/actions/src/action-types.ts
+++ b/src/actions/src/action-types.ts
@@ -81,6 +81,8 @@ export const ActionTypes = {
RENAME_DATASET: `${ACTION_PREFIX}RENAME_DATASET`,
UPDATE_DATASET_PROPS: `${ACTION_PREFIX}UPDATE_DATASET_PROPS`,
UPDATE_DATASET: `${ACTION_PREFIX}UPDATE_DATASET`,
+ RENAME_TABLE_COLUMN: `${ACTION_PREFIX}RENAME_TABLE_COLUMN`,
+ DELETE_TABLE_COLUMN: `${ACTION_PREFIX}DELETE_TABLE_COLUMN`,
TOGGLE_FILTER_ANIMATION: `${ACTION_PREFIX}TOGGLE_FILTER_ANIMATION`,
UPDATE_FILTER_ANIMATION_SPEED: `${ACTION_PREFIX}UPDATE_FILTER_ANIMATION_SPEED`,
PLAY_ANIMATION: `${ACTION_PREFIX}PLAY_ANIMATION`,
diff --git a/src/actions/src/vis-state-actions.ts b/src/actions/src/vis-state-actions.ts
index 8182e5bfa..c17cdfccb 100644
--- a/src/actions/src/vis-state-actions.ts
+++ b/src/actions/src/vis-state-actions.ts
@@ -1512,6 +1512,55 @@ export function updateDataset(
};
}
+export type RenameTableColumnUpdaterAction = {
+ dataId: string;
+ fieldName: string;
+ newName: string;
+};
+/**
+ * Rename a dataset column. The new name becomes the field identity stored in
+ * layers, filters, charts, dataset operations, and saved maps.
+ * @param dataId - dataset id
+ * @param fieldName - current column name
+ * @param newName - next column name
+ * @returns action
+ * @public
+ */
+export function renameTableColumn(
+ dataId: string,
+ fieldName: string,
+ newName: string
+): Merge<RenameTableColumnUpdaterAction, {type: typeof ActionTypes.RENAME_TABLE_COLUMN}> {
+ return {
+ type: ActionTypes.RENAME_TABLE_COLUMN,
+ dataId,
+ fieldName,
+ newName
+ };
+}
+
+export type DeleteTableColumnUpdaterAction = {
+ dataId: string;
+ fieldName: string;
+};
+/**
+ * Delete a dataset column and drop references that required it.
+ * @param dataId - dataset id
+ * @param fieldName - column name
+ * @returns action
+ * @public
+ */
+export function deleteTableColumn(
+ dataId: string,
+ fieldName: string
+): Merge<DeleteTableColumnUpdaterAction, {type: typeof ActionTypes.DELETE_TABLE_COLUMN}> {
+ return {
+ type: ActionTypes.DELETE_TABLE_COLUMN,
+ dataId,
+ fieldName
+ };
+}
+
export type ToggleFilterAnimationUpdaterAction = {
idx: number;
};
diff --git a/src/components/src/common/data-table/header-cell.spec.tsx b/src/components/src/common/data-table/header-cell.spec.tsx
new file mode 100644
index 000000000..da2704bfc
--- /dev/null
+++ b/src/components/src/common/data-table/header-cell.spec.tsx
@@ -0,0 +1,181 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React, {useState} from 'react';
+import {fireEvent, screen} from '@testing-library/react';
+
+import {renderWithTheme} from 'test/helpers/component-jest-utils';
+import HeaderCellFactory, {HeaderCellProps} from './header-cell';
+
+beforeAll(() => {
+ if (typeof window.IntersectionObserver === 'undefined') {
+ window.IntersectionObserver = class {
+ observe() {
+ return undefined;
+ }
+ unobserve() {
+ return undefined;
+ }
+ disconnect() {
+ return undefined;
+ }
+ takeRecords() {
+ return [];
+ }
+ root = null;
+ rootMargin = '';
+ thresholds: number[] = [];
+ } as unknown as typeof IntersectionObserver;
+ }
+});
+
+const HeaderCell = HeaderCellFactory(
+ () => <span />,
+ () => null,
+ () => null
+);
+
+const columns = ['region', 'pop'];
+const colMeta = {
+ region: {name: 'region', type: 'string'},
+ pop: {name: 'pop', type: 'integer'}
+};
+
+function ColumnHeader({
+ renameTableColumn,
+ deleteTableColumn,
+ createFilterFromColumn
+}: {
+ renameTableColumn?: (column: string, newName: string) => void;
+ deleteTableColumn?: (column: string) => void;
+ createFilterFromColumn?: (column: string) => void;
+}) {
+ const [moreOptionsColumn, setMoreOptionsColumn] = useState<string | null>(null);
+ const props = {
+ colMeta,
+ sortColumn: {},
+ pinTableColumn: jest.fn(),
+ copyTableColumn: jest.fn(),
+ sortTableColumn: jest.fn(),
+ renameTableColumn,
+ deleteTableColumn,
+ createFilterFromColumn
+ } as unknown as HeaderCellProps['props'];
+
+ return (
+ <HeaderCell
+ cellInfo={{
+ columnIndex: 0,
+ key: 'region',
+ style: {},
+ isScrolling: false,
+ isVisible: true,
+ parent: null,
+ rowIndex: 0
+ }}
+ columns={columns}
+ isPinned={false}
+ showStats={false}
+ moreOptionsColumn={moreOptionsColumn}
+ toggleMoreOptions={column =>
+ setMoreOptionsColumn(current => (current === column ? null : column))
+ }
+ style={{}}
+ props={props}
+ />
+ );
+}
+
+function openMenu(container: HTMLElement) {
+ fireEvent.click(container.querySelector('.more') as HTMLElement);
+}
+
+function startRename(container: HTMLElement) {
+ openMenu(container);
+ fireEvent.click(screen.getByText('Rename'));
+ return screen.getByLabelText('Rename column') as HTMLInputElement;
+}
+
+describe('column header menu', () => {
+ test('commits a rename on enter and on blur after an edit', () => {
+ const renameTableColumn = jest.fn();
+ const {container} = renderWithTheme(<ColumnHeader renameTableColumn={renameTableColumn} />);
+
+ const input = startRename(container);
+ fireEvent.change(input, {target: {value: 'area'}});
+ fireEvent.keyDown(input, {key: 'Enter'});
+ expect(renameTableColumn).toHaveBeenCalledWith('region', 'area');
+
+ renameTableColumn.mockClear();
+ const next = startRename(container);
+ fireEvent.change(next, {target: {value: 'zone'}});
+ fireEvent.blur(next);
+ expect(renameTableColumn).toHaveBeenCalledWith('region', 'zone');
+ });
+
+ test('cancels a rename on escape and ignores a blur that did not edit', () => {
+ const renameTableColumn = jest.fn();
+ const {container} = renderWithTheme(<ColumnHeader renameTableColumn={renameTableColumn} />);
+
+ const input = startRename(container);
+ fireEvent.change(input, {target: {value: 'area'}});
+ fireEvent.keyDown(input, {key: 'Escape'});
+ expect(renameTableColumn).not.toHaveBeenCalled();
+ expect(screen.getByText('region')).toBeTruthy();
+
+ const untouched = startRename(container);
+ fireEvent.blur(untouched);
+ expect(renameTableColumn).not.toHaveBeenCalled();
+ });
+
+ test('rejects a blank, unchanged, or duplicate name', () => {
+ const renameTableColumn = jest.fn();
+ const {container} = renderWithTheme(<ColumnHeader renameTableColumn={renameTableColumn} />);
+
+ const blank = startRename(container);
+ fireEvent.change(blank, {target: {value: ' '}});
+ fireEvent.keyDown(blank, {key: 'Enter'});
+
+ const same = startRename(container);
+ fireEvent.keyDown(same, {key: 'Enter'});
+
+ const duplicate = startRename(container);
+ fireEvent.change(duplicate, {target: {value: 'pop'}});
+ fireEvent.keyDown(duplicate, {key: 'Enter'});
+
+ expect(renameTableColumn).not.toHaveBeenCalled();
+ });
+
+ test('resets delete confirmation when the menu closes', () => {
+ const deleteTableColumn = jest.fn();
+ const {container} = renderWithTheme(
+ <ColumnHeader deleteTableColumn={deleteTableColumn} renameTableColumn={jest.fn()} />
+ );
+
+ openMenu(container);
+ fireEvent.click(screen.getByText('Delete Column'));
+ expect(screen.getByText('Delete this column?')).toBeTruthy();
+
+ fireEvent.click(document.querySelector('.ReactModal__Overlay') as HTMLElement);
+ expect(screen.queryByText('Delete this column?')).toBeNull();
+
+ openMenu(container);
+ expect(screen.getByText('Delete Column')).toBeTruthy();
+ expect(screen.queryByText('Delete this column?')).toBeNull();
+
+ fireEvent.click(screen.getByText('Delete Column'));
+ fireEvent.click(screen.getByRole('button', {name: 'Delete'}));
+ expect(deleteTableColumn).toHaveBeenCalledWith('region');
+ });
+
+ test('creates a filter from the column menu', () => {
+ const createFilterFromColumn = jest.fn();
+ const {container} = renderWithTheme(
+ <ColumnHeader createFilterFromColumn={createFilterFromColumn} renameTableColumn={jest.fn()} />
+ );
+
+ openMenu(container);
+ fireEvent.click(screen.getByText('Create Filter'));
+ expect(createFilterFromColumn).toHaveBeenCalledWith('region');
+ });
+});
diff --git a/src/components/src/common/data-table/header-cell.tsx b/src/components/src/common/data-table/header-cell.tsx
index 82c1e49f7..196721a79 100644
--- a/src/components/src/common/data-table/header-cell.tsx
+++ b/src/components/src/common/data-table/header-cell.tsx
@@ -1,7 +1,7 @@
// SPDX-License-Identifier: MIT
// Copyright contributors to the kepler.gl project
-import React, {CSSProperties, useState, useCallback, useEffect} from 'react';
+import React, {CSSProperties, useState, useCallback, useEffect, useRef} from 'react';
import styled from 'styled-components';
import classnames from 'classnames';
import Button from './button';
@@ -86,6 +86,18 @@ const StyledHeaderCell = styled.div<{$hasStats?: boolean; $firstCell?: boolean}>
white-space: nowrap;
text-overflow: ellipsis;
}
+ .column-rename-input {
+ width: 100%;
+ min-width: 0;
+ font: inherit;
+ font-weight: 500;
+ color: inherit;
+ background: transparent;
+ border: 1px solid currentColor;
+ border-radius: 2px;
+ padding: 2px 4px;
+ box-sizing: border-box;
+ }
}
}
@@ -192,9 +204,15 @@ function HeaderCellFactory(
setColumnDisplayFormat,
hasStats,
dataId,
- loadColumnStats
+ loadColumnStats,
+ renameTableColumn,
+ deleteTableColumn,
+ createFilterFromColumn
} = props;
const [showFormatter, setShowFormatter] = useState(false);
+ const [renaming, setRenaming] = useState(false);
+ const [renameDraft, setRenameDraft] = useState('');
+ const renamingRef = useRef(false);
const column = columns[columnIndex];
const isGhost = Boolean(column.ghost);
@@ -250,6 +268,34 @@ function HeaderCellFactory(
setShowFormatter(!showFormatter);
}, [showFormatter]);
+ const startRename = useCallback(() => {
+ if (isGhost || !renameTableColumn) {
+ return;
+ }
+ renamingRef.current = true;
+ setRenameDraft(colMeta[column].name);
+ setRenaming(true);
+ }, [isGhost, renameTableColumn, colMeta, column]);
+
+ const finishRename = useCallback(
+ (commit: boolean) => {
+ if (!renamingRef.current) {
+ return;
+ }
+ renamingRef.current = false;
+ setRenaming(false);
+ if (!commit || !renameTableColumn) {
+ return;
+ }
+ const next = renameDraft.trim();
+ if (!next || next === column || columns.includes(next)) {
+ return;
+ }
+ renameTableColumn(column, next);
+ },
+ [column, columns, renameDraft, renameTableColumn]
+ );
+
const headerDetails = isGhost ? (
<div />
) : (
@@ -264,7 +310,35 @@ function HeaderCellFactory(
<FieldToken type={colMeta[column].type} />
<div className="col-name">
<div className="col-name__left">
- <div className="col-name__name">{colMeta[column].name}</div>
+ {renaming ? (
+ <input
+ className="column-rename-input"
+ aria-label="Rename column"
+ value={renameDraft}
+ autoFocus
+ onClick={event => event.stopPropagation()}
+ onDoubleClick={event => event.stopPropagation()}
+ onChange={event => setRenameDraft(event.target.value)}
+ onBlur={() => finishRename(renameDraft.trim() !== colMeta[column].name)}
+ onKeyDown={event => {
+ event.stopPropagation();
+ if (event.key === 'Enter') {
+ event.preventDefault();
+ finishRename(true);
+ } else if (event.key === 'Escape') {
+ event.preventDefault();
+ finishRename(false);
+ }
+ }}
+ onKeyUp={event => {
+ if (event.key === 'Enter' || event.key === 'Escape') {
+ event.stopPropagation();
+ }
+ }}
+ />
+ ) : (
+ <div className="col-name__name">{colMeta[column].name}</div>
+ )}
<Button className="col-name__sort" onClick={onSortTable}>
{isSorted ? (
isSorted === SORT_ORDER.ASCENDING ? (
@@ -303,6 +377,10 @@ function HeaderCellFactory(
pinTableColumn={onPin}
copyTableColumn={onCopy}
setDisplayFormat={setColumnDisplayFormat ? onSetDisplayFormat : undefined}
+ renameTableColumn={renameTableColumn}
+ deleteTableColumn={deleteTableColumn}
+ createFilterFromColumn={createFilterFromColumn}
+ onStartRename={startRename}
/>
</section>
</>
diff --git a/src/components/src/common/data-table/index.tsx b/src/components/src/common/data-table/index.tsx
index ca5118e1c..905c1c5cf 100644
--- a/src/components/src/common/data-table/index.tsx
+++ b/src/components/src/common/data-table/index.tsx
@@ -456,6 +456,9 @@ export interface DataTableProps {
pinTableColumn: (column: string) => void;
setColumnDisplayFormat?: (formats: {[key: string]: string}) => void;
copyTableColumn: (column: string) => void;
+ renameTableColumn?: (column: string, newName: string) => void;
+ deleteTableColumn?: (column: string) => void;
+ createFilterFromColumn?: (column: string) => void;
sortOrder?: number[] | null;
showStats?: boolean;
hasCustomScrollBarStyle?: boolean;
diff --git a/src/components/src/common/data-table/option-dropdown.tsx b/src/components/src/common/data-table/option-dropdown.tsx
index 91d63a489..5d2bfa06f 100644
--- a/src/components/src/common/data-table/option-dropdown.tsx
+++ b/src/components/src/common/data-table/option-dropdown.tsx
@@ -14,7 +14,17 @@ import {
} from '@kepler.gl/constants';
import {getFieldFormatLabels} from '@kepler.gl/utils';
import {ColMeta} from '@kepler.gl/types';
-import {ArrowDown, ArrowUp, Clipboard, Pin, Cancel, Hash} from '../icons';
+import {
+ ArrowDown,
+ ArrowUp,
+ Clipboard,
+ Pin,
+ Cancel,
+ Hash,
+ Edit,
+ Trash,
+ FilterFunnel
+} from '../icons';
const ListItem = ({value}) => (
<div>
@@ -28,6 +38,8 @@ const StyledOptionsDropdown = styled.div`
.list-selector {
border-top: 0;
width: max-content;
+ max-height: 320px;
+ overflow-y: auto;
padding: 8px 0;
}
@@ -52,6 +64,33 @@ const StyledOptionsDropdown = styled.div`
}
`;
+const StyledDeleteConfirm = styled.div`
+ min-width: 180px;
+ padding: 12px;
+ background: ${props => props.theme.dropdownListBgdLT};
+ color: ${props => props.theme.textColorLT};
+ font-size: 12px;
+
+ .column-delete-confirm__actions {
+ display: flex;
+ gap: 8px;
+ margin-top: 10px;
+ }
+
+ button {
+ border: 0;
+ border-radius: 2px;
+ padding: 4px 8px;
+ cursor: pointer;
+ font-size: 12px;
+ }
+
+ .column-delete-confirm__delete {
+ background: ${props => props.theme.negativeBtnBgd || '#b00'};
+ color: ${props => props.theme.negativeBtnColor || '#fff'};
+ }
+`;
+
const StyledPopover = styled.div`
width: 184px;
height: 160px;
@@ -124,6 +163,10 @@ export interface OptionDropdownProps {
sortMode?: string;
isSorted?: string;
isPinned?: boolean;
+ renameTableColumn?: (column: string, newName: string) => void;
+ deleteTableColumn?: (column: string) => void;
+ createFilterFromColumn?: (column: string) => void;
+ onStartRename?: () => void;
}
const OptionDropdown = (props: OptionDropdownProps) => {
@@ -135,9 +178,13 @@ const OptionDropdown = (props: OptionDropdownProps) => {
sortTableColumn,
pinTableColumn,
copyTableColumn,
- setDisplayFormat
+ setDisplayFormat,
+ deleteTableColumn,
+ createFilterFromColumn,
+ onStartRename
} = props;
const [showFormatter, setShowFormatter] = useState(false);
+ const [confirmDelete, setConfirmDelete] = useState(false);
const onOptionSelected: (v: TableOption) => void = useCallback(
({value}) => {
switch (value) {
@@ -162,13 +209,30 @@ const OptionDropdown = (props: OptionDropdownProps) => {
case TABLE_OPTION.FORMAT_COLUMN:
setShowFormatter(true);
return;
+ case TABLE_OPTION.RENAME:
+ onStartRename?.();
+ break;
+ case TABLE_OPTION.CREATE_FILTER:
+ createFilterFromColumn?.(column);
+ break;
+ case TABLE_OPTION.DELETE:
+ setConfirmDelete(true);
+ return;
default:
break;
}
toggleMoreOptions(column);
},
- [column, sortTableColumn, pinTableColumn, copyTableColumn, toggleMoreOptions]
+ [
+ column,
+ sortTableColumn,
+ pinTableColumn,
+ copyTableColumn,
+ toggleMoreOptions,
+ onStartRename,
+ createFilterFromColumn
+ ]
);
const TABLE_OPTION_LIST_ICONS = {
@@ -177,7 +241,10 @@ const OptionDropdown = (props: OptionDropdownProps) => {
ArrowUp,
Clipboard,
Cancel,
- Hash
+ Hash,
+ Edit,
+ Trash,
+ FilterFunnel
};
const formatLabels = getFieldFormatLabels(colMeta[column].type);
@@ -193,19 +260,41 @@ const OptionDropdown = (props: OptionDropdownProps) => {
const onClose = useCallback(() => {
setShowFormatter(false);
+ setConfirmDelete(false);
toggleMoreOptions(column);
}, [column, toggleMoreOptions]);
return (
<Portaled right={120} top={20} isOpened={isOpened} onClose={onClose}>
<StyledOptionsDropdown className="more-options">
- <DropdownList
- displayOption={d => (d as TableOption).display}
- options={options}
- customListItemComponent={ListItem}
- onOptionSelected={onOptionSelected}
- light
- />
+ {confirmDelete ? (
+ <StyledDeleteConfirm className="column-delete-confirm">
+ <div>Delete this column?</div>
+ <div className="column-delete-confirm__actions">
+ <button
+ type="button"
+ className="column-delete-confirm__delete"
+ onClick={() => {
+ deleteTableColumn?.(column);
+ toggleMoreOptions(column);
+ }}
+ >
+ Delete
+ </button>
+ <button type="button" onClick={() => setConfirmDelete(false)}>
+ Cancel
+ </button>
+ </div>
+ </StyledDeleteConfirm>
+ ) : (
+ <DropdownList
+ displayOption={d => (d as TableOption).display}
+ options={options}
+ customListItemComponent={ListItem}
+ onOptionSelected={onOptionSelected}
+ light
+ />
+ )}
<FormatterDropdown
left={120}
top={-10}
diff --git a/src/components/src/modal-container.tsx b/src/components/src/modal-container.tsx
index 932e2c259..77242dd66 100644
--- a/src/components/src/modal-container.tsx
+++ b/src/components/src/modal-container.tsx
@@ -413,6 +413,11 @@ export default function ModalContainerFactory(
sortTableColumn={visStateActions.sortTableColumn}
pinTableColumn={visStateActions.pinTableColumn}
copyTableColumn={visStateActions.copyTableColumn}
+ renameTableColumn={visStateActions.renameTableColumn}
+ deleteTableColumn={visStateActions.deleteTableColumn}
+ createFilterFromColumn={(id, column) =>
+ visStateActions.createOrUpdateFilter(undefined, id, column)
+ }
setColumnDisplayFormat={visStateActions.setColumnDisplayFormat}
loadColumnStats={visStateActions.loadColumnStats}
uiStateActions={uiStateActions}
diff --git a/src/components/src/modals/data-table-modal-column-edit.spec.tsx b/src/components/src/modals/data-table-modal-column-edit.spec.tsx
new file mode 100644
index 000000000..c6889f40f
--- /dev/null
+++ b/src/components/src/modals/data-table-modal-column-edit.spec.tsx
@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import React from 'react';
+import {fireEvent, screen} from '@testing-library/react';
+import {ALL_FIELD_TYPES} from '@kepler.gl/constants';
+import {KeplerTable} from '@kepler.gl/table';
+
+import {renderWithTheme} from 'test/helpers/component-jest-utils';
+import DataTableModalFactory from './data-table-modal';
+
+jest.mock('../common/data-table/cell-size', () => ({
+ renderedSize: () => ({row: 80, header: 80})
+}));
+
+const tableProps: {current: Record<string, unknown> | null} = {current: null};
+
+function StubDataTable(props: {
+ createFilterFromColumn?: (column: string) => void;
+ renameTableColumn?: (column: string, newName: string) => void;
+ deleteTableColumn?: (column: string) => void;
+}) {
+ tableProps.current = props;
+ return (
+ <button type="button" onClick={() => props.createFilterFromColumn?.('region')}>
+ create-filter
+ </button>
+ );
+}
+
+const DataTableModal = DataTableModalFactory(StubDataTable as never, (() => null) as never);
+
+function makeDataset(type: string) {
+ const table = new KeplerTable({
+ info: {id: 'cities', label: 'cities', type},
+ color: [0, 0, 0]
+ });
+ table.updateSchema({
+ fields: [
+ {name: 'region', type: ALL_FIELD_TYPES.string},
+ {name: 'pop', type: ALL_FIELD_TYPES.integer}
+ ],
+ rows: [['west', 1]]
+ });
+ return table;
+}
+
+function renderModal(type: string) {
+ const createFilterFromColumn = jest.fn();
+ const renameTableColumn = jest.fn();
+ const deleteTableColumn = jest.fn();
+ const toggleSidePanel = jest.fn();
+ const toggleModal = jest.fn();
+ const view = renderWithTheme(
+ <DataTableModal
+ dataId="cities"
+ datasets={{cities: makeDataset(type)}}
+ showTab={false}
+ sortTableColumn={jest.fn()}
+ pinTableColumn={jest.fn()}
+ copyTableColumn={jest.fn()}
+ renameTableColumn={renameTableColumn}
+ deleteTableColumn={deleteTableColumn}
+ createFilterFromColumn={createFilterFromColumn}
+ showDatasetTable={jest.fn()}
+ setColumnDisplayFormat={jest.fn()}
+ uiStateActions={{toggleSidePanel, toggleModal} as never}
+ uiState={{} as never}
+ />
+ );
+ return {...view, createFilterFromColumn, toggleSidePanel, toggleModal};
+}
+
+describe('data table column edits', () => {
+ test('create filter opens the filter panel and closes the table', () => {
+ const {createFilterFromColumn, toggleSidePanel, toggleModal} = renderModal('local');
+
+ expect(tableProps.current?.renameTableColumn).toEqual(expect.any(Function));
+ expect(tableProps.current?.deleteTableColumn).toEqual(expect.any(Function));
+
+ fireEvent.click(screen.getByRole('button', {name: 'create-filter'}));
+ expect(createFilterFromColumn).toHaveBeenCalledWith('cities', 'region');
+ expect(toggleSidePanel).toHaveBeenCalledWith('filter');
+ expect(toggleModal).toHaveBeenCalledWith(null);
+ });
+
+ test('externally hosted datasets can create a filter but not rename or delete', () => {
+ renderModal('externally-hosted');
+
+ expect(tableProps.current?.createFilterFromColumn).toEqual(expect.any(Function));
+ expect(tableProps.current?.renameTableColumn).toBeUndefined();
+ expect(tableProps.current?.deleteTableColumn).toBeUndefined();
+ });
+});
diff --git a/src/components/src/modals/data-table-modal.tsx b/src/components/src/modals/data-table-modal.tsx
index a68fb3304..6fcc5092e 100644
--- a/src/components/src/modals/data-table-modal.tsx
+++ b/src/components/src/modals/data-table-modal.tsx
@@ -7,7 +7,11 @@ import DatasetLabel from '../common/dataset-label';
import DataTableFactory from '../common/data-table';
import {renderedSize} from '../common/data-table/cell-size';
import CanvasHack from '../common/data-table/canvas';
-import KeplerTable, {Datasets} from '@kepler.gl/table';
+import KeplerTable, {
+ Datasets,
+ canMutateDatasetSchema,
+ isTabularDatasetForOps
+} from '@kepler.gl/table';
import {UIStateActions} from '@kepler.gl/actions';
import {UiState} from '@kepler.gl/types';
import {getApplicationConfig} from '@kepler.gl/utils';
@@ -126,6 +130,9 @@ interface DataTableModalProps {
sortTableColumn: (id: string, column: string, mode?: string) => void;
pinTableColumn: (id: string, column: string) => void;
copyTableColumn: (id: string, column: string) => void;
+ renameTableColumn?: (id: string, column: string, newName: string) => void;
+ deleteTableColumn?: (id: string, column: string) => void;
+ createFilterFromColumn?: (id: string, column: string) => void;
datasets: Datasets;
showDatasetTable: (id: string) => void;
showTab?: boolean;
@@ -151,6 +158,9 @@ function DataTableModalFactory(
sortTableColumn,
pinTableColumn,
copyTableColumn: copyTableColumnProp,
+ renameTableColumn,
+ deleteTableColumn,
+ createFilterFromColumn,
datasets,
showDatasetTable,
showTab = true,
@@ -271,6 +281,29 @@ function DataTableModalFactory(
[setColumnDisplayFormatProp, dataId]
);
+ const handleRenameTableColumn = useCallback(
+ (column: string, newName: string) => {
+ renameTableColumn?.(dataId, column, newName);
+ },
+ [renameTableColumn, dataId]
+ );
+
+ const handleDeleteTableColumn = useCallback(
+ (column: string) => {
+ deleteTableColumn?.(dataId, column);
+ },
+ [deleteTableColumn, dataId]
+ );
+
+ const handleCreateFilterFromColumn = useCallback(
+ (column: string) => {
+ createFilterFromColumn?.(dataId, column);
+ uiStateActions.toggleSidePanel('filter');
+ uiStateActions.toggleModal(null);
+ },
+ [createFilterFromColumn, dataId, uiStateActions]
+ );
+
const onOpenConfig = useCallback(() => {
setShowConfig(true);
}, []);
@@ -284,6 +317,8 @@ function DataTableModalFactory(
}
const activeDataset = datasets[dataId];
+ const canMutateColumns = canMutateDatasetSchema(activeDataset);
+ const canCreateFilter = isTabularDatasetForOps(activeDataset);
return (
<StyledModal className="dataset-modal" id="dataset-modal">
@@ -322,6 +357,15 @@ function DataTableModalFactory(
pinTableColumn={handlePinTableColumn}
sortTableColumn={handleSortTableColumn}
setColumnDisplayFormat={handleSetColumnDisplayFormat}
+ renameTableColumn={
+ canMutateColumns && renameTableColumn ? handleRenameTableColumn : undefined
+ }
+ deleteTableColumn={
+ canMutateColumns && deleteTableColumn ? handleDeleteTableColumn : undefined
+ }
+ createFilterFromColumn={
+ canCreateFilter && createFilterFromColumn ? handleCreateFilterFromColumn : undefined
+ }
hasStats={enableColumnStats}
loadColumnStats={enableColumnStats ? loadColumnStats : undefined}
/>
diff --git a/src/constants/src/default-settings.ts b/src/constants/src/default-settings.ts
index 155bb221c..9dd350e81 100644
--- a/src/constants/src/default-settings.ts
+++ b/src/constants/src/default-settings.ts
@@ -538,11 +538,24 @@ export const TABLE_OPTION = keyMirror({
PIN: null,
UNPIN: null,
COPY: null,
- FORMAT_COLUMN: null
+ FORMAT_COLUMN: null,
+ RENAME: null,
+ DELETE: null,
+ CREATE_FILTER: null
});
export type TableOption = {
- value: 'SORT_ASC' | 'SORT_DES' | 'UNSORT' | 'PIN' | 'UNPIN' | 'COPY' | 'FORMAT_COLUMN';
+ value:
+ | 'SORT_ASC'
+ | 'SORT_DES'
+ | 'UNSORT'
+ | 'PIN'
+ | 'UNPIN'
+ | 'COPY'
+ | 'FORMAT_COLUMN'
+ | 'RENAME'
+ | 'DELETE'
+ | 'CREATE_FILTER';
display: string;
icon: string;
condition?: (props: any) => boolean;
@@ -584,6 +597,24 @@ export const TABLE_OPTION_LIST: TableOption[] = [
display: 'Format Column',
icon: 'Hash',
condition: props => props.setDisplayFormat
+ },
+ {
+ value: TABLE_OPTION.RENAME,
+ display: 'Rename',
+ icon: 'Edit',
+ condition: props => props.renameTableColumn
+ },
+ {
+ value: TABLE_OPTION.CREATE_FILTER,
+ display: 'Create Filter',
+ icon: 'FilterFunnel',
+ condition: props => props.createFilterFromColumn
+ },
+ {
+ value: TABLE_OPTION.DELETE,
+ display: 'Delete Column',
+ icon: 'Trash',
+ condition: props => props.deleteTableColumn && Object.keys(props.colMeta || {}).length > 1
}
];
diff --git a/src/reducers/src/column-edit-reconcile.ts b/src/reducers/src/column-edit-reconcile.ts
new file mode 100644
index 000000000..caf32d475
--- /dev/null
+++ b/src/reducers/src/column-edit-reconcile.ts
@@ -0,0 +1,94 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {ChartConfig, LayerChartConfig} from '@kepler.gl/types';
+
+type NamedAxis = {
+ field?: {name: string; type?: string} | null;
+ title?: string | null;
+};
+
+function followFieldName(
+ name: string | null | undefined,
+ renames: Record<string, string>,
+ alive: Set<string>
+): string | null {
+ if (!name) {
+ return null;
+ }
+ const next = renames[name] ?? name;
+ return alive.has(next) ? next : null;
+}
+
+function followAxis<T extends NamedAxis>(
+ axis: T | undefined,
+ renames: Record<string, string>,
+ alive: Set<string>
+): T | undefined {
+ if (!axis?.field?.name) {
+ return axis;
+ }
+ const name = followFieldName(axis.field.name, renames, alive);
+ if (!name) {
+ return {...axis, field: null, title: null};
+ }
+ if (name === axis.field.name) {
+ return axis;
+ }
+ return {
+ ...axis,
+ field: {...axis.field, name},
+ title: axis.title === axis.field.name ? name : axis.title
+ };
+}
+
+function isLayerChart(chart: ChartConfig): chart is LayerChartConfig {
+ return chart.type === 'layerChart';
+}
+
+export function remapChartsForDataset(
+ charts: ChartConfig[] | undefined,
+ dataId: string,
+ renames: Record<string, string>,
+ alive: Set<string>
+): ChartConfig[] {
+ return (charts || []).map(chart => {
+ if (chart.dataId !== dataId) {
+ return chart;
+ }
+ const source = chart as ChartConfig & {
+ xAxis?: NamedAxis;
+ yAxis?: NamedAxis;
+ axis?: NamedAxis;
+ groupBy?: NamedAxis;
+ value?: NamedAxis;
+ };
+ const next: ChartConfig = {
+ ...chart,
+ xAxis: followAxis(source.xAxis, renames, alive),
+ yAxis: followAxis(source.yAxis, renames, alive),
+ axis: followAxis(source.axis, renames, alive),
+ groupBy: followAxis(source.groupBy, renames, alive),
+ value: followAxis(source.value, renames, alive)
+ } as ChartConfig;
+
+ if (chart.crossFilter?.fieldNames) {
+ const fieldNames: Record<string, string> = {};
+ Object.entries(chart.crossFilter.fieldNames).forEach(([key, value]) => {
+ const name = followFieldName(value, renames, alive);
+ if (name) {
+ fieldNames[key] = name;
+ }
+ });
+ next.crossFilter = {...chart.crossFilter, fieldNames};
+ }
+
+ if (isLayerChart(chart) && chart.chartDisplay?.idField) {
+ next.chartDisplay = {
+ ...chart.chartDisplay,
+ idField: followFieldName(chart.chartDisplay.idField, renames, alive)
+ };
+ }
+ return next;
+ });
+}
diff --git a/src/reducers/src/column-edit-updaters.spec.ts b/src/reducers/src/column-edit-updaters.spec.ts
new file mode 100644
index 000000000..0c22cb985
--- /dev/null
+++ b/src/reducers/src/column-edit-updaters.spec.ts
@@ -0,0 +1,218 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {ALL_FIELD_TYPES} from '@kepler.gl/constants';
+import {VisStateActions} from '@kepler.gl/actions';
+import {KeplerTable} from '@kepler.gl/table';
+import SchemaManager, {VisState} from '@kepler.gl/schemas';
+
+import visStateReducer from './vis-state';
+import {INITIAL_VIS_STATE} from './vis-state-updaters';
+
+const reduceVisState = visStateReducer as (state: VisState, action: unknown) => VisState;
+
+function makeCities() {
+ const table = new KeplerTable({
+ info: {id: 'cities', label: 'cities', type: 'local'},
+ color: [0, 0, 0]
+ });
+ table.updateSchema({
+ fields: [
+ {name: 'lat', type: ALL_FIELD_TYPES.real},
+ {name: 'lng', type: ALL_FIELD_TYPES.real},
+ {name: 'region', type: ALL_FIELD_TYPES.string},
+ {name: 'pop', type: ALL_FIELD_TYPES.integer}
+ ],
+ rows: [
+ [37.7, -122.4, 'west', 10],
+ [40.7, -74.0, 'east', 40]
+ ]
+ });
+ return table;
+}
+
+function withCities(): VisState {
+ const cities = makeCities();
+ let state: VisState = {
+ ...INITIAL_VIS_STATE,
+ datasets: {cities},
+ interactionConfig: {
+ ...INITIAL_VIS_STATE.interactionConfig,
+ tooltip: {
+ ...INITIAL_VIS_STATE.interactionConfig.tooltip,
+ config: {
+ ...INITIAL_VIS_STATE.interactionConfig.tooltip.config,
+ fieldsToShow: {
+ cities: [{name: 'region', format: null}]
+ }
+ }
+ }
+ }
+ };
+
+ state = reduceVisState(
+ state,
+ VisStateActions.addLayer({
+ id: 'cities-layer',
+ type: 'point',
+ config: {
+ dataId: 'cities',
+ label: 'cities',
+ color: [255, 0, 0],
+ columns: {lat: 'lat', lng: 'lng'},
+ colorField: {name: 'region', type: 'string'},
+ textLabel: [{field: {name: 'region', type: 'string'}}]
+ }
+ })
+ );
+ state = reduceVisState(
+ state,
+ VisStateActions.createOrUpdateFilter(undefined, 'cities', 'region')
+ );
+ state = reduceVisState(
+ state,
+ VisStateActions.addChart({
+ id: 'region-chart',
+ title: 'Regions',
+ type: 'barChart',
+ dataId: 'cities',
+ applyFilters: true,
+ display: {},
+ chartDisplay: {},
+ xAxis: {field: {name: 'region', type: 'string'}, aggregation: null, title: 'region'},
+ yAxis: {field: {name: 'pop', type: 'integer'}, aggregation: 'sum', title: 'Population'},
+ crossFilter: {
+ enabled: false,
+ filterId: 'region-chart-filter',
+ fieldNames: {xAxis: 'region'},
+ value: {}
+ }
+ })
+ );
+ return state;
+}
+
+describe('column edits', () => {
+ test('rename changes the field identity stored in layers, filters, and saved maps', () => {
+ let state = withCities();
+ expect(state.layers).toHaveLength(1);
+ expect(state.filters[0].name).toEqual(['region']);
+
+ state = reduceVisState(state, VisStateActions.renameTableColumn('cities', 'region', 'area'));
+
+ const region = state.datasets.cities.fields.find(field => field.name === 'area');
+ expect(region?.name).toBe('area');
+ expect(region?.id).toBe('area');
+ expect(region?.displayName).toBe('area');
+ expect(state.datasets.cities.fields.map(field => field.name)).toEqual([
+ 'lat',
+ 'lng',
+ 'area',
+ 'pop'
+ ]);
+ expect(state.datasets.cities.dataContainer.rowAsArray(0)[2]).toBe('west');
+
+ const layer = state.layers[0];
+ expect(layer.config.columns.lat.value).toBe('lat');
+ expect(layer.config.columns.lng.value).toBe('lng');
+ expect(layer.config.colorField?.name).toBe('area');
+ expect(layer.config.textLabel[0].field?.name).toBe('area');
+ expect(state.filters[0].name).toEqual(['area']);
+ expect(state.charts[0].xAxis?.field?.name).toBe('area');
+ expect(state.charts[0].yAxis?.field?.name).toBe('pop');
+ expect(state.charts[0].crossFilter?.fieldNames).toEqual({xAxis: 'area'});
+ expect(state.interactionConfig.tooltip.config.fieldsToShow.cities[0].name).toBe('area');
+
+ const saved = SchemaManager.save({
+ visState: state,
+ mapState: {},
+ mapStyle: {},
+ uiState: {}
+ });
+ const savedVisState = saved.config.config.visState;
+ expect(savedVisState.layers?.[0].visualChannels?.colorField).toEqual({
+ name: 'area',
+ type: 'string'
+ });
+ expect(savedVisState.layers?.[0].config.columns.lat).toBe('lat');
+ expect(savedVisState.layers?.[0].config.textLabel?.[0].field?.name).toBe('area');
+ expect(JSON.stringify(savedVisState.filters)).toContain('area');
+ expect(JSON.stringify(savedVisState.filters)).not.toContain('region');
+ expect(savedVisState.charts?.[0].xAxis?.field?.name).toBe('area');
+ });
+
+ test('delete drops references and refuses the last column', () => {
+ let state = withCities();
+ state = reduceVisState(state, VisStateActions.deleteTableColumn('cities', 'pop'));
+
+ expect(state.datasets.cities.fields.map(field => field.name)).toEqual(['lat', 'lng', 'region']);
+ expect(state.layers).toHaveLength(1);
+ expect(state.filters).toHaveLength(1);
+ expect(state.charts[0].yAxis?.field).toBeNull();
+
+ state = reduceVisState(state, VisStateActions.deleteTableColumn('cities', 'lat'));
+ expect(state.layers).toHaveLength(0);
+ expect(state.datasets.cities.fields.map(field => field.name)).toEqual(['lng', 'region']);
+
+ const only = new KeplerTable({
+ info: {id: 'only', label: 'only', type: 'local'},
+ color: [0, 0, 0]
+ });
+ only.updateSchema({
+ fields: [{name: 'region', type: ALL_FIELD_TYPES.string}],
+ rows: [['west']]
+ });
+ const single: VisState = {...INITIAL_VIS_STATE, datasets: {only}};
+ const kept = reduceVisState(single, VisStateActions.deleteTableColumn('only', 'region'));
+ expect(kept.datasets.only.fields.map(field => field.name)).toEqual(['region']);
+ });
+
+ test('duplicate rename and non-tabular datasets are ignored', () => {
+ const state = withCities();
+ const duplicate = reduceVisState(
+ state,
+ VisStateActions.renameTableColumn('cities', 'region', 'pop')
+ );
+ expect(duplicate).toBe(state);
+
+ const tiles = new KeplerTable({
+ info: {id: 'tiles', label: 'tiles', type: 'vector-tile'},
+ color: [0, 0, 0]
+ });
+ tiles.updateSchema({
+ fields: [
+ {name: 'region', type: ALL_FIELD_TYPES.string},
+ {name: 'pop', type: ALL_FIELD_TYPES.integer}
+ ],
+ rows: [['west', 1]]
+ });
+ const tiled: VisState = {...INITIAL_VIS_STATE, datasets: {tiles}};
+ const unchanged = reduceVisState(
+ tiled,
+ VisStateActions.renameTableColumn('tiles', 'region', 'area')
+ );
+ expect(unchanged).toBe(tiled);
+ expect(reduceVisState(tiled, VisStateActions.deleteTableColumn('tiles', 'pop'))).toBe(tiled);
+ });
+
+ test('externally hosted datasets ignore rename and delete', () => {
+ const remote = new KeplerTable({
+ info: {id: 'remote', label: 'remote', type: 'externally-hosted'},
+ color: [0, 0, 0]
+ });
+ remote.updateSchema({
+ fields: [
+ {name: 'region', type: ALL_FIELD_TYPES.string, displayName: 'Region'},
+ {name: 'pop', type: ALL_FIELD_TYPES.integer}
+ ],
+ rows: [['west', 1]]
+ });
+ const state: VisState = {...INITIAL_VIS_STATE, datasets: {remote}};
+
+ expect(
+ reduceVisState(state, VisStateActions.renameTableColumn('remote', 'region', 'area'))
+ ).toBe(state);
+ expect(reduceVisState(state, VisStateActions.deleteTableColumn('remote', 'pop'))).toBe(state);
+ expect(state.datasets.remote.fields[0].displayName).toBe('Region');
+ });
+});
diff --git a/src/reducers/src/dataset-ops-updaters.spec.ts b/src/reducers/src/dataset-ops-updaters.spec.ts
index 43ec86da6..2c9facd88 100644
--- a/src/reducers/src/dataset-ops-updaters.spec.ts
+++ b/src/reducers/src/dataset-ops-updaters.spec.ts
@@ -77,10 +77,11 @@ describe('dataset ops vis-state', () => {
aggregations: {pop: 'sum'}
})
);
+ const resultId = state.groupBys[0].resultId;
state = reduceVisState(state, VisStateActions.runGroupBy(opId));
state = flushCreateTableTasks(state);
- const resultId = state.groupBys[0].resultId;
+ expect(state.groupBys).toHaveLength(0);
expect(state.datasets[resultId]).toBeTruthy();
expect(state.datasets[resultId].metadata.derivedDataset).toEqual({
type: 'groupBy',
@@ -115,6 +116,7 @@ describe('dataset ops vis-state', () => {
state = reduceVisState(state, VisStateActions.runGroupBy(op.id));
state = flushCreateTableTasks(state);
+ expect(state.groupBys).toHaveLength(0);
expect(Object.keys(state.datasets)).toHaveLength(2);
state = reduceVisState(state, VisStateActions.removeDataset('cities'));
expect(state.datasets.cities).toBeUndefined();
@@ -211,6 +213,7 @@ describe('dataset ops vis-state', () => {
state = reduceVisState(state, VisStateActions.runSpatialJoin(op.id));
state = flushCreateTableTasks(state);
+ expect(state.joins).toHaveLength(0);
expect(state.datasets[op.resultId]).toBeTruthy();
state = reduceVisState(state, VisStateActions.removeDataset('pts'));
expect(state.datasets.pts).toBeUndefined();
@@ -219,7 +222,7 @@ describe('dataset ops vis-state', () => {
expect(state.joins).toHaveLength(0);
});
- test('save/load roundtrip keeps derivedDataset metadata and drafts', () => {
+ test('save/load roundtrip keeps the derived dataset and drops the finished group by', () => {
const cities = makeTable(
'cities',
[
@@ -255,7 +258,7 @@ describe('dataset ops vis-state', () => {
| {derivedDataset?: {type?: string} | null}
| undefined;
expect(derivedMeta?.derivedDataset?.type).toBe('groupBy');
- expect(saved.config.config.visState.groupBys?.[0].fieldName).toBe('region');
+ expect(saved.config.config.visState.groupBys ?? []).toHaveLength(0);
});
});
diff --git a/src/reducers/src/dataset-ops-updaters.ts b/src/reducers/src/dataset-ops-updaters.ts
index 830e24d95..69e48d418 100644
--- a/src/reducers/src/dataset-ops-updaters.ts
+++ b/src/reducers/src/dataset-ops-updaters.ts
@@ -115,9 +115,7 @@ export function executeGroupBy(
return {
state: {
...state,
- groupBys: state.groupBys.map(item =>
- item.id === op.id ? {...item, isConfigActive: false, error: null} : item
- )
+ groupBys: state.groupBys.filter(item => item.id !== op.id)
},
proto
};
@@ -210,9 +208,7 @@ export function executeJoin(
return {
state: {
...state,
- joins: state.joins.map(item =>
- item.id === op.id ? {...item, isConfigActive: false, error: null} : item
- )
+ joins: state.joins.filter(item => item.id !== op.id)
},
proto
};
@@ -270,9 +266,7 @@ export function executeSpatialJoin(
return {
state: {
...state,
- joins: state.joins.map(item =>
- item.id === op.id ? {...item, isConfigActive: false, error: null} : item
- )
+ joins: state.joins.filter(item => item.id !== op.id)
},
proto
};
diff --git a/src/reducers/src/vis-state-updaters.ts b/src/reducers/src/vis-state-updaters.ts
index fb0c91574..0e65d2a41 100644
--- a/src/reducers/src/vis-state-updaters.ts
+++ b/src/reducers/src/vis-state-updaters.ts
@@ -190,12 +190,16 @@ import {
KeplerTable,
FilterProps,
assignGpuChannel,
+ buildDeleteColumnData,
+ buildRenameColumnData,
+ canMutateDatasetSchema,
copyTableAndUpdate,
createNewDataEntry,
pinTableColumns,
setFilterGpuMode,
sortDatasetByColumn
} from '@kepler.gl/table';
+import {remapChartsForDataset} from './column-edit-reconcile';
import {findFieldsToShow, removeLayerFromZoomOpacity} from './interaction-utils';
import {
calculateLayerData,
@@ -4478,7 +4482,8 @@ export function updateDatasetUpdater(
datasets: newDatasets,
filters: newFilters,
layers: newLayers,
- interactionConfig
+ interactionConfig,
+ charts: remapChartsForDataset(state.charts, dataId, renames, newFieldsByName)
};
// 6. drop layers that lost their required columns
@@ -4490,6 +4495,54 @@ export function updateDatasetUpdater(
return nextState;
}
+/**
+ * Rename a column's stored identity (`field.name`) and every layer, filter,
+ * tooltip, and chart reference that used the old name.
+ */
+export function renameTableColumnUpdater(
+ state: VisState,
+ action: VisStateActions.RenameTableColumnUpdaterAction
+): VisState {
+ const {dataId, fieldName, newName} = action;
+ const dataset = state.datasets[dataId];
+ if (!dataset || !canMutateDatasetSchema(dataset)) {
+ return state;
+ }
+ const payload = buildRenameColumnData(dataset, fieldName, newName);
+ if (!payload) {
+ return state;
+ }
+ return updateDatasetUpdater(state, {
+ dataId,
+ data: payload.data,
+ renames: payload.renames
+ });
+}
+
+/**
+ * Drop a column and the layers, filters, and other references that required it.
+ * The last remaining column is kept.
+ */
+export function deleteTableColumnUpdater(
+ state: VisState,
+ action: VisStateActions.DeleteTableColumnUpdaterAction
+): VisState {
+ const {dataId, fieldName} = action;
+ const dataset = state.datasets[dataId];
+ if (!dataset || !canMutateDatasetSchema(dataset)) {
+ return state;
+ }
+ const payload = buildDeleteColumnData(dataset, fieldName);
+ if (!payload) {
+ return state;
+ }
+ return updateDatasetUpdater(state, {
+ dataId,
+ data: payload.data,
+ renames: payload.renames
+ });
+}
+
/**
* When a user clicks on the specific map closing icon
* the application will close the selected map
diff --git a/src/reducers/src/vis-state.ts b/src/reducers/src/vis-state.ts
index b0768c676..b839e5549 100644
--- a/src/reducers/src/vis-state.ts
+++ b/src/reducers/src/vis-state.ts
@@ -145,6 +145,10 @@ const actionHandler = {
[ActionTypes.UPDATE_DATASET]: visStateUpdaters.updateDatasetUpdater,
+ [ActionTypes.RENAME_TABLE_COLUMN]: visStateUpdaters.renameTableColumnUpdater,
+
+ [ActionTypes.DELETE_TABLE_COLUMN]: visStateUpdaters.deleteTableColumnUpdater,
+
[ActionTypes.SET_FEATURES]: visStateUpdaters.setFeaturesUpdater,
[ActionTypes.SET_EDITOR_FEATURE_PROPERTIES]: visStateUpdaters.setEditorFeaturePropertiesUpdater,
diff --git a/src/table/src/dataset-ops.spec.ts b/src/table/src/dataset-ops.spec.ts
index 05436bc49..c51fb2029 100644
--- a/src/table/src/dataset-ops.spec.ts
+++ b/src/table/src/dataset-ops.spec.ts
@@ -11,6 +11,7 @@ import {
defaultAggregationsForFields,
groupByDataset,
isDatasetOpsAggregationField,
+ canMutateDatasetSchema,
isTabularDatasetForOps,
joinDatasets,
spatialJoinDatasets,
@@ -433,8 +434,15 @@ describe('dataset-ops engine', () => {
test('isTabularDatasetForOps skips tiles and disabled datasets', () => {
expect(isTabularDatasetForOps({type: 'local'})).toBe(true);
expect(isTabularDatasetForOps({type: ''})).toBe(true);
+ expect(isTabularDatasetForOps({type: 'externally-hosted'})).toBe(true);
expect(isTabularDatasetForOps({type: 'vector-tile'})).toBe(false);
expect(isTabularDatasetForOps({type: 'local', disableDataOperation: true})).toBe(false);
+
+ expect(canMutateDatasetSchema({type: 'local'})).toBe(true);
+ expect(canMutateDatasetSchema({type: ''})).toBe(true);
+ expect(canMutateDatasetSchema({type: 'externally-hosted'})).toBe(false);
+ expect(canMutateDatasetSchema({type: 'vector-tile'})).toBe(false);
+ expect(canMutateDatasetSchema({type: 'local', disableDataOperation: true})).toBe(false);
});
test('aggregation options depend on field type', () => {
diff --git a/src/table/src/dataset-ops/column-edit.spec.ts b/src/table/src/dataset-ops/column-edit.spec.ts
new file mode 100644
index 000000000..9c8dfdaf0
--- /dev/null
+++ b/src/table/src/dataset-ops/column-edit.spec.ts
@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {ALL_FIELD_TYPES} from '@kepler.gl/constants';
+import KeplerTable from '../kepler-table';
+import {buildDeleteColumnData, buildRenameColumnData} from './column-edit';
+
+function makeTable() {
+ const table = new KeplerTable({
+ info: {id: 'cities', label: 'cities', type: 'local'},
+ color: [0, 0, 0]
+ });
+ table.updateSchema({
+ fields: [
+ {name: 'region', type: ALL_FIELD_TYPES.string, displayName: 'Region'},
+ {name: 'pop', type: ALL_FIELD_TYPES.integer, displayName: 'Population'}
+ ],
+ rows: [
+ ['west', 10],
+ ['east', 40]
+ ]
+ });
+ return table;
+}
+
+describe('column edit payloads', () => {
+ test('rename keeps values and records the old name', () => {
+ const payload = buildRenameColumnData(makeTable(), 'region', 'area');
+ expect(payload?.renames).toEqual({region: 'area'});
+ expect(payload?.data.fields.map(field => field.name)).toEqual(['area', 'pop']);
+ expect(payload?.data.fields[0].displayName).toBe('area');
+ expect(payload?.data.fields[1].displayName).toBe('Population');
+ expect(payload?.data.rows).toEqual([
+ ['west', 10],
+ ['east', 40]
+ ]);
+ });
+
+ test('rename rejects a blank or duplicate name', () => {
+ const table = makeTable();
+ expect(buildRenameColumnData(table, 'region', ' ')).toBeNull();
+ expect(buildRenameColumnData(table, 'region', 'pop')).toBeNull();
+ expect(buildRenameColumnData(table, 'region', 'region')).toBeNull();
+ expect(buildRenameColumnData(table, 'missing', 'area')).toBeNull();
+ });
+
+ test('rename keeps arrow columns as vectors', () => {
+ const table = makeTable();
+ const vectors = ['west-col', 'pop-col'];
+ const payload = buildRenameColumnData(
+ {
+ fields: table.fields,
+ dataContainer: {
+ numRows: () => 2,
+ getColumn: index => vectors[index],
+ rowAsArray: () => {
+ throw new Error('row materialization');
+ }
+ } as unknown as typeof table.dataContainer
+ },
+ 'region',
+ 'area'
+ );
+ expect(payload?.data.cols).toEqual(vectors);
+ expect(payload?.data.rows).toEqual([]);
+ });
+
+ test('delete drops the column and refuses the last field', () => {
+ const payload = buildDeleteColumnData(makeTable(), 'pop');
+ expect(payload?.data.fields.map(field => field.name)).toEqual(['region']);
+ expect(payload?.data.fields[0].displayName).toBe('Region');
+ expect(payload?.data.rows).toEqual([['west'], ['east']]);
+ expect(payload?.renames).toEqual({});
+
+ const oneColumn = new KeplerTable({
+ info: {id: 'one', label: 'one', type: 'local'},
+ color: [0, 0, 0]
+ });
+ oneColumn.updateSchema({
+ fields: [{name: 'region', type: ALL_FIELD_TYPES.string}],
+ rows: [['west']]
+ });
+ expect(buildDeleteColumnData(oneColumn, 'region')).toBeNull();
+ });
+});
diff --git a/src/table/src/dataset-ops/column-edit.ts b/src/table/src/dataset-ops/column-edit.ts
new file mode 100644
index 000000000..facfb6e2c
--- /dev/null
+++ b/src/table/src/dataset-ops/column-edit.ts
@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: MIT
+// Copyright contributors to the kepler.gl project
+
+import {Field, ProtoDataset} from '@kepler.gl/types';
+import {DataContainerInterface} from '@kepler.gl/utils';
+
+export type ColumnEditDataset = {
+ fields: Field[];
+ dataContainer: DataContainerInterface;
+};
+
+export type ColumnEditPayload = {
+ data: ProtoDataset['data'];
+ renames: Record<string, string>;
+};
+
+/**
+ * Field descriptor for `updateDataset`, with accessors and per-column stats
+ * stripped so the table rebuilds them against the new container.
+ */
+export function schemaField(field: Field, name: string): ProtoDataset['data']['fields'][number] {
+ const {
+ valueAccessor: _valueAccessor,
+ fieldIdx: _fieldIdx,
+ filterProps: _filterProps,
+ isLoadingStats: _isLoadingStats,
+ ...rest
+ } = field;
+ return {
+ ...rest,
+ name,
+ id: name,
+ // A rename replaces the visible label. Other columns keep theirs.
+ displayName: name === field.name ? field.displayName || name : name
+ };
+}
+
+/**
+ * Project a dataset down to `columns`, preserving Arrow vectors when the
+ * container exposes them so a rename does not round-trip typed columns
+ * through plain rows.
+ */
+export function projectDatasetColumns(
+ dataset: ColumnEditDataset,
+ columns: {sourceIndex: number; name: string}[]
+): ProtoDataset['data'] {
+ const fields = columns.map(({sourceIndex, name}) =>
+ schemaField(dataset.fields[sourceIndex], name)
+ );
+ const dataContainer = dataset.dataContainer;
+ if (typeof dataContainer.getColumn === 'function' && dataContainer.numRows() > 0) {
+ const cols = columns.map(({sourceIndex}) => dataContainer.getColumn?.(sourceIndex));
+ if (cols.length && cols.every(Boolean)) {
+ return {fields, rows: [], cols};
+ }
+ }
+
+ const rowCount = dataContainer.numRows();
+ const rows: unknown[][] = new Array(rowCount);
+ for (let rowIndex = 0; rowIndex < rowCount; rowIndex++) {
+ const source = dataContainer.rowAsArray(rowIndex);
+ rows[rowIndex] = columns.map(({sourceIndex}) => source[sourceIndex]);
+ }
+ return {fields, rows};
+}
+
+export function buildRenameColumnData(
+ dataset: ColumnEditDataset,
+ fieldName: string,
+ newName: string
+): ColumnEditPayload | null {
+ const nextName = newName.trim();
+ if (!nextName || nextName === fieldName) {
+ return null;
+ }
+ const sourceIndex = dataset.fields.findIndex(field => field.name === fieldName);
+ if (sourceIndex < 0) {
+ return null;
+ }
+ if (dataset.fields.some(field => field.name === nextName)) {
+ return null;
+ }
+
+ const columns = dataset.fields.map((field, index) => ({
+ sourceIndex: index,
+ name: field.name === fieldName ? nextName : field.name
+ }));
+ return {
+ data: projectDatasetColumns(dataset, columns),
+ renames: {[fieldName]: nextName}
+ };
+}
+
+export function buildDeleteColumnData(
+ dataset: ColumnEditDataset,
+ fieldName: string
+): ColumnEditPayload | null {
+ const sourceIndex = dataset.fields.findIndex(field => field.name === fieldName);
+ if (sourceIndex < 0 || dataset.fields.length < 2) {
+ return null;
+ }
+ const columns = dataset.fields.flatMap((field, index) =>
+ field.name === fieldName ? [] : [{sourceIndex: index, name: field.name}]
+ );
+ return {
+ data: projectDatasetColumns(dataset, columns),
+ renames: {}
+ };
+}
diff --git a/src/table/src/dataset-ops/index.ts b/src/table/src/dataset-ops/index.ts
index c2ba9c426..e2d700e58 100644
--- a/src/table/src/dataset-ops/index.ts
+++ b/src/table/src/dataset-ops/index.ts
@@ -5,6 +5,7 @@ export * from './types';
export * from './aggregations';
export * from './geometry';
export * from './table-helpers';
+export * from './column-edit';
export * from './group-by';
export * from './join';
export * from './spatial-join';
diff --git a/src/table/src/dataset-ops/table-helpers.ts b/src/table/src/dataset-ops/table-helpers.ts
index b1982b788..3aa63fc3f 100644
--- a/src/table/src/dataset-ops/table-helpers.ts
+++ b/src/table/src/dataset-ops/table-helpers.ts
@@ -7,13 +7,16 @@ import {Field} from '@kepler.gl/types';
import {DatasetOpsTable} from './types';
const TABULAR_TYPES = new Set<string>([DatasetType.LOCAL, DatasetType.EXTERNALLY_HOSTED, '']);
+// Remote tables are reloaded from their source URL, so a rename or delete would
+// not survive refresh or the next map load.
+const SCHEMA_MUTABLE_TYPES = new Set<string>([DatasetType.LOCAL, '']);
-export function isTabularDatasetForOps(
- dataset?: {
- type?: string;
- disableDataOperation?: boolean;
- } | null
-): boolean {
+type DatasetOpTarget = {
+ type?: string;
+ disableDataOperation?: boolean;
+} | null;
+
+export function isTabularDatasetForOps(dataset?: DatasetOpTarget): boolean {
if (!dataset || dataset.disableDataOperation) {
return false;
}
@@ -21,6 +24,13 @@ export function isTabularDatasetForOps(
return TABULAR_TYPES.has(type);
}
+export function canMutateDatasetSchema(dataset?: DatasetOpTarget): boolean {
+ if (!isTabularDatasetForOps(dataset)) {
+ return false;
+ }
+ return SCHEMA_MUTABLE_TYPES.has(dataset?.type ?? '');
+}
+
export function findFieldByName(
fields: Field[],
name: string | null | undefined