Builder

Builds a new document: pages, navigation and metadata; Builder.finish returns a Document to save. Created in the text module when it is loaded (or text: true), else in the reading module (text, extract, then base; vector and image pages only).

Example

await init({ text: true });
const b = new Builder({ producer: "my app" });
const page = b.page("A4");
page.surface().text("Hello, world!", { font: Font.standard("Helvetica"), size: 24, at: [72, 96] });
page.finish();
const bytes = b.finish().save();

Constructors

Constructor

new Builder(options?): Builder

Parameters

options?

BuilderOptions = {}

version, file ID, producer, creation date, compression; text.

Returns

Builder

Throws

LaminaError not-initialized, text-module-not-loaded; unknown-option.

Accessors

hasText

Get Signature

get hasText(): boolean

Whether this builder draws in the text module (fonts and text).

Returns

boolean

Methods

[dispose]()

[dispose](): void

Frees the builder at the end of a using block.

Returns

void

---

destination()

destination(name, index, fit?): this

Defines the named destination name: page index, shown as fit (default: the page).

Parameters

name

string

index

number

fit?

any

Returns

this

---

finish()

finish(): Document

Writes fonts, links, the page tree, outline and metadata; the builder (and its unfinished pages) take no more calls afterwards.

Returns

Document

the new document (unsaved; its save is a full rewrite).

Throws

LaminaError page-index-out-of-range, unknown-destination, invalid-page-labels, invalid-geometry, subset-failed, builder-finished.

---

font()

font(font): FontInfo

Registers font with this builder (otherwise it is registered at first use).

Parameters

font

Font

Returns

FontInfo

Throws

LaminaError text-module-not-loaded, invalid-font, font-not-embeddable.

---

free()

free(): void

Frees the builder’s WASM memory now (finish does this itself); the builder takes no more calls afterwards. Unfinished pages are freed with Page.free.

Returns

void

---

lang()

lang(tag): this

The natural language (/Lang), a BCP 47 tag.

Parameters

tag

string

Returns

this

---

metadata()

metadata(metadata): this

The metadata, written as the Info dictionary and an XMP packet.

Parameters

metadata

MetadataInit

Returns

this

---

outline()

outline(entries): string[]

Adds outline (bookmark) items with their children.

Parameters

entries

readonly OutlineEntryInit[]

Returns

string[]

their IDs, in pre-order.

---

page()

page(size?): Page

A new page of a named size or [width, height] in points.

Parameters

size?

PageSizeName | readonly [number, number] = "A4"

Returns

Page

---

pageLabels()

pageLabels(ranges): this

The page labels (i, ii, 1, 2…), ranges by first page; checked at finish.

Parameters

ranges

readonly PageLabelInit[]

Returns

this

---

viewerPreferences()

viewerPreferences(preferences): this

How viewers present the document when it opens.

Parameters

preferences

ViewerPreferencesInit

Returns

this

---

create()

static create(options?): Builder

As new Builder(options).

Parameters

options?

BuilderOptions

Returns

Builder