Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
[Feat] make data table header cell overridable (#1995)
Igor Dykhta791bbe215ace
diff --git a/src/components/src/common/data-table/cell-size.ts b/src/components/src/common/data-table/cell-size.tsindex 5a40ec73f..c9d7e3e50 100644--- a/src/components/src/common/data-table/cell-size.ts+++ b/src/components/src/common/data-table/cell-size.ts@@ -23,6 +23,7 @@ import {DataContainerInterface} from '@kepler.gl/table';import {parseFieldValue} from '@kepler.gl/utils';const MIN_GHOST_CELL_SIZE: number = 200;+const MIN_CELL_SIZE = 45;type RenderSizeParam = {text: {dataContainer: DataContainerInterface; column: string};@@ -57,9 +58,9 @@ export function renderedSize({fontSize = 12,font = 'Lato',cellPadding = 40,- maxCellSize = 400,- maxHeaderSize = 150,- minCellSize = 45,+ maxCellSize = 500,+ maxHeaderSize = 500,+ minCellSize = MIN_CELL_SIZE,optionsButton = 30}: RenderSizeParam): {row: number; header: number} {if (!document) {diff --git a/src/components/src/common/data-table/header-cell.tsx b/src/components/src/common/data-table/header-cell.tsxnew file mode 100644index 000000000..9309fd0a9--- /dev/null+++ b/src/components/src/common/data-table/header-cell.tsx@@ -0,0 +1,162 @@+import React, {CSSProperties} from 'react';+import styled from 'styled-components';+import classnames from 'classnames';+import Button from './button';+import {ArrowUp, ArrowDown, VertThreeDots} from '../../common/icons';+import OptionDropdown from './option-dropdown';+import {SORT_ORDER} from '@kepler.gl/constants';+import FieldTokenFactory, {FieldTokenProps} from '../../common/field-token';+import {DataTableProps} from './index';++const StyledHeaderCell = styled.div`+ border-bottom: 1px solid ${props => props.theme.headerCellBorderColor};+ border-top: 1px solid ${props => props.theme.headerCellBorderColor};+ padding-top: ${props => props.theme.headerPaddingTop}px;+ padding-right: 0;+ padding-bottom: ${props => props.theme.headerPaddingBottom}px;+ padding-left: ${props => props.theme.cellPaddingSide}px;+ align-items: center;+ justify-content: space-between;+ display: flex;+ flex-direction: row;+ background-color: ${props => props.theme.headerCellBackground};++ &:hover {+ .more {+ color: ${props => props.theme.headerCellIconColor};+ }+ }+ .n-sort-idx {+ font-size: 9px;+ }+ .details {+ font-weight: 500;+ display: flex;+ flex-direction: column;+ justify-content: flex-start;+ height: 100%;+ overflow: hidden;+ flex-grow: 1;++ .col-name {+ display: flex;+ align-items: center;+ justify-content: space-between;+ cursor: pointer;++ .col-name__left {+ display: flex;+ align-items: center;+ overflow: hidden;+ svg {+ margin-left: 6px;+ }+ }+ .col-name__name {+ overflow: hidden;+ white-space: nowrap;+ }+ }+ }++ .more {+ color: transparent;+ margin-left: 5px;+ }+`;++type CellInfo = {+ columnIndex: number;+ isScrolling: boolean;+ isVisible: boolean;+ key: string;+ parent: any;+ rowIndex: number;+ style: CSSProperties;+};++type HeaderCellProps = {+ // passed down from react virtualized Grid+ cellInfo: CellInfo;+ columns: DataTableProps['columns'];+ isPinned?: boolean;+ props: DataTableProps;+ toggleMoreOptions: (moreOptionsColumn: string) => void;+ moreOptionsColumn: null | string;+};++const HeaderCellFactory = (FieldToken: React.FC<FieldTokenProps>) => {+ const HeaderCell = ({+ cellInfo,+ columns,+ isPinned,+ props,+ toggleMoreOptions,+ moreOptionsColumn+ }: HeaderCellProps) => {+ const {columnIndex, key, style} = cellInfo;+ const {colMeta, sortColumn = {}, sortTableColumn, pinTableColumn, copyTableColumn} = props;+ const column = columns[columnIndex];++ const isGhost = column.ghost;+ const isSorted = sortColumn[column];+ const firstCell = columnIndex === 0;+ return (+ <StyledHeaderCell+ className={classnames('header-cell', {+ [`column-${columnIndex}`]: true,+ 'pinned-header-cell': isPinned,+ 'first-cell': firstCell+ })}+ key={key}+ style={style}+ onClick={e => {+ e.shiftKey ? sortTableColumn(column) : null;+ }}+ onDoubleClick={() => sortTableColumn(column)}+ title={column}+ >+ {isGhost ? (+ <div />+ ) : (+ <>+ <section className="details">+ <div className="col-name">+ <div className="col-name__left">+ <div className="col-name__name">{colMeta[column].name}</div>+ <Button className="col-name__sort" onClick={() => sortTableColumn(column)}>+ {isSorted ? (+ isSorted === SORT_ORDER.ASCENDING ? (+ <ArrowUp height="14px" />+ ) : (+ <ArrowDown height="14px" />+ )+ ) : null}+ </Button>+ </div>+ <Button className="more" onClick={() => toggleMoreOptions(column)}>+ <VertThreeDots height="14px" />+ </Button>+ </div>+ <FieldToken type={colMeta[column].type} />+ </section>++ <section className="options">+ <OptionDropdown+ isOpened={moreOptionsColumn === column}+ column={column}+ toggleMoreOptions={toggleMoreOptions}+ sortTableColumn={mode => sortTableColumn(column, mode)}+ pinTableColumn={() => pinTableColumn(column)}+ copyTableColumn={() => copyTableColumn(column)}+ />+ </section>+ </>+ )}+ </StyledHeaderCell>+ );+ };+ return HeaderCell;+};+HeaderCellFactory.deps = [FieldTokenFactory];+export default HeaderCellFactory;diff --git a/src/components/src/common/data-table/index.tsx b/src/components/src/common/data-table/index.tsxindex 938dcb715..d1300fc30 100644--- a/src/components/src/common/data-table/index.tsx+++ b/src/components/src/common/data-table/index.tsx@@ -26,18 +26,15 @@ import {createSelector} from 'reselect';import get from 'lodash.get';import debounce from 'lodash.debounce';-import OptionDropdown from './option-dropdown';import {CellSizeCache} from './cell-size';import Grid from './grid';-import Button from './button';-import {ArrowUp, ArrowDown, VertThreeDots} from '../icons';+import HeaderCellFactory from './header-cell';import {parseFieldValue} from '@kepler.gl/utils';import {adjustCellsToContainer} from './cell-size';-import {ALL_FIELD_TYPES, SORT_ORDER} from '@kepler.gl/constants';-import FieldTokenFactory from '../field-token';+import {ALL_FIELD_TYPES} from '@kepler.gl/constants';import {DataContainerInterface} from '@kepler.gl/table';const defaultHeaderRowHeight = 55;@@ -162,62 +159,6 @@ export const Container = styled.div`.cell.align-right {align-items: flex-end;}- .header-cell {- border-bottom: 1px solid ${props => props.theme.headerCellBorderColor};- border-top: 1px solid ${props => props.theme.headerCellBorderColor};- padding-top: ${props => props.theme.headerPaddingTop}px;- padding-right: 0;- padding-bottom: ${props => props.theme.headerPaddingBottom}px;- padding-left: ${props => props.theme.cellPaddingSide}px;- align-items: center;- justify-content: space-between;- display: flex;- flex-direction: row;- background-color: ${props => props.theme.headerCellBackground};-- &:hover {- .more {- color: ${props => props.theme.headerCellIconColor};- }- }- .n-sort-idx {- font-size: 9px;- }- .details {- font-weight: 500;- display: flex;- flex-direction: column;- justify-content: flex-start;- height: 100%;- overflow: hidden;- flex-grow: 1;-- .col-name {- display: flex;- align-items: center;- justify-content: space-between;- cursor: pointer;-- .col-name__left {- display: flex;- align-items: center;- overflow: hidden;- svg {- margin-left: 6px;- }- }- .col-name__name {- overflow: hidden;- white-space: nowrap;- }- }- }-- .more {- color: transparent;- margin-left: 5px;- }- }}:focus {@@ -233,6 +174,8 @@ export type ColMeta = {name: string;displayName: string;type: string;+ format?: string;+ columnStats?: any;};};@@ -328,6 +271,7 @@ export const TableSection = ({{...headerGridProps}{...gridDimension}scrollLeft={scrollLeft}+ onScroll={onScroll}/></div><div@@ -353,7 +297,9 @@ export const TableSection = ({</AutoSizer>);-interface DataTableProps {+export interface DataTableProps {+ dataId?: string;+ showStats?: boolean;cellSizeCache?: CellSizeCache;pinnedColumns?: string[];columns: (string & {ghost?: boolean})[];@@ -375,8 +321,8 @@ interface DataTableState {ghost?;}-DataTableFactory.deps = [FieldTokenFactory];-function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {+DataTableFactory.deps = [HeaderCellFactory];+function DataTableFactory(HeaderCell: ReturnType<typeof HeaderCellFactory>) {class DataTable extends Component<DataTableProps, DataTableState> {static defaultProps = {dataContainer: null,@@ -386,7 +332,8 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {sortColumn: {},fixedWidth: null,fixedHeight: null,- theme: {}+ theme: {},+ showStats: false};state: DataTableState = {@@ -456,84 +403,6 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {scaleCellsToWidth = debounce(this.doScaleCellsToWidth, 300);- renderHeaderCell = (- columns: (string & {ghost?: boolean})[],- isPinned: boolean,- props: DataTableProps,- toggleMoreOptions,- moreOptionsColumn- ) => {- // eslint-disable-next-line react/display-name- return cellInfo => {- const {columnIndex, key, style} = cellInfo;- const {colMeta, sortColumn = {}, sortTableColumn, pinTableColumn, copyTableColumn} = props;-- const column = columns[columnIndex];- const isGhost = column.ghost;- const isSorted = sortColumn[column];- const firstCell = columnIndex === 0;-- return (- <div- className={classnames('header-cell', {- [`column-${columnIndex}`]: true,- 'pinned-header-cell': isPinned,- 'first-cell': firstCell- })}- key={key}- style={style}- onClick={e => {- e.shiftKey ? sortTableColumn(column) : null;- }}- onDoubleClick={() => sortTableColumn(column)}- title={column}- >- {isGhost ? (- <div />- ) : (- <>- <section className="details">- <div className="col-name">- <div className="col-name__left">- <div className="col-name__name">{colMeta[column].name}</div>- <Button className="col-name__sort" onClick={() => sortTableColumn(column)}>- {isSorted ? (- isSorted === SORT_ORDER.ASCENDING ? (- <ArrowUp height="14px" />- ) : (- <ArrowDown height="14px" />- )- ) : null}- </Button>- </div>- <Button className="more" onClick={() => toggleMoreOptions(column)}>- <VertThreeDots height="14px" />- </Button>- </div>-- <FieldToken type={colMeta[column].type} />- </section>-- <section className="options">- <OptionDropdown- isOpened={moreOptionsColumn === column}- column={column}- toggleMoreOptions={toggleMoreOptions}- sortTableColumn={mode => sortTableColumn(column, mode)}- sortMode={sortColumn && sortColumn[column]}- pinTableColumn={() => pinTableColumn(column)}- copyTableColumn={() => copyTableColumn(column)}- isSorted={isSorted}- isPinned={isPinned}- />- </section>- </>- )}- </div>- );- };- };-renderDataCell = (columns, isPinned, props: DataTableProps) => {return cellInfo => {const {columnIndex, key, style, rowIndex} = cellInfo;@@ -574,13 +443,27 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {};};+ renderHeaderCell(columns, isPinned, props, toggleMoreOptions, moreOptionsColumn) {+ return cellInfo => (+ <HeaderCell+ cellInfo={cellInfo}+ key={cellInfo.columnIndex}+ columns={columns}+ isPinned={isPinned}+ props={props}+ toggleMoreOptions={toggleMoreOptions}+ moreOptionsColumn={moreOptionsColumn}+ />+ );+ }render() {const {dataContainer,pinnedColumns = [],theme = {},fixedWidth,- fixedHeight = 0+ fixedHeight = 0,+ showStats} = this.props;const unpinnedColumns = this.unpinnedColumns(this.props);@@ -594,14 +477,18 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {);const hasPinnedColumns = Boolean(pinnedColumns.length);- const {headerRowHeight = defaultHeaderRowHeight, rowHeight = defaultRowHeight} = theme;+ const {+ headerRowHeight = defaultHeaderRowHeight,+ headerRowWStatsHeight = defaultHeaderRowHeight,+ rowHeight = defaultRowHeight+ } = theme;const headerGridProps = {cellSizeCache,className: 'header-grid',- height: headerRowHeight,+ height: showStats ? headerRowWStatsHeight : headerRowHeight,rowCount: 1,- rowHeight: headerRowHeight+ rowHeight: showStats ? headerRowWStatsHeight : headerRowHeight};const dataGridProps = {@@ -614,7 +501,7 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {return (<Container className="data-table-container" ref={this.root}>- {Object.keys(cellSizeCache).length && (+ {Object.keys(cellSizeCache).length ? (<ScrollSync>{({onScroll, scrollLeft, scrollTop}) => {return (@@ -689,7 +576,7 @@ function DataTableFactory(FieldToken: ReturnType<typeof FieldTokenFactory>) {);}}</ScrollSync>- )}+ ) : null}</Container>);}diff --git a/src/components/src/common/data-table/option-dropdown.tsx b/src/components/src/common/data-table/option-dropdown.tsxindex 217edc236..6ec36b6ce 100644--- a/src/components/src/common/data-table/option-dropdown.tsx+++ b/src/components/src/common/data-table/option-dropdown.tsx@@ -55,8 +55,8 @@ const StyledOptionsDropdown = styled.div`interface OptionDropdownProps {isOpened?: boolean;column: string;- toggleMoreOptions: (order: string) => void;- sortTableColumn: (order: string) => void;+ toggleMoreOptions: (column: string) => void;+ sortTableColumn: (sort: string) => void;pinTableColumn: () => void;copyTableColumn: () => void;sortMode?: string;diff --git a/src/components/src/common/histogram-plot.tsx b/src/components/src/common/histogram-plot.tsxindex d1f58cacc..37059cb8e 100644--- a/src/components/src/common/histogram-plot.tsx+++ b/src/components/src/common/histogram-plot.tsx@@ -49,7 +49,7 @@ const BarUnmemoized = styled.rect<BarType>(const Bar = React.memo(BarUnmemoized);Bar.displayName = 'Bar';-interface HistogramPlotParams {+interface HistogramPlotProps {width: number;height: number;margin: {top: number; bottom: number; left: number; right: number};@@ -68,7 +68,7 @@ function HistogramPlotFactory() {histogram,value,brushComponent- }: HistogramPlotParams) => {+ }: HistogramPlotProps) => {const undefinedToZero = (x: number | undefined) => (x ? x : 0);const domain = useMemo(() =>diff --git a/src/components/src/index.ts b/src/components/src/index.tsindex 83b31cf27..91eac3347 100644--- a/src/components/src/index.ts+++ b/src/components/src/index.ts@@ -220,6 +220,7 @@ export {default as Slider} from './common/slider/slider';export {default as SliderHandle} from './common/slider/slider-handle';export {default as SliderBarHandle} from './common/slider/slider-bar-handle';export {default as ActionPanel, ActionPanelItem} from './common/action-panel';+export {default as HeaderCellFactory} from './common/data-table/header-cell';export {default as DataTableFactory} from './common/data-table';export {default as CanvasHack} from './common/data-table/canvas';export {default as OptionDropdown} from './common/data-table/option-dropdown';diff --git a/src/components/src/modal-container.tsx b/src/components/src/modal-container.tsxindex f6c5b3794..0a07b8803 100644--- a/src/components/src/modal-container.tsx+++ b/src/components/src/modal-container.tsx@@ -79,7 +79,7 @@ import {findDOMNode} from 'react-dom';import {VisState} from '@kepler.gl/schemas';const DataTableModalStyle = css`- top: 80px;+ top: 70px;padding: 32px 0 0 0;width: 90vw;max-width: 90vw;diff --git a/src/components/src/modals/data-table-modal.tsx b/src/components/src/modals/data-table-modal.tsxindex 683a28619..e83bd796a 100644--- a/src/components/src/modals/data-table-modal.tsx+++ b/src/components/src/modals/data-table-modal.tsx@@ -27,6 +27,8 @@ import {renderedSize} from '../common/data-table/cell-size';import CanvasHack from '../common/data-table/canvas';import KeplerTable, {Datasets} from '@kepler.gl/table';+const MIN_STATS_CELL_SIZE = 142;+const dgSettings = {sidePadding: '38px',verticalPadding: '16px',@@ -34,7 +36,7 @@ const dgSettings = {};const StyledModal = styled.div`- min-height: 70vh;+ min-height: 85vh;overflow: hidden;display: flex;`;@@ -124,11 +126,13 @@ function DataTableModalFactory(columns = createSelector(this.fields, fields => fields.map(f => f.name));colMeta = createSelector(this.fields, fields =>fields.reduce(- (acc, {name, displayName, type}) => ({+ (acc, {name, displayName, type, filterProps, format}) => ({...acc,[name]: {name: displayName || name,- type+ type,+ ...(format ? {format} : {}),+ ...(filterProps?.columnStats ? {columnStats: filterProps.columnStats} : {})}}),{}@@ -166,7 +170,8 @@ function DataTableModalFactory(colIdx,type: field.type,fontSize: this.props.theme.cellFontSize,- font: this.props.theme.fontFamily+ font: this.props.theme.fontFamily,+ minCellSize: MIN_STATS_CELL_SIZE})}),{}@@ -219,6 +224,7 @@ function DataTableModalFactory({datasets[dataId] ? (<DataTablekey={dataId}+ dataId={dataId}columns={columns}colMeta={colMeta}cellSizeCache={cellSizeCache}@@ -229,6 +235,7 @@ function DataTableModalFactory(copyTableColumn={this.copyTableColumn}pinTableColumn={this.pinTableColumn}sortTableColumn={this.sortTableColumn}+ showStats/>) : null}</TableContainer>diff --git a/src/table/src/filter-utils.ts b/src/table/src/filter-utils.tsindex ef01b915a..d6dbdbe77 100644--- a/src/table/src/filter-utils.ts+++ b/src/table/src/filter-utils.ts@@ -981,7 +981,10 @@ export function applyFilterFieldName(* Merge one filter with other filter prop domain*//* eslint-disable complexity */-export function mergeFilterDomainStep(filter: Filter, filterProps?: any): Filter | null {+export function mergeFilterDomainStep(+ filter: Filter,+ filterProps?: Partial<Filter>+): (Filter & {step?: number}) | null {if (!filter) {return null;}@@ -1014,9 +1017,9 @@ export function mergeFilterDomainStep(filter: Filter, filterProps?: any): Filtercase ALL_FIELD_TYPES.timestamp:const step =- (filter as TimeRangeFilter).step < filterProps.step+ (filter as TimeRangeFilter).step < (filterProps as TimeRangeFieldDomain).step? (filter as TimeRangeFilter).step- : filterProps.step;+ : (filterProps as TimeRangeFieldDomain).step;return {...newFilter,diff --git a/test/browser/components/modals/data-table-modal-test.js b/test/browser/components/modals/data-table-modal-test.jsindex 69257ad12..8f242c081 100644--- a/test/browser/components/modals/data-table-modal-test.js+++ b/test/browser/components/modals/data-table-modal-test.js@@ -44,7 +44,7 @@ import {StateWFiles, testCsvDataId, testGeoJsonDataId} from 'test/helpers/mock-simport {createDataContainer} from '@kepler.gl/table';-const {VertThreeDots, ArrowUp} = Icons;+const {VertThreeDots} = Icons;const DataTableModal = appInjector.get(DataTableModalFactory);const DataTable = appInjector.get(DataTableFactory);const FieldToken = appInjector.get(FieldTokenFactory);@@ -163,17 +163,25 @@ test('Components -> DataTableModal.render: csv 1', t => {];const expectedColMeta = {- 'gps_data.utc_timestamp': {name: 'gps_data.utc_timestamp', type: 'timestamp'},+ 'gps_data.utc_timestamp': {+ name: 'gps_data.utc_timestamp',+ type: 'timestamp',+ format: 'YYYY-M-D H:m:s'+ },'gps_data.lat': {name: 'gps_data.lat', type: 'real'},'gps_data.lng': {name: 'gps_data.lng', type: 'real'},'gps_data.types': {name: 'gps_data.types', type: 'string'},- epoch: {name: 'epoch', type: 'timestamp'},+ epoch: {name: 'epoch', type: 'timestamp', format: 'X'},has_result: {name: 'has_result', type: 'boolean'},uid: {name: 'uid', type: 'integer'},- time: {name: 'time', type: 'timestamp'},- begintrip_ts_utc: {name: 'begintrip_ts_utc', type: 'timestamp'},- begintrip_ts_local: {name: 'begintrip_ts_local', type: 'timestamp'},- date: {name: 'date', type: 'date'}+ time: {name: 'time', type: 'timestamp', format: 'YYYY-M-DTHH:mm:ss.SSSS'},+ begintrip_ts_utc: {name: 'begintrip_ts_utc', type: 'timestamp', format: 'YYYY-M-D HH:mm:ssZZ'},+ begintrip_ts_local: {+ name: 'begintrip_ts_local',+ type: 'timestamp',+ format: 'YYYY-M-D HH:mm:ssZZ'+ },+ date: {name: 'date', type: 'date', format: 'YYYY-M-D'}};t.deepEqual(props.columns, expectedColumns, 'DataTable should have the correct props.columns');@@ -284,7 +292,7 @@ test('Components -> DataTableModal -> render DataTable: csv 1', t => {t.equal(wrapper2.find('.header-cell').length,- testFields.length,+ testFields.length * 3,`should render ${testFields.length} headers`);@@ -420,7 +428,7 @@ test('Components -> DataTableModal -> render DataTable: sort and pin', t => {t.equal(wrapper2.find('.header-cell').length,- testFields.length,+ testFields.length * 3,`should render ${testFields.length} headers`);@@ -444,7 +452,7 @@ test('Components -> DataTableModal -> render DataTable: sort and pin', t => {t.equal(wrapper2.find('.header-cell')- .at(i)+ .at(i * 3).find('.col-name__name').text(),expectedHeaders[i],@@ -452,15 +460,6 @@ test('Components -> DataTableModal -> render DataTable: sort and pin', t => {);});- t.equal(- wrapper2- .find('.header-cell')- .at(2)- .find(ArrowUp).length,- 1,- 'should render sort icon'- );-t.end();});@@ -542,9 +541,9 @@ test('Components -> cellSize -> renderedSize', t => {.props();const expected = {- _geojson: {row: 400, header: 96},- 'income level of people over 65': {row: 85, header: 150},- engagement: {row: 127, header: 115}+ _geojson: {row: 500, header: 192},+ 'income level of people over 65': {row: 182, header: 209},+ engagement: {row: 182, header: 192}};t.deepEqual(@@ -614,7 +613,7 @@ test('Components -> DataTableModal.render: csv 2', t => {componentInstance.setState(result);wrapper2.update();- t.equal(wrapper2.find('.header-cell').length, 7, `should render 7 header cells`);+ t.equal(wrapper2.find('.header-cell').length, 21, `should render 7 header cells`);// test header cellconst expectedHeaders = [@@ -629,7 +628,7 @@ test('Components -> DataTableModal.render: csv 2', t => {expectedHeaders.forEach((name, index) => {const header = wrapper2.find(`.header-cell.column-${index}`);- t.equal(header.length, 1, 'should render 1 header');+ t.equal(header.length, 3, 'should render 1 header');if (index < 6) {const cellText = header.find('.col-name__name').text();@@ -640,7 +639,7 @@ test('Components -> DataTableModal.render: csv 2', t => {t.equal(header.find(OptionDropdown).length, 1, 'should render OptionDropdown');} else {// if ghost cell- t.equal(header.text(), '', 'cell should be empty');+ t.equal(header.at(2).text(), '', 'cell should be empty');}});