Wijmo
Xlsx
5.20231.904
Wijmo API Module wijmo.xlsx Wijmo API Module

wijmo.xlsx Module

This module has a dependency on the JSZip library, which must be installed separately.

  • In order to use asynchronous Workbook.saveAsync and Workbook.loadAsync methods, install JSZip version 3.*:
    npm install jszip@3 --save
  • In order to use synchronous Workbook.save and Workbook.load methods, install JSZip version 2.*:
    npm install jszip@2 --save
    If your application is not based on npm, and you load modules using script elements in html, you can load it from CDN with a markup like this: For JSZip 3
    <script src="http://cdnjs.cloudflare.com/ajax/libs/jszip/3.1.3/jszip.min.js" />
    For JSZip 2
    <script src="http://cdnjs.cloudflare.com/ajax/libs/jszip/2.5.0/jszip.min.js" />

Classes

Interfaces

Enumerations

Functions

Functions

useJSZip

  • useJSZip(jszip: any): void

  • NOTE: This function is OBSOLETE and retained for compatibility. It is no longer needed because wijmo.xlsx module loads jszip module automatically. You should only ensure that jszip module is installed in your application.

    Defines a reference to JSZip module that will be used by the Wijmo xlsx export modules.

    This method should be used in npm modules based applications to provide wijmo.xlsx module with a reference to the JSZip module retrieved using the ES6 import statement. For example:

    import * as JSZip from 'jszip';
import * as wjcXlsx from 'wijmo/wijmo.xlsx';
wjcXlsx.useJSZip(JSZip);

    Parameters

    • jszip: any

      Reference to the JSZip constructor function.

    Returns void