Interface: TableFeatures#

Defined in: types/TableFeatures.ts:181

Complete feature registry for a table.

This type combines core features, stock features, declaration-merged custom plugins, row-model factory slots, function registries, and type-only meta slots. The concrete features object passed to tableFeatures() determines which feature APIs are included throughout table, row, column, cell, header, options, and state types.

Extends#

• Partial<CoreFeatures>.Partial<StockFeatures>.Partial<Plugins>

Properties#

aggregationFns?#

optional aggregationFns: Record<string, AggregationFn<any, any>>;

Defined in: types/TableFeatures.ts:193

Registry of aggregation functions available to this table by name.

Keys registered here become the valid string values for aggregationFn on column definitions, with full inference. Import the built-in aggregation functions you use individually and register them by their conventional names: aggregationFns: { sum: aggregationFn_sum, myCustomAggregationFn }. Spreading the exported aggregationFns registry also works, but puts every built-in aggregation function in your bundle.

columnFacetingFeature?#

optional columnFacetingFeature: TableFeature;

Defined in: features/stockFeatures.ts:17

Inherited from#

StockFeatures.columnFacetingFeature

columnFilteringFeature?#

optional columnFilteringFeature: TableFeature;

Defined in: features/stockFeatures.ts:18

Inherited from#

StockFeatures.columnFilteringFeature

columnGroupingFeature?#

optional columnGroupingFeature: TableFeature;

Defined in: features/stockFeatures.ts:19

Inherited from#

StockFeatures.columnGroupingFeature

columnMeta?#

optional columnMeta: object;

Defined in: types/TableFeatures.ts:204

Type-only slot for declaring the type of columnDef.meta for all columns of this table.

Pass a phantom value: columnMeta: {} as MyColumnMeta. The value itself is ignored and stripped from the table's registered features at runtime — only its type is used, inferred wherever TFeatures flows.

When omitted, the global declaration-merged ColumnMeta interface applies.

columnOrderingFeature?#

optional columnOrderingFeature: TableFeature;

Defined in: features/stockFeatures.ts:20

Inherited from#

StockFeatures.columnOrderingFeature

columnPinningFeature?#

optional columnPinningFeature: TableFeature;

Defined in: features/stockFeatures.ts:21

Inherited from#

StockFeatures.columnPinningFeature

columnResizingFeature?#

optional columnResizingFeature: TableFeature;

Defined in: features/stockFeatures.ts:22

Inherited from#

StockFeatures.columnResizingFeature

columnSizingFeature?#

optional columnSizingFeature: TableFeature;

Defined in: features/stockFeatures.ts:23

Inherited from#

StockFeatures.columnSizingFeature

columnVisibilityFeature?#

optional columnVisibilityFeature: TableFeature;

Defined in: features/stockFeatures.ts:24

Inherited from#

StockFeatures.columnVisibilityFeature

coreCellsFeature?#

optional coreCellsFeature: TableFeature;

Defined in: core/coreFeatures.ts:11

Inherited from#

CoreFeatures.coreCellsFeature

coreColumnsFeature?#

optional coreColumnsFeature: TableFeature;

Defined in: core/coreFeatures.ts:12

Inherited from#

CoreFeatures.coreColumnsFeature

coreHeadersFeature?#

optional coreHeadersFeature: TableFeature;

Defined in: core/coreFeatures.ts:13

Inherited from#

CoreFeatures.coreHeadersFeature

coreReactivityFeature?#

optional coreReactivityFeature: TableReactivityBindings;

Defined in: core/coreFeatures.ts:10

Inherited from#

CoreFeatures.coreReactivityFeature

coreRowModel()?#

optional coreRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:209

Factory for the table's core (unmodified) row model. Defaults to the built-in createCoreRowModel() when omitted.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

coreRowModelsFeature?#

optional coreRowModelsFeature: TableFeature;

Defined in: core/coreFeatures.ts:14

Inherited from#

CoreFeatures.coreRowModelsFeature

coreRowsFeature?#

optional coreRowsFeature: TableFeature;

Defined in: core/coreFeatures.ts:15

Inherited from#

CoreFeatures.coreRowsFeature

coreTablesFeature?#

optional coreTablesFeature: TableFeature;

Defined in: core/coreFeatures.ts:16

Inherited from#

CoreFeatures.coreTablesFeature

expandedRowModel()?#

optional expandedRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:215

Factory for the client-side expanded row model. Pass the exported createExpandedRowModel() or implement your own. Not needed for server-side expansion.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

facetedMinMaxValues()?#

optional facetedMinMaxValues: (table, columnId) => () => [number, number] | undefined;

Defined in: types/TableFeatures.ts:221

Factory for per-column faceted min/max values. Pass the exported createFacetedMinMaxValues() or implement your own. Not needed for server-side faceting.

Parameters#

