Skip to content

zeropdf v1.3.0


zeropdf / PageOptions

Interface: PageOptions

Defined in: src/types.ts:548

Options for creating or inserting a page.

Properties

PropertyTypeDescriptionDefined in
origin?"bottom-left" | "top-left"Coordinate origin for this page's drawing APIs. "bottom-left" (default) is the native PDF system where y grows upward. "top-left" flips y so it grows downward from the top edge, matching screen/CSS conventions. Applies to the page drawing, annotation, and form-field methods (text, textBlock, richText, rect, line, circle, ellipse, image, path, link, highlight, note, freeText, textField, checkBox, choiceField, radioGroup, pushButton, signatureField, …). The flow/template layout APIs always use bottom-left coordinates.src/types.ts:574
size?PageSizePage size for the generated page.src/types.ts:550
tabOrder?"R" | "C" | "S"Tab order for annotations and form fields on the page. Uses PDF spec values: "R" (row order), "C" (column order), "S" (structure order). Defaults to structure order ("S") for tagged documents, row order otherwise.src/types.ts:562
transparencyGroup?PageTransparencyGroupOptionsTransparency group dict applied to the page (ISO 32000-2 § 11.6.6). Required by some workflows when the page contains transparency or blend modes that must compose against an explicit blending color space.src/types.ts:556

Released under the ISC license.