exceljs
Version:
Excel Workbook Manager - Read and Write xlsx and csv Files.
640 lines (565 loc) • 17.9 kB
JavaScript
/**
* Copyright (c) 2014-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 colCache = require('./../utils/col-cache');
var Range = require('./range');
var Row = require('./row');
var Column = require('./column');
var Enums = require('./enums');
var DataValidations = require('./data-validations');
// Worksheet requirements
// Operate as sheet inside workbook or standalone
// Load and Save from file and stream
// Access/Add/Delete individual cells
// Manage column widths and row heights
var Worksheet = module.exports = function (options) {
options = 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 allows access organised by row. Sparse array of arrays indexed by row-1, col
// Note: _rows is zero based. Must subtract 1 to go from cell.row to index
this._rows = [];
// column definitions
this._columns = null;
// column keys (addRow convenience): key ==> this._collumns index
this._keys = {};
// keep record of all merges
this._merges = {};
this._workbook = options.workbook;
// for tabColor, 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,
firstPageNumber: undefined,
horizontalCentered: false,
verticalCentered: false,
rowBreaks: null,
colBreaks: null
}, options.pageSetup);
this.dataValidations = new DataValidations();
// for freezepanes, split, zoom, gridlines, etc
this.views = options.views || [];
this.autoFilter = options.autoFilter || null;
// for images, etc
this._media = [];
};
Worksheet.prototype = {
get workbook() {
return this._workbook;
},
// when you're done with this worksheet, call this to remove from workbook
destroy: function destroy() {
this._workbook.removeWorksheetEx(this);
},
// Get the bounding range of the cells in this worksheet
get dimensions() {
var dimensions = new Range();
this._rows.forEach(function (row) {
if (row) {
var rowDims = row.dimensions;
if (rowDims) {
dimensions.expand(row.number, rowDims.min, row.number, rowDims.max);
}
}
});
return dimensions;
},
// =========================================================================
// 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 self = 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(self, 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, create it and any gaps before it
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];
},
spliceColumns: function spliceColumns(start, count) {
// each member of inserts is a column of data.
var i;
var inserts = Array.prototype.slice.call(arguments, 2);
var rows = this._rows;
var nRows = rows.length;
if (inserts.length > 0) {
// must iterate over all rows whether they exist yet or not
for (i = 0; i < nRows; i++) {
var rowArguments = [start, count];
inserts.forEach(function (insert) {
// eslint-disable-line no-loop-func
rowArguments.push(insert[i] || null);
});
var row = this.getRow(i + 1);
// eslint-disable-next-line prefer-spread
row.splice.apply(row, rowArguments);
}
} else {
// nothing to insert, so just splice all rows
this._rows.forEach(function (r) {
if (r) {
r.splice(start, count);
}
});
}
// splice column definitions
var nExpand = inserts.length - count;
var nKeep = start + count;
var nEnd = this._columns.length;
if (nExpand < 0) {
for (i = nKeep; i <= nEnd; i++) {
this.getColumn(i + nExpand).defn = this.getColumn(i).defn;
}
for (i = nEnd + nExpand + 1; i <= nEnd; i++) {
this.getColumn(i).defn = null;
}
} else {
for (i = nEnd; i >= nKeep; i--) {
this.getColumn(i + nExpand).defn = this.getColumn(i).defn;
}
}
for (i = start; i < nKeep + nExpand; i++) {
this.getColumn(i).defn = null;
}
},
get columnCount() {
var maxCount = 0;
this.eachRow(function (row) {
maxCount = Math.max(maxCount, row.cellCount);
});
return maxCount;
},
get actualColumnCount() {
// performance nightmare - for each row, counts all the columns used
var counts = [];
var count = 0;
this.eachRow(function (row) {
row.eachCell(function (cell) {
var col = cell.col;
if (!counts[col]) {
counts[col] = true;
count++;
}
});
});
return count;
},
// =========================================================================
// Rows
_commitRow: function _commitRow() {
// nop - allows streaming reader to fill a document
},
get _lastRowNumber() {
// need to cope with results of splice
var rows = this._rows;
var n = rows.length;
while (n > 0 && rows[n - 1] === undefined) {
n--;
}
return n;
},
get _nextRow() {
return this._lastRowNumber + 1;
},
get lastRow() {
if (this._rows.length) {
return this._rows[this._rows.length - 1];
}
return undefined;
},
// find a row (if exists) by row number
findRow: function findRow(r) {
return this._rows[r - 1];
},
get rowCount() {
return this._lastRowNumber;
},
get actualRowCount() {
// counts actual rows that have actual data
var count = 0;
this.eachRow(function () {
count++;
});
return count;
},
// get a row by row number.
getRow: function getRow(r) {
var row = this._rows[r - 1];
if (!row) {
row = this._rows[r - 1] = new Row(this, r);
}
return row;
},
addRow: function addRow(value) {
var row = this.getRow(this._nextRow);
row.values = value;
return row;
},
addRows: function addRows(value) {
var self = this;
value.forEach(function (row) {
self.addRow(row);
});
},
spliceRows: function spliceRows(start, count) {
// same problem as row.splice, except worse.
var inserts = Array.prototype.slice.call(arguments, 2);
var nKeep = start + count;
var nExpand = inserts.length - count;
var nEnd = this._rows.length;
var i, rSrc;
if (nExpand < 0) {
// remove rows
for (i = nKeep; i <= nEnd; i++) {
rSrc = this._rows[i - 1];
if (rSrc) {
this.getRow(i + nExpand).values = rSrc.values;
this._rows[i - 1] = undefined;
} else {
this._rows[i + nExpand - 1] = undefined;
}
}
} else if (nExpand > 0) {
// insert new cells
for (i = nEnd; i >= nKeep; i--) {
rSrc = this._rows[i - 1];
if (rSrc) {
this.getRow(i + nExpand).values = rSrc.values;
} else {
this._rows[i + nExpand - 1] = undefined;
}
}
}
// now copy over the new values
for (i = 0; i < inserts.length; i++) {
this.getRow(start + i).values = inserts[i];
}
},
// iterate over every 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._rows.length;
for (var i = 1; i <= n; i++) {
iteratee(this.getRow(i), i);
}
} else {
this._rows.forEach(function (row) {
if (row && row.hasValues) {
iteratee(row, row.number);
}
});
}
},
// return all rows as sparse array
getSheetValues: function getSheetValues() {
var rows = [];
this._rows.forEach(function (row) {
if (row) {
rows[row.number] = row.values;
}
});
return rows;
},
// =========================================================================
// 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._rows[address.row - 1];
return row ? row.findCell(address.col) : 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);
},
// =========================================================================
// Merge
// convert the range defined by ['tl:br'], [tl,br] or [t,l,b,r] into a single 'merged' cell
mergeCells: function mergeCells() {
var dimensions = new Range(Array.prototype.slice.call(arguments, 0)); // convert arguments into Array
// check cells aren't already merged
_.each(this._merges, 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++) {
// merge all but the master cell
if (i > dimensions.top || j > dimensions.left) {
this.getCell(i, j).merge(master);
}
}
}
// index merge
this._merges[master.address] = dimensions;
},
_unMergeMaster: function _unMergeMaster(master) {
// master is always top left of a rectangle
var merge = this._merges[master.address];
if (merge) {
for (var i = merge.top; i <= merge.bottom; i++) {
for (var j = merge.left; j <= merge.right; j++) {
this.getCell(i, j).unmerge();
}
}
delete this._merges[master.address];
}
},
get hasMerges() {
return _.some(this._merges, function () {
// TODO: this doesn't look right
return true;
});
},
// scan the range defined by ['tl:br'], [tl,br] or [t,l,b,r] and if any cell is part of a merge,
// un-merge the group. Note this function can affect multiple merges and merge-blocks are
// atomic - either they're all merged or all un-merged.
unMergeCells: function unMergeCells() {
var dimensions = new Range(Array.prototype.slice.call(arguments, 0)); // convert arguments into Array
// find any cells in that range and unmerge them
for (var i = dimensions.top; i <= dimensions.bottom; i++) {
for (var j = dimensions.left; j <= dimensions.right; j++) {
var cell = this.findCell(i, j);
if (cell) {
if (cell.type === Enums.ValueType.Merge) {
// this cell merges to another master
this._unMergeMaster(cell.master);
} else if (this._merges[cell.address]) {
// this cell is a master
this._unMergeMaster(cell);
}
}
}
}
},
// ===========================================================================
// Shared Formula
fillFormula: function fillFormula(range, formula, results) {
// Define formula for top-left cell and share to rest
var decoded = colCache.decode(range);
var top = decoded.top,
left = decoded.left,
bottom = decoded.bottom,
right = decoded.right;
var width = right - left + 1;
var masterAddress = colCache.encodeAddress(top, left);
// work out result accessor
var getResult;
if (typeof results === 'function') {
getResult = results;
} else if (Array.isArray(results)) {
if (Array.isArray(results[0])) {
getResult = function getResult(row, col) {
return results[row - top][col - left];
};
} else {
getResult = function getResult(row, col) {
return results[(row - top) * width + (col - left)];
};
}
} else {
getResult = function getResult() {
return undefined;
};
}
var first = true;
for (var r = top; r <= bottom; r++) {
for (var c = left; c <= right; c++) {
if (first) {
this.getCell(r, c).value = {
formula: formula,
result: getResult(r, c)
};
first = false;
} else {
this.getCell(r, c).value = {
sharedFormula: masterAddress,
result: getResult(r, c)
};
}
}
}
},
// =========================================================================
// Images
addImage: function addImageToCells(imageId, range) {
this._media.push({
type: 'image',
imageId: imageId,
range: range
});
},
getImages: function getImages() {
return this._media.filter(function (m) {
return m.type === 'image';
});
},
addBackgroundImage: function addBackgroundImage(imageId) {
this._media.push({
type: 'background',
imageId: imageId
});
},
getBackgroundImageId: function getBackgroundImageId() {
return this._media.filter(function (m) {
return m.type === 'background';
}).map(function (m) {
return m.imageId;
})[0];
},
// ===========================================================================
// Deprecated
get tabColor() {
// eslint-disable-next-line no-console
console.trace('worksheet.tabColor property is now deprecated. Please use worksheet.properties.tabColor');
return this.properties.tabColor;
},
set tabColor(value) {
// eslint-disable-next-line no-console
console.trace('worksheet.tabColor property is now deprecated. Please use worksheet.properties.tabColor');
this.properties.tabColor = value;
},
// ===========================================================================
// Model
get model() {
var model = {
id: this.id,
name: this.name,
dataValidations: this.dataValidations.model,
properties: this.properties,
pageSetup: this.pageSetup,
views: this.views,
autoFilter: this.autoFilter,
media: this._media
};
// =================================================
// columns
model.cols = Column.toModel(this.columns);
// ==========================================================
// Rows
var rows = model.rows = [];
var dimensions = model.dimensions = new Range();
this._rows.forEach(function (row) {
var rowModel = row && row.model;
if (rowModel) {
dimensions.expand(rowModel.number, rowModel.min, rowModel.number, rowModel.max);
rows.push(rowModel);
}
});
// ==========================================================
// Merges
model.merges = [];
_.each(this._merges, function (merge) {
model.merges.push(merge.range);
});
return model;
},
_parseRows: function _parseRows(model) {
var _this = this;
this._rows = [];
model.rows.forEach(function (rowModel) {
var row = new Row(_this, rowModel.number);
_this._rows[row.number - 1] = row;
row.model = rowModel;
});
},
_parseMergeCells: function _parseMergeCells(model) {
var _this2 = this;
_.each(model.mergeCells, function (merge) {
_this2.mergeCells(merge);
});
},
set model(value) {
this.name = value.name;
this._columns = Column.fromModel(this, value.cols);
this._parseRows(value);
this._parseMergeCells(value);
this.dataValidations = new DataValidations(value.dataValidations);
this.properties = value.properties;
this.pageSetup = value.pageSetup;
this.views = value.views;
this.autoFilter = value.autoFilter;
this._media = value.media;
}
};
//# sourceMappingURL=worksheet.js.map