Web SDK

Univer Boards API

Univer Boards アプリケーションで Facade API を使用する方法を説明します。

Facade API は、Univer のサービスとユニットモデルをアプリケーションから利用するためのレイヤーです。ボードの作成、アクティブなページの読み取り、要素の追加、コンテナの更新、スイムレーンの管理といった一般的なボード操作に使用します。

注意

Board の変更 API は同期処理で、boolean または null 許容のハンドルを返します。戻り値を確認してください。

Facade エントリを有効にする

Boards は Web SDK プラグインとして配布されています。アプリケーションで使用するボード機能に対応した Facade エントリをインポートします。

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

Univer インスタンスと必要なプラグインを登録した後に、API オブジェクトを作成します。

TypeScript
const univerAPI = FUniver.newAPI(univer)

ボードを作成・読み取りする

Facade レイヤーを介してボードユニットを作成するには、createBoard を使用します。低レベルのセットアップコードでは、univer.createUnit(UniverInstanceType.UNIVER_BOARD, snapshot) を使用してユニットを作成します。

TypeScript
const board = univerAPI.createBoard({  id: 'board-demo',  name: 'Board Demo',})const activeBoard = univerAPI.getActiveBoard()const sameBoard = univerAPI.getBoard(board.getId())

コア機能に進む

返された FBoard オブジェクトが、アクティブページとそのコンテンツの入口です。詳しい操作は次のガイドを参照してください。

  • 要素では、Board 要素の読み取り、挿入、接続、変形、配置、削除を説明します。
  • コンテナーとスイムレーンでは、枠付きグループ、所属関係、スイムレーン構造を説明します。

リファレンス

このガイドはいかがですか？

© 2026 DreamNum Co., Ltd.