@eigenpal/docx-editor-core/types/content

pictureWatermarkDisplayEmufunctionSource ↗

Compute the display dimensions (in EMUs) for a picture watermark from the source image's natural pixel size. Bounds the larger side to a page-sized default and derives the other from the aspect ratio, so the watermark is never distorted (the serializer would otherwise force a square) and never overflows the page. Returns undefined for an unusable size (zero/NaN), letting callers fall back to defaults.

declare function pictureWatermarkDisplayEmu(naturalWidthPx: number, naturalHeightPx: number): {
    widthEmu: number;
    heightEmu: number;
} | undefined;

BlockSdtinterfaceSource ↗

Block-level SDT (content control wrapping block content).

content is BlockContent[] (not just paragraphs/tables) so a nested block SDT survives the round trip. CT_SdtContentBlock also permits run-level content (bookmarks, etc.); that is carried through the same block-content parsing as elsewhere in the document.

interface BlockSdt

BookmarkEndinterfaceSource ↗

Bookmark end marker (w:bookmarkEnd)

interface BookmarkEnd

BookmarkStartinterfaceSource ↗

Bookmark start marker (w:bookmarkStart)

interface BookmarkStart

BreakContentinterfaceSource ↗

Line break

interface BreakContent

ColumninterfaceSource ↗

Column definition

interface Column

Comment_2interface

A comment from comments.xml — the top-level entity for review comments and replies. id matches the inline CommentRangeStart / CommentRangeEnd markers that anchor it inside a paragraph; parentId threads replies under their parent; done reflects Word's "Resolve" state (w15:done).

interface Comment

CommentRangeEndinterfaceSource ↗

Comment range end marker in paragraph content

interface CommentRangeEnd

CommentRangeStartinterfaceSource ↗

Comment range start marker in paragraph content

interface CommentRangeStart

ComplexFieldinterfaceSource ↗

Complex field (w:fldChar begin/separate/end with w:instrText)

interface ComplexField

DeletioninterfaceSource ↗

Deletion wrapper (w:del) — runs deleted by tracked changes

interface Deletion

DocumentBodyinterfaceSource ↗

Document body (w:body) — the editable content of the document.

Contains the ordered block content (paragraphs and tables), the section layout chain derived from inline sectPr markers, the final sectPr, and any document-level comments. This is what most edit operations mutate; headers/footers/styles live elsewhere in the package.

interface DocumentBody

DrawingContentinterfaceSource ↗

Drawing/image reference

interface DrawingContent

EndnoteinterfaceSource ↗

Endnote (w:endnote)

interface Endnote

EndnotePropertiesinterfaceSource ↗

Endnote properties

interface EndnoteProperties

FieldCharContentinterfaceSource ↗

Field character (begin/separate/end)

interface FieldCharContent

FooterReferenceinterfaceSource ↗

interface FooterReference

FootnoteinterfaceSource ↗

Footnote (w:footnote)

interface Footnote

FootnotePropertiesinterfaceSource ↗

Footnote properties

interface FootnoteProperties

HeaderFooterinterfaceSource ↗

Header or footer content

interface HeaderFooter

HeaderReferenceinterfaceSource ↗

Header or footer reference

interface HeaderReference

HyperlinkinterfaceSource ↗

Hyperlink (w:hyperlink) — wraps runs in a clickable link. External targets resolve through the relationships part (rId → href); internal targets reference a BookmarkStart anchor by name.

interface Hyperlink

Image_2interface

Embedded image (w:drawing with an inline or anchored picture). Carries the relationship-id pointer to the binary in word/media/, its resolved data URL (src), display dimensions, optional crop / transform / wrap behaviors, and anchor positioning for floating images.

See ECMA-376 §20.4 (DrawingML wordprocessingDrawing).

interface Image

ImageCropinterfaceSource ↗

Image crop, expressed as fractions of the source image to trim from each edge. OOXML's <a:srcRect l="10000" t="0" r="5000" b="0"/> uses units of 1/100000 (so 10000 → 0.1 → 10% trimmed from the left). We store the normalised fraction so both the renderer and the saver can read it directly without re-parsing units.

interface ImageCrop

ImagePaddinginterfaceSource ↗

Image padding/margins

interface ImagePadding

ImagePositioninterfaceSource ↗

Position for floating images

interface ImagePosition

ImageSizeinterfaceSource ↗

Image size specification

interface ImageSize

ImageTransforminterfaceSource ↗

