GcDataViewer
GcDocs Data Viewer - v1.0.1 / GcDataViewer
Class: GcDataViewer
GcDocs Data Viewer control.
Hierarchy
ReportViewer↳
GcDataViewer
Table of contents
Properties
Methods
Constructors
Properties
LicenseKey
▪ Static LicenseKey: string
Product license key.
Example
<script>
// Add your license
GcDataViewer.LicenseKey = 'XXX';
// Add your code
const viewer = new GcDataViewer("#viewer");
</script>
Methods
findControl
▸ Static findControl(selector): undefined | GcDataViewer
Gets the viewer instance using the host element or host element selector
Example
var viewer = GcDataViewer.findControl("#root");
Parameters
| Name | Type |
|---|---|
selector |
string | HTMLElement |
Returns
undefined | GcDataViewer
dispose
▸ dispose(): void
Use this method to close and release resources occupied by the GcDataViewer.
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 |
Blob |
The data file. |
fileType |
FileType |
The type of the imported data file. |
openOptions? |
XlsxOpenOptions | SSJsonOpenOptions | CsvOpenOptions |
The options for import data file. |
Returns
Promise<any>
Constructors
constructor
• new GcDataViewer(element)
GcDocs 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