[]
DOC API Demos
Download
(Showing Draft Content)

README

GcDocs Data Viewer - v1.0.1

GcDocs Data Viewer - v1.0.1

Table of contents

Classes

Enumerations

Type Aliases

Type Aliases

XlsxOpenOptions

Ƭ XlsxOpenOptions: Object

Options to open the XLSX file.

Type declaration

Name Type Description
showHiddenSheets? boolean Optional. Whether to show the hidden and very hidden sheets in XLSX file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {showHiddenSheets: true});
showHiddenRows? boolean Optional. Whether to show the hidden rows in XLSX file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {showHiddenRows: true});
showHiddenColumns? boolean Optional. Whether to show the hidden columns in XLSX file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {showHiddenColumns: true});
showFilters? boolean Optional. Whether to show the filters in XLSX file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {showFilters: false});
keepRowGroups? boolean Optional. Whether to show the row groups when loading a XLSX file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {keepRowGroups: false});
keepColumnGroups? boolean Optional. Whether to show the column groups when loading a XLSX file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {keepColumnGroups: false});
password? string Optional. For decrypting password-protected XLSX file. Example javascript viewer.openFile('Documents/HelloWorld.xlsx', FileType.XLSX, {password: "123"});

SSJsonOpenOptions

Ƭ SSJsonOpenOptions: Object

Options to open the SSJSON file.

Type declaration

Name Type Description
showHiddenSheets? boolean Optional. Whether to show the hidden and very hidden sheets in SSJSON file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {showHiddenSheets: true});
showHiddenRows? boolean Optional. Whether to show the hidden rows in SSJSON file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {showHiddenRows: true});
showHiddenColumns? boolean Optional. Whether to show the hidden columns in SSJSON file. The default value is false. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {showHiddenColumns: true});
showFilters? boolean Optional. Whether to show the filters in SSJSON file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {showFilters: false});
keepRowGroups? boolean Optional. Whether to show the row groups when loading a SSJSON file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {keepRowGroups: false});
keepColumnGroups? boolean Optional. Whether to show the column groups when loading a SSJSON file. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.ssjson', FileType.SSJSON, {keepColumnGroups: false});

CsvOpenOptions

Ƭ CsvOpenOptions: Object

Options to open the CSV file.

Type declaration

Name Type Description
columnSeparator? string Optional. Column separator for CSV file. The default value is ','. Example javascript viewer.openFile('Documents/HelloWorld.CSV', FileType.CSV, {columnSeparator: ','});
rowSeparator? string Optional. Row separator for CSV file. The default value is '\r\n'. Example javascript viewer.openFile('Documents/HelloWorld.CSV', FileType.CSV, {rowSeparator: '\\r\\n'});
encoding? string Optional. Encoding for CSV file. The default value is 'UTF-8'. Example javascript viewer.openFile('Documents/HelloWorld.CSV', FileType.CSV, {encoding: 'ANSI'});
columnHasHeader? boolean Optional. Whether the column data in the CSV file has a header. The default value is true. Example javascript viewer.openFile('Documents/HelloWorld.CSV', FileType.CSV, {columnHasHeader: false});