Interface: Table_Internal<TFeatures, TData>#

Defined in: types/Table.ts:94

Internal broad table shape used by feature implementations.

Extends#

• Omit<Table_Table<TFeatures, TData>, Table_InternalBroadenedKeys>.Table_Columns<TFeatures, TData>.Table_Rows<TFeatures, TData>.Table_RowModels<TFeatures, TData>.Table_Headers<TFeatures, TData>

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData = any

Properties#

_cellInstanceInitFns?#

optional _cellInstanceInitFns: <TFeatures, TData, TValue>(cell) => void[];

Defined in: core/table/coreTablesFeature.types.ts:167

Cache of the initCellInstanceData functions for features that define one.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

cell#

Cell<TFeatures, TData, TValue>

Returns#

void

Inherited from#

Omit._cellInstanceInitFns

_cellPrototype?#

optional _cellPrototype: object;

Defined in: core/table/coreTablesFeature.types.ts:173

Prototype cache for Cell objects - shared by all cells in this table

Inherited from#

Table_Core._cellPrototype

_columnInstanceInitFns?#

optional _columnInstanceInitFns: <TFeatures, TData, TValue>(column) => void[];

Defined in: core/table/coreTablesFeature.types.ts:177

Cache of the initColumnInstanceData functions for features that define one.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

column#

Column<TFeatures, TData, TValue>

Returns#

void

Inherited from#

Omit._columnInstanceInitFns

_columnPrototype?#

optional _columnPrototype: object;

Defined in: core/table/coreTablesFeature.types.ts:183

Prototype cache for Column objects - shared by all columns in this table

Inherited from#

Table_Core._columnPrototype

_features#

readonly _features: Partial<CoreFeatures> & TFeatures;

Defined in: core/table/coreTablesFeature.types.ts:187

The features that are enabled for the table.

Inherited from#

Omit._features

_headerGroupInstanceInitFns?#

optional _headerGroupInstanceInitFns: <TFeatures, TData>(headerGroup) => void[];

Defined in: core/table/coreTablesFeature.types.ts:191

Cache of the initHeaderGroupInstanceData functions for features that define one.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

headerGroup#

HeaderGroup<TFeatures, TData>

Returns#

void

Inherited from#

Omit._headerGroupInstanceInitFns

_headerInstanceInitFns?#

optional _headerInstanceInitFns: <TFeatures, TData, TValue>(header) => void[];

Defined in: core/table/coreTablesFeature.types.ts:197

Cache of the initHeaderInstanceData functions for features that define one.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

TValue#

TValue extends unknown = unknown

Parameters#

header#

Header<TFeatures, TData, TValue>

Returns#

void

Inherited from#

Omit._headerInstanceInitFns

_headerPrototype?#

optional _headerPrototype: object;

Defined in: core/table/coreTablesFeature.types.ts:203

Prototype cache for Header objects - shared by all headers in this table

Inherited from#

Table_Core._headerPrototype

_reactivity#

readonly _reactivity: TableReactivityBindings;

Defined in: core/table/coreTablesFeature.types.ts:163

Table reactivity bindings for interacting with TanStack Store.

Inherited from#

Table_Core._reactivity

_rowInstanceInitFns?#

optional _rowInstanceInitFns: <TFeatures, TData>(row) => void[];

Defined in: core/table/coreTablesFeature.types.ts:219

Cache of the initRowInstanceData functions for features that define one.

Type Parameters#

TFeatures#

TFeatures extends TableFeatures

TData#

TData extends RowData

Parameters#

row#

Row<TFeatures, TData>

Returns#

void

Inherited from#

Omit._rowInstanceInitFns

_rowModelFns#

_rowModelFns: RowModelFns_All<TFeatures, TData>;

Defined in: types/Table.ts:105

_rowModels#

_rowModels: CachedRowModel_All<TFeatures, TData>;

Defined in: types/Table.ts:104

_rowPrototype?#

optional _rowPrototype: object;

Defined in: core/table/coreTablesFeature.types.ts:215

