Intelligent Media Management:パラメーター設定

設定方法 パラメーター

aliyun.config({
  url: 'Address for online preview or editing',
  // その他の設定パラメーター。
})

パラメーター

次の表に、サポートされている設定パラメーターを示します。

表示モード

modeパラメーターを設定して表示モードを設定します。

• 例

  aliyun.config({
    mode: 'normal',
  });

• 説明

  パラメーター	説明
  mode	表示モード。有効な値： normal：通常モード。このモードでは、すべての機能が表示されます。これはデフォルト値です。 simple：シンプルモード。このモードでは、ヘッダーとツールバーは表示されません。

ページのカスタマイズ

commandBarsパラメーターを設定して、ページコンポーネントを非表示、表示、無効、または有効にします。

• 例

  次のサンプルコードは、ページの左上隅にあるボタンを非表示にします。

  aliyun.config({
    // 複数のコンポーネントのステータスを同時に設定できます。
    commandBars: [
      {
        cmbId: 'HeaderLeft', // コンポーネントID。
        attributes: {
          visible: false, // コンポーネントを非表示にします。
          enable: false, // コンポーネントを無効にします。コンポーネントは表示されますが、クリックイベントには応答しません。
        },
      },
    ],
  })

• 注意事項

  • cmbIdパラメーターは、コンポーネントIDを表します。コンポーネントIDの詳細については、カスタマイズ可能なコンポーネントを参照してください。

  • 次の表は、コンポーネントのステータスを設定するために使用されるattributesパラメーターについて説明しています。

    パラメーター	タイプ	説明
    visible	boolean	コンポーネントを表示するかどうかを指定します。有効な値： true：コンポーネントを表示します。 false：コンポーネントを表示しません。
    enable	boolean	コンポーネントを有効にするかどうかを指定します。有効な値： true：コンポーネントを有効にします。 false：コンポーネントを無効にします。コンポーネントは表示されますが、クリックイベントには応答しません。

コンポーネントステータスを動的に更新する

初期化中にのみ有効になる設定に加えて、JS-SDKはコンポーネントステータスを動的に更新するためのAPI操作も提供します。次のサンプルコードを参照してください。

const instance = aliyun.config({
  // ...
})

instance.setCommandBars([
  {
    cmbId: 'コンポーネントID',
    attributes: { visible: false, enable: false },
  },
])

コンポーネントコマンドを実行する

executeCommandBarメソッドを呼び出して、コンポーネントコマンドを実行できます。次のサンプルコードを参照してください。

const instance = aliyun.config({
  // ...
})

// コマンドが実行される前に、コンポーネントの準備ができるまで待ちます。
await instance.ready()

// 上部ツールバーのブックマークボタンを自動的にクリックして、ブックマークパネルを開きます。
instance.executeCommandBar('BookMark')

共同作業者の設定

cooperUserAttributeを設定して、共同作業者のプロフィール写真とカーソル色を表示または非表示にします。

• 例

  const instance = aliyun.config({
    cooperUserAttribute: {
      isCooperUsersAvatarVisible: true, // 共同作業者のプロフィール写真を表示します。
      cooperUsersColor: [{
        userId: 'testuid', // ユーザーID。
        color: '#F65B90' // カーソル色。
      }],
    },
  });

• パラメーター

  パラメーター	タイプ	説明
  isCooperUsersAvatarVisible	boolean	共同作業者のプロフィール写真を表示するかどうかを指定します。有効な値： true：プロフィール写真を表示します。 false：プロフィール写真を表示しません。
  cooperUsersColor	array	共同作業者のカーソル色。値はJSON配列です。次のサンプルコードを参照してください。 userId：文字列型の値で指定されたユーザーID。 color：文字列型の値で指定されたカーソル色。

共同作業者のカーソル色を動的に設定する

初期化中にのみ有効になる設定に加えて、JS-SDKは共同作業者のカーソル色を動的に設定するためのAPI操作も提供します。次のサンプルコードを参照してください。

await instance.ready()
instance.setCooperUserColor([
  { userId: 'testuid1', color: '#333333' },
  { userId: 'testuid2', color: '#666666' },
])

クリップボードイベントをリッスンする

