# IBoardData

- Human documentation: [https://docs.univer.ai/reference/types/board-data](https://docs.univer.ai/reference/types/board-data)

- Agent Markdown: [https://docs.univer.ai/reference/types/board-data.md](https://docs.univer.ai/reference/types/board-data.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [types/board-data.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/types/board-data.mdx)

---

A whiteboard snapshot. Use the [Boards Facade](https://docs.univer.ai/reference/facade/board.md) to manipulate live board elements and serialize the result.

## Import

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

## Definition

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

## Related types

* [`IBoardPageSize`](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)
* [`IBoardPage`](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)
* [`Record`](https://unpkg.com/@typescript/typescript-darwin-arm64@7.0.2/lib/lib.es5.d.ts)
* [`IBoardTransitionData`](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)
* [`IBoardThemeData`](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)
* [`IResources`](https://unpkg.com/@univerjs/core@1.0.0-rc.0/lib/types/services/resource-manager/type.d.ts)
* [`BoardCustomData`](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)

**Package:** [`@univerjs-pro/boards`](https://docs.univer.ai/reference/packages/plugins/univerjs-pro/boards.md) · [Type definitions](https://unpkg.com/@univerjs-pro/boards@1.0.0-rc.0/lib/types/board.type.d.ts)