table#

any

columnId#

string

Returns#

(): [number, number] | undefined;

Returns#

[number, number] | undefined

facetedRowModel()?#

optional facetedRowModel: (table, columnId) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:230

Factory for the per-column faceted row model. Pass the exported createFacetedRowModel() or implement your own. Not needed for server-side faceting.

Parameters#

table#

any

columnId#

string

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

facetedUniqueValues()?#

optional facetedUniqueValues: (table, columnId) => () => Map<any, number>;

Defined in: types/TableFeatures.ts:236

Factory for per-column faceted unique values. Pass the exported createFacetedUniqueValues() or implement your own. Not needed for server-side faceting.

Parameters#

table#

any

columnId#

string

Returns#

(): Map<any, number>;

Returns#

Map<any, number>

filteredRowModel()?#

optional filteredRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:242

Factory for the client-side filtered row model. Pass the exported createFilteredRowModel() or implement your own. Not needed for server-side filtering.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

filterFns?#

optional filterFns: Record<string, FilterFn<any, any>>;

Defined in: types/TableFeatures.ts:254

Registry of filter functions available to this table by name.

Keys registered here become the valid string values for filterFn on column definitions and the globalFilterFn option, with full inference. Import the built-in filter functions you use individually and register them by their conventional names: filterFns: { includesString: filterFn_includesString, myCustomFilterFn }. Spreading the exported filterFns registry also works, but puts every built-in filter function in your bundle.

filterMeta?#

optional filterMeta: object;

Defined in: types/TableFeatures.ts:266

Type-only slot for declaring the type of the filter meta that filter functions attach to rows via addMeta and that is read back from row.columnFiltersMeta.

Pass a phantom value: filterMeta: {} as MyFilterMeta (or metaHelper<MyFilterMeta>()). The value itself is ignored and stripped from the table's registered features at runtime; only its type is used.

When omitted, the global declaration-merged FilterMeta interface applies.

globalFilteringFeature?#

optional globalFilteringFeature: TableFeature;

Defined in: features/stockFeatures.ts:25

Inherited from#

StockFeatures.globalFilteringFeature

groupedRowModel()?#

optional groupedRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:272

Factory for the client-side grouped row model. Pass the exported createGroupedRowModel() or implement your own. Not needed for server-side grouping.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

paginatedRowModel()?#

optional paginatedRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:278

Factory for the client-side paginated row model. Pass the exported createPaginatedRowModel() or implement your own. Not needed for server-side pagination.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

rowExpandingFeature?#

optional rowExpandingFeature: TableFeature;

Defined in: features/stockFeatures.ts:26

Inherited from#

StockFeatures.rowExpandingFeature

rowPaginationFeature?#

optional rowPaginationFeature: TableFeature;

Defined in: features/stockFeatures.ts:27

Inherited from#

StockFeatures.rowPaginationFeature

rowPinningFeature?#

optional rowPinningFeature: TableFeature;

Defined in: features/stockFeatures.ts:28

Inherited from#

StockFeatures.rowPinningFeature

rowSelectionFeature?#

optional rowSelectionFeature: TableFeature;

Defined in: features/stockFeatures.ts:29

Inherited from#

StockFeatures.rowSelectionFeature

rowSortingFeature?#

optional rowSortingFeature: TableFeature;

Defined in: features/stockFeatures.ts:30

Inherited from#

StockFeatures.rowSortingFeature

sortedRowModel()?#

optional sortedRowModel: (table) => () => RowModel<any, any>;

Defined in: types/TableFeatures.ts:284

Factory for the client-side sorted row model. Pass the exported createSortedRowModel() or implement your own. Not needed for server-side sorting.

Parameters#

table#

any

Returns#

(): RowModel<any, any>;

Returns#

RowModel<any, any>

sortFns?#

optional sortFns: Record<string, SortFn<any, any>>;

Defined in: types/TableFeatures.ts:295

Registry of sorting functions available to this table by name.

Keys registered here become the valid string values for sortFn on column definitions, with full inference. Import the built-in sorting functions you use individually and register them by their conventional names: sortFns: { alphanumeric: sortFn_alphanumeric, myCustomSortFn }. Spreading the exported sortFns registry also works, but puts every built-in sorting function in your bundle.

tableMeta?#

optional tableMeta: object;

Defined in: types/TableFeatures.ts:305

Type-only slot for declaring the type of this table's options.meta.

Pass a phantom value: tableMeta: {} as MyTableMeta. The value itself is ignored and stripped from the table's registered features at runtime — only its type is used, inferred wherever TFeatures flows.

When omitted, the global declaration-merged TableMeta interface applies.

workerRowModelsFeature?#

optional workerRowModelsFeature: TableFeature;

Defined in: worker/createTableWorker.ts:23

Inherited from#

Plugins.workerRowModelsFeature