Skip to main content
Module

x/sheetjs/types/write.ts

πŸ“— SheetJS Community Edition -- Spreadsheet Data Toolkit
Extremely Popular
Latest
File
/* writing feature test -- look for TEST: in comments *//* vim: set ts=2 ft=javascript: */
/* original data */const data: any[][] = [ [1, 2, 3], [true, false, null, "sheetjs"], ["foo bar", "baz", new Date("2014-02-19T14:30Z"), "0.3"], ["baz", null, "qux", 3.14159], ["hidden"], ["visible"]];
const ws_name = "SheetJS";
const wscols: XLSX.ColInfo[] = [ {wch: 6}, // "characters" {wpx: 50}, // "pixels" , {hidden: true} // hide column];
/* At 96 PPI, 1 pt = 1 px */const wsrows: XLSX.RowInfo[] = [ {hpt: 12}, // "points" {hpx: 16}, // "pixels" , {hpx: 24, level:3}, {hidden: true}, // hide row {hidden: false}];
console.log("Sheet Name: " + ws_name);console.log("Data: ");let i = 0;for(i = 0; i !== data.length; ++i) console.log(data[i]);console.log("Columns :");for(i = 0; i !== wscols.length; ++i) console.log(wscols[i]);
/* require XLSX */import * as XLSX from 'xlsx';
/* blank workbook constructor */
let wb: XLSX.WorkBook = { SheetNames: <string[]>[], Sheets: {} };
wb = XLSX.utils.book_new();
/* convert an array of arrays in JS to a CSF spreadsheet */const ws: XLSX.WorkSheet = XLSX.utils.aoa_to_sheet(data, {cellDates:true});
/* TEST: add worksheet to workbook */wb.SheetNames.push(ws_name);wb.Sheets[ws_name] = ws;XLSX.utils.book_append_sheet(wb, ws, ws_name);
/* TEST: simple formula */(<XLSX.CellObject>ws['C1']).f = "A1+B1";ws['C2'] = {t:'n', f:"A1+B1"};
/* TEST: single-cell array formula */
ws['D1'] = {t:'n', f:"SUM(A1:C1*A1:C1)", F:"D1:D1"};
XLSX.utils.sheet_set_array_formula(ws, 'D1:D1', "SUM(A1:C1*A1:C1)");
/* TEST: multi-cell array formula */ws['E1'] = {t:'n', f:"TRANSPOSE(A1:D1)", F:"E1:E4"};ws['E2'] = {t:'n', F:"E1:E4"};ws['E3'] = {t:'n', F:"E1:E4"};ws['E4'] = {t:'n', F:"E1:E4"};XLSX.utils.sheet_set_array_formula(ws, 'E1:E4', "TRANSPOSE(A1:D1)");ws["!ref"] = "A1:E6";
/* TEST: column props */ws['!cols'] = wscols;
/* TEST: row props */ws['!rows'] = wsrows;
/* TEST: hyperlink note: Excel does not automatically style hyperlinks */(<XLSX.CellObject>ws['A4']).l = { Target: "#E2" };XLSX.utils.cell_set_internal_link(ws['A4'], "E2");(<XLSX.CellObject>ws['A3']).l = { Target: "http://sheetjs.com", Tooltip: "Visit us <SheetJS.com!>" };XLSX.utils.cell_set_hyperlink(ws['A3'], "http://sheetjs.com", "Visit us <SheetJS.com!>");
/* TEST: built-in format */(<XLSX.CellObject>ws['B1']).z = "0%"; // Format Code 9XLSX.utils.cell_set_number_format(ws['B1'], "0%");
/* TEST: custom format */const custfmt = "\"This is \"\\ 0.0";(<XLSX.CellObject>ws['C2']).z = custfmt;XLSX.utils.cell_set_number_format(ws['C2'], custfmt);
/* TEST: page margins */ws['!margins'] = { left:1.0, right:1.0, top:1.0, bottom:1.0, header:0.5, footer:0.5 };
/* TEST: merge cells */ws['!merges'] = [ XLSX.utils.decode_range("A6:C6") ];
console.log("JSON Data:");console.log(XLSX.utils.sheet_to_json(ws, {header:1}));
/* TEST: hidden sheets */wb.SheetNames.push("Hidden");wb.Sheets["Hidden"] = XLSX.utils.aoa_to_sheet(["Hidden".split(""), [1,2,3]]);wb.Workbook = {Sheets:[]};wb.Workbook.Sheets[1] = {Hidden:1};const data_2 = ["Hidden".split(""), [1,true,3,'a',,'c'], [2,false,true,'sh33t',,'j5']];XLSX.utils.book_append_sheet(wb, XLSX.utils.aoa_to_sheet(data_2), "Hidden");XLSX.utils.book_set_sheet_visibility(wb, "Hidden", XLSX.utils.consts.SHEET_HIDDEN);
/* TEST: properties */wb.Props = { Title: "SheetJS Test", Subject: "Tests", Author: "Devs at SheetJS", Manager: "Sheet Manager", Company: "SheetJS", Category: "Experimentation", Keywords: "Test", Comments: "Nothing to say here", LastAuthor: "Not SheetJS", CreatedDate: new Date(2017,1,19)};
/* TEST: comments */
(<XLSX.CellObject>ws['A4']).c = [];(<XLSX.CellObject>ws['A4']).c.push({a:"SheetJS",t:"I'm a little comment, short and stout!\n\nWell, Stout may be the wrong word"});
XLSX.utils.cell_add_comment(ws['A4'], "I'm a little comment, short and stout!\n\nWell, Stout may be the wrong word", "SheetJS");
/* TEST: sheet protection */ws['!protect'] = { password:"password", /* enable formatting rows and columns */ formatRows:false, formatColumns:false, /* disable editing objects and scenarios */ objects:true, scenarios:true};
/* TEST: Workbook Properties */if(!wb.Workbook) wb.Workbook = {Sheets:[], WBProps:{}};if(!wb.Workbook.WBProps) wb.Workbook.WBProps = {};wb.Workbook.WBProps.filterPrivacy = true;wb.Workbook.Views = [{RTL:true}];
console.log("Worksheet Model:");console.log(ws);
const filenames: Array<[string]|[string, XLSX.WritingOptions]> = [ ['sheetjs.xlsx', {bookSST:true}], ['sheetjs.xlsm'], ['sheetjs.xlsb'], ['sheetjs.xlam'], ['sheetjs.biff8.xls', {bookType:'xls'}], ['sheetjs.biff5.xls', {bookType:'biff5'}], ['sheetjs.biff2.xls', {bookType:'biff2'}], ['sheetjs.xml.xls', {bookType:'xlml'}], ['sheetjs.xla'], ['sheetjs.ods'], ['sheetjs.fods'], ['sheetjs.csv'], ['sheetjs.txt'], ['sheetjs.slk'], ['sheetjs.eth'], ['sheetjs.htm'], ['sheetjs.dif'], ['sheetjs.dbf', {sheet:"Hidden"}], ['sheetjs.rtf'], ['sheetjs.prn']];
filenames.forEach((r) => { /* write file */ XLSX.writeFile(wb, r[0], <XLSX.WritingOptions>r[1]); /* test by reading back files */ XLSX.readFile(r[0]);});