Workbook Class

Parameters

• Optional done: Object

  Callback invoked when the method finishes executing.

Returns void

// This sample opens an xlsx file chosen from Open File
// dialog and creates a workbook instance to load the file.
 
// HTML
<input type="file"
    id="importFile"
    accept="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
/>
 
// JavaScript
var workbook, // receives imported IWorkbook
    importFile = document.getElementById('importFile');
 
importFile.addEventListener('change', function () {
    loadWorkbook();
});
 
function loadWorkbook() {
    var reader,
        workbook,
        file = importFile.files[0];
    if (file) {
        reader = new FileReader();
        reader.onload = function (e) {
           workbook = new wijmo.xlsx.Workbook(),
           workbook.load(reader.result);
        };
        reader.readAsDataURL(file);
    }
}

Parameters

• data: string | ArrayBuffer

  ArrayBuffer or base-64 string that contains the xlsx file content.

• Optional includeStyles: boolean

  Indicates whether styles should be imported from xlsx file. The default value is true.

Returns void

Parameters

• data: string | ArrayBuffer

  ArrayBuffer or base-64 string that contains the xlsx file content.

• onLoaded: Object

  This callback provides an approach to get an instance of the loaded workbook. Since this method is an asynchronous method, user is not able to get instance of the loaded workbook immediately. User has to get the instance through this callback. This has a single parameter, instance of the loaded workbook. It will be passed to user.

• Optional onError: Object

  This callback catches error information when loading. This has a single parameter, the failure reason. Return value is be passed to user, if he wants to catch the load failure reason.

  For example:

  workbook.loadAsync(base64, function (workbook) {
       // User can access the loaded workbook instance in this callback.
       var app = worksheet.application ;
       ...
  }, function (reason) {
       // User can catch the failure reason in this callback.
       console.log('The reason of load failure is ' + reason);
  });
  

• Optional includeStyles: boolean

  Indicates whether styles should be imported from xlsx file. The default value is true.

Returns void

function exportXlsx(fileName) {
    var book = new wijmo.xlsx.Workbook(),
        sheet = new wijmo.xlsx.WorkSheet(),
        bookRow = new wijmo.xlsx.WorkbookRow(),
        bookCell = new wijmo.xlsx.WorkbookCell();
    bookCell.value = 'Hello, Excel!';
    bookRow.cells.push(bookCell);
    sheet.rows.push(bookRow);
    book.sheets.push(sheet);
    book.save(fileName);
}

Parameters

• Optional fileName: string

  Name of the xlsx file to save.

Returns string

A base-64 string that represents the content of the file.

Parameters

• Optional fileName: string

  Name of the xlsx file to save.

• Optional onSaved: Object

  This callback provides an approach to get the base-64 string that represents the content of the saved workbook. Since this method is an asynchronous method, user does not get the base-64 string immediately. User has to get the base-64 string via this callback. This has a single parameter, the base-64 string of the saved workbook. It will be passed to user.

• Optional onError: Object

  This callback catches error information when saving. This has a single parameter, the failure reason. Return value will be passed to user, if he wants to catch the save failure reason.

• Optional onProgress: Object

  Callback function that gives feedback about the progress of a task. The function accepts a single argument, the current progress as a number between 0 and 100.

  For example:

  workbook.saveAsync('', function (base64){
       // User can access the base64 string in this callback.
       document.getElementByID('export').href = 'data:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;' + 'base64,' + base64;
  }, function (reason){
       // User can catch the failure reason in this callback.
       console.log('The reason of save failure is ' + reason);
  });
  

Returns void