クイックスタート

Univer Boards をインストールする前に、API とドキュメント全体で使われる 4 つの概念を確認します。これらは、Board の構成、保存、変更、操作の仕組みを表します。

基本概念

プラグイン

Univer の機能はプラグインとして提供されます。@univerjs-pro/boards は Board モデル、コマンド、UniverBoardsPlugin を提供し、@univerjs-pro/boards-ui はキャンバス、編集 UI、UniverBoardsUIPlugin を提供します。リッチテキスト、描画、インク、図形編集のパッケージは、セットアップ時に登録する技術的なレンダリング依存関係です。ほかの Univer 製品について事前に知っている必要はありません。表とマインドマップの要素は任意の Board プラグインです。

アプリケーションに必要な製品プラグインだけを登録してください。インストールガイドに、ブラウザー向けの完全な設定と依存関係を掲載しています。

スナップショットとデータモデル

IBoardData は 1 つの Board ユニットを永続化する形式です。ページは pages、その順序は pageOrder に保存されます。各ページでは、要素を elements、描画順を elementOrder に保存します。リソース、テーマ、アクティブページ、ズーム、Board 設定もスナップショットに含まれます。

スナップショットは Board の作成、保存、復元に使用します。ユニットの起動後は、スナップショットオブジェクトを直接変更しないでください。スキーマについては Board のデータ構造と Board 要素を参照してください。

コマンド

実行中の変更はコマンドを経由します。コマンド層または Facade 層で要素の挿入、変形、コンテナーへの移動、ページ状態の変更を行うことで、モデル、キャンバス、元に戻す/やり直す、共同編集の経路が一致します。

アプリケーションコードでは Facade API を優先してください。Facade が公開していない低レベルの統合が必要な場合に限り、コマンド ID を直接使用します。

Facade API

Facade API は FBoard と要素ハンドルを通じて Board のコマンド層とモデル層をラップします。@univerjs-pro/boards/facade をインポートし、プラグイン登録後に FUniver.newAPI(univer) で API を作成します。これにより Board の作成や取得、アクティブページと要素の参照、コンテナーとスイムレーンの管理ができます。

次にインストールと基本的な使い方へ進み、Boards Facade API ガイドで Board コンテンツの作成と編集を確認してください。