Skip to main content

Chart

Chart members every host shares; the host owns the frame (size, id, position). Import from @reductoai/docx/node, @reductoai/docx/officejs.

Chart properties

Chart.addSeries()

Append a series, modelled on the target plot’s last one (axis wiring and cache structure are cloned; the theme’s accent cycle colours it). For a combo chart, plotKind picks the family (“column”, “line”, …); default is the first plot. Omitting name leaves the legend entry blank.

Chart.assertLive()

Throws when the frame left its part.

Chart.colorStyle()

The chart’s cs:colorStyle part; a host that keeps none reads as Excel’s default.

Chart.convertToShape()

Extension (VBA InlineShape.ConvertToShape): floats an inline chart with square wrap at the column and paragraph origin, and returns its Shape for position and wrap. A floating chart returns its Shape as is.

Chart.detached()

Chart.frameSizePt()

The frame’s size in points, for plot-area geometry.

Chart.getDataTable()

Excel.Chart.getDataTable(): throws when the chart type cannot show one.

Chart.getDataTableOrNullObject()

Excel.Chart.getDataTableOrNullObject(): isNullObject when the chart type cannot show one.

Chart.noteChange()

Chart.seal()

Chart.setColorStyle()

Chart.styleAxisTitle()

The look a new axis title takes: Office’s 10pt grey on a styled chart.

Chart.textRef()

A c:strRef with its cache for a cell formula; a host without cells leaves it empty.

Diagram

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

Diagram properties

Diagram.assertLive()

Equation

Import from @reductoai/docx/officejs.

Equation properties

Equation.delete()

Equation.getRange()

The one object character the equation occupies in its paragraph’s text.

Equation.setTex()

Rewrites the equation in place; { display } switches between inline and display math.

Frame

Word.Frame: one text frame. Edits reach every paragraph of the frame and are untracked. Import from @reductoai/docx/officejs.

Frame properties

Frame.delete()

Removes the frame; its text stays where it is, as Word’s Frame.Delete does.

Frame.set()

Not implemented. These Office.js members throw: copy, cut, select.

FrameCollection

Word.FrameCollection: the frames of the document or of a range. Import from @reductoai/docx/officejs.

FrameCollection properties

FrameCollection.add()

Frames the range’s paragraphs as Word’s Insert Frame does: wrap around, 9 pt from the text, anchored to the column and paragraph. A paragraph already in a frame joins the new one.

FrameCollection.at()

FrameCollection.delete()

Removes every frame of the collection; the text stays.

FrameCollection.getFirst()

FrameCollection.getFirstOrNullObject()

OfficeJS null-object variant; inspect isNullObject before other members.

FrameCollection.getItem()

OfficeJS spelling of at().

FrameCollection.getLast()

FrameCollection.getLastOrNullObject()

OfficeJS null-object variant; inspect isNullObject before other members.

GradientStop

One a:gs: VBA GradientStop. Import from @reductoai/docx/officejs.

GradientStop properties

GradientStop.set()

GradientStopCollection

a:gsLst: VBA GradientStops. Import from @reductoai/docx/officejs.

GradientStopCollection properties

GradientStopCollection.delete()

VBA GradientStops.Delete; a gradient keeps at least two stops.

GradientStopCollection.insert()

VBA GradientStops.Insert; index is 0-based and defaults to the end.

PictureFormat

VBA PictureFormat: each crop is in points of the uncropped picture at its current scale. Setting one keeps the scale and moves that edge, so the frame grows or shrinks with it. Import from @reductoai/docx/officejs.

PictureFormat properties

ReflectionFormat

Word.ReflectionFormat (WordApiDesktop 1.3) on a shape: one a:reflection in a:effectLst. Import from @reductoai/docx/officejs.

ReflectionFormat properties

ReflectionFormat.set()

Shape

A live handle to one floating textbox: the w:r run holding its wp:anchor. Import from @reductoai/docx/node, @reductoai/docx/officejs.

Shape properties

Shape.bringToFront()

Paint above every other floating shape: one past the document-wide maximum wp:anchor z (relativeHeight). Ink behind the body text (behindText) stays behind it; this orders the float layer only.

Shape.delete()

Remove the shape from the document. Handles into it become detached.

Shape.flip()

VBA Shape.Flip: mirrors the shape about its centre; a second flip undoes it.

Shape.getBase64ImageSrc()

Shape.getRange()

Extension: the drawing’s one character in its paragraph, as VBA’s InlineShape.Range (Shape.Anchor for a floating one). Its font sets the run’s, which sizes the line an inline shape sits on.

Shape.moveHorizontally()

Shift the horizontal offset by a delta in points.

Shape.moveVertically()

Shift the vertical offset by a delta in points.

Shape.scaleHeight()

Multiply the height by factor. Only “CurrentSize” scaling is supported.

Shape.scaleWidth()

Multiply the width by factor. Only “CurrentSize” scaling is supported.

Shape.sendToBack()

Paint below every other floating shape (document-wide minimum z minus one, floored at 0).

Shape.set()

Shape.setFreeformPath()

Extension: Word’s Edit Points / Crop to Shape. Replaces the geometry of a shape or a picture’s mask with a freeform; SVG path data (M, L, H, V, C, Q, Z) in points from its top-left.

ShapeAdjustments

PowerPoint.Adjustments (VBA Shape.Adjustments) on a Word shape: the preset’s a:avLst. A length is a fraction of the shape (50000 → 0.5), an angle is in degrees. Import from @reductoai/docx/officejs.

ShapeAdjustments properties

ShapeAdjustments.get()

ShapeAdjustments.set()

ShapeFill

Import from @reductoai/docx/officejs.

ShapeFill properties

ShapeFill.clear()

Make the shape transparent (a:noFill).

ShapeFill.set()

ShapeFill.setSolidColor()

ShapeFill.twoColorGradient()

VBA FillFormat.TwoColorGradient: the solid colour (or black) shading to white.

ShapeGroup

Word.ShapeGroup: the members of a wpg group drawing, each a child Shape. Import from @reductoai/docx/officejs.

ShapeGroup properties

ShapeLine

The outline (a:ln) of a shape’s own spPr, named after Excel’s ShapeLineFormat. An absent a:ln means the theme’s line (a:style/a:lnRef), which reads as visible with no explicit color; the first write materializes the element. Import from @reductoai/docx/officejs.

ShapeLine properties

ShapeShadow

Word.ShadowFormat on a shape or picture: one a:outerShdw in a:effectLst, as Word’s Shadow gallery writes it. Offsets and blur are in points. Import from @reductoai/docx/officejs.

ShapeShadow properties

ShapeShadow.incrementOffsetX()

ShapeShadow.incrementOffsetY()

ShapeShadow.set()

ShapeTextWrap

Import from @reductoai/docx/officejs.

ShapeTextWrap properties

ShapeTextWrap.set()

TextFrame

A textbox shape’s text-body properties (wps:bodyPr), OfficeJS Word.TextFrame. Geometry the box’s own layout honours: vertical anchoring, insets, auto-size, word wrap. Import from @reductoai/docx/officejs.

TextFrame properties

TextFrame.set()