Skip to content
Log in

Types: editor: Shapes and charts

ChartLegend

Import from @reductoai/pptx/editor.

type ChartLegend = "right" | "left" | "top" | "bottom" | "topRight" | "none"

ChartRef

A chart reference (c:f) and whether it reads numbers (c:numRef) or text (c:strRef).

Import from @reductoai/pptx/editor.

Name Type Description
f string
multiLevel? { across: boolean }
numeric boolean

ChartRefCache

levels (multi-level only) runs from the leaf out; points is the leaf.

Import from @reductoai/pptx/editor.

type ChartRefCache = ChartRef & { levels?: (string | null)[][]; points: (string | null)[] }

ChartSeriesData

Import from @reductoai/pptx/editor.

Name Type Description
name string
values (number | null)[]

ChartSeriesEdit

Import from @reductoai/pptx/editor.

type ChartSeriesEdit = { from: number; op: "move"; to: number } | { index: number; op: "remove" } | { hidden: boolean; index: number; op: "hide" }

ChartSeriesRefs

Where one series reads its name, categories (or x values), values and bubble sizes.

Import from @reductoai/pptx/editor.

Name Type Description
categories? string
name? string
size? string
values string
x? string

ChartSource

Every series’ references; numericCategories: the categories are numbers or dates.

Import from @reductoai/pptx/editor.

Name Type Description
family “category” | “scatter” | “bubble”
numericCategories boolean
series ChartSeriesRefs[]

ChartView

The selected chart.

Import from @reductoai/pptx/editor.

Name Type Description
categories string[]
cells ChartHiddenEmpty Select Data > Hidden and Empty Cells.
dataLabels boolean Whether every series shows data labels.
design ChartDesign What the Chart Design tab shows: each element’s state, the colour scheme, how many layouts and styles.
editable boolean False for scatter and bubble charts, whose sheet has x values: they are read only here.
elements { label: string; part: string }[] Every element the chart has, in the order of PowerPoint’s element list.
key string
legend ChartLegend
legendEntries SeriesEntry[] Select Data’s Legend Entries (Series): every series in plot order, hidden ones too.
part string The element the Format pane edits; a click on the selected chart picks the one under it.
series ChartSeriesData[]
title string | null
type string The Excel chart type of the first series (“ColumnClustered”, “Pie”, …).
workbook boolean The chart reads cells of a workbook it embeds: Edit Data opens that workbook.

ChartWorkbook

What Edit Data opens: the chart’s workbook and the references it reads from it. A chart with no workbook gets one laid out from its own data (made); a chart linked to a file outside the deck shows its last values, read-only (linked names the file).

Import from @reductoai/pptx/editor.

Name Type Description
bytes Uint8Array
linked? string
made? boolean
refs ChartRef[]
source? ChartSource Present when the series form one block Edit Data can grow.
visibleOnly boolean

ClipPicture

The copied shapes laid out alone, and the box their ink covers in hmm.

Import from @reductoai/pptx/editor.

Name Type Description
bounds LayoutBBox
doc LayoutDocument

GradientEdit

One change in the pane; a stop is named by its index in GradientState.stops.

Import from @reductoai/pptx/editor.

type GradientEdit = { kind: GradientFillType } | { angle: number } | { color?: string; position?: number; stop: number; transparency?: number } | { addStop: number } | { removeStop: number }

GradientState

Import from @reductoai/pptx/editor.

Name Type Description
angle number Clockwise degrees of a linear gradient.
kind GradientFillType
stops GradientStopState[] In the order the file keeps them, which the pane’s stop numbers follow.

GradientStopState

Import from @reductoai/pptx/editor.

Name Type Description
color string #RRGGBB, resolved through the theme.
position number 0–1.
transparency number 0–1.

PictureAspect

Crop > Aspect Ratio: width over height, or the picture’s own.

Import from @reductoai/pptx/editor.

type PictureAspect = { height: number; width: number } | "original"

PictureView

The one selected picture: its crop and transparency, as Picture Format shows them.

Import from @reductoai/pptx/editor.

Name Type Description
crop CropInsets
key string
recolor? PictureRecolor The Recolor tile it shows; undefined for a recolor no tile writes.
transparency number

ShapeColor

#RRGGBB, or a colour of the deck’s theme; brightness is Lighter (0 to 1) or Darker (-1 to 0).

Import from @reductoai/pptx/editor.

type ShapeColor = string | { brightness?: number; theme: ShapeThemeColor }

ShapeStyleState

What Shape Fill and Shape Outline show as current; a field is absent when the shapes differ.

Import from @reductoai/pptx/editor.

Name Type Description
beginArrow? ArrowheadStyle
dash? ShapeLineDashStyle
endArrow? ArrowheadStyle
fill? string | null #RRGGBB, or null for No Fill; absent on a gradient or picture fill.
glow? number | null The Glow, Reflection and Soft Edges preset ids (EFFECT_PRESETS), or null for none.
gradient? GradientState Format Shape > Gradient fill: the type, angle and stops of a gradient fill.
line? string | null #RRGGBB, or null for No Outline.
reflection? number | null
shadow? number | null The Shadow gallery’s preset id (SHADOW_PRESETS), or null for No Shadow.
softEdge? number | null
weight? number Points.

Type to search…

escClose