Image transformation

interface ImageTransform

ImageWrapinterfaceSource ↗

Image wrap type for floating images

interface ImageWrap

InlineSdtinterfaceSource ↗

Inline SDT (content control within a paragraph)

interface InlineSdt

InsertioninterfaceSource ↗

Insertion wrapper (w:ins) — runs inserted by tracked changes

interface Insertion

InstrTextContentinterfaceSource ↗

Field instruction text

interface InstrTextContent

MathEquationinterfaceSource ↗

Math equation content (m:oMath or m:oMathPara)

interface MathEquation

MoveFrominterfaceSource ↗

Move-from wrapper (w:moveFrom) — content moved away from this position

interface MoveFrom

MoveFromRangeEndinterfaceSource ↗

Move-from range end marker (w:moveFromRangeEnd)

interface MoveFromRangeEnd

MoveFromRangeStartinterfaceSource ↗

Move-from range start marker (w:moveFromRangeStart) — ECMA-376 §17.13.5.22 Pairs with moveFromRangeEnd to delimit the source of a move in the document.

interface MoveFromRangeStart

MoveTointerfaceSource ↗

Move-to wrapper (w:moveTo) — content moved into this position

interface MoveTo

MoveToRangeEndinterfaceSource ↗

Move-to range end marker (w:moveToRangeEnd)

interface MoveToRangeEnd

MoveToRangeStartinterfaceSource ↗

Move-to range start marker (w:moveToRangeStart) — ECMA-376 §17.13.5.24 Pairs with moveToRangeEnd to delimit the destination of a move.

interface MoveToRangeStart

NoBreakHyphenContentinterfaceSource ↗

Non-breaking hyphen

interface NoBreakHyphenContent

NoteReferenceContentinterfaceSource ↗

Footnote or endnote reference

interface NoteReferenceContent

NoteRefMarkContentinterfaceSource ↗

Footnote/endnote auto-number mark (w:footnoteRef / w:endnoteRef).

Distinct from [NoteReferenceContent](NoteReferenceContent): that is the *reference* placed in the document body (w:footnoteReference), whereas this is the numbering placeholder that lives *inside* the note body — the run carrying it is what Word renders as the note's leading superscript number. Preserving it keeps the note's own number visible on round-trip.

interface NoteRefMarkContent

ParagraphinterfaceSource ↗

Paragraph (w:p) — the primary block-level container in a Word document.

Every paragraph carries direct formatting (formatting), tracked property changes (propertyChanges), inline content (content), and optional list rendering / section break metadata. paraId is Word's stable identifier (w14:paraId) and is what EditorBridge and the agent toolkit use to address paragraphs.

See ECMA-376 §17.3.1.

interface Paragraph

ParagraphPropertyChangeinterfaceSource ↗

Paragraph property change (w:pPrChange)

interface ParagraphPropertyChange

PictureWatermarkinterfaceSource ↗

Picture watermark — a scaled, optionally washed-out background image.

interface PictureWatermark

PropertyChangeInfointerfaceSource ↗

Generic tracked property-change wrapper metadata (w:*PrChange)

interface PropertyChangeInfo extends TrackedChangeInfo

RuninterfaceSource ↗

A run (w:r) — a contiguous span of inline content sharing one set of character properties (bold, italic, font, color, etc.). Runs are the atomic unit of character formatting; toggling bold on a selection that spans different formatting creates new runs.

See ECMA-376 §17.3.2.

interface Run

```ts
const run: Run = {
  type: 'run',
  formatting: { bold: true },
  content: [{ type: 'text', text: 'Hello' }],
};
```

RunPropertyChangeinterfaceSource ↗

Run property change (w:rPrChange)

interface RunPropertyChange

SdtDataBindinginterfaceSource ↗

XML data binding (w:dataBinding) — links a content control to a node in a Custom XML data store. Modeled read-only; the binding round-trips verbatim via rawPropertiesXml (this projection is for inspection, e.g. "which controls are bound, and to what XPath"). The editor does not resolve or sync bound values.

interface SdtDataBinding

SdtPropertiesinterfaceSource ↗

SDT properties (w:sdtPr).

The modeled fields are a **read-only projection** for downstream tooling (tag/alias addressing, template extraction). They are NOT the serialization source: the original w:sdtPr is captured verbatim in rawPropertiesXml and replayed on save, which preserves element order (CT_SdtPr is an xsd:sequence), avoids double-emission, and keeps unmodeled features (data binding, w15:*, @lastValue) lossless.

