Skip to content
Log in

Types: editor: Slides and shows

BackgroundFill

One Format Background choice; style is a Background Styles cell, 1 to 12.

Import from @reductoai/pptx/editor.

type BackgroundFill = { color: ShapeColor; kind: "solid"; transparency?: number } | { kind: "gradient"; type?: Exclude<SlideBackgroundGradientFillType, "Unsupported"> } | { background?: string; foreground?: string; kind: "pattern"; pattern: SlideBackgroundPatternFillType } | { bytes: Uint8Array; kind: "picture"; transparency?: number } | { kind: "style"; style: number } | { kind: "reset" }

BackgroundStylePreview

A Background Styles cell, drawn from the theme: CSS for the fill and the text colour on it.

Import from @reductoai/pptx/editor.

Name Type Description
fill string
style number
text string

BackgroundView

What Format Background shows for a page.

Import from @reductoai/pptx/editor.

Name Type Description
color? string #RRGGBB of a solid fill.
hideGraphics boolean Hide background graphics: the layout’s and master’s shapes are not drawn.
own boolean The page states its own background rather than following its layout or master.
style? number The Background Styles cell, 1 to 12, when the page uses one.
transparency? number
type SlideBackgroundFillType

GuideView

One guide in points from the top or left edge, colour #RRGGBB. A locked guide belongs to the page’s layout or master: it shows and snaps but moves only in Slide Master view.

Import from @reductoai/pptx/editor.

Name Type Description
color string
id number
locked? true
orientation GuideOrientation
position number

HeaderFooterSettings

The dialog’s Slide tab. A fixed date shows dateText; otherwise it is a field in dateFormat.

Import from @reductoai/pptx/editor.

Name Type Description
date boolean
dateFixed boolean
dateFormat DateTimeFormat
dateText string
footer boolean
footerText string
notOnTitleSlide boolean
slideNumber boolean

LayoutChoice

A slide layout the Layout gallery offers; part names it in commands.

Import from @reductoai/pptx/editor.

Name Type Description
master string
name string
part string

LayoutEvent

What a browser layout host reports: the pipeline phases plus its font fetches.

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

type LayoutEvent = ConvertProgress | { bytes: number; done: number; kind: "fetch"; phase: "fonts"; total: number } | { bytes: number; kind: "reflow"; phase: "fonts" }

LayoutProgress

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

type LayoutProgress = (event: LayoutEvent) => void

MasterPage

A page of Slide Master view.

Import from @reductoai/pptx/editor.

Name Type Description
kind “master” | “layout”
master string
name string
part string

MediaCall

A media command of an animation: playFrom(s), togglePause, pause, resume or stop.

Import from @reductoai/pptx/editor.

Name Type Description
cmd “play” | “toggle” | “pause” | “resume” | “stop”
from? number Seconds a playFrom starts at.
shape string

MediaPlayback

How one video or sound plays, from its p:cMediaNode. Shapes are named by p:cNvPr@id.

Import from @reductoai/pptx/editor.

Name Type Description
hideWhenStopped boolean Hide While Not Playing.
mute boolean
repeat number Plays in a row; Infinity for Loop until Stopped.
rewind boolean Rewind after Playing: the poster comes back at the end.
shape string
volume number 0 to 1; ECMA’s default is half.

MediaSource

Where a store reads a media part from; PptxEditor is one.

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

Name Type Description
mediaBlob() (part: string, type?: string) => Blob | null

MediaTiming

The media side of a slide’s timing; animations that move no media are not listed.

Import from @reductoai/pptx/editor.

Name Type Description
clicks MediaCall[][] Calls each click of the main sequence makes, in order (On Click).
media MediaPlayback[]
start MediaCall[] Calls when the slide comes up (Automatically).
triggers { calls: MediaCall[]; shape: string }[] Calls a click on a shape makes (a trigger; PowerPoint toggles each video on its own click).

OutlineSlide

Import from @reductoai/pptx/editor.

Name Type Description
body OutlineParagraph[] The paragraphs of the body, subtitle and content placeholders that hold text, in shape order.
slide number
title OutlineParagraph[] The title placeholder’s paragraphs; empty when the slide has no title placeholder.

PaintedMedia

A picture whose ink comes from a media player.

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

Name Type Description
id string The id the picture paints under on the media page.
windows PaintWindow[]
image() () => unknown The image to paint now; undefined keeps the poster.
stamp() () => string Changes when image paints something else.

SectionView

A section of the slide list: count slides from slide start.

Import from @reductoai/pptx/editor.

Name Type Description
count number
id string
name string
start number

ShowMediaPaint

The slide’s page with its media pictures under ids of their own, the page it came from and what paints them.

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

Name Type Description
page LayoutPage
source LayoutPage
videos PaintedMedia[]

ShowMediaSource

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

Name Type Description
images ReadonlyMap<string, unknown>
objects (slide: number) => readonly SlideObject[]
urls MediaUrls

ShowMode

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

type ShowMode = "show" | "presenter" | "follow"

ShowOptions

start: a slide index (shown even when hidden, as PowerPoint does) or the first shown slide.

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

Name Type Description
mode ShowMode
peer? string
start number | “first”

ShowSlide

One slide as a slide show plays it.

Import from @reductoai/pptx/editor.

Name Type Description
advanceAfterMs? number Moves on by itself after this long on screen (advTm).
advanceOnClick boolean False when a click does not move past the slide (advClick="0").
hidden boolean
media MediaTiming When the slide’s videos and sounds play, and how.
notes string
part string The slide part.
transition? ShowTransition

ShowTransition

How a slide comes on screen in a show; effect is the DrawingML element’s local name.

Import from @reductoai/pptx/editor.

Name Type Description
dir? string dir: a side (l, u, r, d), a corner (lu, …), in/out or horz/vert.
durationMs number
effect string
orient? string orient of a split, blinds, checker or bar transition.
spokes? number Spokes of a wheel.
thruBlk? boolean Fade and cut through black.

SlideBox

Points from the slide’s top-left corner.

Import from @reductoai/pptx-editor.

Name Type Description
h number
w number
x number
y number

SlideComment

A comment thread on a slide.

Import from @reductoai/pptx/editor.

type SlideComment = CommentReply & { at?: { x: number; y: number }; key?: string; legacy?: true; replies: CommentReply[]; resolved: boolean; target?: Rect[] }

SlideMeta

Import from @reductoai/pptx/editor.

Name Type Description
animated boolean It has a transition or animations.
comments number Open comment threads.
hidden boolean
layout string The part of the slide’s layout.

Type to search…

escClose