API reference

Tables & autoFilter

Excel Tables, table styles, and column-level autoFilter.

5 exports · 2 source files

Table

# addExcelTable function

High-level wrapper that builds a TableDefinition + pushes it onto `ws.tables` in one call. Auto-assigns the workbook-unique `id`, derives `displayName` from the supplied `name`, and constructs `TableColumn` records (1-based ids) from a string-array shorthand.

function addExcelTable(wb: Workbook, ws: Worksheet, opts: { autoFilter?: AutoFilter; columns: readonly (string | TableColumn)[]; displayName?: string; headerRowCount?: number; name: string; ref: string; style?: string; styleInfo?: TableStyleInfo; totalsRowCount?: number; totalsRowShown?: boolean }): TableDefinition

Parameters

Name	Type	Description
`wb`	`Workbook`
`ws`	`Worksheet`
`opts`	`{ autoFilter?: AutoFilter; columns: readonly (string \| TableColumn)[]; displayName?: string; headerRowCount?: number; name: string; ref: string; style?: string; styleInfo?: TableStyleInfo; totalsRowCount?: number; totalsRowShown?: boolean }`

Returns

TableDefinition

# makeTableColumn function

src/worksheet/table.ts:60

function makeTableColumn(opts: { id: number; name: string }): TableColumn

Parameters

Name	Type	Description
`opts`	`{ id: number; name: string }`

Returns

TableColumn

# makeTableDefinition function

src/worksheet/table.ts:64

function makeTableDefinition(opts: { autoFilter?: AutoFilter; columns?: TableColumn[]; displayName: string; headerRowCount?: number; id: number; name?: string; ref: string; styleInfo?: TableStyleInfo; totalsRowCount?: number; totalsRowShown?: boolean }): TableDefinition

Parameters

Name	Type	Description
`opts`	`{ autoFilter?: AutoFilter; columns?: TableColumn[]; displayName: string; headerRowCount?: number; id: number; name?: string; ref: string; styleInfo?: TableStyleInfo; totalsRowCount?: number; totalsRowShown?: boolean }`

Returns

TableDefinition

Auto filter

src/worksheet/auto-filter.ts

# makeAutoFilter function

src/worksheet/auto-filter.ts:25

function makeAutoFilter(opts: { filterColumns?: FilterColumn[]; ref: string }): AutoFilter

Parameters

Name	Type	Description
`opts`	`{ filterColumns?: FilterColumn[]; ref: string }`

Returns

AutoFilter

# makeFilterColumn function

src/worksheet/auto-filter.ts:29

function makeFilterColumn(opts: { blank?: boolean; colId: number; values: readonly string[] }): FilterColumn

Parameters

Name	Type	Description
`opts`	`{ blank?: boolean; colId: number; values: readonly string[] }`

Returns

FilterColumn