Class DsDataViewer

constructor

• new DsDataViewer(element): DsDataViewer

• Document Solutions Data Viewer constructor.

  Parameters

  • element: string | HTMLElement

    root container element or selector pattern used to select the root container element.

  Returns DsDataViewer

Static LicenseKey

<script>
 // Add your license
 DsDataViewer.LicenseKey = 'XXX';
 // Add your code
 const viewer = new DsDataViewer("#viewer");
</script>
Copy

toolbarLayout

• get toolbarLayout(): DataToolbarLayout

• Get the current toolbar layout information.

  Returns DataToolbarLayout

  Example

  viewer.toolbarLayout
  Copy

• set toolbarLayout(buttons): void

• Sets the toolbar layout information and modify layout.

  Parameters

  • buttons: DataToolbarLayout

  Returns void

  Example

  viewer.toolbarLayout = { default: ['open', 'zoom', 'fullscreen', 'theme-change'] }
  Copy

sidebarLayout

• get sidebarLayout(): string[]

• Get the current sidebar layout information.

  Returns string[]

  Example

  viewer.sidebarLayout
  Copy

• set sidebarLayout(sidebarLayout): void

• Sets the sidebar layout information and modify layout. Currently supported: SearchPanel.

  Parameters

  • sidebarLayout: string[]

  Returns void

  Example

  // Open SearchPanel
  viewer.sidebarLayout = ['SearchPanel'];
  // Clear all sidebars
  viewer.sidebarLayout = [''];
  // Default sidebar layout
  viewer.sidebarLayout = [];
  Copy

Static findControl

• findControl(selector): undefined | DsDataViewer

• Gets the viewer instance using the host element or host element selector

  Parameters

  • selector: string | HTMLElement

  Returns undefined | DsDataViewer

  Example

  var viewer = DsDataViewer.findControl("#root");
  Copy

dispose

• dispose(): void

• Use this method to close and release resources occupied by the DsDataViewer.

  Returns void

openFile

• openFile(file, fileType, openOptions?): Promise<any>

• Open data file.

  Parameters

  • file: string | Blob | URL

    The data file.

  • fileType: FileType

    The type of the imported data file.

  • Optional openOptions: XlsxOpenOptions | SSJsonOpenOptions | CsvOpenOptions | SjsOpenOptions

    The options for imported data file.

  Returns Promise<any>

  Example

  viewer.openFile("Documents/HelloWorld.xlsx", FileType.XLSX, {loadHiddenSheets: true});
  Copy

getSheet

• getSheet(index): WorkSheet

• Fetches the specified sheet based on the index.

  Parameters

  • index: number

    The index of the sheet to return.

  Returns WorkSheet

  The specified sheet.

  Example

  viewer.getSheet(0)
  Copy

getSheetFromName

• getSheetFromName(name): WorkSheet

• Fetches the sheet with the specified name.

  Parameters

  • name: string

    The sheet name.

  Returns WorkSheet

  The sheet with the specified name.

  Example

  viewer.getSheetFromName("Sheet1")
  Copy

getActiveSheet

• getActiveSheet(): WorkSheet

• Fetches the active sheet.

  Returns WorkSheet

  The active sheet instance.

  Example

  viewer.getActiveSheet()
  Copy

showSidebar

• showSidebar(show): void

• Set the visibility of the sidebar.

  Parameters

  • show: boolean

    The visibility of the sidebar.

  Returns void

  Example

  viewer.showSidebar(true)
  Copy