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§
- 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.
- Node
- A node in the document tree.
- Page
Config - Configuration for a page: size, margins, orientation.
- Signature
Config - Configuration for digitally signing a PDF with an X.509 certificate.
- Source
Location - Source code location for click-to-source in the dev server inspector.
- TextRun
- An inline styled run within a Text node.
Enums§
- Canvas
Op - A canvas drawing operation.
- Column
Width - Edge
Value - A margin edge value — either a fixed point value or auto.
- Fixed
Position - Where a fixed element is placed on the page.
- Node
Kind - The different kinds of nodes in the document tree.
- Page
Size - Standard page sizes in points.
- PdfA
Conformance - PDF/A conformance level.
- Position
- Positioning mode for a node.