Back to Table

Table_Table

docs/reference/interfaces/Table_Table.md

8.21.35.8 KB
Original Source

Interface: Table_Table<TFeatures, TData>

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

Extends

Type Parameters

TFeatures

TFeatures extends TableFeatures

TData

TData extends RowData

Properties

_cellPrototype?

ts
optional _cellPrototype: object;

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

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

Inherited from

Table_CoreProperties._cellPrototype


_columnPrototype?

ts
optional _columnPrototype: object;

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

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

Inherited from

Table_CoreProperties._columnPrototype


_features

ts
_features: Partial<CoreFeatures> & TFeatures;

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

The features that are enabled for the table.

Inherited from

Table_CoreProperties._features


_headerPrototype?

ts
optional _headerPrototype: object;

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

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

Inherited from

Table_CoreProperties._headerPrototype


_rowModelFns

ts
_rowModelFns: RowModelFns<TFeatures, TData>;

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

The row model processing functions that are used to process the data by features.

Inherited from

Table_CoreProperties._rowModelFns


_rowModels

ts
_rowModels: CachedRowModels<TFeatures, TData>;

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

The row models that are enabled for the table.

Inherited from

Table_CoreProperties._rowModels


_rowPrototype?

ts
optional _rowPrototype: object;

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

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

Inherited from

Table_CoreProperties._rowPrototype


baseStore

ts
baseStore: Store<TableState<TFeatures>>;

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

The base store for the table. This can be used to write to the table state.

Inherited from

Table_CoreProperties.baseStore


initialState

ts
initialState: TableState<TFeatures>;

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

This is the resolved initial state of the table.

Inherited from

Table_CoreProperties.initialState


options

ts
options: TableOptions<TFeatures, TData>;

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

A read-only reference to the table's current options.

Inherited from

Table_CoreProperties.options


reset()

ts
reset: () => void;

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

Call this function to reset the table state to the initial state.

Returns

void


setOptions()

ts
setOptions: (newOptions) => void;

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

This function can be used to update the table options.

Parameters

newOptions

Updater<TableOptions<TFeatures, TData>>

Returns

void


store

ts
store: ReadonlyStore<TableState<TFeatures>>;

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

Where the table state is stored.

Inherited from

Table_CoreProperties.store