Successful PDF output returned by the renderer.
Byte exports are defensive copies. The document owns previews and object URLs
created through it; dispose releases them and invalidates future exports.
Instances are renderer-owned results and cannot be constructed directly.
Signature
export declare class PdfDocumentProperties
| Property | Type | Required | Read only | Default | Description |
|---|---|---|---|---|---|
diagnostics | readonly Diagnostic[] | Yes | Yes | None | Diagnostics retained from both browser snapshotting and native rendering. |
pageCount | number | Yes | Yes | None | Number of pages reported by the native renderer. |
Methods
toUint8Array()
Returns a defensive copy of the PDF bytes.
toUint8Array(): Uint8Array<ArrayBufferLike>;Parameters
This API does not accept parameters.
Returns
Uint8Array<ArrayBufferLike>toArrayBuffer()
Returns a standalone copy suitable for storage or transfer APIs.
toArrayBuffer(): ArrayBuffer;Parameters
This API does not accept parameters.
Returns
ArrayBuffertoBlob()
Returns a new application/pdf Blob.
toBlob(): Blob;Parameters
This API does not accept parameters.
Returns
BlobcreateObjectURL()
Creates an object URL tracked by this document.
createObjectURL(): string;Parameters
This API does not accept parameters.
Returns
stringrevokeObjectURL()
Revokes an object URL previously created by this document.
revokeObjectURL(url: string): void;Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
url | string | Yes | None | Object URL created by this document. |
Returns
voidpreview()
Replaces a target's contents with the package canvas preview.
preview(target: HTMLElement, options?: PdfPreviewOptions): Promise<PdfPreview>;Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
target | HTMLElement | Yes | None | Target stage or preview element. |
options | PdfPreviewOptions | No | {} | Options for this operation. |
Returns
Promise<PdfPreview>download()
Starts a browser download and revokes its temporary object URL.
download(filename?: string): void;Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filename | string | No | "file.pdf" | Download filename. |
Returns
voiddispose()
Disposes owned previews, revokes object URLs, and invalidates byte exports.
dispose(): void;Parameters
This API does not accept parameters.
Returns
void