interface SdtProperties

SectioninterfaceSource ↗

One section of the document — a SectionProperties plus the block content (Paragraphs and Tables) that lives under those properties.

Sections are derived during parse: every paragraph carrying an inline sectPr ends a section, and the body's final sectPr defines the last section. Each section may carry its own headers/footers map.

interface Section

SectionPropertiesinterfaceSource ↗

Section properties (w:sectPr) — page geometry, margins, columns, header/footer references, and page numbering for one section of the document. Sections are introduced by inline sectPr markers on the terminating paragraph (Paragraph.sectionProperties) and the body's final sectPr.

All distance units are twips (1/20 of a point) on the wire. The layout engine converts to pixels.

See ECMA-376 §17.6.

interface SectionProperties

SeparatorContentinterfaceSource ↗

Footnote/endnote separator mark (w:separator / w:continuationSeparator).

These appear inside the special separator notes (w:type="separator" and w:type="continuationSeparator") and draw the horizontal rule Word places between the body and its notes. They carry no content; Word rejects a notes part whose separator notes have lost these markers, so they must round-trip.

interface SeparatorContent

ShapeinterfaceSource ↗

Shape/drawing object (wps:wsp)

interface Shape

ShapeContentinterfaceSource ↗

Shape reference

interface ShapeContent

ShapeFillinterfaceSource ↗

Shape fill type

interface ShapeFill

ShapeOutlineinterfaceSource ↗

Shape outline/stroke

interface ShapeOutline

ShapeTextBodyinterfaceSource ↗

Text body inside a shape

interface ShapeTextBody

SimpleFieldinterfaceSource ↗

Simple field (w:fldSimple)

interface SimpleField

SoftHyphenContentinterfaceSource ↗

Soft hyphen

interface SoftHyphenContent

SymbolContentinterfaceSource ↗

Symbol character (special font character)

interface SymbolContent

TabContentinterfaceSource ↗

Tab character

interface TabContent

TableinterfaceSource ↗

Table (w:tbl) — a block-level grid of rows × cells. Tables carry their own formatting layer (borders, shading, alignment, indent, floating placement) and an explicit column-width grid in twips. Tables can nest arbitrarily through TableCell.content.

See ECMA-376 §17.4.

interface Table

TableCellinterfaceSource ↗

Table cell (w:tc). Holds nested block content (paragraphs and nested tables), cell-level formatting (borders, shading, vertical merge), tracked property changes, and tracked structural changes for cell insert/delete/merge operations.

interface TableCell

TableCellPropertyChangeinterfaceSource ↗

Table cell property change (w:tcPrChange)

interface TableCellPropertyChange

TablePropertyChangeinterfaceSource ↗

Table property change (w:tblPrChange)

interface TablePropertyChange

TableRowinterfaceSource ↗

Table row (w:tr) — an ordered list of TableCell plus row-level formatting (height, repeated header, cantSplit) and tracked changes for inserts/deletes.

interface TableRow

TableRowPropertyChangeinterfaceSource ↗

Table row property change (w:trPrChange)

interface TableRowPropertyChange

TableStructuralChangeInfointerfaceSource ↗

Table structural tracked change metadata (row/cell insert/delete/merge)

interface TableStructuralChangeInfo

TextBoxinterfaceSource ↗

Text box (floating text container)

interface TextBox

TextContentinterfaceSource ↗

Plain text run content (w:t). preserveSpace mirrors the xml:space="preserve" attribute and matters for runs that begin or end with whitespace — without it, Word collapses leading/trailing spaces.

interface TextContent

TextWatermarkinterfaceSource ↗

Text watermark (e.g. "CONFIDENTIAL", "DRAFT").

interface TextWatermark

TrackedChangeInfointerfaceSource ↗

Tracked change metadata (w:ins, w:del attributes)

interface TrackedChangeInfo

BlockContenttypeSource ↗

Block-level content types

type BlockContent = Paragraph | Table | BlockSdt;

EndnotePositiontypeSource ↗

Endnote position

type EndnotePosition = 'sectEnd' | 'docEnd';

FieldtypeSource ↗

type Field = SimpleField | ComplexField;

FieldTypetypeSource ↗

Known field types

