Workbook Builder

Sheets

Creating sheets with layout options, freeze panes, and right-to-left direction.

Create sheets with .sheet(name, options?).

import { createWorkbook
 } from "@chronicstone/typed-xlsx";

const workbook
 = createWorkbook
();

workbook
.sheet
("Financial Overview", {
  tablesPerRow
: 2,
  tableColumnGap
: 2,
  tableRowGap
: 1,
  freezePane
: { rows
: 1, columns
: 2 },
});

Sheet options currently cover:

tablesPerRow
tableColumnGap
tableRowGap
freezePane
rightToLeft

The buffered builder fully supports multi-table sheet layouts. The stream builder is optimized for large commit-based exports, so the most common pattern is one streamed table per sheet.

import { createWorkbookStream
 } from "@chronicstone/typed-xlsx";

const workbook
 = createWorkbookStream
();

workbook
.sheet
("Audit Log", {
  freezePane
: { rows
: 1 },
  rightToLeft
: false,
});

Overview

The two workbook builders — createWorkbook() for buffered exports and createWorkbookStream() for streaming.

Tables

Connecting a schema and row data to a sheet in buffered and stream mode.