AppliedChange
A change the replica took, in order. reverse is the change that takes it
back, against the state after it: on an undo, a redo and a tagged local change.
Not exported by name. You get it from the API.
ApplyOptions
Not exported by name. You get it from the API.
ApplyStep
One step of a batch that applyChanges takes as one undo step: a change, or
a review command (an accept or reject of revisions) read back as one. An empty
change with a tag is a mark: an undo step that is not sent, and whose undo and
redo report the tag (a card rejected outside the document).
Not exported by name. You get it from the API.
CaretMove
Not exported by name. You get it from the API.
CellPathStep
One hop from a host cell into a table it holds; tbl indexes the cell’s own w:tbl children.
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 donecarries 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 pageare heartbeats. No heartbeat for N seconds means the process is stuck inside one block and can be killed.parse partmarks each loader stage (styles, images, charts, fonts, headers, body, notes), so parse silence is attributable to a named stage.parse blockticks the body walk;parse imageticks each resolved image (metafile rasterisation dominates image-heavy docs). None carry progress totals: they are liveness only.runPipelineandconvertDocxToPdfopen the file in their layout engine and send onlystartanddone;extractDocxalso sends the stage beats.
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/docx/browser.
DecodedPng
Not exported by name. You get it from the API.
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.
Import from @reductoai/docx/browser.
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/docx/node.
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/docx/browser.
FaceKey
Import from @reductoai/docx/browser.
FaceSet
A family’s four faces. Slots may be absent for partially-covered families.
Import from @reductoai/docx/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/docx/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/docx/browser.
FetchProgress
Import from @reductoai/docx/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/docx/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.
ImageFlip
Which axes a drawing’s ink is mirrored across, about its bbox centre.
Not exported by name. You get it from the API.
IndexScope
A story being edited in place, and the page it is edited on. Lines whose
storyRel equals story are the addressable set.
Not exported by name. You get it from the API.
InkChoice
A host’s reviewer colours, as data so a layout worker can take them: authors names an
author’s colour, palette replaces Word’s by-author order for the rest.
Import from @reductoai/docx/browser.
LayoutAnchor
A floating (wp:anchor) drawing, absolutely positioned on the page.
Not exported by name. You get it from the API.
LayoutBBox
Import from @reductoai/docx/node.
LayoutBorderSide
One drawn border side (pt width + CSS hex color). Absent side = no border.
Not exported by name. You get it from the API.
LayoutBoxPt
Import from @reductoai/docx/node, @reductoai/docx/officejs.
LayoutColumnBand
Not exported by name. You get it from the API.
LayoutCommentBalloon
Import from @reductoai/docx/browser.
LayoutDocument
Import from @reductoai/docx/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.
LayoutEngineSource
Where the engine is: a URL of engine.wasm, its bytes, or a compiled WebAssembly.Module.
Import from @reductoai/docx/browser.
LayoutEvent
Pipeline events, plus the browser’s font fetches; the engine settles its faces first, so reflow never fires.
Import from @reductoai/docx/browser.
LayoutHeader
The document-level part of the IR, known before any page is laid; a LayoutDocument is one.
Import from @reductoai/docx/node.
LayoutImageRef
Not exported by name. You get it from the API.
LayoutLine
Import from @reductoai/docx/browser.
LayoutLinearGradient
Not exported by name. You get it from the API.
LayoutOverlapKind
“shape” is a floating textbox’s painted frame (fill/border chrome).
Import from @reductoai/docx/node, @reductoai/docx/officejs.
LayoutOverlapOptions
Import from @reductoai/docx/node, @reductoai/docx/officejs.
LayoutPage
Import from @reductoai/docx/browser.
LayoutPageBorder
Page border emitted from the owning section’s w:pgBorders.
Not exported by name. You get it from the API.
LayoutProgress
Import from @reductoai/docx/browser.
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.
LayoutRequest
Not exported by name. You get it from the API.
LayoutReviewLayer
Import from @reductoai/docx/browser.
LayoutReviewTransform
Import from @reductoai/docx/browser.
LayoutRun
Import from @reductoai/docx/browser.
LayoutShapeGeom
Not exported by name. You get it from the API.
LayoutTable
Import from @reductoai/docx/browser.
LayoutTableCell
Import from @reductoai/docx/browser.
LayoutUnit
Not exported by name. You get it from the API.
LayoutView
How revisions and comments are laid; a layout function maps it onto its own options.
Not exported by name. You get it from the API.
LigaturePolicy
The ligature groups a run is shaped with, plus w14:cntxtAlts as +calt.
Absent means the font’s own defaults (fontkit turns liga/clig/calt on).
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.
LiveSource
What the cache needs from a session: its edit counter and the live package.
Import from @reductoai/docx/node.
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/docx/browser.
MetafileKind
Metafile flavours we can rasterise, as told by the magic bytes.
Import from @reductoai/docx/browser.
OutlineView
Import from @reductoai/docx-editor, @reductoai/docx-editor/model.
ParseInput
Import from @reductoai/docx/browser.
ParseOptions
Import from @reductoai/docx/browser, @reductoai/docx/node.
PdfPainterCounts
Not exported by name. You get it from the API.
PipelineOptions
Import from @reductoai/docx/node.
PngDecoder
Not exported by name. You get it from the API.
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.
Not exported by name. You get it from the API.
Presence
A selection as token indices in the server’s document after change seq: of the
body, or of the story stream story (word/footer1.xml#story, word/footnotes.xml#w:footnote|2).
Not exported by name. You get it from the API.
ProgressCallback
Import from @reductoai/docx/browser.
RangeLayoutOverlap
Laid content whose bounds intersect a range (or its requested clearance).
Text uses glyph-ink bounds. Images use their laid outer rectangle, which can
include transparent padding; image hits are advisory and may be visually
harmless (a signature intentionally crossing a rule is a common example).
Import from @reductoai/docx/node, @reductoai/docx/officejs.
RangeLayoutRect
One laid rectangle for a range. Multi-line ranges return one rectangle per line.
Import from @reductoai/docx/node, @reductoai/docx/officejs.
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.
Not exported by name. You get it from the API.
RenderedPng
page is the source LayoutPage.index, numbered as in RenderPngOptions.pages.
Import from @reductoai/docx/node.
RenderPdfOptions
Import from @reductoai/docx/browser.
RenderPdfResult
Import from @reductoai/docx/browser.
RenderPdfTimings
Coarse renderer phases, useful for profiling without changing output.
Not exported by name. You get it from the API.
RenderPngOptions
Import from @reductoai/docx/node.
Selection
anchor is where the drag started; focus moves. Equal ⇒ collapsed caret.
Not exported by name. You get it from the API.
SequencedChange
Another writer’s change and the seq the server gave it.
Not exported by name. You get it from the API.
SessionLayoutHost
A host that answers “the laid pages of this session, as of now”. OfficeJS
and other layout-backed readers take one instead of laying out themselves.
Import from @reductoai/docx/officejs.
SniffedImage
Not exported by name. You get it from the API.
SniffedPicture
Not exported by name. You get it from the API.
SourceAnchor
Import from @reductoai/docx/browser.
SrcRect
Source-window fractions, each in [-1, 1); see LayoutDocument.images.
Not exported by name. You get it from the API.
TextFillGradient
A run’s gradient fill before layout knows its box: a DrawingML lin angle or circle focus.
Not exported by name. You get it from the API.
TextReflection
A Word w14:reflection; opacities and endPos are fractions.
Not exported by name. You get it from the API.
TextShadow
Not exported by name. You get it from the API.
TextStroke
dash: on and off lengths in stroke widths; absent is solid. round: round dash caps.
Not exported by name. You get it from the API.
TextStyle
Import from @reductoai/docx/browser.
TrackedChangesView
simple: Word’s Simple Markup, the final text with a change bar beside each revised line.
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.
WasmEngineSource
The engine’s bytes, or a WebAssembly.Module compiled from them.
Import from @reductoai/docx/browser.