> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reducto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Types: OfficeJS: Shapes, pictures and charts

## `AnchoredImageSpec`

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

```ts theme={null}
type AnchoredImageSpec = InlineImageSpec & { alignH?: "left" | "center" | "right"; alignV?: "top" | "center" | "bottom"; behindText?: boolean; leftPt?: number; relativeFromH?: "page" | "margin" | "column"; relativeFromV?: "page" | "margin" | "paragraph"; topPt?: number; wrap?: ImageWrapType; wrapSide?: ImageWrapSide }
```

## `ArrowheadLength`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ArrowheadLength = "Short" | "Medium" | "Long"
```

## `ArrowheadStyle`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ArrowheadStyle = "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"
```

## `ArrowheadWidth`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ArrowheadWidth = "Narrow" | "Medium" | "Wide"
```

## `Clip`

The members of one change a range holds, and the part of each it cuts.

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

| Name | Type | Description |
| - | - | - |
| `members` | `XElement[]` | |
| `parts` | `Map<XElement, [number, number]>` | |

## `Clipper`

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

```ts theme={null}
type Clipper = (members: readonly XElement[]) => Clip & { caret?: () => Range } | undefined
```

## `DiagramCreateSpec`

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

| Name | Type | Description |
| - | - | - |
| `heightPt?` | `number` | |
| `kind` | `DiagramKind` | |
| `nodes` | `DiagramNode[]` | |
| `widthPt?` | `number` | |

## `EffectExtent`

How far a drawing's effects reach past its frame, in points (`wp:effectExtent`).

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `bottom` | `number` | |
| `left` | `number` | |
| `right` | `number` | |
| `top` | `number` | |

## `EffectKind`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

```ts theme={null}
type EffectKind = "shadow" | "reflection" | "glow" | "softEdges"
```

## `EffectPreset`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `attrs` | `Readonly<Record<string, string>>` | Attributes of the effect element, in EMU and 60000ths of a degree. |
| `color?` | `{ alpha?: number; preset?: string; satMod?: number; scheme?: string }` | The effect's colour: a preset or scheme colour, with Word's modifiers in its order. |
| `effect` | `EffectKind` | |
| `group?` | `string` | The gallery's section: "outer", "inner" or "perspective" for shadows. |
| `label` | `string` | |
| `name` | `string` | |

## `FlatWrap`

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

```ts theme={null}
type FlatWrap = "Square" | "Tight" | "TopAndBottom" | "None" | "Through"
```

## `FloatingPictureOptions`

Import from `@reductoai/docx/node`, `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `altText?` | `string` | |
| `behindText?` | `boolean` | Paint behind text; requires wrap "None". |
| `fallback?` | `string` | Extension: for an SVG, the base64 PNG or JPEG shown where SVG is not read. |
| `height?` | `number` | |
| `left?` | `number` | Offset in points from the anchor reference edge; default 0. |
| `name?` | `string` | |
| `relativeFromH?` | `"page" \| "margin" \| "column"` | Defaults match insertTextBox: "column" / "paragraph". |
| `relativeFromV?` | `"page" \| "margin" \| "paragraph"` | |
| `top?` | `number` | |
| `width?` | `number` | Points; absent = natural size. One dimension given = aspect-scaled. |
| `wrap?` | `"Square" \| "Tight" \| "TopAndBottom" \| "None" \| "Through"` | OfficeJS-style casing; default "Square". |
| `wrapSide?` | `"Both" \| "Left" \| "Right" \| "Largest"` | |

## `FrameAnchor`

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

```ts theme={null}
type FrameAnchor = typeof ANCHORS[number]
```

## `FrameRelativeHorizontalPosition`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type FrameRelativeHorizontalPosition = "Margin" | "Page" | "Column"
```

## `FrameRelativeVerticalPosition`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type FrameRelativeVerticalPosition = "Margin" | "Page" | "Paragraph"
```