Prototype cache for Row objects - shared by all rows in this table

Inherited from#

Table_Core._rowPrototype

atoms#

atoms: Atoms<TFeatures> & Atoms_All;

Defined in: types/Table.ts:114

The readonly derived atoms for each TableState slice. Each derives from its corresponding baseAtom plus, optionally, a per-slice external atom or external state value (precedence: external atom > external state > base atom).

Overrides#

Omit.atoms

baseAtoms#

baseAtoms: BaseAtoms<TFeatures> & BaseAtoms_All;

Defined in: types/Table.ts:113

The internal writable atoms for each TableState slice. This is the library's single write surface — all state mutations from features land here.

Overrides#

Omit.baseAtoms

getAllColumns()#

getAllColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:91

Normalizes options.columns into the table's nested column hierarchy.

Returns#

Column<TFeatures, TData, unknown>[]

Inherited from#

Table_Columns.getAllColumns

getAllFlatColumns()#

getAllFlatColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:95

Flattens the nested column hierarchy, including parent/group columns.

Returns#

Column<TFeatures, TData, unknown>[]

Inherited from#

Table_Columns.getAllFlatColumns

getAllFlatColumnsById()#

getAllFlatColumnsById: () => Record<string, Column<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:83

Returns a map of all flat columns by their ID.

Returns#

Record<string, Column<TFeatures, TData, unknown>>

Inherited from#

Table_Columns.getAllFlatColumnsById

getAllLeafColumns()#

getAllLeafColumns: () => Column<TFeatures, TData, unknown>[];

Defined in: core/columns/coreColumnsFeature.types.ts:99

Collects all terminal leaf columns, excluding parent/group columns.

Returns#

Column<TFeatures, TData, unknown>[]

Inherited from#

Table_Columns.getAllLeafColumns

getAllLeafColumnsById()#

getAllLeafColumnsById: () => Record<string, Column<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:103

Returns a map of all leaf-node columns by their ID. This does not include parent columns.

Returns#

Record<string, Column<TFeatures, TData, unknown>>

Inherited from#

Table_Columns.getAllLeafColumnsById

getColumn()#

getColumn: (columnId) => 
  | Column<TFeatures, TData, unknown>
  | undefined;

Defined in: core/columns/coreColumnsFeature.types.ts:107

Returns a single column by its ID.

Parameters#

columnId#

string

Returns#

| Column<TFeatures, TData, unknown> | undefined

Inherited from#

Table_Columns.getColumn

getCoreRowModel()#

getCoreRowModel: () => RowModel<TFeatures, TData>;

Defined in: core/row-models/coreRowModelsFeature.types.ts:34

Returns the core row model before any processing has been applied.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getCoreRowModel

getDefaultColumnDef()#

getDefaultColumnDef: () => Partial<ColumnDef<TFeatures, TData, unknown>>;

Defined in: core/columns/coreColumnsFeature.types.ts:87

Resolves built-in, feature-level, and user-defined default column options.

Returns#

Partial<ColumnDef<TFeatures, TData, unknown>>

Inherited from#

Table_Columns.getDefaultColumnDef

getExpandedRowModel()#

getExpandedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:120

Resolves the row model after expanded rows have been flattened into view.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getExpandedRowModel

getFacetedMinMaxValues()#

getFacetedMinMaxValues: () => [number, number] | undefined;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:35

Computes min/max numeric facet values for the active faceting context.

Requires a facetedMinMaxValues row-model factory on the features option.

Returns#

[number, number] | undefined

Inherited from#

Table_RowModels.getFacetedMinMaxValues

getFacetedRowModel()#

getFacetedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:41

Computes the row model used to derive facet values.

Requires a facetedRowModel row-model factory on the features option.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getFacetedRowModel

getFacetedUniqueValues()#

getFacetedUniqueValues: () => Map<any, number>;

Defined in: features/column-faceting/columnFacetingFeature.types.ts:47

Computes unique facet values and occurrence counts.

Requires a facetedUniqueValues row-model factory on the features option.

Returns#

Map<any, number>

