Skip to content
Log in

Types: editor: Other

AlignEdge

Import from @reductoai/pptx/editor.

type AlignEdge = "left" | "center" | "right" | "top" | "middle" | "bottom"

AnimationBuild

Effect Options > Sequence, for a shape with text.

Import from @reductoai/pptx/editor.

type AnimationBuild = "object" | "allAtOnce" | "paragraph"

AnimationClass

The Animations gallery as PowerPoint for Windows writes it: preset ids, subtypes and the behaviours of each effect at its default length. Lengths are milliseconds.

Import from @reductoai/pptx/editor.

type AnimationClass = "entrance" | "emphasis" | "exit"

AnimationEffect

Import from @reductoai/pptx/editor.

type AnimationEffect = "appear" | "fade" | "flyIn" | "floatIn" | "split" | "wipe" | "zoom" | "pulse" | "spin" | "growShrink" | "transparency" | "disappear" | "fadeOut" | "flyOut" | "floatOut" | "splitOut" | "wipeOut" | "zoomOut"

AnimationItem

One effect of the main sequence, as the Animation Pane lists it.

Import from @reductoai/pptx/editor.

Name Type Description
click number The click that starts it; 0 when it runs as the slide comes up.
cls AnimationClass | “path” | “media” | “other”
delay number
duration number Seconds.
effect AnimationEffect | “other” other is an effect the gallery does not offer.
index number
label string
option? string
paragraph? number
shape string
start AnimationStart

AnimationStart

Import from @reductoai/pptx/editor.

type AnimationStart = "click" | "with" | "after"

AnimationState

The Animations tab for the selected shapes: their first effect, and how many there are.

Import from @reductoai/pptx/editor.

Name Type Description
build? AnimationBuild
cls? AnimationItem[“cls”]
count number
delay number
duration number
effect AnimationEffect | “other” | “none”
option? string
start AnimationStart

AnimationTiming

Import from @reductoai/pptx/editor.

Name Type Description
delay? number
duration? number
start? AnimationStart

ArrangeScope

“selection” measures the shapes against each other; “slide” against the page.

Import from @reductoai/pptx/editor.

type ArrangeScope = "slide" | "selection"

CellRange

Import from @reductoai/pptx/editor.

Name Type Description
col number
cols number
row number
rows number

CommentSpan

Selected characters of shape key’s text, or of its table cell cell.

Import from @reductoai/pptx/editor.

type CommentSpan = CommentSpanRange & { cell?: GridCell; key: string }

CommentSpanRange

Characters a comment points at, as PowerPoint counts them: a paragraph break is one.

Import from @reductoai/pptx/editor.

Name Type Description
length number
start number

CommentStop

Review > Previous and Next: a step through every comment thread in the deck.

Import from @reductoai/pptx/editor.

Name Type Description
id string
slide number

ComponentContext

What a component’s live view gets.

Import from @reductoai/pptx-editor.

Name Type Description
active boolean The whole view takes pointer input: after a double-click on the stage, in Slide Show and when read-only.
box SlideBox The fallback’s box on the slide, in points.
flipH boolean
flipV boolean
info ComponentInfo
model PptxEditorModel
presenting boolean True while mounted inside Slide Show mode.
readOnly boolean
rotDeg number Clockwise turn in degrees; el is already turned with it.
selected boolean The carrier shape is selected on the stage.
slide number 0-based slide index where the component lives.
state S The state, a table component’s cells folded in.
commit() (next: S) => Promise<void> New state: the fallback is drawn again, and both land as one undo step.
select() () => void Selects the component’s carrier shape on the slide.

ComponentFallback

What PowerPoint, the PDF and the canvas show for a component: a picture, a real PowerPoint table whose cells hold the component’s data, or a group of shapes.

Import from @reductoai/pptx-editor, @reductoai/pptx/editor.

