PDFiumDocumentBuilder
Defined in: src/document/builder.ts:31
Builder for creating new PDF documents from scratch.
Example
Section titled “Example”using builder = pdfium.createDocument();builder.addPage();const bytes = builder.save();Extends
Section titled “Extends”Accessors
Section titled “Accessors”disposed
Section titled “disposed”Get Signature
Section titled “Get Signature”get disposed():
boolean
Defined in: src/core/disposable.ts:73
Whether this resource has been disposed.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”pageCount
Section titled “pageCount”Get Signature
Section titled “Get Signature”get pageCount():
number
Defined in: src/document/builder.ts:79
Get the number of pages in the document.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”[dispose]()
Section titled “[dispose]()”[dispose]():
void
Defined in: src/core/disposable.ts:148
Dispose of this resource, freeing WASM memory.
This method is idempotent - calling it multiple times has no effect after the first call.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”addPage()
Section titled “addPage()”addPage(
options?):PDFiumPageBuilder
Defined in: src/document/builder.ts:90
Add a new page to the document.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options? | { height?: number; width?: number; } | Page dimensions (default: US Letter 612x792 points) |
options.height? | number | - |
options.width? | number | - |
Returns
Section titled “Returns”A page builder for adding content
deletePage()
Section titled “deletePage()”deletePage(
pageIndex):void
Defined in: src/document/builder.ts:121
Delete a page by index.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
pageIndex | number | Zero-based page index to delete |
Returns
Section titled “Returns”void
dispose()
Section titled “dispose()”dispose():
void
Defined in: src/core/disposable.ts:164
Alias for Symbol.dispose for explicit calls.
Returns
Section titled “Returns”void
Example
Section titled “Example”document.dispose();Inherited from
Section titled “Inherited from”loadStandardFont()
Section titled “loadStandardFont()”loadStandardFont(
fontName):PDFiumBuilderFont
Defined in: src/document/builder.ts:151
Load a standard PDF font (e.g., “Helvetica”, “Times-Roman”, “Courier”).
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
fontName | string | Standard font name |
Returns
Section titled “Returns”A font handle for use with page builder’s addText method
save()
Section titled “save()”save(
options):Uint8Array
Defined in: src/document/builder.ts:175
Save the document to a byte array.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
options | SaveOptions | Save options |
Returns
Section titled “Returns”Uint8Array
The serialised PDF bytes