Class GcDataViewer

GcDocs Data Viewer control.

Hierarchy

  • ReportViewer
    • GcDataViewer

Constructors

Properties

Accessors

Methods

Constructors

  • GcDocs Data Viewer constructor.

    Parameters

    • element: string | HTMLElement

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

    Returns GcDataViewer

Properties

LicenseKey: string

Product license key.

Example

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

Accessors

  • get toolbarLayout(): DataToolbarLayout
  • Get the current toolbar layout information.

    Returns DataToolbarLayout

    Example

    viewer.toolbarLayout
    
  • set toolbarLayout(buttons): void
  • Sets the toolbar layout information and modify layout.

    Parameters

    Returns void

    Example

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

Methods

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

    Parameters

    • selector: string | HTMLElement

    Returns undefined | GcDataViewer

    Example

    var viewer = GcDataViewer.findControl("#root");
    
  • Use this method to close and release resources occupied by the GcDataViewer.

    Returns void

  • Open data file.

    Parameters

    Returns Promise<any>

    Example

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