## `FrameSizeRule`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type FrameSizeRule = "Auto" | "AtLeast" | "Exact"
```

## `FrameSource`

Where a frame's w:framePr lives: the paragraphs of one frame, or a paragraph style.

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

| Name | Type | Description |
| - | - | - |
| `ctx` | `FacadeContext` | |
| `commit()` | `() => void` | |
| `elements()` | `(create: boolean) => XElement[]` | The framePr elements to read and edit; with create, a missing one is made. |
| `paragraphs()` | `() => XElement[] \| undefined` | The framed paragraphs; undefined for a style's frame. |

## `FrameUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type FrameUpdateData = Partial<WritableProperties<Frame>>
```

## `GradientScope`

The fill a gradient handle edits; undefined once the fill is no longer a gradient.

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

| Name | Type | Description |
| - | - | - |
| `changed()` | `() => void` | |
| `gradFill()` | `() => XElement \| undefined` | |

## `GradientStopUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type GradientStopUpdateData = WritableProperties<GradientStop>
```

## `GradientStyle`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type GradientStyle = "Horizontal" | "Vertical"
```

## `ImageAlign`

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

```ts theme={null}
type ImageAlign = { align: "left" | "center" | "right"; axis: "horizontal"; relativeTo: "page" | "margin" } | { align: "top" | "center" | "bottom"; axis: "vertical"; relativeTo: "page" | "margin" }
```

## `ImageFormat`

Mirrors the Word.ImageFormat enum, PascalCased to match the other OfficeJS unions.

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ImageFormat = "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Svg"
```

## `ImageWrapSide`

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

```ts theme={null}
type ImageWrapSide = "bothSides" | "left" | "right" | "largest"
```

## `ImageWrapType`

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

```ts theme={null}
type ImageWrapType = "none" | "square" | "tight" | "topAndBottom" | "through"
```

## `InlineImageSpec`

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

| Name | Type | Description |
| - | - | - |
| `alt?` | `string` | |
| `heightPt` | `number` | |
| `name?` | `string` | |
| `widthPt` | `number` | |

## `InlinePictureUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type InlinePictureUpdateData = WritableProperties<InlinePicture>
```

## `InsertImageFloat`

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

```ts theme={null}
type InsertImageFloat = Omit<AnchoredImageSpec, "widthPt" | "heightPt" | "alt" | "name">
```

## `InsertImageOptions`

A picture, with its position in the editing session's paragraph text space.

Import from `@reductoai/docx/node`.

| Name | Type | Description |
| - | - | - |
| `alt?` | `string` | |
| `bytes` | `Uint8Array` | |
| `float?` | `InsertImageFloat` | Float the picture (wp:anchor with wrapping); absent = inline (wp:inline). |
| `heightPt` | `number` | |
| `mime` | `SniffedPicture["mime"]` | |
| `name?` | `string` | |
| `offset?` | `number` | |
| `svg?` | `Uint8Array` | The SVG original behind `bytes`, its raster fallback. |
| `widthPt` | `number` | |

## `InsertInlinePictureOptions`

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

| Name | Type | Description |
| - | - | - |
| `fallback?` | `string` | Extension: for an SVG, the base64 PNG or JPEG shown where SVG is not read. |
| `height?` | `number` | Display height in points; width keeps the image's aspect when omitted. |
| `width?` | `number` | Display width in points; height keeps the image's aspect when omitted. |

## `InsertMathArgs`

insertMath's parameters, shared by the Body, Paragraph and Range doors.

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type InsertMathArgs<Location> = [tex: string, insertLocation?: Location, options?: InsertMathOptions]
```

