exceljs
Version:
Excel Workbook Manager - Read and Write xlsx and csv Files.
533 lines (451 loc) • 16.6 kB
JavaScript
/**
* Copyright (c) 2015-2017 Guyon Roche
* LICENCE: MIT - please refer to LICENCE file included with this module
* or https://github.com/guyonroche/exceljs/blob/master/LICENSE
*/
'use strict';
var _ = require('../../utils/under-dash');
var RelType = require('../../xlsx/rel-type');
var colCache = require('../../utils/col-cache');
var Dimensions = require('../../doc/range');
var StringBuf = require('../../utils/string-buf');
var Row = require('../../doc/row');
var Column = require('../../doc/column');
var SheetRelsWriter = require('./sheet-rels-writer');
var DataValidations = require('../../doc/data-validations');
var xmlBuffer = new StringBuf();
// ============================================================================================
// Xforms
var ListXform = require('../../xlsx/xform/list-xform');
var DataValidationsXform = require('../../xlsx/xform/sheet/data-validations-xform');
var SheetPropertiesXform = require('../../xlsx/xform/sheet/sheet-properties-xform');
var SheetFormatPropertiesXform = require('../../xlsx/xform/sheet/sheet-format-properties-xform');
var ColXform = require('../../xlsx/xform/sheet/col-xform');
var RowXform = require('../../xlsx/xform/sheet/row-xform');
var HyperlinkXform = require('../../xlsx/xform/sheet/hyperlink-xform');
var SheetViewXform = require('../../xlsx/xform/sheet/sheet-view-xform');
var PageMarginsXform = require('../../xlsx/xform/sheet/page-margins-xform');
var PageSetupXform = require('../../xlsx/xform/sheet/page-setup-xform');
var AutoFilterXform = require('../../xlsx/xform/sheet/auto-filter-xform');
var PictureXform = require('../../xlsx/xform/sheet/picture-xform');
// since prepare and render is functional, we can use singletons
var xform = {
dataValidations: new DataValidationsXform(),
sheetProperties: new SheetPropertiesXform(),
sheetFormatProperties: new SheetFormatPropertiesXform(),
columns: new ListXform({ tag: 'cols', length: false, childXform: new ColXform() }),
row: new RowXform(),
hyperlinks: new ListXform({ tag: 'hyperlinks', length: false, childXform: new HyperlinkXform() }),
sheetViews: new ListXform({ tag: 'sheetViews', length: false, childXform: new SheetViewXform() }),
pageMargins: new PageMarginsXform(),
pageSeteup: new PageSetupXform(),
autoFilter: new AutoFilterXform(),
picture: new PictureXform()
};
// ============================================================================================
var WorksheetWriter = module.exports = function (options) {
// in a workbook, each sheet will have a number
this.id = options.id;
// and a name
this.name = options.name || 'Sheet' + this.id;
// rows are stored here while they need to be worked on.
// when they are committed, they will be deleted.
this._rows = [];
// column definitions
this._columns = null;
// column keys (addRow convenience): key ==> this._columns index
this._keys = {};
// keep record of all merges
this._merges = [];
this._merges.add = function () {}; // ignore cell instruction
// keep record of all hyperlinks
this._sheetRelsWriter = new SheetRelsWriter(options);
// keep a record of dimensions
this._dimensions = new Dimensions();
// first uncommitted row
this._rowZero = 1;
// committed flag
this.committed = false;
// for data validations
this.dataValidations = new DataValidations();
// for sharing formulae
this._formulae = {};
this._siFormulae = 0;
// for default row height, outline levels, etc
this.properties = Object.assign({}, {
defaultRowHeight: 15,
dyDescent: 55,
outlineLevelCol: 0,
outlineLevelRow: 0
}, options.properties);
// for all things printing
this.pageSetup = Object.assign({}, {
margins: { left: 0.7, right: 0.7, top: 0.75, bottom: 0.75, header: 0.3, footer: 0.3 },
orientation: 'portrait',
horizontalDpi: 4294967295,
verticalDpi: 4294967295,
fitToPage: !!(options.pageSetup && (options.pageSetup.fitToWidth || options.pageSetup.fitToHeight) && !options.pageSetup.scale),
pageOrder: 'downThenOver',
blackAndWhite: false,
draft: false,
cellComments: 'None',
errors: 'displayed',
scale: 100,
fitToWidth: 1,
fitToHeight: 1,
paperSize: undefined,
showRowColHeaders: false,
showGridLines: false,
horizontalCentered: false,
verticalCentered: false,
rowBreaks: null,
colBreaks: null
}, options.pageSetup);
// using shared strings creates a smaller xlsx file but may use more memory
this.useSharedStrings = options.useSharedStrings || false;
this._workbook = options.workbook;
// views
this._views = options.views || [];
// auto filter
this.autoFilter = options.autoFilter || null;
// start writing to stream now
this._writeOpenWorksheet();
// background
if (options.background && options.background.type === 'image') {
var imageName = this._workbook.addMedia(options.background);
var pictureId = this._sheetRelsWriter.addMedia({
Target: '../media/' + imageName,
Type: RelType.Image
});
this._background = {
rId: pictureId
};
}
this.startedData = false;
};
WorksheetWriter.prototype = {
get workbook() {
return this._workbook;
},
get stream() {
if (!this._stream) {
// eslint-disable-next-line no-underscore-dangle
this._stream = this._workbook._openStream('/xl/worksheets/sheet' + this.id + '.xml');
// pause stream to prevent 'data' events
this._stream.pause();
}
return this._stream;
},
// destroy - not a valid operation for a streaming writer
// even though some streamers might be able to, it's a bad idea.
destroy: function destroy() {
throw new Error('Invalid Operation: destroy');
},
commit: function commit() {
var _this = this;
if (this.committed) {
return;
}
// commit all rows
this._rows.forEach(function (cRow) {
if (cRow) {
// write the row to the stream
_this._writeRow(cRow);
}
});
// we _cannot_ accept new rows from now on
this._rows = null;
if (!this.startedData) {
this._writeOpenSheetData();
}
this._writeCloseSheetData();
this._writeAutoFilter();
this._writeMergeCells();
// for some reason, Excel can't handle dimensions at the bottom of the file
// this._writeDimensions();
this._writeHyperlinks();
this._writeDataValidations();
this._writePageMargins();
this._writePageSetup();
this._writeBackground();
this._writeCloseWorksheet();
// signal end of stream to workbook
this.stream.end();
// also commit the hyperlinks if any
this._sheetRelsWriter.commit();
this.committed = true;
},
// return the current dimensions of the writer
get dimensions() {
return this._dimensions;
},
get views() {
return this._views;
},
// =========================================================================
// Columns
// get the current columns array.
get columns() {
return this._columns;
},
// set the columns from an array of column definitions.
// Note: any headers defined will overwrite existing values.
set columns(value) {
var _this2 = this;
// calculate max header row count
this._headerRowCount = value.reduce(function (pv, cv) {
var headerCount = cv.header && 1 || cv.headers && cv.headers.length || 0;
return Math.max(pv, headerCount);
}, 0);
// construct Column objects
var count = 1;
var columns = this._columns = [];
value.forEach(function (defn) {
var column = new Column(_this2, count++, false);
columns.push(column);
column.defn = defn;
});
},
getColumnKey: function getColumnKey(key) {
return this._keys[key];
},
setColumnKey: function setColumnKey(key, value) {
this._keys[key] = value;
},
deleteColumnKey: function deleteColumnKey(key) {
delete this._keys[key];
},
eachColumnKey: function eachColumnKey(f) {
_.each(this._keys, f);
},
// get a single column by col number. If it doesn't exist, it and any gaps before it
// are created.
getColumn: function getColumn(c) {
if (typeof c === 'string') {
// if it matches a key'd column, return that
var col = this._keys[c];
if (col) return col;
// otherwise, assume letter
c = colCache.l2n(c);
}
if (!this._columns) {
this._columns = [];
}
if (c > this._columns.length) {
var n = this._columns.length + 1;
while (n <= c) {
this._columns.push(new Column(this, n++));
}
}
return this._columns[c - 1];
},
// =========================================================================
// Rows
get _nextRow() {
return this._rowZero + this._rows.length;
},
// iterate over every uncommitted row in the worksheet, including maybe empty rows
eachRow: function eachRow(options, iteratee) {
if (!iteratee) {
iteratee = options;
options = undefined;
}
if (options && options.includeEmpty) {
var n = this._nextRow;
for (var i = this._rowZero; i < n; i++) {
iteratee(this.getRow(i), i);
}
} else {
this._rows.forEach(function (row) {
if (row.hasValues) {
iteratee(row, row.number);
}
});
}
},
_commitRow: function _commitRow(cRow) {
// since rows must be written in order, we commit all rows up till and including cRow
var found = false;
while (this._rows.length && !found) {
var row = this._rows.shift();
this._rowZero++;
if (row) {
this._writeRow(row);
found = row.number === cRow.number;
this._rowZero = row.number + 1;
}
}
},
get lastRow() {
// returns last uncommitted row
if (this._rows.length) {
return this._rows[this._rows.length - 1];
}
return undefined;
},
// find a row (if exists) by row number
findRow: function findRow(rowNumber) {
var index = rowNumber - this._rowZero;
return this._rows[index];
},
getRow: function getRow(rowNumber) {
var index = rowNumber - this._rowZero;
// may fail if rows have been comitted
if (index < 0) {
throw new Error('Out of bounds: this row has been committed');
}
var row = this._rows[index];
if (!row) {
this._rows[index] = row = new Row(this, rowNumber);
}
return row;
},
addRow: function addRow(value) {
var row = new Row(this, this._nextRow);
this._rows[row.number - this._rowZero] = row;
row.values = value;
return row;
},
// ================================================================================
// Cells
// returns the cell at [r,c] or address given by r. If not found, return undefined
findCell: function findCell(r, c) {
var address = colCache.getAddress(r, c);
var row = this.findRow(address.row);
return row ? row.findCell(address.column) : undefined;
},
// return the cell at [r,c] or address given by r. If not found, create a new one.
getCell: function getCell(r, c) {
var address = colCache.getAddress(r, c);
var row = this.getRow(address.row);
return row.getCellEx(address);
},
mergeCells: function mergeCells() {
// may fail if rows have been comitted
var dimensions = new Dimensions(Array.prototype.slice.call(arguments, 0)); // convert arguments into Array
// check cells aren't already merged
this._merges.forEach(function (merge) {
if (merge.intersects(dimensions)) {
throw new Error('Cannot merge already merged cells');
}
});
// apply merge
var master = this.getCell(dimensions.top, dimensions.left);
for (var i = dimensions.top; i <= dimensions.bottom; i++) {
for (var j = dimensions.left; j <= dimensions.right; j++) {
if (i > dimensions.top || j > dimensions.left) {
this.getCell(i, j).merge(master);
}
}
}
// index merge
this._merges.push(dimensions);
},
// ================================================================================
_write: function _write(text) {
xmlBuffer.reset();
xmlBuffer.addText(text);
this.stream.write(xmlBuffer);
},
_writeSheetProperties: function _writeSheetProperties(xmlBuf, properties, pageSetup) {
var sheetPropertiesModel = {
tabColor: properties && properties.tabColor,
pageSetup: pageSetup && pageSetup.fitToPage ? {
fitToPage: pageSetup.fitToPage
} : undefined
};
xmlBuf.addText(xform.sheetProperties.toXml(sheetPropertiesModel));
},
_writeSheetFormatProperties: function _writeSheetFormatProperties(xmlBuf, properties) {
var sheetFormatPropertiesModel = properties ? {
defaultRowHeight: properties.defaultRowHeight,
dyDescent: properties.dyDescent,
outlineLevelCol: properties.outlineLevelCol,
outlineLevelRow: properties.outlineLevelRow
} : undefined;
xmlBuf.addText(xform.sheetFormatProperties.toXml(sheetFormatPropertiesModel));
},
_writeOpenWorksheet: function _writeOpenWorksheet() {
xmlBuffer.reset();
xmlBuffer.addText('<?xml version="1.0" encoding="UTF-8" standalone="yes"?>');
xmlBuffer.addText('<worksheet xmlns="http://schemas.openxmlformats.org/spreadsheetml/2006/main"' + ' xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships"' + ' xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"' + ' mc:Ignorable="x14ac"' + ' xmlns:x14ac="http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac">');
this._writeSheetProperties(xmlBuffer, this.properties, this.pageSetup);
xmlBuffer.addText(xform.sheetViews.toXml(this.views));
this._writeSheetFormatProperties(xmlBuffer, this.properties);
this.stream.write(xmlBuffer);
},
_writeColumns: function _writeColumns() {
var cols = Column.toModel(this.columns);
if (cols) {
xform.columns.prepare(cols, { styles: this._workbook.styles });
this.stream.write(xform.columns.toXml(cols));
}
},
_writeOpenSheetData: function _writeOpenSheetData() {
this._write('<sheetData>');
},
_writeRow: function _writeRow(row) {
if (!this.startedData) {
this._writeColumns();
this._writeOpenSheetData();
this.startedData = true;
}
if (row.hasValues || row.height) {
var model = row.model;
var options = {
styles: this._workbook.styles,
sharedStrings: this.useSharedStrings ? this._workbook.sharedStrings : undefined,
hyperlinks: this._sheetRelsWriter.hyperlinksProxy,
merges: this._merges,
formulae: this._formulae,
siFormulae: this._siFormulae
};
xform.row.prepare(model, options);
this.stream.write(xform.row.toXml(model));
}
},
_writeCloseSheetData: function _writeCloseSheetData() {
this._write('</sheetData>');
},
_writeMergeCells: function _writeMergeCells() {
if (this._merges.length) {
xmlBuffer.reset();
xmlBuffer.addText('<mergeCells count="' + this._merges.length + '">');
this._merges.forEach(function (merge) {
xmlBuffer.addText('<mergeCell ref="' + merge + '"/>');
});
xmlBuffer.addText('</mergeCells>');
this.stream.write(xmlBuffer);
}
},
_writeHyperlinks: function _writeHyperlinks() {
// eslint-disable-next-line no-underscore-dangle
this.stream.write(xform.hyperlinks.toXml(this._sheetRelsWriter._hyperlinks));
},
_writeDataValidations: function _writeDataValidations() {
this.stream.write(xform.dataValidations.toXml(this.dataValidations.model));
},
_writePageMargins: function _writePageMargins() {
this.stream.write(xform.pageMargins.toXml(this.pageSetup.margins));
},
_writePageSetup: function _writePageSetup() {
this.stream.write(xform.pageSeteup.toXml(this.pageSetup));
},
_writeAutoFilter: function _writeAutoFilter() {
this.stream.write(xform.autoFilter.toXml(this.autoFilter));
},
_writeBackground: function _writeBackground() {
if (this._background) {
this.stream.write(xform.picture.toXml(this._background));
}
},
_writeDimensions: function _writeDimensions() {
// for some reason, Excel can't handle dimensions at the bottom of the file
// and we don't know the dimensions until the commit, so don't write them.
// this._write('<dimension ref="' + this._dimensions + '"/>');
},
_writeCloseWorksheet: function _writeCloseWorksheet() {
this._write('</worksheet>');
}
};
//# sourceMappingURL=worksheet-writer.js.map