API / interfaces / worksheet

Interface: WorkSheet

Worksheet object with column, row, merge, protection, and filter metadata

Hierarchy

Extends:

• Sheet

Properties

!data

optional

!data: DenseSheetData

Dense cell storage: 2D array indexed by [row][col]

!type

optional

!type: "sheet" | "chart"

Sheet type: "sheet" for worksheets, "chart" for chart sheets

!ref

optional

!ref: string

Used range reference (e.g. "A1

!margins

optional

!margins: MarginInfo

Page margin settings

!cols

optional

!cols: ColInfo[]

Column properties array (index corresponds to column index)

!rows

optional

!rows: RowInfo[]

Row properties array (index corresponds to row index)

!merges

optional

!merges: Range[]

Array of merged cell ranges

!protect

optional

!protect: ProtectInfo

Sheet protection settings

!autofilter

optional

!autofilter: AutoFilterInfo

AutoFilter definition

Source

src/types.ts

← WorkbookProperties | WriteOptions →