## `InsertMathOptions`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type InsertMathOptions = TexOptions & { display?: boolean }
```

## `InsertShapeOptions`

OfficeJS InsertShapeOptions: geometry in points. Word defaults to 1 inch square at 0,0.

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

| Name | Type | Description |
| - | - | - |
| `height?` | `number` | |
| `left?` | `number` | |
| `top?` | `number` | |
| `width?` | `number` | |

## `ParagraphFrame`

Word's text frame (VBA `Frame`, `DropCap`; extension, Office.js has no frame).
Each axis takes an offset or an alignment inside its anchor; both anchors
default to `text` (the column and the paragraph).

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `dropCap?` | `typeof DROP_CAPS[number]` | |
| `heightPt?` | `number` | |
| `heightRule?` | `typeof HEIGHT_RULES[number]` | |
| `horizontalAnchor?` | `FrameAnchor` | |
| `horizontalDistancePt?` | `number` | Clearance between the frame and the text beside it. |
| `lines?` | `number` | Body lines a drop cap spans, 1 through 10. |
| `verticalAnchor?` | `FrameAnchor` | |
| `verticalDistancePt?` | `number` | Clearance between the frame and the text above and below it. |
| `widthPt?` | `number` | Frame width; omitted or 0 sizes the frame to its text. |
| `wrap?` | `typeof WRAPS[number]` | |
| `xAlign?` | `typeof X_ALIGNS[number]` | |
| `xPt?` | `number` | |
| `yAlign?` | `typeof Y_ALIGNS[number]` | |
| `yPt?` | `number` | |

## `PictureCrop`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `bottomPt` | `number` | |
| `leftPt` | `number` | |
| `rightPt` | `number` | |
| `topPt` | `number` | |

## `PictureInsertLocation`

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

```ts theme={null}
type PictureInsertLocation = "Start" | "End" | "Before" | "After" | "Replace"
```

## `PictureRecolor`

One tile of Word's Recolor gallery. "dark" is the scheme colour over black, "light" a dark
shade of it over white; "blackWhite" is the luminance cut-off in percent.

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

```ts theme={null}
type PictureRecolor = { kind: "grayscale" } | { kind: "sepia" } | { kind: "washout" } | { kind: "blackWhite"; threshold: number } | { color: typeof RECOLOR_DARK[number]; kind: "dark" } | { color: typeof RECOLOR_LIGHT[number]; kind: "light" }
```

## `ReflectionFormatUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ReflectionFormatUpdateData = WritableProperties<ReflectionFormat>
```

## `ReflectionType`

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

```ts theme={null}
type ReflectionType = "Mixed" | "None" | `Type${1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9}`
```

## `RunGlow`

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

| Name | Type | Description |
| - | - | - |
| `color` | `string` | "accent1" through "accent6", or RRGGBB. |
| `sizePt` | `number` | Glow size in points, 0 through 150. |
| `transparency?` | `number` | 0 opaque … 1 clear; Word's gallery uses 0.6. |

## `RunTextGradient`

Font Color > Gradient: Word's light variation of `color`, linear at `angleDeg` or radial from `from`.

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

| Name | Type | Description |
| - | - | - |
| `angleDeg?` | `number` | Degrees clockwise from the +x axis, as `w14:lin/@w14:ang`; 90 by default. |
| `color` | `string` | RRGGBB the stops tint. |
| `from?` | `TextGradientFocus` | A radial (`w14:path circle`) gradient spreading from this point instead. |

## `RunTextReflection`

Text Effects > Reflection, in the Format Text Effects pane's terms.

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

| Name | Type | Description |
| - | - | - |
| `blurPt` | `number` | |
| `distancePt` | `number` | |
| `endTransparency?` | `number` | Transparency where the fade ends; 0.997 by default. |
| `size` | `number` | Share of the glyph height the fade covers, 0..1. |
| `transparency` | `number` | 0 opaque … 1 clear, at the glyphs. |

## `SceneConnectorSpec`

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `arrow?` | `"None" \| "End" \| "Start" \| "Both"` | Arrowhead placement; default End (at `to`). |
| `from` | `string` | |
| `kind?` | `"Straight" \| "Elbow"` | Straight => straightConnector1, Elbow => bentConnector3; default Straight. |
| `lineColor?` | `string` | |
| `lineWeight?` | `number` | |
| `to` | `string` | |

## `SceneLineSpec`

A free polyline through points; unlike a connector it joins no shapes.

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `arrow?` | `"None" \| "End" \| "Start" \| "Both"` | Arrowhead placement; default None. End sits on the last point. |
| `lineColor?` | `string` | |
| `lineWeight?` | `number` | |
| `name?` | `string` | |
| `points` | `readonly (readonly [number, number])[]` | Two or more \[left, top] points, relative to the scene origin. |

## `SceneOptions`

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `connectors?` | `readonly SceneConnectorSpec[]` | |
| `height?` | `number` | |
| `left?` | `number` | Offset in points from the anchor reference edge; default 0. |
| `lines?` | `readonly SceneLineSpec[]` | |
| `name?` | `string` | |
| `relativeFromH?` | `"page" \| "margin" \| "column"` | |
| `relativeFromV?` | `"page" \| "margin" \| "paragraph"` | |
| `shapes?` | `readonly SceneShapeSpec[]` | |
| `top?` | `number` | |
| `width?` | `number` | Extension: a fixed group frame in points from the scene origin; default the members' bounds. |

## `SceneShapeSpec`

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `base64ImageString?` | `string` | Extension: a picture member, as insertInlinePictureFromBase64 takes it, instead of a geometry. |
| `fallback?` | `string` | Extension: for an SVG `base64ImageString`, the base64 PNG or JPEG shown where SVG is not read. |
| `fillColor?` | `string` | RRGGBB or #RRGGBB; fill defaults transparent, line defaults none. |
| `font?` | `TextboxFont` | |
| `geometricShapeType?` | `GeometricShapeType` | The shape's geometry: a preset, or `path` for a freeform. |
| `height?` | `number` | |
| `id` | `string` | Caller-chosen id; connectors reference it. |
| `left` | `number` | Points, relative to the scene origin; the group is sized to the shapes. |
| `lineColor?` | `string` | |
| `lineWeight?` | `number` | |
| `name?` | `string` | |
| `path?` | `string` | Extension: a freeform, as Paragraph.insertFreeform spells it — absolute SVG path data (M, L, H, V, C, Q, Z) in points from the shape's top-left. |
| `rotation?` | `number` | Clockwise degrees; default 0. |
| `text?` | `string` | Label inside the shape; "\n" splits paragraphs. "" gives an empty text body to fill through `body`. |
| `textAlign?` | `"Left" \| "Center" \| "Right"` | Horizontal label alignment; default Center, as Word centers a drawn shape's text. |
| `textAnchor?` | `"Top" \| "Middle" \| "Bottom"` | |
| `textMargins?` | `number \| { bottom?: number; left?: number; right?: number; top?: number }` | Text-box insets in points, one number for all four sides; default 7.2 left/right, 3.6 top/bottom. |
| `textSpacing?` | `{ lineSpacing?: LineSpacingSpec; spaceAfter?: number; spaceBefore?: number }` | Spacing on every label paragraph, as Paragraph.set and setLineSpacing spell it. |
| `top` | `number` | |
| `width?` | `number` | A path's box defaults to its furthest point. |

## `ShapeContentJson`

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

| Name | Type | Description |
| - | - | - |
| `altTextDescription` | `string` | |
| `altTextTitle` | `string` | |
| `fill?` | `{ foregroundColor?: string; type: "Solid" \| "NoFill" \| "Gradient" \| "Mixed" }` | |
| `id` | `number` | |
| `imageFormat?` | `ImageFormat` | |
| `name` | `string` | |
| `rotation?` | `number` | |
| `text?` | `string` | |
| `type` | `ShapeType` | |
| `visible` | `boolean` | |

## `ShapeDash`

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

```ts theme={null}
type ShapeDash = typeof SHAPE_DASHES[number]
```

## `ShapeFillGradient`

Shape Fill > Gradient: a Light or Dark Variation of the fill colour, linear or radial.

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `angleDeg?` | `number` | Degrees clockwise from +x, as `a:lin/@ang`; 90 by default. |
| `dark?` | `boolean` | Dark Variations shade the colour; Light ones (the default) tint it. |
| `from?` | `ShapeGradientFocus` | A circle gradient spreading from this point instead. |

## `ShapeFillUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeFillUpdateData = WritableProperties<ShapeFill>
```

## `ShapeFlipType`

VBA `MsoFlipCmd`: msoFlipHorizontal, msoFlipVertical.

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeFlipType = "Horizontal" | "Vertical"
```

