---
title: "Types: editor: Slides and shows"
---

> 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: editor: Slides and shows

## `BackgroundFill`

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

Import from `@reductoai/pptx/editor`.

```ts
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 |
| --- | --- | --- |
| <a id="backgroundstylepreview-fill" data-search="BackgroundStylePreview.fill"></a>`fill` | <code>string</code> |  |
| <a id="backgroundstylepreview-style" data-search="BackgroundStylePreview.style"></a>`style` | <code>number</code> |  |
| <a id="backgroundstylepreview-text" data-search="BackgroundStylePreview.text"></a>`text` | <code>string</code> |  |


## `BackgroundView`

What Format Background shows for a page.

Import from `@reductoai/pptx/editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="backgroundview-color" data-search="BackgroundView.color"></a>`color?` | <code>string</code> | `#RRGGBB` of a solid fill. |
| <a id="backgroundview-hidegraphics" data-search="BackgroundView.hideGraphics"></a>`hideGraphics` | <code>boolean</code> | Hide background graphics: the layout's and master's shapes are not drawn. |
| <a id="backgroundview-own" data-search="BackgroundView.own"></a>`own` | <code>boolean</code> | The page states its own background rather than following its layout or master. |
| <a id="backgroundview-style" data-search="BackgroundView.style"></a>`style?` | <code>number</code> | The Background Styles cell, 1 to 12, when the page uses one. |
| <a id="backgroundview-transparency" data-search="BackgroundView.transparency"></a>`transparency?` | <code>number</code> |  |
| <a id="backgroundview-type" data-search="BackgroundView.type"></a>`type` | <code><a href="/office/pptx/api/types-facade#slidebackgroundfilltype">SlideBackgroundFillType</a></code> |  |


## `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 |
| --- | --- | --- |
| <a id="guideview-color" data-search="GuideView.color"></a>`color` | <code>string</code> |  |
| <a id="guideview-id" data-search="GuideView.id"></a>`id` | <code>number</code> |  |
| <a id="guideview-locked" data-search="GuideView.locked"></a>`locked?` | <code>true</code> |  |
| <a id="guideview-orientation" data-search="GuideView.orientation"></a>`orientation` | <code><a href="/office/pptx/api/types-facade#guideorientation">GuideOrientation</a></code> |  |
| <a id="guideview-position" data-search="GuideView.position"></a>`position` | <code>number</code> |  |


## `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 |
| --- | --- | --- |
| <a id="headerfootersettings-date" data-search="HeaderFooterSettings.date"></a>`date` | <code>boolean</code> |  |
| <a id="headerfootersettings-datefixed" data-search="HeaderFooterSettings.dateFixed"></a>`dateFixed` | <code>boolean</code> |  |
| <a id="headerfootersettings-dateformat" data-search="HeaderFooterSettings.dateFormat"></a>`dateFormat` | <code><a href="/office/pptx/api/types-facade#datetimeformat">DateTimeFormat</a></code> |  |
| <a id="headerfootersettings-datetext" data-search="HeaderFooterSettings.dateText"></a>`dateText` | <code>string</code> |  |
| <a id="headerfootersettings-footer" data-search="HeaderFooterSettings.footer"></a>`footer` | <code>boolean</code> |  |
| <a id="headerfootersettings-footertext" data-search="HeaderFooterSettings.footerText"></a>`footerText` | <code>string</code> |  |
| <a id="headerfootersettings-notontitleslide" data-search="HeaderFooterSettings.notOnTitleSlide"></a>`notOnTitleSlide` | <code>boolean</code> |  |
| <a id="headerfootersettings-slidenumber" data-search="HeaderFooterSettings.slideNumber"></a>`slideNumber` | <code>boolean</code> |  |


## `LayoutChoice`

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

Import from `@reductoai/pptx/editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="layoutchoice-master" data-search="LayoutChoice.master"></a>`master` | <code>string</code> |  |
| <a id="layoutchoice-name" data-search="LayoutChoice.name"></a>`name` | <code>string</code> |  |
| <a id="layoutchoice-part" data-search="LayoutChoice.part"></a>`part` | <code>string</code> |  |


## `LayoutEvent`

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

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

```ts
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.

```ts
type LayoutProgress = (event: LayoutEvent) => void
```


## `MasterPage`

A page of Slide Master view.

Import from `@reductoai/pptx/editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="masterpage-kind" data-search="MasterPage.kind"></a>`kind` | <code>"master" &#124; "layout"</code> |  |
| <a id="masterpage-master" data-search="MasterPage.master"></a>`master` | <code>string</code> |  |
| <a id="masterpage-name" data-search="MasterPage.name"></a>`name` | <code>string</code> |  |
| <a id="masterpage-part" data-search="MasterPage.part"></a>`part` | <code>string</code> |  |


## `MediaCall`

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

Import from `@reductoai/pptx/editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="mediacall-cmd" data-search="MediaCall.cmd"></a>`cmd` | <code>"play" &#124; "toggle" &#124; "pause" &#124; "resume" &#124; "stop"</code> |  |
| <a id="mediacall-from" data-search="MediaCall.from"></a>`from?` | <code>number</code> | Seconds a `playFrom` starts at. |
| <a id="mediacall-shape" data-search="MediaCall.shape"></a>`shape` | <code>string</code> |  |


