PDFPageElement

Instance properties

Also inherits properties from its parent interface, PDFElement.

PDFPageElement.anno Read only

The annotation layer: links and form fields, with sync().

PDFPageElement.canvas

A string: the canvas engine, ".js" (PDF.js) or "ium" (PDFium). Reflects canvas.

PDFPageElement.controls

A boolean value: the page has viewer controls. Reflects controls.

PDFPageElement.file Read only

The PDFFileElement whose page this is, or null.

PDFPageElement.fullscreen Read only

A boolean value: the page is shown fullscreen.

PDFPageElement.image Read only

The image layer, with export() and metrics.

PDFPageElement.loading

A string: "eager" or "lazy". Reflects loading.

PDFPageElement.no

A number: the page number, negative from the end. Reflects no.

PDFPageElement.noUnclamped

A number: the page number as written, without clamping.

PDFPageElement.of

A string: the id of the file. Reflects of.

PDFPageElement.off Read only

A DOMTokenList of the parts the page leaves out. Reflects -.

PDFPageElement.offset Read only

An object whose x and y shift the content. Reflects offset:x and offset:y.

PDFPageElement.orientation Read only

A string: "portrait", "landscape" or "square".

PDFPageElement.rotation

A number: the rotation in degrees, a multiple of 90. Reflects rotation.

PDFPageElement.scale

A number: the zoom factor. Reflects scale.

PDFPageElement.signatures

A boolean value: the page shows its signature cards. Reflects signatures.

PDFPageElement.svg

A boolean value: the page is drawn as SVG. Reflects svg.

PDFPageElement.watermark

A string or null: a preview of the evaluation watermark on licensed domains. Reflects watermark.

Instance methods

Also inherits methods from its parent interface, PDFElement.

PDFPageElement.toggleFullscreen()

Shows the page fullscreen, or brings it back. Resolves to whether it worked.

PDFPageElement.update()

Draws the page again; resolves when done.

Events

Listen to these events using addEventListener(). WebPDF elements have no on… event handler properties.

error

The page cannot find its file, or its engine failed.

load

The page knows its size, before it draws.

render

The page has drawn.

signature

A signature on the page was clicked. Cancelable.

Examples

A page with a page counter

HTML

<pdf-file id=f src=//pdf.ist/web.pdf></pdf-file>
<p>Page <output id=no></output></p>
<pdf-page of=f id=page controls scale=0.4></pdf-page>

JavaScript

const page = document.querySelector("#page");
const out = document.querySelector("#no");
page.addEventListener("render", () => {
  out.value = `${page.no} of ${page.file.js.numPages}`;
});

Result

Specifications

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

Browser compatibility

See also

• <pdf-page>
• PDFFileElement
• Using WebPDF
• Viewer controls