| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202 |
- 'use strict';
- const Worksheet = require('./worksheet');
- const DefinedNames = require('./defined-names');
- const XLSX = require('../xlsx/xlsx');
- const CSV = require('../csv/csv');
- // Workbook requirements
- // Load and Save from file and stream
- // Access/Add/Delete individual worksheets
- // Manage String table, Hyperlink table, etc.
- // Manage scaffolding for contained objects to write to/read from
- class Workbook {
- constructor() {
- this.category = '';
- this.company = '';
- this.created = new Date();
- this.description = '';
- this.keywords = '';
- this.manager = '';
- this.modified = this.created;
- this.properties = {};
- this.calcProperties = {};
- this._worksheets = [];
- this.subject = '';
- this.title = '';
- this.views = [];
- this.media = [];
- this._definedNames = new DefinedNames();
- }
- get xlsx() {
- if (!this._xlsx) this._xlsx = new XLSX(this);
- return this._xlsx;
- }
- get csv() {
- if (!this._csv) this._csv = new CSV(this);
- return this._csv;
- }
- get nextId() {
- // find the next unique spot to add worksheet
- for (let i = 1; i < this._worksheets.length; i++) {
- if (!this._worksheets[i]) {
- return i;
- }
- }
- return this._worksheets.length || 1;
- }
- addWorksheet(name, options) {
- const id = this.nextId;
- // if options is a color, call it tabColor (and signal deprecated message)
- if (options) {
- if (typeof options === 'string') {
- // eslint-disable-next-line no-console
- console.trace('tabColor argument is now deprecated. Please use workbook.addWorksheet(name, {properties: { tabColor: { argb: "rbg value" } }');
- options = {
- properties: {
- tabColor: {
- argb: options
- }
- }
- };
- } else if (options.argb || options.theme || options.indexed) {
- // eslint-disable-next-line no-console
- console.trace('tabColor argument is now deprecated. Please use workbook.addWorksheet(name, {properties: { tabColor: { ... } }');
- options = {
- properties: {
- tabColor: options
- }
- };
- }
- }
- const lastOrderNo = this._worksheets.reduce((acc, ws) => (ws && ws.orderNo) > acc ? ws.orderNo : acc, 0);
- const worksheetOptions = Object.assign({}, options, {
- id,
- name,
- orderNo: lastOrderNo + 1,
- workbook: this
- });
- const worksheet = new Worksheet(worksheetOptions);
- this._worksheets[id] = worksheet;
- return worksheet;
- }
- removeWorksheetEx(worksheet) {
- delete this._worksheets[worksheet.id];
- }
- removeWorksheet(id) {
- const worksheet = this.getWorksheet(id);
- if (worksheet) {
- worksheet.destroy();
- }
- }
- getWorksheet(id) {
- if (id === undefined) {
- return this._worksheets.find(Boolean);
- }
- if (typeof id === 'number') {
- return this._worksheets[id];
- }
- if (typeof id === 'string') {
- return this._worksheets.find(worksheet => worksheet && worksheet.name === id);
- }
- return undefined;
- }
- get worksheets() {
- // return a clone of _worksheets
- return this._worksheets.slice(1).sort((a, b) => a.orderNo - b.orderNo).filter(Boolean);
- }
- eachSheet(iteratee) {
- this.worksheets.forEach(sheet => {
- iteratee(sheet, sheet.id);
- });
- }
- get definedNames() {
- return this._definedNames;
- }
- clearThemes() {
- // Note: themes are not an exposed feature, meddle at your peril!
- this._themes = undefined;
- }
- addImage(image) {
- // TODO: validation?
- const id = this.media.length;
- this.media.push(Object.assign({}, image, {
- type: 'image'
- }));
- return id;
- }
- getImage(id) {
- return this.media[id];
- }
- get model() {
- return {
- creator: this.creator || 'Unknown',
- lastModifiedBy: this.lastModifiedBy || 'Unknown',
- lastPrinted: this.lastPrinted,
- created: this.created,
- modified: this.modified,
- properties: this.properties,
- worksheets: this.worksheets.map(worksheet => worksheet.model),
- sheets: this.worksheets.map(ws => ws.model).filter(Boolean),
- definedNames: this._definedNames.model,
- views: this.views,
- company: this.company,
- manager: this.manager,
- title: this.title,
- subject: this.subject,
- keywords: this.keywords,
- category: this.category,
- description: this.description,
- language: this.language,
- revision: this.revision,
- contentStatus: this.contentStatus,
- themes: this._themes,
- media: this.media,
- calcProperties: this.calcProperties
- };
- }
- set model(value) {
- this.creator = value.creator;
- this.lastModifiedBy = value.lastModifiedBy;
- this.lastPrinted = value.lastPrinted;
- this.created = value.created;
- this.modified = value.modified;
- this.company = value.company;
- this.manager = value.manager;
- this.title = value.title;
- this.subject = value.subject;
- this.keywords = value.keywords;
- this.category = value.category;
- this.description = value.description;
- this.language = value.language;
- this.revision = value.revision;
- this.contentStatus = value.contentStatus;
- this.properties = value.properties;
- this.calcProperties = value.calcProperties;
- this._worksheets = [];
- value.worksheets.forEach(worksheetModel => {
- const {
- id,
- name,
- state
- } = worksheetModel;
- const orderNo = value.sheets && value.sheets.findIndex(ws => ws.id === id);
- const worksheet = this._worksheets[id] = new Worksheet({
- id,
- name,
- orderNo,
- state,
- workbook: this
- });
- worksheet.model = worksheetModel;
- });
- this._definedNames.model = value.definedNames;
- this.views = value.views;
- this._themes = value.themes;
- this.media = value.media || [];
- }
- }
- module.exports = Workbook;
- //# sourceMappingURL=workbook.js.map
|