1. module node-excel-export
   1. function node-excel-export.buildExport (!(params instanceof Array)
   2. object node-excel-export.excel
2. module node-excel-export.excel
   1. function node-excel-export.excel.build (array)
   2. function node-excel-export.excel.parse (mixed, options)

module node-excel-export

function node-excel-export.buildExport (!(params instanceof Array)

• description and source-code

  params => {
    if (!(params instanceof Array)) throw 'buildExport expects an array'
  
    let sheets = []
    params.forEach(function (sheet, index) {
      let specification = sheet.specification
      let dataset = sheet.data
      let sheet_name = sheet.name || 'Sheet' + index + 1
      let data = []
      let merges = sheet.merges
      let config = {
        cols: []
      }
  
      if (!specification || !dataset) throw 'missing specification or dataset.'
  
      if (sheet.heading) {
        sheet.heading.forEach(function (row) {
          data.push(row)
        })
      }
  
      //build the header row
      let header = []
      for (let col in specification) {
        header.push({
          value: specification[col].displayName,
          style: specification[col].headerStyle || ''
        })
  
        if (specification[col].width) {
          if (Number.isInteger(specification[col].width)) {
            config.cols.push({ wpx: specification[col].width })
          } else if (Number.isInteger(parseInt(specification[col].width))) {
            config.cols.push({ wch: specification[col].width })
          } else {
            throw 'Provide column width as a number'
          }
        } else {
          config.cols.push({})
        }
  
      }
      data.push(header) //Inject the header at 0
  
      dataset.forEach(record => {
        let row = []
        for (let col in specification) {
          let cell_value = record[col]
  
          if (specification[col].cellFormat && typeof specification[col].cellFormat == 'function') {
            cell_value = specification[col].cellFormat(record[col], record)
          }
  
          if (specification[col].cellStyle && typeof specification[col].cellStyle == 'function') {
            cell_value = {
              value: cell_value,
              style: specification[col].cellStyle(record[col], record)
            }
          } else if (specification[col].cellStyle) {
            cell_value = {
              value: cell_value,
              style: specification[col].cellStyle
            }
          }
  
  
          // TODO: REMOVE
          // if (specification[col].mergeGroup) {
          //   cell_value.merge = specification[col].mergeGroup
          // }
  
          row.push(cell_value) // Push new cell to the row
        }
        data.push(row) // Push new row to the sheet
      })
  
      sheets.push({
        name: sheet_name,
        data: data,
        merge: merges,
        config: config
      })
  
    })
  
    return excel.build(sheets)
  
  }

• example usage

  ...
  { start: { row: 1, column: 1 }, end: { row: 1, column: 10 } },
  { start: { row: 2, column: 1 }, end: { row: 2, column: 5 } },
  { start: { row: 2, column: 6 }, end: { row: 2, column: 10 } }
  ]
  
  // Create the excel report.
  // This function will return Buffer
  const report = excel.buildExport(
  [ // <- Notice that this is an array. Pass multiple sheets to create multi sheet report
    {
      name: 'Report', // <- Specify sheet name (optional)
      heading: heading, // <- Raw heading array (optional)
      merges: merges, // <- Merge cell ranges
      specification: specification, // <- Report specification
      data: dataset // <-- Report data
  ...

module node-excel-export.excel

function node-excel-export.excel.build (array)

• description and source-code

  build = function (array) {
    let defaults = {
      bookType:'xlsx',
      bookSST: false,
      type:'binary'
    };
    let wb = new Workbook();
    array.forEach(function(worksheet) {
      let name = worksheet.name || 'Sheet';
      let data = sheet_from_array_of_arrays(worksheet.data || [], worksheet.merge);
      wb.SheetNames.push(name);
      wb.Sheets[name] = data;
  
      if(worksheet.config.cols) {
        wb.Sheets[name]['!cols'] = worksheet.config.cols
      }
  
    });
  
    let data = XLSX.write(wb, defaults);
    if(!data) return false;
    let buffer = new Buffer(data, 'binary');
    return buffer;
  
  }

• example usage

  ...
        data: data,
        merge: merges,
        config: config
      })
  
    })
  
    return excel.build(sheets)
  
  }
  
  module.exports = {
    buildExport
  }
  ...

function node-excel-export.excel.parse (mixed, options)

• description and source-code

  parse = function (mixed, options) {
    let ws;
    if(typeof mixed === 'string') ws = XLSX.readFile(mixed, options);
    else ws = XLSX.read(mixed, options);
    return _.map(ws.Sheets, function(sheet, name) {
      return {name: name, data: XLSX.utils.sheet_to_json(sheet, {header: 1, raw: true})};
    });
  }

• example usage

  ...
  
  'use strict';
  
  const XLSX = require('xlsx-style');
  
  function datenum(v, date1904) {
  if(date1904) v += 1462;
  let epoch = Date.parse(v);
  return (epoch - new Date(Date.UTC(1899, 11, 30))) / (24 * 60 * 60 * 1000);
  }
  
  function sheet_from_array_of_arrays(data, merges) {
  let ws = {};
  let range = {s: {c:10000000, r:10000000}, e: {c:0, r:0}};
  for(let R = 0; R !== data.length; ++R) {
  ...