type ComponentFallback = { alt?: string; bytes: Uint8Array; heightPt: number; kind: "picture"; mime: "image/png" | "image/jpeg" | "image/gif" | "image/bmp" | "image/tiff" | "image/x-emf" | "image/x-wmf" | "image/svg+xml"; svg?: Uint8Array; widthPt: number } | { heightPt?: number; kind: "table"; rows: string[][]; style?: TableStyleName; widthPt?: number } | { deck: Uint8Array; kind: "group" }

ComponentInfo

A component found on a slide.

Import from @reductoai/pptx-editor, @reductoai/pptx/editor.

Name Type Description
carrier “picture” | “table” | “group”
id string
key string Unique in this read. Equal to id except on a copy, which gets its own id at its next edit.
rows? string[][] Table: cell text row by row, the data a table component reads back.
shapeKey string Shape key on that slide (SlideObject.key, e.g. “3” or “2.1”).
slide number 0-based slide index where the component lives.
state unknown The JSON state; undefined when the carrier’s state does not parse.
type string

ComponentPlacement

Where a component lands on a slide, in points from the top-left corner.

Import from @reductoai/pptx-editor, @reductoai/pptx/editor.

Name Type Description
height? number
left? number
top? number
width? number

ConnectionSite

A connection site on the slide, in page hmm: site is its index in the shape’s preset.

Import from @reductoai/pptx/editor.

Name Type Description
key string
site number
x number
y number

ConnectorEnd

Which end of a connector: a:stCxn or a:endCxn.

Import from @reductoai/pptx/editor.

type ConnectorEnd = "start" | "end"

DesignView

One master in the Themes gallery’s “This Presentation” row.

Import from @reductoai/pptx/editor.

Name Type Description
id string The master’s id, what applyDesign takes.
layout string The layout its thumbnail paints: the title layout, else the first.
name string The theme’s name, as PowerPoint labels the design.
slides number How many slides follow it.

DistributeAxis

Import from @reductoai/pptx/editor.

type DistributeAxis = "horizontal" | "vertical"

DrawTool

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

type DrawTool = "curve" | "freeform" | "scribble"

EffectKind

Import from @reductoai/pptx/editor.

type EffectKind = "glow" | "reflection" | "softEdge"

FindHit

One match of find: frame offsets in one story of one slide.

Import from @reductoai/pptx/editor.

Name Type Description
end number
slide number
start number
story string

Frame

flipH/flipV as the page shows them, group flips included; absent keeps the shape’s own.

Import from @reductoai/pptx/editor.

type Frame = LayoutBBox & { flipH?: boolean; flipV?: boolean; rotDeg?: number }

FreeformPoint

Import from @reductoai/pptx/editor.

Name Type Description
x number
y number

FreeformSpec

Nodes in page hmm; curve runs a smooth curve through them, else straight lines join them.

Import from @reductoai/pptx/editor.

Name Type Description
closed? boolean
curve? boolean
points FreeformPoint[]

GridCell

Import from @reductoai/pptx/editor.

Name Type Description
col number
row number

LineSpacing

A multiple of single spacing (1.5), or an exact height in points.

Import from @reductoai/pptx/editor.

type LineSpacing = { multiple: number } | { points: number }

LineSpec

Import from @reductoai/pptx/editor.

Name Type Description
beginArrow? ArrowheadStyle
connector ConnectorType
endArrow? ArrowheadStyle

LinkSettings

What the Insert Hyperlink dialog sends.

Import from @reductoai/pptx/editor.

Name Type Description
address string
screenTip? string
text? string Text to display; text only. Left out, the linked text stays as it is.

LinkState

What the dialog shows on open.

Import from @reductoai/pptx/editor.

Name Type Description
address string
linked boolean The selection carries a link: Edit Link and Remove Link apply.
screenTip string
text string | null Text to display; null on shapes, which have none.

ListFormat

size in percent of the text (25 to 400); color null takes the text colour; startAt numbers only.

Import from @reductoai/pptx/editor.

Name Type Description
color? ShapeColor | null
size? number
startAt? number

ListKind

Import from @reductoai/pptx/editor.

type ListKind = ListMarker["kind"]

ListMarker

A bullet character in its font, or one of PowerPoint’s numbering schemes.