## `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 |
| --- | --- | --- |
| <a id="mediaplayback-hidewhenstopped" data-search="MediaPlayback.hideWhenStopped"></a>`hideWhenStopped` | <code>boolean</code> | Hide While Not Playing. |
| <a id="mediaplayback-mute" data-search="MediaPlayback.mute"></a>`mute` | <code>boolean</code> |  |
| <a id="mediaplayback-repeat" data-search="MediaPlayback.repeat"></a>`repeat` | <code>number</code> | Plays in a row; Infinity for Loop until Stopped. |
| <a id="mediaplayback-rewind" data-search="MediaPlayback.rewind"></a>`rewind` | <code>boolean</code> | Rewind after Playing: the poster comes back at the end. |
| <a id="mediaplayback-shape" data-search="MediaPlayback.shape"></a>`shape` | <code>string</code> |  |
| <a id="mediaplayback-volume" data-search="MediaPlayback.volume"></a>`volume` | <code>number</code> | 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 |
| --- | --- | --- |
| <a id="mediasource-mediablob" data-search="MediaSource.mediaBlob"></a>`mediaBlob()` | <code>(part: string, type?: string) =&gt; Blob &#124; null</code> |  |


## `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 |
| --- | --- | --- |
| <a id="mediatiming-clicks" data-search="MediaTiming.clicks"></a>`clicks` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#mediacall">MediaCall</a>[][]</code> | Calls each click of the main sequence makes, in order (On Click). |
| <a id="mediatiming-media" data-search="MediaTiming.media"></a>`media` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#mediaplayback">MediaPlayback</a>[]</code> |  |
| <a id="mediatiming-start" data-search="MediaTiming.start"></a>`start` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#mediacall">MediaCall</a>[]</code> | Calls when the slide comes up (Automatically). |
| <a id="mediatiming-triggers" data-search="MediaTiming.triggers"></a>`triggers` | <code>&#123; calls: <a href="/office/pptx/api/types-editor-slides-and-shows#mediacall">MediaCall</a>[]; shape: string &#125;[]</code> | 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 |
| --- | --- | --- |
| <a id="outlineslide-body" data-search="OutlineSlide.body"></a>`body` | <code><a href="/office/pptx/api/types-editor-text-and-fonts#outlineparagraph">OutlineParagraph</a>[]</code> | The paragraphs of the body, subtitle and content placeholders that hold text, in shape order. |
| <a id="outlineslide-slide" data-search="OutlineSlide.slide"></a>`slide` | <code>number</code> |  |
| <a id="outlineslide-title" data-search="OutlineSlide.title"></a>`title` | <code><a href="/office/pptx/api/types-editor-text-and-fonts#outlineparagraph">OutlineParagraph</a>[]</code> | 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 |
| --- | --- | --- |
| <a id="paintedmedia-id" data-search="PaintedMedia.id"></a>`id` | <code>string</code> | The id the picture paints under on the media page. |
| <a id="paintedmedia-windows" data-search="PaintedMedia.windows"></a>`windows` | <code>PaintWindow[]</code> |  |
| <a id="paintedmedia-image" data-search="PaintedMedia.image"></a>`image()` | <code>() =&gt; unknown</code> | The image to paint now; undefined keeps the poster. |
| <a id="paintedmedia-stamp" data-search="PaintedMedia.stamp"></a>`stamp()` | <code>() =&gt; string</code> | 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 |
| --- | --- | --- |
| <a id="sectionview-count" data-search="SectionView.count"></a>`count` | <code>number</code> |  |
| <a id="sectionview-id" data-search="SectionView.id"></a>`id` | <code>string</code> |  |
| <a id="sectionview-name" data-search="SectionView.name"></a>`name` | <code>string</code> |  |
| <a id="sectionview-start" data-search="SectionView.start"></a>`start` | <code>number</code> |  |


## `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 |
| --- | --- | --- |
| <a id="showmediapaint-page" data-search="ShowMediaPaint.page"></a>`page` | <code><a href="/office/pptx/api/types-layout#layoutpage">LayoutPage</a></code> |  |
| <a id="showmediapaint-source" data-search="ShowMediaPaint.source"></a>`source` | <code><a href="/office/pptx/api/types-layout#layoutpage">LayoutPage</a></code> |  |
| <a id="showmediapaint-videos" data-search="ShowMediaPaint.videos"></a>`videos` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#paintedmedia">PaintedMedia</a>[]</code> |  |


