この Topic では、WebOfficeWidget の使用方法について説明します。
1. コンストラクターの設定
ウィジェットの iframe のマウントポイントとスタイルを設定します。
デフォルトでは、iframe は body 要素にマウントされます。必要に応じて、iframe のマウントポイントをカスタマイズできます。例:
<div id="container"></div>import { WebOfficeWidget } from 'aliyun-pds-js-widget';
const domain_id = 'bj1'; // ドメイン ID。
const token_info = {
access_token: 'xxxxx',
refresh_token: 'xxxxx',
// ...
};
const widgetOpts = {
widget_endpoint: `https://${domain_id}.apps.aliyunpds.com`,
api_endpoint: `https://${domain_id}.api.aliyunpds.com`,
// マウントポイント。
container: document.querySelector('#container'),
// カスタムスタイル。
iframe_style: {
width: '100%',
height: '100%',
},
// 埋め込みページ。
module: 'office/viewer',
token_info,
// 更新されたトークンを取得する関数を設定します。
refresh_token_fun: async () => {
// ビジネス処理ロジック。サーバー上でカプセル化されている refreshToken 操作を呼び出します。
// new_token_info サーバーから新しいトークンを取得します。
// let new_token_info = await fetch(.....)
return new_token_info;
},
domain_id,
drive_id: '1', // ドキュメントが配置されているドライブの ID。
file_id: 'xxxx', // ドキュメントの ID。
};
const ins = new WebOfficeWidget(widgetOpts);
WebOfficeWidget コンストラクター パラメーター
パラメーター | タイプ | 必須 | 説明 |
module | string | はい | コンポーネント名。有効な値:
|
widget_endpoint | string | はい | コンポーネントにアクセスするために使用される URL。ほとんどの場合、このパラメーターの値は、アプリケーションをホストするドメイン名です。 |
api_endpoint | string | はい | PDS のバックエンド API のドメイン名。 |
container | string または HTMLElement | はい | コンポーネントのマウントに使用する要素。 |
lang | string | 言語。有効な値:zh_CN および en_US。初回は、ブラウザーの navigator.language プロパティで指定された言語がデフォルトで使用されます。 | |
token_info | Object | はい | アクセストークン。トークン JSON オブジェクトを渡します。 |
share_token | string | リソースを共有するときに必要な、共有用のアクセストークン。 | |
refresh_token_fun | Function | はい | アクセストークンの有効期限が切れたときに更新するために使用されるメソッド。メソッドが呼び出されると、新しいアクセストークンが返されます。 |
refresh_share_token_fun | Function | 共有用アクセストークンの有効期限が切れたときに更新するために使用されるメソッド。メソッドが呼び出されると、共有用の新しいアクセストークンが返されます。 | |
iframe_style | Object | カスタム iframe スタイル。 | |
iframe_attr | Object | カスタム iframe 属性。 | |
domain_id | string | はい | ドメイン ID。 |
drive_id | string | ドライブ ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。 | |
share_id | string | 共有 ID。 drive_id パラメーターと share_id パラメーターのいずれかを指定する必要があります。 | |
file_id | string | はい | ドキュメントの ID。 |
revision_id | string | 複数バージョンを持つドキュメントのバージョン ID。 |
2. インスタンスメソッド
サンプルコード:
const ins = new WebOfficeWidget(widgetOpts)
// メソッドを呼び出します。
ins.setLang('zh_CN')WebOfficeWidget でサポートされているメソッド
メソッド | 説明 | パラメーターの説明 |
setToken | コンポーネントのログオン状態を設定します。 | トークン情報を含む JSON オブジェクト。 |
removeToken | コンポーネントのログオン状態をクリアします。 | 該当なし |
setLang | コンポーネントの言語を設定します。 | 言語を示す文字列。ハイフン (-) をアンダースコア (_) に置き換えます。たとえば、簡体字中国語を使用する場合は、値を zh_CN に設定します。これは、ブラウザーの zh-CN に対応します。 |
setShareToken | コンポーネントの共有トークンを設定します。 | string |
on | イベントをリッスンします。 | 詳細は以下を参照してください。 |
destroy | コンポーネントを破棄します。 | 該当なし |
3. イベントをリッスンする
コンポーネントのイベントリスニングを有効にします。コンポーネントで特定のイベントが発生すると、対応するコールバックが返されます。
サンプルコード:
const ins = new WebOfficeWidget(widgetOpts);
ins.on('Event name', function(data) {
// 処理を実行...
})サポートされているイベント
イベント | 説明 | ペイロード パラメーター |
load | コンポーネントがレンダリングされ、初めてトリガーされます。 | 該当なし |
error | コンポーネントエラーが発生します。 | コンポーネントエラーが発生したときにトリガーされるオブジェクト。例:{code: "TokenExpired", mesage:"xxx"}。 |
tokenChanged | コンポーネントのトークンが変更されます。 |
|
shareTokenChanged | コンポーネントの共有トークンが変更されます。 |
|
langChanged | コンポーネントの言語が変更されます。 |
|
特定のエラーイベントのエラーコード
TokenInvalid: トークンが無効または指定されていません。
TokenExpired: トークンの有効期限が切れています。
その他のエラーコードについては、エラー処理 をご参照ください。