getClipboardDataパラメーターを設定して、モバイルアプリケーションがシステムクリップボードからデータを取得できるようにします。

ドキュメントにコンテンツを貼り付けるときに、getClipboardData関数を渡してシステムクリップボードデータを取得し、objectまたはpromiseオブジェクトを返すことができます。次のサンプルコードを参照してください。

aliyun.config({
  // システムクリップボードデータ関数を取得します。
  getClipboardData: () => {
    // データを処理します。

    return Promise.resolve({
      text: 'test-text', // TEXT形式のデータ。
      html: test-html, // HTML形式のデータ。表ドキュメントのみがこの形式をサポートしています。
      updateExternal: true, // データが内部クリップボードからコピーされたかどうかを指定します。trueは外部クリップボードからコピーされたデータを示します。falseは内部クリップボードからコピーされたデータを示します。
    })
  },
})

トーストメッセージイベントをリッスンする

onToastパラメーターを設定して、トーストメッセージを無効にし、トーストメッセージのカスタムスタイルを取得します。次のサンプルコードを参照してください。

// トーストメッセージインターセプト関数を設定します。
aliyun.config({
  onToast: ({ msg, action }) => {
    // データを処理します。
    console.log('msg: ', msg) // メッセージ。
    console.log('action: ', action) // アクション。
  },
})

次の表は、actionパラメーターについて説明しています。

外部リンクへのリダイレクトをリッスンする

onHyperLinkOpenパラメーターを設定して、外部リンクへのリダイレクトをインターセプトし、リンク情報を取得して処理します。次のサンプルコードを参照してください。

// 外部リンクへのリダイレクトのインターセプト関数を設定します。
aliyun.config({
  onHyperLinkOpen: ({ linkUrl }) => {
    // データを処理します。
    console.log('linkUrl: ', linkUrl) // 外部リンク。
  },
})

共通コンポーネント設定

commonOptionsパラメーターを設定して、特定の機能を有効または無効にし、開かれたドキュメントのステータスを制御します。

• パラメーター

  パラメーター	説明
  isShowTopArea	上部領域を表示するかどうかを指定します。有効な値： true：上部領域を表示します。 false：ヘッダーとツールバーを含む上部領域を表示しません。
  isShowHeader	ヘッダーを表示するかどうかを指定します。有効な値： true：ヘッダーを表示します。 false：ヘッダーを表示しません。
  isBrowserViewFullscreen	ブラウザー領域でのみ全画面表示を許可するかどうかを指定します。有効な値： true：ブラウザー領域でのみ全画面表示を許可しますが、標準の全画面表示は許可しません。 false：標準の全画面表示を許可します。
  isIframeViewFullscreen	iframe領域でのみ全画面表示を許可するかどうかを指定します。有効な値： true：iframe領域でのみ全画面表示を許可しますが、標準の全画面表示は許可しません。 false：標準の全画面表示を許可します。
  acceptVisualViewportResizeEvent	WebOfficeが外部VisualViewportサイズ変更イベントを受け入れるかどうかを指定します。

• 例

  aliyun.config({
    // すべてのタイプのドキュメントに適用可能な共通設定。
    commonOptions: {
      isShowTopArea: false, // ヘッダーとツールバーを含む上部領域を非表示にします。
      isShowHeader: false, // ヘッダー領域を非表示にします。
      isBrowserViewFullscreen: false, // ブラウザー領域でのみ全画面表示を許可します。
      isIframeViewFullscreen: false, // iframe領域でのみ全画面表示を許可します。
      acceptVisualViewportResizeEvent: true, // WebOfficeが外部VisualViewportサイズ変更イベントを受け入れることを許可します。
    },
  })

テキストドキュメントの設定

wordOptionsパラメーターを設定して、テキストドキュメントをカスタマイズします。

• パラメーター

  パラメーター	説明
  isShowDocMap	目次を有効にするかどうかを指定します。この機能はデフォルトで有効になっています。
  isBestScale	ドキュメントを開いたときに最適な倍率で表示するかどうかを指定します。
  isShowBottomStatusBar	下部のステータスバーを表示するかどうかを指定します。
  isOpenIntoEdit	モバイルデバイスでドキュメントを開いたときに編集モードに入るかどうかを指定します。 説明 この機能を使用するには、編集権限が必要です。
  isShowHoverToolbars	モバイルデバイスで下部にツールバーを表示するかどうかを指定します。
  isVoiceCommentEnabled	モバイルデバイスで音声コメントを有効にするかどうかを指定します。
  showFontDownloadNotice	モバイルデバイスでフォントダウンロードプロンプトを表示するかどうかを指定します。

