PDFFileElement: load() method

Syntax

load()
load(data)
load(pdf, xfdf)

Parameters

data Optional

The PDF: a URL (as a string or a URL), a Blob, an ArrayBuffer, a Uint8Array, a File or a FileSystemFileHandle. Files and handles named .xfdf are loaded as form data instead. Without it, the file loads its current source again, or reads its remembered file handle again.

pdf, xfdf

Two File objects or handles, one named .pdf and one .xfdf, in either order: the PDF and its form data.

Return value

A Promise: for a URL or bytes, it resolves to data when the file has loaded; for a file or handle, to the File. With two arguments, it resolves to the PDF's File once the PDF has loaded and its form data is applied.

Exceptions

PDFLoadError

Rejects with this error (exported by the WebPDF module) when loading fails; its cause is the error event's error.

TypeError

Thrown for more than two arguments, or for two files that are not one .pdf and one .xfdf.

Usage notes

• When a direct fetch of an http: or https: URL fails, the file retries once through the built-in proxy (see proxy) before the promise settles: it resolves if the retry loads, and rejects only if the retry fails too.
• Loading the URL the file already has loads it again.
• src and data load files too; load() also tells you when it is done.

Examples

Loading a file and waiting for it

const file = document.querySelector("pdf-file");
try {
  await file.load("//new.webpdf.pro/forms.pdf");
} catch (error) {
  console.warn(error.message, error.cause); // "data failed to load", and why
}

Loading a PDF with its form data

const [pdf, xfdf] = input.files; // form.pdf and form.xfdf
await document.querySelector("pdf-file").load(pdf, xfdf);

Specifications

Not part of any specification. <pdf-file> and <pdf-page> are autonomous custom elements defined by WebPDF.pro.

Browser compatibility

See also

• PDFFileElement.open()
• PDFFileElement.src
• PDFFileElement.data
• load