Expand description
§Document Model
The input representation for the rendering engine. A document is a tree of nodes, each with a type, style properties, and children. This is designed to be easily produced by a React reconciler, an HTML parser, or direct JSON construction.
The model is intentionally close to the DOM/React mental model: you have containers (View), text (Text), images (Image), and tables (Table). But there is one critical addition: Page is a first-class node type.
Structs§
- Attachment
- A file embedded as a PDF attachment (associated file).
- Certification
Config - Configuration for digitally certifying a PDF with an X.509 certificate.
- Chart
Data Point - A data point for bar charts and pie charts.
- Chart
Series - A data series for line charts and area charts.
- Column
Def - Column definition for tables.
- Document
- A complete document ready for rendering.
- DotPlot
Group - A group of data points for dot plots.
- Edges
- Edge values (top, right, bottom, left) used for padding and page margins.
- Font
Entry - A custom font to register with the engine.
- Margin
Edges - Margin edges that support auto values.
- Metadata
- Document metadata embedded in the PDF.
- Named
Page Set - The page-config family for one named page (CSS
@page <name>). - Node
- A node in the document tree.
- Page
Config - Configuration for a page: size, margins, orientation.
- Redaction
Pattern - A text pattern to search for in a PDF for redaction.
- Redaction
Region - A rectangular region to redact in an existing PDF.
- Source
Location - Source code location for click-to-source in the dev server inspector.
- TextRun
- An inline styled run within a Text node.
- Zugferd
Meta - Factur-X / ZUGFeRD XMP identification (the
fx:extension schema).
Enums§
- AfRelationship
/AFRelationshipvalues (PDF 2.0 §14.13, used by PDF/A-3).- Background
Position - Where a background image is positioned on a page (relevant for
cover/containwhen the image doesn’t fill the page exactly). - Background
Size - How a background image is scaled to fit a page.
- Canvas
Op - A canvas drawing operation.
- Column
Width - Edge
Value - A margin edge value — either a fixed point value or auto.
- Fixed
Page Filter - Which pages a fixed element repeats on.
- Fixed
Position - Where a fixed element is placed on the page.
- List
Marker Type - Marker style for a
List. Maps to CSSlist-style-type: - Node
Kind - The different kinds of nodes in the document tree.
- Page
Size - Standard page sizes in points.
- Pattern
Type - How to interpret a text pattern for redaction search.
- PdfA
Conformance - PDF/A conformance level.
- PdfVersion
- The output PDF version. The 1.7 arm is the writer as it has always
been; every 2.0 behavior lives behind explicit
V2_0match arms so the default path is textually unchanged. - Position
- Positioning mode for a node.