@sheetkit/node / JsStreamWriter

Class: JsStreamWriter

Defined in: binding.d.ts:4

Forward-only streaming writer for large sheets.

Constructors

Constructor

new JsStreamWriter(): JsStreamWriter

Returns

JsStreamWriter

Accessors

sheetName

Get Signature

get sheetName(): string

Defined in: binding.d.ts:6

Get the sheet name.

Returns

string

Methods

addMergeCell()

addMergeCell(reference): void

Defined in: binding.d.ts:22

Add a merge cell reference (e.g., "A1:C3").

Parameters

reference

string

Returns

void

---

setColOutlineLevel()

setColOutlineLevel(col, level): void

Defined in: binding.d.ts:28

Set column outline level (1-based, level 0-7).

Parameters

col

number

level

number

Returns

void

---

setColStyle()

setColStyle(col, styleId): void

Defined in: binding.d.ts:24

Set column style for a single column (1-based).

Parameters

col

number

styleId

number

Returns

void

---

setColVisible()

setColVisible(col, visible): void

Defined in: binding.d.ts:26

Set column visibility (1-based).

Parameters

col

number

visible

boolean

Returns

void

---

setColWidth()

setColWidth(col, width): void

Defined in: binding.d.ts:8

Set column width (1-based column number).

Parameters

col

number

width

number

Returns

void

---

setColWidthRange()

setColWidthRange(minCol, maxCol, width): void

Defined in: binding.d.ts:10

Set column width for a range of columns.

Parameters

minCol

number

maxCol

number

width

number

Returns

void

---

setFreezePanes()

setFreezePanes(topLeftCell): void

Defined in: binding.d.ts:33

Set freeze panes. The top_left_cell is the cell below and to the right of the frozen area (e.g., "A2" freezes row 1).

Parameters

topLeftCell

string

Returns

void

---

writeRow()

writeRow(row, values): void

Defined in: binding.d.ts:12

Write a row of values. Rows must be written in ascending order.

Parameters

row

number

values

(string | number | boolean | null)[]

Returns

void

---

writeRows()

writeRows(startRow, rows): void

Defined in: binding.d.ts:18

Write multiple rows at once starting at the given row number. More efficient than calling writeRow in a loop because it crosses the FFI boundary only once.

Parameters

startRow

number

rows

(string | number | boolean | null)[][]

Returns

void

---

writeRowWithStyle()

writeRowWithStyle(row, values, styleId): void

Defined in: binding.d.ts:20

Write a row with a specific style ID applied to all cells.

Parameters

row

number

values

(string | number | boolean | null)[]

styleId

number

Returns

void