type FieldType = 'PAGE' | 'NUMPAGES' | 'NUMWORDS' | 'NUMCHARS' | 'DATE' | 'TIME' | 'CREATEDATE' | 'SAVEDATE' | 'PRINTDATE' | 'AUTHOR' | 'TITLE' | 'SUBJECT' | 'KEYWORDS' | 'COMMENTS' | 'FILENAME' | 'FILESIZE' | 'TEMPLATE' | 'DOCPROPERTY' | 'DOCVARIABLE' | 'REF' | 'PAGEREF' | 'NOTEREF' | 'HYPERLINK' | 'TOC' | 'TOA' | 'INDEX' | 'SEQ' | 'STYLEREF' | 'AUTONUM' | 'AUTONUMLGL' | 'AUTONUMOUT' | 'IF' | 'MERGEFIELD' | 'NEXT' | 'NEXTIF' | 'ASK' | 'SET' | 'QUOTE' | 'INCLUDETEXT' | 'INCLUDEPICTURE' | 'SYMBOL' | 'ADVANCE' | 'EDITTIME' | 'REVNUM' | 'SECTION' | 'SECTIONPAGES' | 'USERADDRESS' | 'USERNAME' | 'USERINITIALS' | 'UNKNOWN';

FootnotePositiontypeSource ↗

Footnote position

type FootnotePosition = 'pageBottom' | 'beneathText' | 'sectEnd' | 'docEnd';

HeaderFooterTypetypeSource ↗

Header/footer type

type HeaderFooterType = 'default' | 'first' | 'even';

LineNumberRestarttypeSource ↗

Line number restart type

type LineNumberRestart = 'continuous' | 'newPage' | 'newSection';

NoteNumberRestarttypeSource ↗

Number restart type

type NoteNumberRestart = 'continuous' | 'eachSect' | 'eachPage';

PageOrientationtypeSource ↗

Page orientation

type PageOrientation = 'portrait' | 'landscape';

ParagraphContenttypeSource ↗

Inline content that can appear inside a paragraph. Covers runs (text), hyperlinks, bookmarks, fields, structured document tags, comment range markers, tracked-change wrappers, and math equations. Every node in this union carries a type discriminator so consumers can narrow at runtime.

type ParagraphContent = Run | Hyperlink | BookmarkStart | BookmarkEnd | SimpleField | ComplexField | InlineSdt | CommentRangeStart | CommentRangeEnd | Insertion | Deletion | MoveFrom | MoveTo | MoveFromRangeStart | MoveFromRangeEnd | MoveToRangeStart | MoveToRangeEnd | MathEquation;

RunContenttypeSource ↗

All possible run content types

type RunContent = TextContent | TabContent | BreakContent | SymbolContent | NoteReferenceContent | NoteRefMarkContent | SeparatorContent | FieldCharContent | InstrTextContent | SoftHyphenContent | NoBreakHyphenContent | DrawingContent | ShapeContent;

SdtTypetypeSource ↗

SDT type (content control type).

Values mirror the w:sdtPr type-marker element names from ECMA-376 §17.5.2 (CT_SdtPr), with two deliberate exceptions: - checkbox is the w14:checkbox (Office 2010) extension, not a base OOXML type marker. - buildingBlockGallery covers both w:docPartObj and w:docPartList.

A w:sdtPr with no type marker means richText (the spec default). A type marker the parser does not model maps to unknown — it is never coerced to richText, so the projection stays honest. Round-trip fidelity does not depend on this enum: the raw w:sdtPr is replayed verbatim (see rawPropertiesXml).

type SdtType = 'richText' | 'plainText' | 'date' | 'dropDownList' | 'comboBox' | 'checkbox' | 'picture' | 'buildingBlockGallery' | 'group' | 'equation' | 'citation' | 'bibliography' | 'unknown';

SectionStarttypeSource ↗

Section start type

type SectionStart = 'continuous' | 'nextPage' | 'oddPage' | 'evenPage' | 'nextColumn';

ShapeTypetypeSource ↗

Shape types

