初始化JS-SDK时,通过分别配置不同文档对应的功能选项,可以开启和关闭文档中的特定功能和控制文档打开时的状态;通过设置commandBars选项,可以隐藏或禁用页面的组件。

自定义功能选项

注意 所有功能选项只能通过初始化配置控制,不支持热切换。

示例代码如下,配置项的值类型为Boolean,值可选true和false,请根据实际需要设置。

aliyun.config({
    //通用选项,适用于所有类型的文档。
    commonOptions: {
      isShowTopArea: false, //隐藏顶部区域(头部和工具栏)。
      isShowHeader: false //隐藏头部区域。

    },
    //WORD文档相关配置。
    wordOptions: {
      isShowDocMap: false,
      isBestScale: true
    },
    //PDF文档相关配置。
    pdfOptions: {
      isShowComment: true,
      isInSafeMode: false
    },
    //演示文档相关配置。
    pptOptions: {
      isShowBottomStatusBar: true
    }
})
配置项包括通用选项(commonOptions)、文字文档配置项(wordOptions)、PDF文档配置项(pdfOptions)和演示文档配置项(pptOptions),相关参数和最低支持版本说明如下:
说明 目前除了通用选项,表格文档暂无其他相关配置。
  • 通用选项(commonOptions)
    参数 说明 最低支持版本
    isShowTopArea 是否显示顶部区域(头部和工具栏)。 1.1.2
    isShowHeader 是否显示头部区域。 1.1.2
    isBrowserViewFullscreen 是否在浏览器区域全屏。 1.1.5
    isIframeViewFullscreen 是否在iframe区域内全屏。 1.1.5
  • 文字文档配置项(wordOptions)
    参数 说明 最低支持版本
    isShowDocMap 是否显示目录,默认不显示。 1.1.2
    isBestScale 打开文档时,默认以最佳比例显示。 1.1.2
    isShowBottomStatusBar 在PC中预览WORD文档时,是否展示底部状态栏。 1.1.5
  • PDF文档配置项(pdfOptions)
    参数 说明 最低支持版本
    isShowComment 是否显示注解,默认显示。 1.1.2
    isInSafeMode 是否处于安全模式,默认不是安全模式。

    当PDF文档处于安全模式下时,不能划选文字,不能复制以及不能通过链接跳转。

    1.1.2
    isShowBottomStatusBar 在PC预览PDF文档时,是否展示底部状态栏。 1.1.5
  • 演示文档配置项(pptOptions)
    配置项 说明 最低支持版本
    isShowBottomStatusBar 在PC预览演示文档时,是否展示底部状态栏。 1.1.5

组件状态设置

不同版本使用的数据结构如下所示。
  • V1.1.2及以上版本
    //从V1.1.2版本开始使用新的数据结构。
    aliyun.config({
      commandBars: [
        //可以配置多个组件。
        {
          cmbId: "组件ID",
          attributes: {
            visible: false, //隐藏组件。
            enable: false, //禁用组件,组件显示但不响应点击事件。
          }
        }
      ]
    })
  • V1.1.1版本
    //V1.1.1版本使用的数据结构。
    aliyun.config({
      commandBars: [
        //可以配置多个组件。
        {
          cmbId: "组件ID",
          attributes: [
             {name: 'visible', value: false}, //隐藏组件。
             {name: 'enable', value: false} //禁用组件,组件显示但不响应点击事件。
          ]
        }
      ]
    })
commandBars选项的参数说明请参见下表。
参数 说明
cmbId 目前支持如下组件ID,请根据实际需要设置。
  • 当组件类型为PDF文档时,使用PDFMobilePageBar组件ID,表示移动端页码。
  • 当组件类型为演示文档时,使用WPPMobileMarkButton组件ID,表示移动端浮动备注按钮。
attributes 包括visible和enable属性,属性值类型为Boolean,值可选true和false,请根据实际需要设置。
  • visible用于组件显示切换。
    • 当设置为false时,隐藏组件。
    • 当设置为true时,显示组件。
  • enable用于组件状态切换,禁用或开启。
    • 当设置为false时,禁用组件,组件显示但不响应点击事件。
    • 当设置为true时,开启组件,能正常响应点击事件。
以上组件状态设置只是初始化时生效,通过JS-SDK可以动态更新组件状态接口。
demo.setCommandBars([...]) //配置和初始化配置相同。