## `ShowMediaSource`

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

| Name | Type | Description |
| --- | --- | --- |
| <a id="showmediasource-images" data-search="ShowMediaSource.images"></a>`images` | <code>ReadonlyMap&lt;string, unknown&gt;</code> |  |
| <a id="showmediasource-objects" data-search="ShowMediaSource.objects"></a>`objects` | <code>(slide: number) =&gt; readonly <a href="/office/pptx/api/types-layout#slideobject">SlideObject</a>[]</code> |  |
| <a id="showmediasource-urls" data-search="ShowMediaSource.urls"></a>`urls` | <code><a href="/office/pptx/api/more-classes-slides-and-shows#mediaurls">MediaUrls</a></code> |  |


## `ShowMode`

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

```ts
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 |
| --- | --- | --- |
| <a id="showoptions-mode" data-search="ShowOptions.mode"></a>`mode` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#showmode">ShowMode</a></code> |  |
| <a id="showoptions-peer" data-search="ShowOptions.peer"></a>`peer?` | <code>string</code> |  |
| <a id="showoptions-start" data-search="ShowOptions.start"></a>`start` | <code>number &#124; "first"</code> |  |


## `ShowSlide`

One slide as a slide show plays it.

Import from `@reductoai/pptx/editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="showslide-advanceafterms" data-search="ShowSlide.advanceAfterMs"></a>`advanceAfterMs?` | <code>number</code> | Moves on by itself after this long on screen (`advTm`). |
| <a id="showslide-advanceonclick" data-search="ShowSlide.advanceOnClick"></a>`advanceOnClick` | <code>boolean</code> | False when a click does not move past the slide (`advClick="0"`). |
| <a id="showslide-hidden" data-search="ShowSlide.hidden"></a>`hidden` | <code>boolean</code> |  |
| <a id="showslide-media" data-search="ShowSlide.media"></a>`media` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#mediatiming">MediaTiming</a></code> | When the slide's videos and sounds play, and how. |
| <a id="showslide-notes" data-search="ShowSlide.notes"></a>`notes` | <code>string</code> |  |
| <a id="showslide-part" data-search="ShowSlide.part"></a>`part` | <code>string</code> | The slide part. |
| <a id="showslide-transition" data-search="ShowSlide.transition"></a>`transition?` | <code><a href="/office/pptx/api/types-editor-slides-and-shows#showtransition">ShowTransition</a></code> |  |


## `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 |
| --- | --- | --- |
| <a id="showtransition-dir" data-search="ShowTransition.dir"></a>`dir?` | <code>string</code> | `dir`: a side (`l`, `u`, `r`, `d`), a corner (`lu`, …), `in`/`out` or `horz`/`vert`. |
| <a id="showtransition-durationms" data-search="ShowTransition.durationMs"></a>`durationMs` | <code>number</code> |  |
| <a id="showtransition-effect" data-search="ShowTransition.effect"></a>`effect` | <code>string</code> |  |
| <a id="showtransition-orient" data-search="ShowTransition.orient"></a>`orient?` | <code>string</code> | `orient` of a split, blinds, checker or bar transition. |
| <a id="showtransition-spokes" data-search="ShowTransition.spokes"></a>`spokes?` | <code>number</code> | Spokes of a wheel. |
| <a id="showtransition-thrublk" data-search="ShowTransition.thruBlk"></a>`thruBlk?` | <code>boolean</code> | Fade and cut through black. |


## `SlideBox`

Points from the slide's top-left corner.

Import from `@reductoai/pptx-editor`.

| Name | Type | Description |
| --- | --- | --- |
| <a id="slidebox-h" data-search="SlideBox.h"></a>`h` | <code>number</code> |  |
| <a id="slidebox-w" data-search="SlideBox.w"></a>`w` | <code>number</code> |  |
| <a id="slidebox-x" data-search="SlideBox.x"></a>`x` | <code>number</code> |  |
| <a id="slidebox-y" data-search="SlideBox.y"></a>`y` | <code>number</code> |  |


## `SlideComment`

A comment thread on a slide.

Import from `@reductoai/pptx/editor`.

```ts
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 |
| --- | --- | --- |
| <a id="slidemeta-animated" data-search="SlideMeta.animated"></a>`animated` | <code>boolean</code> | It has a transition or animations. |
| <a id="slidemeta-comments" data-search="SlideMeta.comments"></a>`comments` | <code>number</code> | Open comment threads. |
| <a id="slidemeta-hidden" data-search="SlideMeta.hidden"></a>`hidden` | <code>boolean</code> |  |
| <a id="slidemeta-layout" data-search="SlideMeta.layout"></a>`layout` | <code>string</code> | The part of the slide's layout. |

Source: https://docs.reducto.ai/office/pptx/api/types-editor-slides-and-shows/index.mdx