type ShapeType = 'rect' | 'roundRect' | 'ellipse' | 'triangle' | 'rtTriangle' | 'parallelogram' | 'trapezoid' | 'pentagon' | 'hexagon' | 'heptagon' | 'octagon' | 'decagon' | 'dodecagon' | 'star4' | 'star5' | 'star6' | 'star7' | 'star8' | 'star10' | 'star12' | 'star16' | 'star24' | 'star32' | 'line' | 'straightConnector1' | 'bentConnector2' | 'bentConnector3' | 'bentConnector4' | 'bentConnector5' | 'curvedConnector2' | 'curvedConnector3' | 'curvedConnector4' | 'curvedConnector5' | 'rightArrow' | 'leftArrow' | 'upArrow' | 'downArrow' | 'leftRightArrow' | 'upDownArrow' | 'quadArrow' | 'leftRightUpArrow' | 'bentArrow' | 'uturnArrow' | 'leftUpArrow' | 'bentUpArrow' | 'curvedRightArrow' | 'curvedLeftArrow' | 'curvedUpArrow' | 'curvedDownArrow' | 'stripedRightArrow' | 'notchedRightArrow' | 'homePlate' | 'chevron' | 'rightArrowCallout' | 'downArrowCallout' | 'leftArrowCallout' | 'upArrowCallout' | 'leftRightArrowCallout' | 'quadArrowCallout' | 'circularArrow' | 'flowChartProcess' | 'flowChartAlternateProcess' | 'flowChartDecision' | 'flowChartInputOutput' | 'flowChartPredefinedProcess' | 'flowChartInternalStorage' | 'flowChartDocument' | 'flowChartMultidocument' | 'flowChartTerminator' | 'flowChartPreparation' | 'flowChartManualInput' | 'flowChartManualOperation' | 'flowChartConnector' | 'flowChartOffpageConnector' | 'flowChartPunchedCard' | 'flowChartPunchedTape' | 'flowChartSummingJunction' | 'flowChartOr' | 'flowChartCollate' | 'flowChartSort' | 'flowChartExtract' | 'flowChartMerge' | 'flowChartOnlineStorage' | 'flowChartDelay' | 'flowChartMagneticTape' | 'flowChartMagneticDisk' | 'flowChartMagneticDrum' | 'flowChartDisplay' | 'wedgeRectCallout' | 'wedgeRoundRectCallout' | 'wedgeEllipseCallout' | 'cloudCallout' | 'borderCallout1' | 'borderCallout2' | 'borderCallout3' | 'accentCallout1' | 'accentCallout2' | 'accentCallout3' | 'callout1' | 'callout2' | 'callout3' | 'accentBorderCallout1' | 'accentBorderCallout2' | 'accentBorderCallout3' | 'actionButtonBlank' | 'actionButtonHome' | 'actionButtonHelp' | 'actionButtonInformation' | 'actionButtonBackPrevious' | 'actionButtonForwardNext' | 'actionButtonBeginning' | 'actionButtonEnd' | 'actionButtonReturn' | 'actionButtonDocument' | 'actionButtonSound' | 'actionButtonMovie' | 'irregularSeal1' | 'irregularSeal2' | 'frame' | 'halfFrame' | 'corner' | 'diagStripe' | 'chord' | 'arc' | 'bracketPair' | 'bracePair' | 'leftBracket' | 'rightBracket' | 'leftBrace' | 'rightBrace' | 'can' | 'cube' | 'bevel' | 'donut' | 'noSmoking' | 'blockArc' | 'foldedCorner' | 'smileyFace' | 'heart' | 'lightningBolt' | 'sun' | 'moon' | 'cloud' | 'snip1Rect' | 'snip2SameRect' | 'snip2DiagRect' | 'snipRoundRect' | 'round1Rect' | 'round2SameRect' | 'round2DiagRect' | 'plaque' | 'teardrop' | 'mathPlus' | 'mathMinus' | 'mathMultiply' | 'mathDivide' | 'mathEqual' | 'mathNotEqual' | 'gear6' | 'gear9' | 'funnel' | 'pieWedge' | 'pie' | 'leftCircularArrow' | 'leftRightCircularArrow' | 'swooshArrow' | 'textBox';

TrackedRunChangetypeSource ↗

Run-level tracked wrappers represented in WordprocessingML.

type TrackedRunChange = Insertion | Deletion | MoveFrom | MoveTo;

VerticalAligntypeSource ↗

Vertical alignment

type VerticalAlign = 'top' | 'center' | 'both' | 'bottom';

WatermarktypeSource ↗

A document watermark — text or picture.

type Watermark = TextWatermark | PictureWatermark;

DEFAULT_WATERMARK_PRESETSconstSource ↗

Default text-watermark presets shown in the watermark dialog, mirroring the canned phrases MS Word offers. Adapters expose a watermarkPresets prop to override this list; both React and Vue fall back to these when unset.

DEFAULT_WATERMARK_PRESETS: readonly string[]