• 例

  aliyun.config({
    wordOptions: {
      isShowDocMap: false, // 目次を無効にします。この機能はデフォルトで有効になっています。
      isBestScale: false, // ドキュメントを開いたときに最適な倍率で表示しません。ドキュメントはデフォルトで最適な倍率で表示されます。
      isShowBottomStatusBar: false, // 下部のステータスバーを表示しません。
      mobile: {
        isOpenIntoEdit: false, // モバイルデバイスでドキュメントを開いたときに編集モードに入りません。
        isShowHoverToolbars: false, // モバイルデバイスで下部にツールバーを表示しません。
        isVoiceCommentEnabled: false, // モバイルデバイスで音声コメントを無効にします。
        showFontDownloadNotice: false, // モバイルデバイスでフォントダウンロードプロンプトを表示しません。
      },
    },
  })

表ドキュメントの設定

使用可能な設定はありません。

プレゼンテーションドキュメントの設定

pptOptionsパラメーターを設定して、プレゼンテーションドキュメントをカスタマイズします。

• パラメーター

  パラメーター	説明
  isShowBottomStatusBar	下部のステータスバーを表示するかどうかを指定します。
  isShowRemarkView	注釈ビューを表示するかどうかを指定します。
  isShowInsertMedia	オーディオおよびビデオファイルのエントリフィールドを表示するかどうかを指定します。
  isOpenIntoEdit	モバイルデバイスでドキュメントを開いたときに編集モードに入るかどうかを指定します。 説明 この機能を使用するには、編集権限が必要です。
  showPrevTipWhilePlay	モバイルデバイスで再生が前のページに移動したときに前のページプロンプトを表示するかどうかを指定します。
  isShowReviewLogo	モバイルデバイスの左上隅にレビューロゴを表示するかどうかを指定します。
  isShowComment	コメントを表示するかどうかを指定します。

• 例

  aliyun.config({
    pptOptions: {
      isShowBottomStatusBar: false, // 下部のステータスバーを表示しません。
      isShowRemarkView: true, // 注釈ビューを表示します。
      isShowInsertMedia: true, // オーディオおよびビデオファイルのエントリフィールドを表示します。
      isShowComment: true, // コメントを表示します。
      mobile: {
        isOpenIntoEdit: false, // モバイルデバイスでドキュメントを開いたときに編集モードに入りません。
        showPrevTipWhilePlay: true, // モバイルデバイスでの再生が前のページに移動したときに「前のページ」プロンプトを表示します。
        isShowReviewLogo: false, // モバイルデバイスの左上隅にレビューロゴを表示しません。
      },
    },
  })

PDFドキュメントの設定

pdfOptionsパラメーターを設定して、PDFドキュメントをカスタマイズします。

• パラメーター

  パラメーター	説明
  isShowComment	コメントを表示するかどうかを指定します。コメントはデフォルトで表示されます。
  isInSafeMode	ドキュメントがセーフモードであるかどうか。セーフモードでは、テキストを選択またはコピーしたり、リンクを開いたりすることはできません。ドキュメントはデフォルトではセーフモードではありません。
  isBestScale	ドキュメントを開いたときに最適な倍率で表示するかどうか。
  isShowBottomStatusBar	下部のステータスバーを表示するかどうかを指定します。
  disBackScrollPos	スクロールの復元を無効にするかどうか。

• 例

  aliyun.config({
    pdfOptions: {
      isShowComment: false, // コメントを表示しません。コメントはデフォルトで表示されます。
      isInSafeMode: false, // ドキュメントがセーフモードではないことを指定します。
      isBestScale: false, // ドキュメントを開いたときに最適な倍率で表示しません。
      isShowBottomStatusBar: false, // 下部のステータスバーを表示しません。
      disBackScrollPos: true, // スクロール復元を無効にします。
    },
  })