Import from @reductoai/pptx/editor.

type ListMarker = { char: string; font?: string; kind: "bullet" } | { kind: "number"; style: NumberStyle }

ListState

What the selected paragraphs show; marker only when they all show the same one.

Import from @reductoai/pptx/editor.

Name Type Description
canDemote boolean
canPromote boolean
format? ListFormat The size, colour and start number the listed paragraphs share; absent when none shows a marker.
kind ListKind | “none” | “mixed”
marker? ListMarker
picture? true Every paragraph shows a picture bullet.

NumberStyle

Import from @reductoai/pptx/editor.

type NumberStyle = Exclude<BulletStyle, "Unsupported">

OutlinePatch

Import from @reductoai/pptx/editor.

Name Type Description
beginArrow? ArrowheadStyle Arrowheads; a closed shape has none, so only lines and connectors take them.
color? ShapeColor | null null is No Outline; the weight and dashes stay for the next colour.
dash? ShapeLineDashStyle
endArrow? ArrowheadStyle
weight? number Points.

PainterState

Import from @reductoai/pptx/editor.

Name Type Description
brush boolean The pointer paints the next selection; false after Ctrl+Shift+C, which keeps the copy for Ctrl+Shift+V.
from “shape” | “text”
sticky boolean A double click locks the brush on until Esc or another click on the button.

PaneItem

Import from @reductoai/pptx/editor.

Name Type Description
children? PaneItem[] A group’s shapes, front-most first.
hidden boolean
key string
kind SlideObjectKind
name string

PaneName

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

type PaneName = "rail" | "notes" | "comments" | "format" | "data" | "selection" | "altText"

Phase

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

Name Type Description
detail string
elapsedMs number Frozen at the moment the phase finished; live phases time themselves.
id PhaseId
ratio number | null null when no total is known: the track runs indeterminate.
startedAt number
status PhaseStatus

PhaseId

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

type PhaseId = "parse" | "layout" | "paint"

PhaseStatus

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

type PhaseStatus = "pending" | "active" | "done"

Platform

Key names for bindings: parse, read from an event, and label per platform.

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

type Platform = "mac" | "win"

PptxHookOptions

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

Name Type Description
rustWasmUrl? string
wasmUrl? DeckEngineSource URL, bytes or compiled module of @reductoai/pptx/engine.wasm.

ProgressView

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

Name Type Description
blocks number Body blocks seen while parsing; names the parse row once it closes.
inline boolean A document already on screen, or its first pages, keeps the block small.
name string
pages number Page count from the last finished layout pass; 0 while unknown.
phases Phase[]

Screen

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

type Screen = { kind: "slide"; media?: ShowMediaPaint; page: LayoutPage } | { kind: "black" } | { kind: "white" } | { kind: "end"; text: string }

ThemeView

Import from @reductoai/pptx/editor.

Name Type Description
colors? ThemeColorSet
fonts? ThemeFontSet

TransitionEffect

The Transitions gallery and its Effect Options, as PowerPoint for Windows writes each pick: the effect element, its speed, and p14:dur where the default length is not a speed’s length.

Import from @reductoai/pptx/editor.

type TransitionEffect = "fade" | "push" | "wipe" | "split" | "reveal" | "cut" | "randomBars" | "shape" | "uncover" | "cover" | "flash"

TransitionState

The slide’s transition as the Transitions tab shows it.

Import from @reductoai/pptx/editor.

Name Type Description
advanceAfter number | null Seconds on screen before the slide moves on by itself; null when it waits.
advanceOnClick boolean
duration number Seconds.
effect TransitionEffect | “none” | “other” other is an effect the gallery does not offer.
option? string

TransitionTiming

Import from @reductoai/pptx/editor.

Name Type Description
advanceAfter? number | null
advanceOnClick? boolean
duration? number

ZoomMode

Zoom as PowerPoint offers it: Fit, or a percentage where 100% shows an inch as 96 CSS pixels.

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

type ZoomMode = number | "fit"

Type to search…

escClose