Skip to main content
Types that layout, rendering and font loading name, A to Z.

BrowserMetafileOptions

Import from @reductoai/pptx/browser.

CaretMove

Import from @reductoai/pptx/editor.

CellPathStep

One hop from a host cell into a table it holds; tbl indexes the cell’s own w:tbl children. Import from @reductoai/pptx/editor.

ChartHitSource

Not exported by name. You get it from the API.

ConvertProgress

Progress events for the docx -> pdf path. A supervisor (e.g. a Modal job with a hard timeout) can read these to tell “slow but alive” from “stuck”:
  • layout done carries the page count. That is the earliest point where a caller can size the remaining budget (render cost is ~linear in pages).
  • layout page / render page are heartbeats. No heartbeat for N seconds means the process is stuck inside one block and can be killed.
  • parse part marks each loader stage (styles, images, charts, fonts, headers, body, notes), so parse silence is attributable to a named stage. parse block ticks the body walk; parse image ticks each resolved image (metafile rasterisation dominates image-heavy docs). None carry progress totals: they are liveness only. runPipeline and convertDocxToPdf open the file in their layout engine and send only start and done; extractDocx also sends the stage beats.
Cancellation: layout and paint are synchronous, so AbortSignal.timeout cannot fire while they hold the event loop — the signal options abort at checkpoints only after abort() had a chance to run (async phase boundaries, or an abort requested before the sync phase started). For a hard in-process deadline over the sync phases, THROW from the onProgress callback: it is invoked synchronously at every checkpoint and the error propagates out of the pipeline. Import from @reductoai/pptx, @reductoai/pptx/browser.

DecodedPng

Import from @reductoai/pptx/pdf.

DeleteUnit

How far a delete key reaches from a collapsed caret. Import from @reductoai/pptx/editor.

DocProperties

Package metadata (docProps/core.xml, docProps/app.xml). Text values are verbatim; dates stay in the W3CDTF form Word wrote. Only present keys are emitted, so an empty <dc:title/> reads as absent. Not exported by name. You get it from the API.

EastAsianScript

Not exported by name. You get it from the API.

EditTarget

Stable source coordinates shared by the layout parser and the editor. A cell’s row/col are local to the table that holds it; path names the host cells from the body table down to that table, so a nested cell never aliases a host cell at the same coordinates. Import from @reductoai/pptx/editor.

EmbeddedFaceData

One embedded face, serializable: it travels inside the layout IR so a renderer in another process (or a browser) embeds the same bytes the measurer used. id is the face’s stable identity (embed:<doc>/<slug>). Not exported by name. You get it from the API.

EmbeddedFontMap

Import from @reductoai/pptx, @reductoai/pptx/browser.

FaceKey

Import from @reductoai/pptx, @reductoai/pptx/browser.

FaceSet

A family’s four faces. Slots may be absent for partially-covered families. Import from @reductoai/pptx, @reductoai/pptx/browser.

FaceSource

One face: a stable identity plus a byte source. id is what caches key on (an absolute file path for node system fonts, embed:<doc>/<family>-<key> for document-embedded faces, whatever the adapter chooses in a browser). bytes() may be lazy and returns null when the face is unavailable. Import from @reductoai/pptx, @reductoai/pptx/browser.

FaceTable

A static font mirror: which families exist, which face id fills each slot, and which file holds each face. Families register up front with empty faces; a face’s bytes arrive only when a layout trace (or familyFaces) asks. Import from @reductoai/pptx/browser.

FetchProgress

Not exported by name. You get it from the API.

FontBuffer

A font face for the SVG rasteriser: stable id plus its bytes. Import from @reductoai/pptx/browser.

FontDecl

Font-table properties used to select a substitute face. Not exported by name. You get it from the API.

FontDeclMap

Import from @reductoai/pptx, @reductoai/pptx/browser.

FontFallback

One requested family that the registry could not serve as itself. Not exported by name. You get it from the API.

FontFallbackReason

Why a requested family was not the family that got served. alias a metric-compatible clone from SUBSTITUTIONS (Arial -> Liberation Sans). Expected on the portable profile; metrics are designed to match, so this is information, not a defect. script a complex-script fallback replaced the run’s face. The served face has DIFFERENT advances, so line breaks and page count move. missing nothing matched the name at all and resolveFamily’s fontTable rule chose the face. Same metric risk as script. Not exported by name. You get it from the API.

FontMirrorStats

Import from @reductoai/pptx/node.

ImageFlip

Which axes a drawing’s ink is mirrored across, about its bbox centre. Not exported by name. You get it from the API.

LayoutAnchor

A floating (wp:anchor) drawing, absolutely positioned on the page. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutBBox

Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutBorderSide

One drawn border side (pt width + CSS hex color). Absent side = no border. Not exported by name. You get it from the API.

LayoutColumnBand

Not exported by name. You get it from the API.

LayoutCommentBalloon

Not exported by name. You get it from the API.

LayoutDocument

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutDrawingGrid

w:settings drawing grid, shown by Word’s View > Gridlines. Steps are the gap between drawn lines (spacing times display-every); 0 draws no lines that way. Absent origin = the page’s margin corner, and the grid fills the margin box; otherwise it fills the page. Not exported by name. You get it from the API.

LayoutImageRef

Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutLine

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutLinearGradient

Not exported by name. You get it from the API.

LayoutPage

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutPageBorder

Page border emitted from the owning section’s w:pgBorders. Not exported by name. You get it from the API.

LayoutRect

A decoration rectangle (paragraph w:shd fill / w:pBdr borders), drawn under all text and table content. bbox in hmm from the page’s top-left. Not exported by name. You get it from the API.

LayoutReviewLayer

Not exported by name. You get it from the API.

LayoutReviewTransform

Not exported by name. You get it from the API.

LayoutRun

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutShapeGeom

Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutTable

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutTableCell

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

LayoutUnit

Not exported by name. You get it from the API.

LineEndSize

a:headEnd/a:tailEnd @len and @w; absent is med. Not exported by name. You get it from the API.

LineEndType

a:headEnd/a:tailEnd @type, less none (which is simply absent). Not exported by name. You get it from the API.

LineWrap

Not exported by name. You get it from the API.

LiveField

A field Word recalculates at layout time: page and section numbers and counts, running heading, paragraph count. Not exported by name. You get it from the API.

MeasureText

Width of text when drawn with the run’s face and size. Only ratios against the run’s own text are used, so any consistent unit works (canvas px, pt). Not exported by name. You get it from the API.

MetafileBackend

Platform half of the metafile pipeline: rasterise an SVG at zoom. Node’s default backend loads @resvg/resvg-js lazily; a browser host injects a wasm equivalent via setMetafileBackend. Import from @reductoai/pptx/browser.

MetafileKind

Metafile flavours we can rasterise, as told by the magic bytes. Import from @reductoai/pptx/browser.

MetafileWorkerOptions

Import from @reductoai/pptx/browser.

PdfPainterCounts

Not exported by name. You get it from the API.

PngDecoder

Import from @reductoai/pptx/pdf.

Position

A caret: offset is a UTF-16 index into the target’s text. side picks one of Word’s stops at an inline content control’s edge: “before” joins the text before it, “after” the text after an empty control. Import from @reductoai/pptx/editor.

ProgressCallback

Import from @reductoai/pptx, @reductoai/pptx/browser.

RasterBudget

How many output pixels a metafile may spend per CSS px of its placement. Not exported by name. You get it from the API.

Rect

Page-local rectangle in hmm (the IR unit); rot turns it as the painter turns its line. Import from @reductoai/pptx/editor.

RenderedPng

page is the source LayoutPage.index, numbered as in RenderPngOptions.pages. Import from @reductoai/pptx/node.

RenderPdfOptions

Import from @reductoai/pptx/pdf.

RenderPdfResult

Import from @reductoai/pptx/pdf.

RenderPdfTimings

Coarse renderer phases, useful for profiling without changing output. Import from @reductoai/pptx/pdf.

RenderPngOptions

Import from @reductoai/pptx/node.

RgbaEncoder

RGBA -> PNG; defaults to OffscreenCanvas when the host omits it. Import from @reductoai/pptx/browser.

SlideMedia

A picture’s media: a part of the package or an outside address; neither when the link is broken. Import from @reductoai/pptx/editor.

SlideObject

Import from @reductoai/pptx/editor.

SlideObjectKind

Import from @reductoai/pptx/editor.

SourceAnchor

@reductoai/pptx — PPTX → LayoutDocument. Browser-safe: no node builtins. Surface: OPC access and the part graph, the raw shape tree, theme context and the placeholder cascade, geometry and pictures, text layout inside a shape, DrawingML tables, charts, and SmartArt. File I/O and the system font scan live in ./node; the PDF writer in ./pdf; browser backends in ./browser. Import from @reductoai/pptx, @reductoai/pptx/browser.

SrcRect

Source-window fractions, each in [-1, 1); see LayoutDocument.images. Not exported by name. You get it from the API.

SvgRasterizer

Platform half a host or worker must supply: SVG -> PNG at zoom. Not exported by name. You get it from the API.

TableFaceProvider

A FaceProvider over a FaceTable, plus the by-family verbs a host needs around it. Import from @reductoai/pptx/browser.

TableGrid

A laid table in page hmm: grid edges (n + 1 each) and the origin cell of every merged area. Import from @reductoai/pptx/editor.

TableStyleName

Not exported by name. You get it from the API.

Turn

Turned text: lines are laid upright and painted turned about a pivot (LayoutLine.rot). Not exported by name. You get it from the API.

WorkerLike

Structural Worker/DedicatedWorkerGlobalScope. The handler slots are any-typed on purpose: a DOM MessageEvent handler is only assignable to a narrower one through any, and callers annotate with MessageLike. Not exported by name. You get it from the API.

WorkerScopeLike

Not exported by name. You get it from the API.