exceljs
Version:
Excel Workbook Manager - Read and Write xlsx and csv Files.
454 lines (392 loc) • 14.7 kB
JavaScript
/**
* Copyright (c) 2015 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 PromishLib = require('../../../utils/promish');
var utils = require('../../../utils/utils');
var Enums = require('../../../doc/enums');
var XmlStream = require('../../../utils/xml-stream');
var BaseXform = require('../base-xform');
var StaticXform = require('../static-xform');
var ListXform = require('../list-xform');
var FontXform = require('./font-xform');
var FillXform = require('./fill-xform');
var BorderXform = require('./border-xform');
var NumFmtXform = require('./numfmt-xform');
var StyleXform = require('./style-xform');
// custom numfmt ids start here
var NUMFMT_BASE = 164;
// =============================================================================
// StylesXform is used to generate and parse the styles.xml file
// it manages the collections of fonts, number formats, alignments, etc
var StylesXform = module.exports = function (initialise) {
this.map = {
numFmts: new ListXform({ tag: 'numFmts', count: true, childXform: new NumFmtXform() }),
fonts: new ListXform({ tag: 'fonts', count: true, childXform: new FontXform(), $: { 'x14ac:knownFonts': 1 } }),
fills: new ListXform({ tag: 'fills', count: true, childXform: new FillXform() }),
borders: new ListXform({ tag: 'borders', count: true, childXform: new BorderXform() }),
cellStyleXfs: new ListXform({ tag: 'cellStyleXfs', count: true, childXform: new StyleXform() }),
cellXfs: new ListXform({ tag: 'cellXfs', count: true, childXform: new StyleXform({ xfId: true }) }),
// for style manager
numFmt: new NumFmtXform(),
font: new FontXform(),
fill: new FillXform(),
border: new BorderXform(),
style: new StyleXform({ xfId: true }),
cellStyles: StylesXform.STATIC_XFORMS.cellStyles,
dxfs: StylesXform.STATIC_XFORMS.dxfs,
tableStyles: StylesXform.STATIC_XFORMS.tableStyles,
extLst: StylesXform.STATIC_XFORMS.extLst
};
if (initialise) {
// StylesXform also acts as style manager and is used to build up styles-model during worksheet processing
this.init();
}
};
utils.inherits(StylesXform, BaseXform, {
STYLESHEET_ATTRIBUTES: {
xmlns: 'http://schemas.openxmlformats.org/spreadsheetml/2006/main',
'xmlns:mc': 'http://schemas.openxmlformats.org/markup-compatibility/2006',
'mc:Ignorable': 'x14ac x16r2',
'xmlns:x14ac': 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/ac',
'xmlns:x16r2': 'http://schemas.microsoft.com/office/spreadsheetml/2015/02/main'
},
STATIC_XFORMS: {
cellStyles: new StaticXform({ tag: 'cellStyles', $: { count: 1 }, c: [{ tag: 'cellStyle', $: { name: 'Normal', xfId: 0, builtinId: 0 } }] }),
dxfs: new StaticXform({ tag: 'dxfs', $: { count: 0 } }),
tableStyles: new StaticXform({ tag: 'tableStyles', $: { count: 0, defaultTableStyle: 'TableStyleMedium2', defaultPivotStyle: 'PivotStyleLight16' } }),
extLst: new StaticXform({ tag: 'extLst', c: [{ tag: 'ext', $: { uri: '{EB79DEF2-80B8-43e5-95BD-54CBDDF9020C}', 'xmlns:x14': 'http://schemas.microsoft.com/office/spreadsheetml/2009/9/main' }, c: [{ tag: 'x14:slicerStyles', $: { defaultSlicerStyle: 'SlicerStyleLight1' } }] }, { tag: 'ext', $: { uri: '{9260A510-F301-46a8-8635-F512D64BE5F5}', 'xmlns:x15': 'http://schemas.microsoft.com/office/spreadsheetml/2010/11/main' }, c: [{ tag: 'x15:timelineStyles', $: { defaultTimelineStyle: 'TimeSlicerStyleLight1' } }] }] })
}
}, {
initIndex: function initIndex() {
this.index = {
style: {},
numFmt: {},
numFmtNextId: 164, // start custom format ids here
font: {},
border: {},
fill: {}
};
},
init: function init() {
// Prepare for Style Manager role
this.model = {
styles: [],
numFmts: [],
fonts: [],
borders: [],
fills: []
};
this.initIndex();
// default (zero) font
this._addFont({ size: 11, color: { theme: 1 }, name: 'Calibri', family: 2, scheme: 'minor' });
// default (zero) border
this._addBorder({});
// add default (all zero) style
this._addStyle({ numFmtId: 0, fontId: 0, fillId: 0, borderId: 0, xfId: 0 });
// add default fills
this._addFill({ type: 'pattern', pattern: 'none' });
this._addFill({ type: 'pattern', pattern: 'gray125' });
},
render: function render(xmlStream, model) {
model = model || this.model;
//
// <fonts count="2" x14ac:knownFonts="1">
xmlStream.openXml(XmlStream.StdDocAttributes);
xmlStream.openNode('styleSheet', StylesXform.STYLESHEET_ATTRIBUTES);
if (this.index) {
// model has been built by style manager role (contains xml)
if (model.numFmts && model.numFmts.length) {
xmlStream.openNode('numFmts', { count: model.numFmts.length });
model.numFmts.forEach(function (numFmtXml) {
xmlStream.writeXml(numFmtXml);
});
xmlStream.closeNode();
}
xmlStream.openNode('fonts', { count: model.fonts.length });
model.fonts.forEach(function (fontXml) {
xmlStream.writeXml(fontXml);
});
xmlStream.closeNode();
xmlStream.openNode('fills', { count: model.fills.length });
model.fills.forEach(function (fillXml) {
xmlStream.writeXml(fillXml);
});
xmlStream.closeNode();
xmlStream.openNode('borders', { count: model.borders.length });
model.borders.forEach(function (borderXml) {
xmlStream.writeXml(borderXml);
});
xmlStream.closeNode();
this.map.cellStyleXfs.render(xmlStream, [{ numFmtId: 0, fontId: 0, fillId: 0, borderId: 0, xfId: 0 }]);
xmlStream.openNode('cellXfs', { count: model.styles.length });
model.styles.forEach(function (styleXml) {
xmlStream.writeXml(styleXml);
});
xmlStream.closeNode();
} else {
// model is plain JSON and needs to be xformed
this.map.numFmts.render(xmlStream, model.numFmts);
this.map.fonts.render(xmlStream, model.fonts);
this.map.fills.render(xmlStream, model.fills);
this.map.borders.render(xmlStream, model.borders);
this.map.cellStyleXfs.render(xmlStream, [{ numFmtId: 0, fontId: 0, fillId: 0, borderId: 0, xfId: 0 }]);
this.map.cellXfs.render(xmlStream, model.styles);
}
// trailing static stuff
StylesXform.STATIC_XFORMS.cellStyles.render(xmlStream);
StylesXform.STATIC_XFORMS.dxfs.render(xmlStream);
StylesXform.STATIC_XFORMS.tableStyles.render(xmlStream);
StylesXform.STATIC_XFORMS.extLst.render(xmlStream);
xmlStream.closeNode();
},
parseOpen: function parseOpen(node) {
if (this.parser) {
this.parser.parseOpen(node);
return true;
}
switch (node.name) {
case 'styleSheet':
this.initIndex();
return true;
default:
this.parser = this.map[node.name];
if (this.parser) {
this.parser.parseOpen(node);
}
return true;
}
},
parseText: function parseText(text) {
if (this.parser) {
this.parser.parseText(text);
}
},
parseClose: function parseClose(name) {
if (this.parser) {
if (!this.parser.parseClose(name)) {
this.parser = undefined;
}
return true;
}
switch (name) {
case 'styleSheet':
var model = this.model = {};
var add = function add(propName, xform) {
if (xform.model && xform.model.length) {
model[propName] = xform.model;
}
};
add('numFmts', this.map.numFmts);
add('fonts', this.map.fonts);
add('fills', this.map.fills);
add('borders', this.map.borders);
add('styles', this.map.cellXfs);
// index numFmts
this.index = {
model: [],
numFmt: []
};
if (model.numFmts) {
var numFmtIndex = this.index.numFmt;
model.numFmts.forEach(function (numFmt) {
numFmtIndex[numFmt.id] = numFmt.formatCode;
});
}
return false;
default:
// not quite sure how we get here!
return true;
}
},
// add a cell's style model to the collection
// each style property is processed and cross-referenced, etc.
// the styleId is returned. Note: cellType is used when numFmt not defined
addStyleModel: function addStyleModel(model, cellType) {
if (!model) {
return 0;
}
// if we have seen this style object before, assume it has the same styleId
if (this.weakMap && this.weakMap.has(model)) {
return this.weakMap.get(model);
}
var style = {};
cellType = cellType || Enums.ValueType.Number;
if (model.numFmt) {
style.numFmtId = this._addNumFmtStr(model.numFmt);
} else {
switch (cellType) {
case Enums.ValueType.Number:
style.numFmtId = this._addNumFmtStr('General');
break;
case Enums.ValueType.Date:
style.numFmtId = this._addNumFmtStr('mm-dd-yy');
break;
default:
break;
}
}
if (model.font) {
style.fontId = this._addFont(model.font);
}
if (model.border) {
style.borderId = this._addBorder(model.border);
}
if (model.fill) {
style.fillId = this._addFill(model.fill);
}
if (model.alignment) {
style.alignment = model.alignment;
}
var styleId = this._addStyle(style);
if (this.weakMap) {
this.weakMap.set(model, styleId);
}
return styleId;
},
// given a styleId (i.e. s="n"), get the cell's style model
// objects are shared where possible.
getStyleModel: function getStyleModel(id) {
// if the style doesn't exist return null
var style = this.model.styles[id];
if (!style) return null;
// have we built this model before?
var model = this.index.model[id];
if (model) return model;
// build a new model
model = this.index.model[id] = {};
// -------------------------------------------------------
// number format
if (style.numFmtId) {
var numFmt = this.index.numFmt[style.numFmtId] || NumFmtXform.getDefaultFmtCode(style.numFmtId);
if (numFmt) {
model.numFmt = numFmt;
}
}
function addStyle(name, group, styleId) {
if (styleId) {
var part = group[styleId];
if (part) {
model[name] = part;
}
}
}
addStyle('font', this.model.fonts, style.fontId);
addStyle('border', this.model.borders, style.borderId);
addStyle('fill', this.model.fills, style.fillId);
// -------------------------------------------------------
// alignment
if (style.alignment) {
model.alignment = style.alignment;
}
return model;
},
// =========================================================================
// Private Interface
_addStyle: function _addStyle(style) {
var xml = this.map.style.toXml(style);
var index = this.index.style[xml];
if (index === undefined) {
index = this.index.style[xml] = this.model.styles.length;
this.model.styles.push(xml);
}
return index;
},
// =========================================================================
// Number Formats
_addNumFmtStr: function _addNumFmtStr(formatCode) {
// check if default format
var index = NumFmtXform.getDefaultFmtId(formatCode);
if (index !== undefined) return index;
// check if already in
index = this.index.numFmt[formatCode];
if (index !== undefined) return index;
index = this.index.numFmt[formatCode] = NUMFMT_BASE + this.model.numFmts.length;
var xml = this.map.numFmt.toXml({ id: index, formatCode: formatCode });
this.model.numFmts.push(xml);
return index;
},
// =========================================================================
// Fonts
_addFont: function _addFont(font) {
var xml = this.map.font.toXml(font);
var index = this.index.font[xml];
if (index === undefined) {
index = this.index.font[xml] = this.model.fonts.length;
this.model.fonts.push(xml);
}
return index;
},
// =========================================================================
// Borders
_addBorder: function _addBorder(border) {
var xml = this.map.border.toXml(border);
var index = this.index.border[xml];
if (index === undefined) {
index = this.index.border[xml] = this.model.borders.length;
this.model.borders.push(xml);
}
return index;
},
// =========================================================================
// Fills
_addFill: function _addFill(fill) {
var xml = this.map.fill.toXml(fill);
var index = this.index.fill[xml];
if (index === undefined) {
index = this.index.fill[xml] = this.model.fills.length;
this.model.fills.push(xml);
}
return index;
}
// =========================================================================
});
// the stylemanager mock acts like StyleManager except that it always returns 0 or {}
StylesXform.Mock = function () {
StylesXform.call(this);
this.model = {
styles: [{ numFmtId: 0, fontId: 0, fillId: 0, borderId: 0, xfId: 0 }],
numFmts: [],
fonts: [{ size: 11, color: { theme: 1 }, name: 'Calibri', family: 2, scheme: 'minor' }],
borders: [{}],
fills: [{ type: 'pattern', pattern: 'none' }, { type: 'pattern', pattern: 'gray125' }]
};
};
utils.inherits(StylesXform.Mock, StylesXform, {
// =========================================================================
// Style Manager Interface
// override normal behaviour - consume and dispose
parseStream: function parseStream(stream) {
stream.autodrain();
return PromishLib.Promish.resolve();
},
// add a cell's style model to the collection
// each style property is processed and cross-referenced, etc.
// the styleId is returned. Note: cellType is used when numFmt not defined
addStyleModel: function addStyleModel(model, cellType) {
switch (cellType) {
case Enums.ValueType.Date:
return this.dateStyleId;
default:
return 0;
}
},
get dateStyleId() {
if (!this._dateStyleId) {
var dateStyle = {
numFmtId: NumFmtXform.getDefaultFmtId('mm-dd-yy')
};
this._dateStyleId = this.model.styles.length;
this.model.styles.push(dateStyle);
}
return this._dateStyleId;
},
// given a styleId (i.e. s="n"), get the cell's style model
// objects are shared where possible.
getStyleModel: function getStyleModel() /* id */{
return {};
}
});
//# sourceMappingURL=styles-xform.js.map