QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-19 08:04:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(types): consolidate shared table types and fix Funnel enum typo (#37768)

Browse Source 
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Evan Rusackas
2026-02-09 01:14:34 -05:00
committed by GitHub
parent 82d6076804
commit ebee9bb3f9
6 changed files with 135 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
superset-frontend/plugins/plugin-chart-table/src/types.ts
View File

@@ -17,64 +17,35 @@
* under the License.
*/
import {
NumberFormatter,
TimeFormatter,
TimeGranularity,
QueryFormMetric,
ChartProps,
DataRecord,
DataRecordValue,
DataRecordFilters,
QueryMode,
ChartDataResponseResult,
QueryFormData,
SetDataMaskHook,
ContextMenuFilters,
CurrencyFormatter,
Currency,
} from '@superset-ui/core';
import { GenericDataType } from '@apache-superset/core/api/core';
import { ColorFormatters } from '@superset-ui/chart-controls';
import type {
BasicColorFormatterType,
ColorFormatters,
DataColumnMeta,
ServerPaginationData,
TableColumnConfig,
} from '@superset-ui/chart-controls';
export type CustomFormatter = (value: DataRecordValue) => string;
export type TableColumnConfig = {
d3NumberFormat?: string;
d3SmallNumberFormat?: string;
d3TimeFormat?: string;
columnWidth?: number;
horizontalAlign?: 'left' | 'right' | 'center';
showCellBars?: boolean;
alignPositiveNegative?: boolean;
colorPositiveNegative?: boolean;
truncateLongCells?: boolean;
currencyFormat?: Currency;
visible?: boolean;
customColumnName?: string;
displayTypeIcon?: boolean;
// Re-export shared types used by internal plugin files that import from './types'
// Types used locally in this file - re-export from local binding
export type {
BasicColorFormatterType,
DataColumnMeta,
ServerPaginationData,
TableColumnConfig,
};
export interface DataColumnMeta {
// `key` is what is called `label` in the input props
key: string;
// `label` is verbose column name used for rendering
label: string;
// `originalLabel` preserves the original label when time comparison transforms the labels
originalLabel?: string;
dataType: GenericDataType;
formatter?:
| TimeFormatter
| NumberFormatter
| CustomFormatter
| CurrencyFormatter;
isMetric?: boolean;
isPercentMetric?: boolean;
isNumeric?: boolean;
config?: TableColumnConfig;
isChildColumn?: boolean;
description?: string;
currencyCodeColumn?: string;
}
// Types only re-exported, not used locally - direct re-export
export type { SearchOption, SortByItem } from '@superset-ui/chart-controls';
export interface TableChartData {
records: DataRecord[];
@@ -110,31 +81,6 @@ export interface TableChartProps extends ChartProps {
queriesData: ChartDataResponseResult[];
}
export type BasicColorFormatterType = {
backgroundColor: string;
arrowColor: string;
mainArrow: string;
};
export type SortByItem = {
id: string;
key: string;
desc?: boolean;
};
export type SearchOption = {
value: string;
label: string;
};
export interface ServerPaginationData {
pageSize?: number;
currentPage?: number;
sortBy?: SortByItem[];
searchText?: string;
searchColumn?: string;
}
export interface TableChartTransformedProps<D extends DataRecord = DataRecord> {
timeGrain?: TimeGranularity;
height: number;