開発者向けONLYOFFICE Docs 8.0：APIとDoc Builderのアップデート

2024年02月05日著者：Denis

バージョン8.0の新機能リリースに伴い、エディタ、ドキュメントビルダー、プラグインのAPIを更新しました。詳細は以下をご覧ください。

ONLYOFFICE Docs 8.0 for developers: API and Doc Builder updates

PDFのサポート

documentTypeパラメータにpdfドキュメントタイプを追加しました。これは、記入可能なフィールドを含むPDFファイル*が完全にサポートされ、ONLYOFFICE PDFエディタで注釈や記入のために開くことができるようになったことを意味します。以前はそのようなファイルはドキュメントとして認識され、ドキュメントエディタで開かれていました。

var docEditor = new DocsAPI.DocEditor("placeholder", {     
    "documentType": "pdf",

*DjVu、OXPS、XPSにも対応しています。

フォームを操作するためのAPI

コールバックハンドラに追加された formsdataurl パラメータにより、送信されたフォームデータを含む JSON ファイルの URL を定義できます。このファイルには以下のパラメータが含まれます：

キー
タグ
値
タイプ (text、checkBox、picture、comboBox、dropDownList、dateTime、radio)

さらに、DocBuilder API には新しいフォーム・メソッドがあります：

ApiDocument/GetFormsData：現在のドキュメントに存在するすべてのフォームのデータを返します；
ApiDocument/SetFormsData：指定されたフォームにデータを設定します。

builder.CreateFile("docx"); 
var oDocument = Api.GetDocument(); 
var oParagraph1 = oDocument.GetElement(0); 
var oCheckBox = Api.CreateCheckBoxForm({"key": "BestCompany"}); 
oParagraph1.Push(oCheckBox); 
var oTextForm = Api.CreateTextForm({"key": "CompanyName"}); 
oParagraph1.Push(oTextForm); 
oDocument.SetFormsData([    
   {"key": "BestCompany", "value": true},     
   {"key": "CompanyName", "value": "ONLYOFFICE"} 
]); 
builder.SaveFile("docx", "SetFormsData.docx"); 
builder.CloseFile();

WOPIサポートの強化

最新リリースでは、ブラウザからサーバへのリクエストに追加されるWOPISrcクエリパラメータが追加されました。これにより、ONLYOFFICEの複数の独立したインスタンスを作成することができます。WOPISrcによるロードバランシングリクエストは、共同編集が正しく機能することを保証します：同じドキュメントを編集している全てのユーザーは、同じサーバーからサービスを受けます。

WOPIについては、インテグレータから送信されたパラメータが使用されます。Docs API については、document.key パラメータが WOPISrc に書き込まれます。

変換API

変換リクエストに追加された watermark フィールドは、変換中にPDF・画像ファイルに挿入されるしおりのプロパティを含む JSON オブジェクトを定義します。

"async": false,    
"filetype": "docx",     
"key": "Khirz6zTPdfd7",     
"outputtype": "pdf",     
"title": "Example Document Title.docx",     
"url": "https://example.com/url-to-example-document.docx",     
"watermark": {         
  "align": 1,         
  "fill": [255, 0, 0],        
  "height": 100,        
  "margins": [ 10, 10, 10, 10 ],
  ...

OracleおよびMicrosoft SQL Serverデータベースのサポート

サポートされているデータベースには、Oracle と Microsoft SQL Server があります。接続するには、データベースタイプをoracle / mssqlに変更してください。Dockerの場合は、DB_TYPEパラメータを調整する必要があります。

そのほかにも以下のデータベースも利用できます：

oracle用の高度な接続設定 – oracleExtraOptions
mssql用の高度な接続設定 – msSqlExtraOptions

ユーザーアバター

バージョン8.0から、エディタに表示されるユーザーアバターを追加して、チームをより見やすくすることができるようになりました。

このため、setUsers メソッドと onRequestUsers イベントに info オペレーション・タイプが追加され、data.idパラメータで指定された ID を持つユーザのアバターが設定されます。また、新しく追加されたusers.imageフィールドは、ユーザーアバターへのパスを定義します。

var onRequestUsers = function (event) {     
   var c = event.data.c;     
   var id = event.data.id;    
   ...      
docEditor.setUsers({         
   "c": event.data.c,         
   "users": [             
     {                 
     "email": "john@example.com",                 
     "id": "78e1e841",                 
     "image": "https://example.com/url-to-user-avatar1.png",                 
     "name": "John Smith"             
     },

さらに、editorConfig.userパラメータにユーザーアバターへのパスを定義するimageフィールドが追加されました：

var docEditor = new DocsAPI.DocEditor("placeholder", {    
"editorConfig": {
...
    "user": {             
    "group": "Group1",             
    "id": "78e1e841",             
    "image": "https://example.com/url-to-user-avatar.png",             
    "name": "John Smith"         
     }

エディタ用APIのさらなる更新

editorConfig.customization.mobileForceView パラメータで、起動時にモバイルドキュメントエディタを表示/編集モードで開くかどうかを定義できるようになりました。デフォルト値はtrueです。
events.onRequestReferenceDataイベントに送られるデータオブジェクトのリンクフィールド。

ONLYOFFICE Docs Developerの最新バージョンを入手：

今すぐダウンロド