API Reference

ISlideData

A presentation snapshot containing its slides, page size, themes, and metadata. Use the Slides Facade to edit a live presentation.

Import

TypeScript

import type { ISlideData } from '@univerjs-pro/slides'

Definition

TypeScript

interface ISlideData {  id: string  name: string  rev?: number  appVersion?: string  locale?: LocaleType  defaultPageSize: ISlidePageSize  slideOrder: string[]  slides: Record<string, ISlidePage>  masterPageOrder?: string[]  masterPages?: Record<string, ISlideMasterPage>  layoutPageOrder?: string[]  layoutPages?: Record<string, ISlideLayoutPage>  handoutMasterPageOrder?: string[]  handoutMasterPages?: Record<string, ISlideHandoutMasterPage>  notesMasterPageOrder?: string[]  notesMasterPages?: Record<string, ISlideNotesMasterPage>  activeSlideId?: string  transitionRecords?: Record<string, ISlideTransition>  slideTransitionRefs?: Record<string, string>  theme?: ISlideThemeData  themes?: Record<string, ISlideThemeData>  zoomRatio?: number  resources?: IResources  custom?: SlideCustomData}

Fields

`id`

Required · string

`name`

Required · string

`rev`

Optional · number | undefined

`appVersion`

Optional · string | undefined

`locale`

Optional · LocaleType | undefined

`defaultPageSize`

Required · ISlidePageSize

`slideOrder`

Required · string[]

`slides`

Required · Record<string, ISlidePage>

`masterPageOrder`

Optional · string[] | undefined

`masterPages`

Optional · Record<string, ISlideMasterPage> | undefined

`layoutPageOrder`

Optional · string[] | undefined

`layoutPages`

Optional · Record<string, ISlideLayoutPage> | undefined

`handoutMasterPageOrder`

Optional · string[] | undefined

`handoutMasterPages`

Optional · Record<string, ISlideHandoutMasterPage> | undefined

`notesMasterPageOrder`

Optional · string[] | undefined

`notesMasterPages`

Optional · Record<string, ISlideNotesMasterPage> | undefined

`activeSlideId`

Optional · string | undefined

`transitionRecords`

Optional · Record<string, ISlideTransition> | undefined

`slideTransitionRefs`

Optional · Record<string, string> | undefined

`theme`

Optional · ISlideThemeData | undefined

`themes`

Optional · Record<string, ISlideThemeData> | undefined

`zoomRatio`

Optional · number | undefined

`resources`

Optional · IResources | undefined

`custom`

Optional · SlideCustomData | undefined

Package: @univerjs-pro/slides · Type definitions

How is this guide?