開発者向けONLYOFFICE Docs 7.2:ライブビューアを有効にする方法

2022年10月14日著者:Denis

ONLYOFFICE Docsのバージョン7.2で追加されたライブビューアは、テキスト文書、スプレッドシート、スライドを「閲覧のみ」のモードで開いたときに、他の共同作業者が行った変更をリアルタイムで見ることができるようにします。お使いのインスタンスで有効にする方法をご覧ください。

ONLYOFFICE Docs 7.2 for developers: how to enable live viewer

起動方法

editorConfig.coEditingのパラメータに、以下のような組み合わせで表示モードを設定してください。

{mode: ‘fast’, change: true} は、ライブビューアを有効にし、ページの再読み込みなしでオフライン(基本)ビューアに切り替え、戻ることができます。この場合、ライブビューアはユーザーのデフォルトで有効になります。

"coEditing": {
"mode": "fast",
"change": true
}

ONLYOFFICE Docs 7.2 for developers: how to enable live viewer

この設定をエディタインタフェースで無効にするには、ユーザーは「閲覧のみ」のモードでドキュメントを開き、「ファイル」→「詳細設定」→「コラボレーション」に切り替えて、「他のユーザーの変更点を表示する」の設定のチェックを外す必要があります。

{mode: ‘fast’, change: false} は、オフライン・ビューワに切り替えることなく、ライブ・ビューワを有効にします。

"coEditing": { 
    "mode": "fast", 
    "change": false
}

{mode: ‘strict’, change: true} :デフォルトでは基本ビューアが開きますが、詳細設定でライブビューアにモードを切り替えることができます。

"coEditing": { 
    "mode": "strict", 
    "change": true
}

{mode: ‘strict’, change: false} :オフラインビューアは、ライブビューアに切り替えることなく、デフォルトで開かれます。

"coEditing": { 
    "mode": "strict", 
    "change": false
}

ライブビューアには新しいライセンスが必要?

ライブビューアのサーバー接続数は別途カウントされ、新しいライセンスではconnection_viewフィールドで制限されます。 古いライセンスでは、ライブビューアは使用できません。しかし、ONLYOFFICE Docs v.7.2と新しいライセンスを取得した場合、ライブビューアは既存の統合機能で動作します。

モバイルライブビューアの設定方法

モバイルエディタでは、パラメータを操作する方式はウェブ版と同じです。唯一の違いは、ユーザーが表示モードを変更することを許可しないことです(そのため、設定に「他のユーザーからの変更を表示する」オプションはありません)。

ライブビューアに制限はある?

以下の場合は、基本ビューアのみが使用されます。

カーソル表示の調整方法

ライブビューアでは、 document.permissions.userInfoGroups パラメータを設定することで、他のユーザのカーソルを表示することができます。変更内容は編集モードと同じように表示されます。