APIまとめ:ONLYOFFICE Docsの最新アップデート
私たちは、カスタマイズ性、互換性、セキュリティの向上を目的とした一連のAPIアップデートをONLYOFFICE Docsに展開しました。カスタムワークフローの構築、安全なドキュメントコラボレーションの実現、先進的な API との統合など、これらの強化機能により無限の可能性が広がります。以下では、最新の追加機能と改善点を詳しくご紹介します。
対応ファイル形式の拡張
Docs API は、ユーザーがさまざまなファイル形式をシームレスに扱えるよう、さらなるファイル形式のサポートを追加しました。対応形式には Apple iWork や Hancom Office 形式が含まれます:
pages
key
numbers
hwp
hwpx
これらの形式はdocumentTypeプロパティで指定できます。例:
const config = {
documentType: "pages",
カスタマイズオプションの強化
開発者はエディタの動作や外観をより細かく制御できるようになりました。主な更新内容は以下の通りです:
- 機能チップの非表示
editorConfig.customization.features.featuresTips パラメータで、新機能のツールチップを初回ロード時に表示するかどうかを切り替えられます。デフォルトは true
です。
- スプレッドシートのスクロールバー表示
バージョン 8.3 以降では、スプレッドシートエディタ読み込み時に水平/垂直スクロールバーを自動表示または非表示に設定できます。showHorizontalScroll および showVerticalScroll をご確認ください。
- プレゼンテーションスライドショーの背景色
slidePlayerBackground パラメータで、HEX、RGB、RGBA の形式でスライドショー背景色を指定できます。例:#ff0000, rgb(255,0,0), rgba(255,0,0,0.5)
showHorizontalScroll: true,
showVerticalScroll: true,
slidePlayerBackground: "#000000",
- 文書見出しの色
wordHeadingsColor パラメータで、エディタ内の見出しスタイルの色を HEX 形式でカスタマイズできます。
- モバイル版 Info ボタン
editorConfig.customization.mobile.info で、モバイルエディタの「ドキュメント情報」ボタン表示を切り替えられます。デフォルトは false
です。
- ポインタモード
pointerMode パラメータで、ビューワーのポインタモード(select または hand)を設定できます。デフォルトは select
です。
- ビューワーのコンパクトツールバー
compactToolbar パラメータがビューモードにも対応し、フル/コンパクトのツールバー切り替えが可能になりました。ビューモードのデフォルトは true
です。
セキュリティ機能の強化
Docs API ではパスワード保護ファイルの対応として、events.onUserActionRequired イベントを追加しました。ユーザー操作が必要な以下のケースで呼び出されます:
- 保護されたドキュメントを開くためにパスワード入力が必要な場合
- TXT ファイルの文字エンコーディングを選択する必要がある場合
- CSV ファイルの文字エンコーディングおよび区切り文字を選択する必要がある場合
イベントの使用例:
function onUserActionRequired() {
console.log("Enter a password")
};
const config = {
events: {
onUserActionRequired,
},
};
const docEditor = new DocsAPI.DocEditor("placeholder", config);
さらに、drop コマンドで特定ユーザーの編集権限を禁止できるようになりました:
{
"c": "drop",
"key": "Khirz6zTPdfd7",
"users": ["6d5a81d0"]
}
詳しい Docs API の変更履歴は こちら をご覧ください。
新しい Office API メソッド
Office API にはドキュメント管理機能の強化として、以下の更新が含まれます:
- Bookmarks
- Content Controls
- Sections
- Autofilters
- Selection
- その他多数
これらにより、よりリッチな操作体験が可能になります。詳細は Office API 変更履歴 をご確認ください。
Plugins API の更新
プラグイン機能を拡張する新しいメソッドとプロパティが追加されました:
- コンテンツ取得
GetSelectedContent メソッドで、指定した形式の選択コンテンツを取得できます。
expression.GetSelectedContent(prop);
- エラーメッセージ表示
ShowError メソッドで、プラグイン内にエラーや警告メッセージを表示できます。
expression.ShowError(error, level);
- Content Control プロパティ強化
新プロパティ Shd
(背景シェーディング)と Border
が ContentControlProperties オブジェクトに追加され、ビジュアルカスタマイズが向上しました。
- パネル起動状態
isActivated パラメータで、プラグインパネルの展開(true
)または折りたたみ(false
)初期設定を指定できます。
プラグイン API 更新の全一覧は こちら をご覧ください。
ONLYOFFICEの無料アカウントを登録する
オンラインでドキュメント、スプレッドシート、スライド、フォーム、PDFファイルの閲覧、編集、共同作業