# Univer Boards API

> 瞭解如何在 Univer Boards 應用程式中使用 Facade API。

- Human documentation: [https://docs.univer.ai/zh-TW/guides/boards/features/core/boards-api](https://docs.univer.ai/zh-TW/guides/boards/features/core/boards-api)

- Agent Markdown: [https://docs.univer.ai/zh-TW/guides/boards/features/core/boards-api.md](https://docs.univer.ai/zh-TW/guides/boards/features/core/boards-api.md)

- Requested language: `zh-TW`

- Content language: `zh-TW`

- Documentation version: `1.2.0`

- Source: [boards/features/core/boards-api.zh-TW.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/features/core/boards-api.zh-TW.mdx)

---

Facade API 在 Univer 服務和單元模型之上提供一層供應用程式使用的介面。您可以使用它執行常見的 Board 操作，例如建立畫板、讀取作用中頁面、新增元素、更新容器及管理泳道。

> [!WARNING: 注意]
> Board 變更 API 是同步的，並回傳 `boolean` 或可為空的控制代碼。讀取結果前請檢查回傳值。

## 啟用 Facade 進入點

Boards 以 Web SDK 外掛程式的形式發行。請匯入應用程式所用 Board 功能的 Facade 進入點：

```ts
import { FUniver } from '@univerjs/core/facade'
import '@univerjs-pro/boards/facade'
```

建立 Univer 執行個體並註冊必要的外掛程式後，再建立 API 物件：

```ts
const univerAPI = FUniver.newAPI(univer)
```

## 建立及讀取畫板

使用 `createBoard` 透過 Facade 層建立 Board 單元。在較底層的設定程式碼中，請使用 `univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot)` 建立單元。

```ts
const board = univerAPI.createBoard({
  id: 'board-demo',
  name: 'Board Demo',
})

const activeBoard = univerAPI.getActiveBoard()
const sameBoard = univerAPI.getBoard(board.getId())
```

## 繼續瞭解核心功能

回傳的 `FBoard` 物件是存取目前頁面及其內容的入口。詳細操作請繼續閱讀對應指南：

* [元素](https://docs.univer.ai/zh-TW/guides/boards/features/core/elements.md)介紹如何讀取、插入、連接、變形、排列和刪除 Board 元素。
* [容器與泳道](https://docs.univer.ai/zh-TW/guides/boards/features/core/containers.md)介紹帶邊框群組、元素隸屬和泳道結構。

## 參考資料

* [通用 API](https://docs.univer.ai/zh-TW/guides/boards/features/core/general-api.md)
* [Boards Facade 參考資料](https://docs.univer.ai/zh-TW/reference/facade/board.md)
* [Board 資料模型](https://docs.univer.ai/zh-TW/guides/boards/model/board-data.md)
* [Board 元素](https://docs.univer.ai/zh-TW/guides/boards/model/board-elements.md)