# 活頁簿資料結構

- Human documentation: [https://docs.univer.ai/zh-TW/guides/sheets/model/workbook-data](https://docs.univer.ai/zh-TW/guides/sheets/model/workbook-data)

- Agent Markdown: [https://docs.univer.ai/zh-TW/guides/sheets/model/workbook-data.md](https://docs.univer.ai/zh-TW/guides/sheets/model/workbook-data.md)

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

- Source: [sheets/model/workbook-data.zh-TW.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/sheets/model/workbook-data.zh-TW.mdx)

---

## IWorkbookData

[`IWorkbookData`](https://docs.univer.ai/zh-TW/reference/types/workbook-data.md) 表示 Univer Sheets 中活頁簿的快照。

### 屬性

| 屬性         | 類型                                               | 說明                    |
| ---------- | ------------------------------------------------ | --------------------- |
| id         | `string`                                         | Univer Sheets 的唯一識別碼。 |
| name       | `string`                                         | Univer Sheets 的名稱。    |
| appVersion | `string`                                         | Univer 模型定義的版本。       |
| locale     | `LocaleType`                                     | 文件的語言環境。              |
| styles     | `Record<string, Nullable<IStyleData>>`           | 活頁簿的樣式引用。             |
| sheetOrder | `string[]`                                       | 代表工作表順序的工作表 ID 陣列。    |
| sheets     | `{ [sheetId: string]: Partial<IWorksheetData> }` | 包含各工作表資料的紀錄。          |
| resources? | `IResources`                                     | 儲存外掛的資料。              |

### 範例

```typescript
const workbookData: IWorkbookData = {
  id: 'unique-workbook-id',
  name: '我的活頁簿',
  appVersion: '0.10.2',
  locale: LocaleType.ZH_TW,
  styles: {/* 樣式定義 */},
  sheetOrder: ['sheet1', 'sheet2'],
  sheets: {
    sheet1: {/* 工作表資料 */},
    sheet2: {/* 工作表資料 */},
  },
}
```

### 用法

IWorkbookData 是 Univer Sheets 用於儲存資料的物件。主要用於

1. [使用 IWorkbookData 建立 Univer Sheets](https://docs.univer.ai/zh-TW/guides/sheets/features/core/sheets-api.md#create-worksheet)
2. [自 Univer Sheets 儲存 IWorkbookData](https://docs.univer.ai/zh-TW/guides/sheets/features/core/sheets-api.md#get-workbook-data)

`resources` 屬性用於儲存外掛的資料。前往 [外掛自訂模型](/blog/custom-model) 瞭解更多。