## `ShapeGeometry`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `ends?` | `[ShapePoint, ShapePoint]` | A connector's start and end in the same space: Word frames it with these, not a box. |
| `handles` | `ShapePoint[]` | Yellow adjust handles, in points from the upright shape's top-left, mirrored as the shape is flipped. |
| `preset` | `string` | The `a:prstGeom` name: `roundRect`, `arc`, `curvedConnector3`… |

## `ShapeGradientFocus`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

```ts theme={null}
type ShapeGradientFocus = "center" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight"
```

## `ShapeInsetsPt`

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

| Name | Type | Description |
| - | - | - |
| `bottom` | `number` | |
| `left` | `number` | |
| `right` | `number` | |
| `top` | `number` | |

## `ShapeJson`

A group member (isChild) has no anchor, so its snapshot carries no size, position or wrap.

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeJson = ShapeContentJson & { allowOverlap?: boolean; behindText?: boolean; height?: number; horizontalAlignment?: HorizontalAlignment; inline?: true; isChild?: true; left?: number; relativeHorizontalPosition?: RelativeHorizontalPosition; relativeVerticalPosition?: RelativeVerticalPosition; top?: number; verticalAlignment?: VerticalAlignment; width?: number; wrap?: ShapeWrap; wrapSide?: ShapeWrapSide }
```

## `ShapeLineStyle`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `color` | `string` | RRGGBB. |
| `dash` | `ShapeDash` | |
| `weightPt` | `number` | |

## `ShapePoint`

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `xPt` | `number` | |
| `yPt` | `number` | |

## `ShapeScaleFrom`

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

```ts theme={null}
type ShapeScaleFrom = "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"
```

## `ShapeScaleType`

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

```ts theme={null}
type ShapeScaleType = "CurrentSize" | "OriginalSize"
```

## `ShapeShadowUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeShadowUpdateData = WritableProperties<ShapeShadow> & { foregroundColor?: ColorFormatUpdateData }
```

## `ShapeStyle`

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

| Name | Type | Description |
| - | - | - |
| `fill` | `string \| null` | RRGGBB solid fill; null for no fill. |
| `fillMixed?` | `true` | Set when the fill is a gradient, picture or pattern the palette cannot show. |
| `frame` | `ShapeTextFrame` | |
| `line` | `ShapeLineStyle \| null` | Solid outline; null for no line. |

## `ShapeTextDirection`

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

```ts theme={null}
type ShapeTextDirection = typeof SHAPE_TEXT_DIRECTIONS[number]
```

## `ShapeTextFrame`

`wps:bodyPr`: how the text sits inside the box.

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

| Name | Type | Description |
| - | - | - |
| `direction` | `ShapeTextDirection` | |
| `fitToText` | `boolean` | `a:spAutoFit`: the box grows to its text instead of clipping it. |
| `insetsPt` | `ShapeInsetsPt` | |
| `vAlign` | `ShapeVAlign` | |
| `wrapText` | `boolean` | `@wrap`: false lets lines run past the box instead of wrapping. |

## `ShapeTextWrapUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeTextWrapUpdateData = WritableProperties<ShapeTextWrap>
```

## `ShapeType`

What the anchor's a:graphicData carries. "GeometricShape" is a free wps
shape without a text body (ovals, arrows, callout chrome); "Unsupported"
covers foreign payloads such as charts and diagrams.

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeType = "TextBox" | "Picture" | "GeometricShape" | "GroupShape" | "Canvas" | "Unsupported"
```

