API Reference

IBoardData

A whiteboard snapshot. Use the Boards Facade to manipulate live board elements and serialize the result.

Import

TypeScript

import type { IBoardData } from '@univerjs-pro/boards'

Definition

TypeScript

interface IBoardData {  id: string  rev?: number  name: string  appVersion: string  locale?: string  defaultPageSize: IBoardPageSize  pageOrder: string[]  pages: Record<string, IBoardPage>  activePageId?: string  slideOrder?: string[]  slides?: Record<string, IBoardPage>  masterPageOrder?: string[]  masterPages?: Record<string, IBoardPage>  layoutPageOrder?: string[]  layoutPages?: Record<string, IBoardPage>  handoutMasterPageOrder?: string[]  handoutMasterPages?: Record<string, IBoardPage>  notesMasterPageOrder?: string[]  notesMasterPages?: Record<string, IBoardPage>  activeSlideId?: string  transitionRecords?: Record<string, IBoardTransitionData>  slideTransitionRefs?: Record<string, string>  theme?: IBoardThemeData  themes?: Record<string, IBoardThemeData>  zoomRatio?: number  resources?: IResources  custom?: BoardCustomData}

Fields

`id`

Required · string

`rev`

Optional · number | undefined

`name`

Required · string

`appVersion`

Required · string

`locale`

Optional · string | undefined

`defaultPageSize`

Required · IBoardPageSize

`pageOrder`

Required · string[]

`pages`

Required · Record<string, IBoardPage>

`activePageId`

Optional · string | undefined

`slideOrder`

Optional · string[] | undefined

`slides`

Optional · Record<string, IBoardPage> | undefined

`masterPageOrder`

Optional · string[] | undefined

`masterPages`

Optional · Record<string, IBoardPage> | undefined

`layoutPageOrder`

Optional · string[] | undefined

`layoutPages`

Optional · Record<string, IBoardPage> | undefined

`handoutMasterPageOrder`

Optional · string[] | undefined

`handoutMasterPages`

Optional · Record<string, IBoardPage> | undefined

`notesMasterPageOrder`

Optional · string[] | undefined

`notesMasterPages`

Optional · Record<string, IBoardPage> | undefined

`activeSlideId`

Optional · string | undefined

`transitionRecords`

Optional · Record<string, IBoardTransitionData> | undefined

`slideTransitionRefs`

Optional · Record<string, string> | undefined

`theme`

Optional · IBoardThemeData | undefined

`themes`

Optional · Record<string, IBoardThemeData> | undefined

`zoomRatio`

Optional · number | undefined

`resources`

Optional · IResources | undefined

`custom`

Optional · BoardCustomData | undefined

Package: @univerjs-pro/boards · Type definitions

How is this guide?