SeizenTableInstance

Defined in: packages/core/src/table/useSeizenTable.ts:84

Instance returned by useSeizenTable

Type Parameters

TData

TData

Properties

clearSelection()

clearSelection: () => void

Defined in: packages/core/src/table/useSeizenTable.ts:104

Clear all row selections.

Returns

void

---

eventBus

eventBus: object

Defined in: packages/core/src/table/useSeizenTable.ts:261

Event bus for plugin communication. Use this to emit custom events that plugins can subscribe to.

emit()

emit: <K>(event, payload) => void

Emit an event to all subscribers

Type Parameters

K

K extends keyof SeizenTableEventMap<unknown> | string & object

Parameters

event

K

payload

K extends keyof SeizenTableEventMap<unknown> ? SeizenTableEventMap<unknown>[K<K>] : unknown

Returns

void

subscribe()

subscribe: <K>(event, callback) => () => void

Subscribe to an event

Type Parameters

K

K extends keyof SeizenTableEventMap<unknown> | string & object

Parameters

event

K

callback

(payload) => void

Returns

Unsubscribe function

(): void

Returns

void

Example

// Emit a custom event
table.eventBus.emit("my-custom-event", { data: "value" });

---

getColumnOrder()

getColumnOrder: () => ColumnOrderState

Defined in: packages/core/src/table/useSeizenTable.ts:218

Get the current column order.

Returns

ColumnOrderState

Array of column IDs in order

---

getColumns()

getColumns: () => SeizenTableColumn<TData>[]

Defined in: packages/core/src/table/useSeizenTable.ts:186

Get the column definitions.

Returns

SeizenTableColumn<TData>[]

Array of column definitions

---

getColumnVisibility()

getColumnVisibility: () => VisibilityState

Defined in: packages/core/src/table/useSeizenTable.ts:196

Get the current column visibility state.

Returns

VisibilityState

Object mapping column IDs to visibility (true = visible)

---

getData()

getData: () => TData[]

Defined in: packages/core/src/table/useSeizenTable.ts:180

Get the current table data.

Returns

TData[]

Array of row data

---

getFilterState()

getFilterState: () => ColumnFiltersState

Defined in: packages/core/src/table/useSeizenTable.ts:114

Get the current column filter state.

Returns

ColumnFiltersState

Array of column filters

---

getGlobalFilter()

getGlobalFilter: () => string

Defined in: packages/core/src/table/useSeizenTable.ts:126

Get the current global filter value.

Returns

string

Global filter string

---

getPaginationState()

getPaginationState: () => PaginationState

Defined in: packages/core/src/table/useSeizenTable.ts:158

Get the current pagination state.

Returns

PaginationState

Pagination state including pageIndex and pageSize

---

getSelectedRows()

getSelectedRows: () => TData[]

Defined in: packages/core/src/table/useSeizenTable.ts:93

Get the currently selected rows.

Returns

TData[]

Array of selected row data

---

getSortingState()

getSortingState: () => SortingState

Defined in: packages/core/src/table/useSeizenTable.ts:142

Get the current sorting state.

Returns

SortingState

Array of sorting configurations

---

moveColumn()

moveColumn: (columnId, toIndex) => void

Defined in: packages/core/src/table/useSeizenTable.ts:231

Move a column to a new position.

Parameters

columnId

string

The column ID to move

toIndex

number

The target index

Returns

void

---

plugin

plugin: PluginControl

Defined in: packages/core/src/table/useSeizenTable.ts:245

Plugin control interface.

---

plugins

plugins: SeizenTablePlugin<any>[]

Defined in: packages/core/src/table/useSeizenTable.ts:240

Plugins registered with this table.

---

remote

readonly remote: boolean | RemoteOptions

Defined in: packages/core/src/table/useSeizenTable.ts:285

Remote Mode configuration.

• false when not in Remote Mode
• true when in Remote Mode without totalRowCount (e.g., cursor pagination without total)
• { totalRowCount: number } when in Remote Mode with totalRowCount

Plugins can use this to adjust their behavior.

Example

if (table.remote) {
  // Hide global search in Remote Mode
  return null;
}
// Access totalRowCount for pagination (check if it's an object first)
const total = typeof table.remote === 'object' ? table.remote.totalRowCount : undefined;

---

setColumnOrder()

setColumnOrder: (order) => void

Defined in: packages/core/src/table/useSeizenTable.ts:224

Set the column order.

Parameters

order

ColumnOrderState

Array of column IDs in desired order

Returns

void

---

setColumnVisibility()

setColumnVisibility: (visibility) => void

Defined in: packages/core/src/table/useSeizenTable.ts:202

Set column visibility state.

Parameters

visibility

VisibilityState

Object mapping column IDs to visibility

Returns

void

---

setFilter()

setFilter: (filter) => void

Defined in: packages/core/src/table/useSeizenTable.ts:120

Set column filters programmatically.

Parameters

filter

ColumnFiltersState

Column filter state to apply

Returns

void

---

setGlobalFilter()

setGlobalFilter: (value) => void

Defined in: packages/core/src/table/useSeizenTable.ts:132

Set the global filter value.

Parameters

value

string

Filter string to apply across all columns

Returns

void

---

setPageIndex()

setPageIndex: (index) => void

Defined in: packages/core/src/table/useSeizenTable.ts:164

Set the current page index (0-based).

Parameters

index

number

Page index to navigate to

Returns

void

---

setPageSize()

setPageSize: (size) => void

Defined in: packages/core/src/table/useSeizenTable.ts:170

Set the number of rows per page.

Parameters

size

number

Number of rows to display per page

Returns

void

---

setSelectedRows()

setSelectedRows: (rows) => void

Defined in: packages/core/src/table/useSeizenTable.ts:99

Set the selected rows programmatically.

Parameters

rows

TData[]

Array of row data to select

Returns

void

---

setSorting()

setSorting: (sorting) => void

Defined in: packages/core/src/table/useSeizenTable.ts:148

Set sorting programmatically.

Parameters

sorting

SortingState

Sorting state to apply

Returns

void

---

toggleColumnVisibility()

toggleColumnVisibility: (columnId) => void

Defined in: packages/core/src/table/useSeizenTable.ts:208

Toggle visibility of a specific column.

Parameters

columnId

string

The column ID to toggle

Returns

void