Univer Boards の概要

Univer Boards とは

Univer Boards は、Univer Office SDK のキャンバス製品です。ドキュメントがグリッド、ページ、スライドデッキのいずれでもなく、自由形式のワークスペースである場合に使用します。ホワイトボード、図、付箋、コネクタ、埋め込みテーブル、マインドマップは、すべてここで扱えます。

Univer Office SDK は、埋め込みエディターとヘッドレスのコンテンツ処理を提供する Web SDK、共同編集とファイルのインポート・エクスポートを提供する Server SDK、エージェントのワークフローを提供する AI SDK で構成されます。

Boards は、独立した Web SDK ユニットタイプとして実装されています。実行時に UniverInstanceType.UNIVER_BOARD ユニットを作成し、サポートする要素に必要なモデルプラグインと UI プラグインを登録します。

ブラウザ互換性

Web SDK は Chrome 88 をターゲットとしてコンパイルされていますが、これはすべての主流環境を完全にサポートすることを保証するものではありません。Web SDK が以下のブラウザおよび Node.js 環境で問題なく動作するよう努めています。

互換性に関する問題が発生した場合、まずは適切なポリフィルを使用して解決を試みてください。それでも問題が解決しない場合は、Issue の提出 をご検討ください。

Node.js 互換性

Web SDK は Node.js 環境でも動作可能で、v18.17.0 以降のバージョンをサポートしています。

主な機能

• ページと要素の順序：ページを pages に、描画可能なオブジェクトを各ページの elements に保存し、両方の階層で明示的な順序配列を使用します。
• キャンバス要素：テキスト、図形、画像、コネクター、グループ、コンテナ、スイムレーンを扱います。
• コマンド駆動の編集：要素の変更、順序、親子関係を 1 つのコマンド層に集約し、権限と、任意の履歴・コラボレーション統合用フックを提供します。
• ブラウザーキャンバス：要素を描画し、選択、変形、クリップボード、テキスト編集、ビューポート操作、パネルを提供します。
• 拡張可能なアダプター：表、マインドマップ、グラフ、リソース、印刷、交換などの任意の Boards 機能を追加できます。
• 永続化：ページ、リソース、テーマ、アクティブページの状態を含む IBoardData スナップショットを作成、復元、保存します。

ドキュメントの読み方

画面左側にドキュメントのナビゲーションがあります。ページは基礎から応用へ順に構成されているため、その順で進めてもよいですし、必要な章だけを選んで読むこともできます。サイドバー上部で Univer Boards のドキュメントに切り替えることもできます。

画面右側には現在ページの目次が表示されます。目的のページを素早く見つけたい場合は、上部の検索バーや検索ショートカット（Ctrl+K または Cmd+K）を利用してください。

まずは クイックスタート から始めることをおすすめします。

前提知識

ドキュメントは初心者にも分かりやすく設計していますが、Web SDK に集中できるよう、読み始める前にいくつかの基礎知識があることを前提としています。

効率よく理解するために、JavaScript とそのエコシステムの基本的な理解をおすすめします。

Node.js 上で Web SDK を動かしたい場合は、Node.js の基礎知識も必要です。

共同編集、共有履歴やコメント、ファイル変換が必要な場合は、Univer Server SDK の必要なモジュールをアプリのバックエンドに組み込みます。認証、権限、ストレージ、デプロイはアプリ側で用意します。ブラウザー内の編集だけなら、これらのサービスは不要です。

Univer Boards を拡張する

Web SDK は拡張性を重視して設計されているため、ニーズに合わせて自由にカスタマイズできます。