## `ShapeUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type ShapeUpdateData = WritableProperties<Shape> & { body?: BodyUpdateData; fill?: ShapeFillUpdateData; textFrame?: TextFrameUpdateData; textWrap?: ShapeTextWrapUpdateData }
```

## `ShapeVAlign`

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

```ts theme={null}
type ShapeVAlign = typeof SHAPE_VALIGNS[number]
```

## `ShapeWrap`

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

```ts theme={null}
type ShapeWrap = keyof typeof SHAPE_WRAPS
```

## `ShapeWrapSide`

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

```ts theme={null}
type ShapeWrapSide = keyof typeof SHAPE_WRAP_SIDES
```

## `TextboxFont`

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

| Name | Type | Description |
| - | - | - |
| `bold?` | `boolean` | |
| `color?` | `string` | RRGGBB text color. |
| `italic?` | `boolean` | |
| `name?` | `string` | |
| `sizePt?` | `number` | |

## `TextBoxOptions`

Floating-textbox geometry, in points, plus optional chrome and run styling.

Import from `@reductoai/docx/node`, `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `fillColor?` | `string` | RRGGBB or #RRGGBB box fill; default transparent. |
| `font?` | `TextboxFont` | |
| `height?` | `number` | |
| `left?` | `number` | Offset in points from the anchor reference edge; default 0. |
| `lineColor?` | `string` | RRGGBB or #RRGGBB box outline; default none. |
| `relativeFromH?` | `"page" \| "margin" \| "column"` | Anchor reference edges; defaults "column" / "paragraph". |
| `relativeFromV?` | `"page" \| "margin" \| "paragraph"` | |
| `top?` | `number` | |
| `width?` | `number` | |

