API

Every function takes its content first and its settings second.

Leaves

Function	What it does
`text(content, style?)`	Puts a string on the page. Style: `font`, `size`, `color`, `lineHeight`, `align`, `field`.
`image(src, { width?, height? })`	PNG or JPEG from a path or bytes. Aspect ratio always kept.
`divider({ color?, thickness? })`	A line across the width in a column, the height in a row. Defaults `#cccccc`, 1.
`spacer()`	Takes leftover space and draws nothing.
`pageBreak()`	Starts a new page here.

Containers

Function	What it does
`row(children, options?)`	Places things side by side.
`column(children, options?)`	Stacks things top to bottom. The one container that splits across pages.
`table(rows, options)`	Rows and columns of cells with a header that repeats on every page. See Tables.

Row and column options: gap, align, justify, padding, background, margin; column also takes keep.

Wrappers

Function	What it does
`padding(child, insets)`	Space around something. Insets: a number, `{ x, y }`, or `{ top, right, bottom, left }`.
`background(child, color)`	A colour behind something, sized to it.
`fill(child, share?)`	Take a share of the leftover in a row or column. Must be a direct child. Default share 1.
`width(child, points)`, `height(child, points)`	Exactly this wide or tall on one axis; the other passes through.
`keep(child)`	Never split; moves whole to the next page if it does not fit.

Outputs

Function	What it does
`render(tree, options?)`	PDF bytes as a `Uint8Array`. Options: `size`, `margins`, `fonts`, `defaultStyle`.
`renderHtml(tree, options?)`	The same layout as an HTML fragment. Adds `imageSrc`, `classPrefix`, `stylesheet`, `pretty`. See Live preview.
`renderDisplayList(tree, options?)`	The same layout as data: pages of `text`, `rect`, `image`, and `clip` ops.

Checking

Function What it does

validate(tree, { fonts?, defaultStyle? }) Walks the tree and returns findings for mistakes that would render silently wrong: a fill or spacer that is not a direct child of a row or column, justify alongside a fill, a table column whose key no row has or with neither key nor format, an unregistered font, long text directly in a row, padding on a table. Each finding has a level, a path into the tree, and a message that says what to change. Never throws, never renders.

Function	What it does
`validate(tree, { fonts?, defaultStyle? })`	Walks the tree and returns findings for mistakes that would render silently wrong: a `fill` or `spacer` that is not a direct child of a row or column, `justify` alongside a fill, a table column whose key no row has or with neither key nor format, an unregistered font, long text directly in a row, `padding` on a table. Each finding has a `level`, a `path` into the tree, and a message that says what to change. Never throws, never renders.

Types

Node, Finding, ValidateOptions, TextStyle, Insets, FlexOptions, BoxOptions, Align, Justify, TableOptions, TableColumn, CellValue, RowAppearance, ImageOptions, DividerOptions, RenderOptions, HtmlOptions, PageSize, DisplayList, Page, Op, Size, Offset, Rect.

Bytes in and out are Uint8Array. A Node Buffer is accepted anywhere bytes are.

API ​

Leaves ​

Containers ​

Wrappers ​

Outputs ​

Checking ​

Types ​

API