FlowDoc

The semantic IR tree (ir-design §5): everything a reader extracts from the document bytes, format-neutrally — the flow body plus its document-scoped companions (styles, numbering, header/footer bands, notes, charts, binary resources, metadata). Caller-supplied conversion options (fonts, PDF/A profile, signature, …) are deliberately NOT part of the tree; they parameterize transforms, not the document.

body carries FINAL effective properties — readers materialize list markers and resolve the style cascade while building it — so render projections must not re-apply styles/numbering, which remain only as round-trip material.

Properties

body

readonly body: readonly BodyElement[]

Defined in: src/core/ir/flow.ts:44

The document flow content, carrying resolved, effective properties.

charts?

readonly optional charts?: ReadonlyMap<string, Chart>

Defined in: src/core/ir/flow.ts:64

Parsed charts keyed by relationship id (ChartBlock.chartRelId).

comments?

readonly optional comments?: ReadonlyMap<string, Comment>

Defined in: src/core/ir/flow.ts:62

§17.13.4 review comments by id, anchored from a run’s commentRef.

embeddedFonts?

readonly optional embeddedFonts?: ReadonlyMap<string, FontRegistry>

Defined in: src/core/ir/flow.ts:68

Fonts embedded in the source document itself (docx fontTable), by name.

endnotes?

readonly optional endnotes?: ReadonlyMap<string, readonly BodyElement[]>

Defined in: src/core/ir/flow.ts:60

footnotes?

readonly optional footnotes?: ReadonlyMap<string, readonly BodyElement[]>

Defined in: src/core/ir/flow.ts:59

§17.11 footnotes/endnotes content by id (separator stubs excluded).

headersFooters?

readonly optional headersFooters?: ReadonlyMap<string, readonly BodyElement[]>

Defined in: src/core/ir/flow.ts:57

info?

readonly optional info?: DocumentInfo

Defined in: src/core/ir/flow.ts:70

Document metadata from docProps/core.xml.

kind

readonly kind: "flow"

Defined in: src/core/ir/flow.ts:42

Discriminant for SourceDoc (a FlowDoc passes through projection).

language?

readonly optional language?: string

Defined in: src/core/ir/flow.ts:72

Document natural language hint (BCP-47), e.g. for tagged-PDF /Lang.

numbering?

readonly optional numbering?: Numbering

Defined in: src/core/ir/flow.ts:56

Raw numbering definitions (round-trip material). body already carries the materialized list markers — readers apply numbering as a FlowDoc transform, so render projections must not re-apply it.