控制台指南

最佳实践

开发者指南

API 文档

SDK 文档

填写文档满意度调查问卷,赢取缤纷好礼> HOT

配置项说明

最近更新时间:2022-06-24 17:54:09

显示模式

通过初始化配置选项类,开启不同的显示模式:

var demo = COSDocPreviewSDK.config({
    mode: 'normal', 
})

配置选项说明如下:

mode 选项值 说明 是否默认选项
normal 普通模式,展示所有功能界面
simple 极简模式,不显示头部和工具栏

自定义配置选项

初始化 JS-SDK 时,通过分别配置不同文档对应的配置选项,可以开启或关闭文档中的特定配置以及控制文档打开时的状态。

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

    },
    //WORD文档相关配置。
    wordOptions: {
      isShowDocMap: false,
      isBestScale: true
    },
    //PDF文档相关配置。
    pdfOptions: {
      isShowComment: true,
      isInSafeMode: false
    },
    //演示文档相关配置。
    pptOptions: {
      isShowBottomStatusBar: true
    }
})

  • 通用配置项:commonOptions
    配置项说明默认值
    isShowTopArea是否显示顶部区域(头部和工具栏)false
    isShowHeader是否显示头部区域false
    isBrowserViewFullscreen是否在浏览器区域全屏false
    isIframeViewFullscreen是否在 iframe 区域内全屏false
  • 文字文件配置项:wordOptions
    配置项说明默认值
    isShowDocMap是否开启目录功能,默认开启true
    isBestScale打开文档时,默认以最佳比例显示(适用于 PC)true
    isShowBottomStatusBar是否展示底部状态栏(适用于 PC)false
  • PDF 配置项:pdfOptions
    配置项说明默认值
    isShowComment是否显示注解,默认显示true
    isInSafeMode是否处于安全模式(安全模式下不能划选文字,不能复制以及不能通过链接跳转),默认不是安全模式false
    isShowBottomStatusBar是否展示底部状态栏(适用于 PC)false
  • 演示文件配置项:pptOptions
    配置项说明默认值
    isShowBottomStatusBar是否展示底部状态栏(适用于 PC)false

组件状态设置

可以通过 commandBars 选项来隐藏或禁用页面的组件。

COSDocPreviewSDK.config({
    //通用选项,适用于所有类型的文档。
    commandBars: [
      {
        cmbId: 'Print', // 组件ID
        attributes: {
          visible: false, // 组件是否显示,默认为true。false:隐藏组件;true:显示组件
          enable: false, // 禁用或者开启组件,默认为true
        },
      },
    ]
})

目前可用的组件列表如下:

组件ID说明适用范围
Print打印功能,和 ctrl+P 打印快捷键所有文档
MobileHeader客户端的顶部工具栏所有文档
WriterHoverToolbars客户端的底部工具栏文字文件
DownloadImg双击图片下载按钮图标演示文件
PlayComponentToolbar全屏播放时右上角工具栏演示文件
PlayContextCheckImage播放时右键 - 查看原图演示文件
FloatMenuCheckImage选中图片时浮动菜单栏 - 查看原图演示文件
WPPMobileCommentButton客户端底部工具栏的评论按钮演示文件
PDFMobilePageBar客户端的页码PDF文件
目录