Skip to main content

Interface: PageSettings

Settings for PDF page layout and formatting.

This interface defines the physical properties and visual settings for PDF documents generated from product configurations. It controls aspects like page size, orientation, margins, and rendering behavior, ensuring consistent and professional documentation.

Well-configured page settings are crucial for creating PDFs that are both visually appealing and optimized for their intended use, whether for digital sharing, professional printing, or reference documentation.

Properties​

displayHeaderFooter?​

optional displayHeaderFooter: boolean

Whether to show header and footer content.

When true, the generated PDF will include header and footer areas that can contain information like company logos, page numbers, document titles, or disclaimers.

format?​

optional format: PaperSize | "LETTER" | "LEGAL" | "TABLOID" | "LEDGER" | "letter" | "legal" | "tabloid" | "ledger" | "a0" | "a1" | "a2" | "a3" | "a4" | "a5" | "a6"

Standard paper size format.

Instead of specifying exact dimensions, you can use a standard paper size name like "A4" or "Letter". This ensures compatibility with standard printing equipment and document management systems.

Common formats include:

  • Letter (8.5" × 11") - Standard in North America
  • A4 (210mm × 297mm) - Standard in most of the world
  • Legal (8.5" × 14") - For legal documents
  • Tabloid/Ledger (11" × 17") - For larger documents

height?​

optional height: string | number

Height dimension of the PDF page.

This can be specified as a number (interpreted as pixels) or a string with a unit (e.g., "11in", "297mm"). The height determines the vertical space available for content layout.

landscape?​

optional landscape: boolean

Whether to use landscape orientation.

By default, pages use portrait orientation (height greater than width). When set to true, the page will be rotated to landscape orientation (width greater than height), which is better for wide content like tables or certain product visualizations.

margin?​

optional margin: PDFMargin

Page margin settings.

Defines the empty space around the edge of the page content. Proper margins improve readability and allow space for binding, notes, or other post-processing of the document.

omitBackground?​

optional omitBackground: boolean

Allows transparent backgrounds in the PDF.

When true, the default white background is omitted, allowing content with transparency to show through. This is useful for creating overlays or graphics with transparent elements.

pageRanges?​

optional pageRanges: string

Specific pages or page ranges to include.

This allows selective printing of only certain pages from a larger document, using a format like "1-5, 8, 11-13".

preferCSSPageSize?​

optional preferCSSPageSize: boolean

Respects CSS page size declarations over format settings.

When true, any

Page​

size declarations in the content's CSS will take precedence over the dimensions specified in width, height, or format options.

scale?​

optional scale: number

Scaling factor for content rendering.

This adjusts the size of the content relative to the page. Values between 0.1 and 2 are accepted, where 1 represents 100% (normal size) rendering.

width?​

optional width: string | number

Width dimension of the PDF page.

This can be specified as a number (interpreted as pixels) or a string with a unit (e.g., "8.5in", "215.9mm"). The width determines the horizontal space available for content layout.