[]
DEMOS DOCS API PRICING
FREE TRIAL
(Showing Draft Content)

DsDataViewer

Document Solutions Data Viewer - v7.1.0 / DsDataViewer

Class: DsDataViewer

Document Solutions Data Viewer control.

Hierarchy

  • ReportViewer

    ↳ DsDataViewer

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• new DsDataViewer(element)

Document Solutions Data Viewer constructor.

Parameters

Name Type Description
element string | HTMLElement root container element or selector pattern used to select the root container element.

Overrides

ReportViewer.constructor

Properties

LicenseKey

▪ Static LicenseKey: string

Product license key.

Example

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

Accessors

toolbarLayout

• get toolbarLayout(): DataToolbarLayout

Get the current toolbar layout information.

Example

viewer.toolbarLayout

Returns

DataToolbarLayout

• set toolbarLayout(buttons): void

Sets the toolbar layout information and modify layout.

Example

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

Parameters

Name Type
buttons DataToolbarLayout

Returns

void

Methods

findControl

▸ Static findControl(selector): undefined | DsDataViewer

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

Example

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

Parameters

Name Type
selector string | HTMLElement

Returns

undefined | DsDataViewer

dispose

▸ dispose(): void

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

Returns

void

Overrides

ReportViewer.dispose

openFile

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

Open data file.

Example

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

Parameters

Name Type Description
file string | Blob | URL The data file.
fileType FileType The type of the imported data file.
openOptions? XlsxOpenOptions | SSJsonOpenOptions | CsvOpenOptions | SjsOpenOptions The options for imported data file.

Returns

Promise<any>