Inherited from#

Table_RowModels.getFacetedUniqueValues

getFilteredRowModel()#

getFilteredRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:296

Resolves the row model after column and global filters have been applied.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getFilteredRowModel

getFlatHeaders()#

getFlatHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: core/headers/coreHeadersFeature.types.ts:25

Flattens every header from every header group, including parent and placeholder headers.

Returns#

Header<TFeatures, TData, unknown>[]

Inherited from#

Table_Headers.getFlatHeaders

getFooterGroups()#

getFooterGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: core/headers/coreHeadersFeature.types.ts:20

Builds footer groups by reversing the current header group order.

Returns#

HeaderGroup<TFeatures, TData>[]

Inherited from#

Table_Headers.getFooterGroups

getGroupedRowModel()#

getGroupedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:140

Resolves the row model after grouping has been applied.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getGroupedRowModel

getHeaderGroups()#

getHeaderGroups: () => HeaderGroup<TFeatures, TData>[];

Defined in: core/headers/coreHeadersFeature.types.ts:16

Builds the visible header groups for the current column tree, visibility, and pinning state.

Returns#

HeaderGroup<TFeatures, TData>[]

Inherited from#

Table_Headers.getHeaderGroups

getLeafHeaders()#

getLeafHeaders: () => Header<TFeatures, TData, unknown>[];

Defined in: core/headers/coreHeadersFeature.types.ts:29

Collects only leaf headers, excluding parent/group headers.

Returns#

Header<TFeatures, TData, unknown>[]

Inherited from#

Table_Headers.getLeafHeaders

getMaxSubRowDepth()#

getMaxSubRowDepth: () => number;

Defined in: core/rows/coreRowsFeature.types.ts:138

Returns the deepest structural row depth in the core row model. Root rows are depth 0, direct sub-rows are depth 1, and so on.

Returns#

number

Inherited from#

Table_Rows.getMaxSubRowDepth

getPaginatedRowModel()#

getPaginatedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:125

Resolves the row model after pagination has sliced the current page.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPaginatedRowModel

getPreExpandedRowModel()#

getPreExpandedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-expanding/rowExpandingFeature.types.ts:124

Reads the row model immediately before expansion.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPreExpandedRowModel

getPreFilteredRowModel()#

getPreFilteredRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/column-filtering/columnFilteringFeature.types.ts:300

Reads the row model immediately before filtering.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPreFilteredRowModel

getPreGroupedRowModel()#

getPreGroupedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/column-grouping/columnGroupingFeature.types.ts:144

Reads the row model immediately before grouping.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPreGroupedRowModel

getPrePaginatedRowModel()#

getPrePaginatedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-pagination/rowPaginationFeature.types.ts:129

Reads the row model immediately before pagination.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPrePaginatedRowModel

getPreSortedRowModel()#

getPreSortedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-sorting/rowSortingFeature.types.ts:276

Reads the row model immediately before sorting.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getPreSortedRowModel

getRow()#

getRow: (id, searchAll?) => Row<TFeatures, TData>;

Defined in: core/rows/coreRowsFeature.types.ts:153

Returns the row with the given ID.

Parameters#

id#

string

searchAll?#

boolean

Returns#

Row<TFeatures, TData>

Inherited from#

Table_Rows.getRow

getRowId()#

getRowId: (_, index, parent?) => string;

Defined in: core/rows/coreRowsFeature.types.ts:149

Returns the row id for a given row.

Parameters#

_#

TData

index#

number

parent?#

Row<TFeatures, TData>

Returns#

string

Inherited from#

Table_Rows.getRowId

getRowModel()#

getRowModel: () => RowModel<TFeatures, TData>;

Defined in: core/row-models/coreRowModelsFeature.types.ts:38

Returns the final model after all processing from other used features has been applied. This is the row model that is most commonly used for rendering.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getRowModel

getRowsInDisplayOrder()#

getRowsInDisplayOrder: () => Row<TFeatures, TData>[];

Defined in: core/rows/coreRowsFeature.types.ts:145

Returns the rows in the current display order and assigns their display indexes. When expanded rows bypass pagination, expanded descendants are included in this order. This is the memoized source for row.getDisplayIndex().

Returns#

Row<TFeatures, TData>[]

Inherited from#

Table_Rows.getRowsInDisplayOrder

getSortedRowModel()#

getSortedRowModel: () => RowModel<TFeatures, TData>;

Defined in: features/row-sorting/rowSortingFeature.types.ts:280

Resolves the row model after sorting has been applied.

Returns#

RowModel<TFeatures, TData>

Inherited from#

Table_RowModels.getSortedRowModel

initialState#

initialState: ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap> & TableState_All;

Defined in: types/Table.ts:112

options#

options: object & DebugKeysFor<CoreFeatures & TableFeatures> & TableOptions_Core<TFeatures, TData> & Partial<TableOptions_Aggregation & TableOptions_ColumnFiltering<TFeatures, TData> & TableOptions_ColumnGrouping & TableOptions_ColumnOrdering & TableOptions_ColumnPinning & TableOptions_ColumnResizing & TableOptions_ColumnSizing & TableOptions_ColumnVisibility & TableOptions_GlobalFiltering<TFeatures, TData> & TableOptions_RowExpanding<TFeatures, TData> & TableOptions_RowPagination & TableOptions_RowPinning<TFeatures, TData> & TableOptions_RowSelection<TFeatures, TData> & TableOptions_RowSorting> & object;

Defined in: types/Table.ts:106

Type Declaration#

debugAll?#

optional debugAll: boolean;

debugCache?#

optional debugCache: boolean;

debugCells?#

optional debugCells: boolean;

debugColumns?#

optional debugColumns: boolean;

debugHeaders?#

optional debugHeaders: boolean;

debugRows?#

optional debugRows: boolean;

debugTable?#

optional debugTable: boolean;

Type Declaration#

atoms?#

optional atoms: Partial<{
  columnFilters?: Atom<ColumnFiltersState>;
  columnOrder?: Atom<ColumnOrderState>;
  columnPinning?: Atom<ColumnPinningState>;
  columnResizing?: Atom<columnResizingState>;
  columnSizing?: Atom<ColumnSizingState>;
  columnVisibility?: Atom<ColumnVisibilityState>;
  expanded?: Atom<ExpandedState>;
  globalFilter?: Atom<any>;
  grouping?: Atom<GroupingState>;
  pagination?: Atom<PaginationState>;
  rowPinning?: Atom<RowPinningState>;
  rowSelection?: Atom<RowSelectionState>;
  sorting?: Atom<SortingState>;
}>;

initialState?#

optional initialState: TableState_All;

state?#

optional state: TableState_All;

optionsStore?#

readonly optional optionsStore: Atom<TableOptions<TFeatures, TData>>;

Defined in: core/table/coreTablesFeature.types.ts:244

Writable atom for table options. Only created when createOptionsStore is true on the active core reactivity bindings. Adapters that opt out keep options as plain resolved data instead of backing them with an atom.

Inherited from#

Omit.optionsStore

reset()#

reset: () => void;

Defined in: core/table/coreTablesFeature.types.ts:264

Resets the table's internal base atoms to table.initialState.

Prefer feature-specific reset APIs, such as resetPagination, when a state slice may be owned by an external atom or needs that feature's blank/default reset behavior. After resetting internal atoms, this also invokes feature reset hooks for mutable, transient table-instance data.

Returns#

void

Inherited from#

Omit.reset

setOptions()#

setOptions: (newOptions) => void;

Defined in: core/table/coreTablesFeature.types.ts:269

Updates the table options by applying a value or updater to the current resolved options and then merging them through options.mergeOptions.

Parameters#

newOptions#

Updater<TableOptions<TFeatures, TData>>

Returns#

void

Inherited from#

Omit.setOptions

store#

store: ReadonlyStore<ExtractFeatureMapTypes<TFeatures, TableState_FeatureMap>> & ReadonlyStore<TableState_All>;

Defined in: types/Table.ts:115