tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

Configuration Item Description

Last updated: 2024-06-12 15:27:03

    Display Mode

    Enable different display modes by initializing the configuration option class:
    var demo = COSDocPreviewSDK.config({
        mode: 'normal', 
    })
    The configuration options are as described below:
    mode Value
    Description
    Default Option
    normal
    Normal mode, with all functional UIs shown
    Yes
    simple
    Simple mode, with no header and toolbar shown
    No

    Custom Configuration Options

    When initializing the JS-SDK, by configuring different options for different types of files, you can enable or disable specific configurations in a file and control its status when it is opened.
    COSDocPreviewSDK.config({
        // Common option, which is applicable to all types of files.
        commonOptions: {
          isShowTopArea: false, // Hide the top area (header and toolbar).
          isShowHeader: false // Hide the header area.
    
        },
        // Word file configurations.
        wordOptions: {
          isShowDocMap: false,
          isBestScale: true
        },
        // PDF file configurations.
        pdfOptions: {
          isShowComment: true,
          isInSafeMode: false
        },
        // Presentation file configurations.
        pptOptions: {
          isShowBottomStatusBar: true
        }
    })
    Common configuration items: commonOptions
    Configuration Item
    Description
    Default Value
    isShowTopArea
    Whether to show the top area (header and toolbar)
    false
    isShowHeader
    Whether to show the header area
    false
    isBrowserViewFullscreen
    Whether to enable full screen mode in the browser area
    false
    isIframeViewFullscreen
    Whether to enable full screen mode in the iframe area
    false
    Text file configuration items: wordOptions
    Configuration Item
    Description
    Default Value
    isShowDocMap
    Whether to enable the directory feature, which is enabled by default.
    true
    isBestScale
    Whether to display the file at the best scale by default (for PC) when the file is opened
    true
    isShowBottomStatusBar
    Whether to show the bottom status bar (for PC)
    false
    PDF file configuration items: pdfOptions
    Configuration Item
    Description
    Default Value
    isShowComment
    Whether to show annotations, which are shown by default.
    true
    isInSafeMode
    Whether to enable the safe mode (text cannot be selected or copied and links cannot be opened). It is disabled by default.
    false
    isShowBottomStatusBar
    Whether to show the bottom status bar (for PC)
    false
    Presentation file configuration items: pptOptions
    Configuration Item
    Description
    Default Value
    isShowBottomStatusBar
    Whether to show the bottom status bar (for PC)
    false

    Component Status Settings

    Page components can be hidden or disabled through the commandBars option.
    COSDocPreviewSDK.config({
        // Common option, which is applicable to all types of files.
        commandBars: [
          {
            cmbId: 'Print', // Component ID
            attributes: {
              visible: false, // Whether to show the component. Valid values: `false` (no), `true` (yes). Default value: `true`.
              enable: false, // Whether to enable the component. Default value: `true`.
            },
          },
        ]
    })
    The list of currently available components is as follows:
    Component ID
    Description
    Scope of Application
    Print
    Print feature and the Ctrl + P shortcut for print
    All files
    MobileHeader
    Top toolbar in the client
    All files
    WriterHoverToolbars
    Bottom toolbar in the client
    Word files
    DownloadImg
    Download icon when the image is double-clicked
    Presentation files
    PlayComponentToolbar
    Toolbar in the top-right corner when in full screen mode
    Presentation files
    PlayContextCheckImage
    Right click during playback - View original image
    Presentation files
    FloatMenuCheckImage
    Floating menu bar when the image is selected - View original image
    Presentation files
    WPPMobileCommentButton
    Comment button on the bottom toolbar in the client
    Presentation files
    PDFMobilePageBar
    Page number in the client
    PDF files
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy