tubular-common/src/Models/ColumnModel.ts

Tubular Common Models and Data Transformer

import type { AggregateFunctions, ColumnDataType, ColumnSortDirection, CompareOperators } from './Column';

export interface ColumnModel {
    aggregate: AggregateFunctions;
    dataType: ColumnDataType;
    dateOriginFormat?: string; // YYYY-MM-DD (default)
    dateDisplayFormat?: string; // YYYY-MM-DD (default)
    dateTimeOriginFormat?: string; // YYYY-MM-DDTHH:mm:ss (default)
    dateTimeDisplayFormat?: string; // YYYY-MM-DDTHH:mm:ss (default)
    filterArgument: string[] | number[] | undefined;
    filterOperator: CompareOperators | undefined;
    filterText: string | undefined;
    filterable: boolean;
    exportable: boolean;
    isKey: boolean;
    label: string;
    isComputed: boolean;
    getComputedStringValue?: (column: ColumnModel, row: unknown, isHeader: boolean) => string;
    name: string;
    searchable: boolean;
    sortDirection: ColumnSortDirection;
    sortOrder: number;
    sortable: boolean;
    visible: boolean;
}