ONLYOFFICE Docs 9.3 開発者向けアップデート：PDF API、Office JavaScript APIの新メソッド、その他多数

ONLYOFFICE Docs 9.3では、開発者向けの多数のアップデートが提供されています。今バージョンではAPIの機能が大幅に拡張され、エディターの統合・拡張においてより高い柔軟性と制御性が実現しました。主要な強化点を詳しく解説していきます。

新しいPDFのAPIを導入

バージョン9.3における最も重要な追加機能の一つが、新しく登場したPDFのAPIです。この強力なツールセットにより、PDFドキュメントをプログラムから作成・操作することが可能になります。テキスト、画像、テーブル、図形などさまざまな要素を追加しながら、複雑なPDFファイルをゼロから構築できます。

このAPIはドキュメントの構造とコンテンツを細かく制御できるように設計されています。ページの管理、リッチテキストの書式設定、図形やその他のオブジェクトの正確な配置が可能です。これにより、ドキュメント生成の自動化や、アプリケーション内でのカスタムPDFソリューションの作成に新たな可能性が広がります。

新しいPDFファイルを作成するコードサンプルをご覧ください。

// create a PDF file with ONLYOFFICE Document Builder
builder.CreateFile("pdf")

// create a new 'oDocument' variable and get the created PDF document
const oDocument = Api.GetDocument()

// create a new paragraph for the PDF content
const oParagraph = Api.CreateParagraph()

// set the paragraph justification to center the text
oParagraph.SetJc("center")

// add a text containing a single 'Center' word to the paragraph
oParagraph.AddText("Center")

// push the paragraph to the document
oDocument.Push(oParagraph)

// save the resulting PDF document as a file in the .pdf format with the 'example.pdf' name and close it
builder.SaveFile("pdf", "example.pdf")
builder.CloseFile()

Office JavaScript APIの大幅な強化

Office JavaScript APIは大規模なアップグレードを受け、ドキュメントの自動化や操作を強化する多数の新メソッドが各モジュールに追加されました。

フォーム機能の強化

フォームを操作するための豊富なメソッドが追加されました。ボタン、チェックボックス、コンボボックス、テキストフィールドなどのフォームフィールドをプログラムから管理できるようになります。これにより、動的なフォームの作成や操作が可能になり、高度なデータ入力ソリューションの構築が容易になります。

図形・注釈機能の拡張

図形や注釈を扱うAPIが大幅に強化されました。新しいメソッドにより、形状・ジオメトリ・塗りつぶしや線などの視覚的プロパティをより細かく制御できます。具体的には、以下の管理が可能になっています。

• 注釈（キャレット、円、ハイライト、インクなど）
• ジオメトリとパス
• 塗りつぶし（グラデーション、カラー）と線

スプレッドシートAPIのApiStroke/GetFillメソッドのコードサンプルをご確認ください。

// Creates a shape with a colored border and retrieves its fill properties.
let worksheet = Api.GetActiveSheet();
let fill = Api.CreateSolidFill(Api.CreateRGBColor(255, 200, 100));
let stroke = Api.CreateStroke(2 * 36000, Api.CreateSolidFill(Api.CreateRGBColor(0, 0, 255)));
let shape = worksheet.AddShape("rect", 60 * 36000, 40 * 36000, fill, stroke, 3, 0, 2, 2);
let strokeObj = shape.GetLine();
if (strokeObj) {
    let strokeFill = strokeObj.GetFill();
    if (strokeFill) {
        worksheet.GetRange("A1").SetValue("Stroke fill type: " + strokeFill.GetType());
    }
}

チャートとテーブルメソッドの高度化

チャートとテーブルの操作がより柔軟になりました。新しいApiChartおよびApiTableメソッドにより、作成・変更に対するプログラムによる制御が強化され、よりダイナミックでデータ豊富なドキュメントを構築できます。

その他の主なJavaScript API追加機能

• フィルターとバリデーション：Autofilter、Filter、Validationの新メソッドが追加され、スプレッドシートのデータ管理が向上しました。
• 脚注と文末脚注：ドキュメントへの脚注・文末脚注の追加と管理をプログラムから行えるようになりました。
• ハイパーリンクとトランジション：ハイパーリンクやプレゼンテーションのスライドトランジションをより詳細に制御できます。

新メソッドの全一覧を確認する

プラグイン・マクロAPIの改善

バージョン9.3では、プラグイン・マクロ向けAPIにも重要なアップデートが加えられています。これらの強化により、開発者はONLYOFFICEエディタの機能をより多くの方法で拡張できるようになります。さらに強力で統合されたプラグインの作成、マクロによる複雑なワークフローの自動化、特定のユーザーニーズに合わせたカスタム機能の提供が可能です。

例えば、IsFormSignedメソッドは、指定したフォームにデジタル署名がされているかどうかを確認します。

window.Asc.plugin.executeMethod ("IsFormSigned", [], function(isSigned) {    
console.log ("Form is signed: " + isSigned);
});

新たに導入されたPDFエディタ用マクロAPIでは、ページ、フォーム、注釈、オートシェイプ、テーブル、画像、チャートの追加・削除・編集が可能です。以下は、PDF APIにおけるwindow.Asc.plugin.executeMethod内のSetMacrosメソッドの使用例です。

window.Asc.plugin.executeMethod ("SetMacros", [JSON.stringify (Content)], function () {    
window.Asc.plugin.executeCommand ("close", "");
});

プラグイン・マクロAPIの全変更履歴を確認する