## `TextEffectOptions`

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

| Name | Type | Description |
| - | - | - |
| `fillColor?` | `string` | RRGGBB or #RRGGBB; default black. |
| `fillTransparency?` | `number` | 0 opaque … 1 clear. |
| `fontBold?` | `boolean` | |
| `fontItalic?` | `boolean` | |
| `fontName?` | `string` | Default "Calibri", as Word's watermark. |
| `fontSize?` | `number` | Points; the text is stretched over the box either way. |
| `height` | `number` | |
| `horizontalAlignment?` | `"Left" \| "Center" \| "Right"` | |
| `left?` | `number` | Floating offset in points from the relative origin; an alignment wins over it. |
| `relativeHorizontalPosition?` | `keyof typeof RELATIVE_H` | Default "Column". |
| `relativeVerticalPosition?` | `keyof typeof RELATIVE_V` | Default "Paragraph". |
| `rotation?` | `number` | Degrees clockwise. |
| `top?` | `number` | |
| `verticalAlignment?` | `"Top" \| "Center" \| "Bottom"` | |
| `width` | `number` | Box size in points; required. |
| `wrapType?` | `"Inline" \| "Front" \| "Behind"` | Office.js Word.ShapeTextWrapType subset; default "Inline". |

## `TextFrameOrientation`

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

```ts theme={null}
type TextFrameOrientation = keyof typeof ORIENTATIONS | "None" | "Mixed"
```

## `TextFrameUpdateData`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type TextFrameUpdateData = WritableProperties<TextFrame>
```

## `TextGradientFocus`

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

```ts theme={null}
type TextGradientFocus = "center" | "topLeft" | "topRight" | "bottomLeft" | "bottomRight"
```

## `TextWatermark`

The Printed Watermark dialog's text options.

Import from `@reductoai/docx/officejs`.

| Name | Type | Description |
| - | - | - |
| `color?` | `string` | #RRGGBB or a colour name; default silver. |
| `font?` | `string` | Default Calibri. |
| `layout?` | `WatermarkLayout` | Default Diagonal. |
| `semitransparent?` | `boolean` | Default true. |
| `size?` | `number \| "Auto"` | Points; "Auto" (or absent) sizes the text to the page. |
| `text` | `string` | |

## `Watermark`

Word's text watermark; picture watermarks are not authored.

Import from `@reductoai/docx-editor`, `@reductoai/docx-editor/model`.

| Name | Type | Description |
| - | - | - |
| `color?` | `string` | RRGGBB; default silver C0C0C0. |
| `font?` | `string` | Default Calibri. |
| `layout?` | `"diagonal" \| "horizontal"` | Default diagonal (315°). |
| `semitransparent?` | `boolean` | Default true: half transparent. |
| `sizePt?` | `number` | Absent: Auto, sized to the page. |
| `text` | `string` | |

## `WatermarkLayout`

Import from `@reductoai/docx/officejs`.

```ts theme={null}
type WatermarkLayout = "Diagonal" | "Horizontal"
```

## `WrapDoors`

The flat doors ShapeTextWrap is spelled over; Shape supplies them.

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

| Name | Type | Description |
| - | - | - |
| `anchor` | `() => XElement` | The drawing frame the distances live on: wp:anchor, or wp:inline. |
| `changed` | `() => void` | |
| `getBehind` | `() => boolean` | |
| `getSide` | `() => FlatSide \| undefined` | |
| `getWrap` | `() => FlatWrap` | |
| `isInline` | `() => boolean` | |
| `setBehind` | `(value: boolean) => void` | |
| `setInline` | `() => void` | |
| `setSide` | `(value: FlatSide) => void` | |
| `setWrap` | `(value: FlatWrap) => void` | |

## `WrapPoint`

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

| Name | Type | Description |
| - | - | - |
| `x` | `number` | |
| `y` | `number` | |
