# ワークブックデータ構造

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

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

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.1.0`

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

---

## IWorkbookData

[`IWorkbookData`](https://docs.univer.ai/ja-JP/reference/types/workbook-data.md) は Univer Sheet におけるワークブックのスナップショットを表します。

### プロパティ

| プロパティ      | タイプ                                              | 説明                      |
| ---------- | ------------------------------------------------ | ----------------------- |
| 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: 'My Workbook',
  appVersion: '0.10.2',
  locale: LocaleType.JA_JP,
  styles: {/* スタイル定義 */},
  sheetOrder: ['sheet1', 'sheet2'],
  sheets: {
    sheet1: {/* シートデータ */},
    sheet2: {/* シートデータ */},
  },
}
```

### 使い方

IWorkbookData は Univer Sheets でデータを格納するために使用されるオブジェクトです。主に以下の用途で使用されます：

1. [IWorkbookData を使用した Univer Sheets の作成](https://docs.univer.ai/ja-JP/guides/sheets/features/core/sheets-api.md#create-worksheet)
2. [Univer Sheets からの IWorkbookData の保存](https://docs.univer.ai/ja-JP/guides/sheets/features/core/sheets-api.md#get-workbook-data)

`resources` プロパティはプラグインデータを格納するために使用されます。[プラグインカスタムモデル](/blog/custom-model) を参照してください