@yuanliwei/exceljs 4.4.0

package/lib/doc/range.js

@@ -0,0 +1,257 @@
+const colCache = require('../utils/col-cache');
+
+// used by worksheet to calculate sheet dimensions
+class Range {
+  constructor() {
+    this.decode(arguments);
+  }
+
+  setTLBR(t, l, b, r, s) {
+    if (arguments.length < 4) {
+      // setTLBR(tl, br, s)
+      const tl = colCache.decodeAddress(t);
+      const br = colCache.decodeAddress(l);
+      this.model = {
+        top: Math.min(tl.row, br.row),
+        left: Math.min(tl.col, br.col),
+        bottom: Math.max(tl.row, br.row),
+        right: Math.max(tl.col, br.col),
+        sheetName: b,
+      };
+
+      this.setTLBR(tl.row, tl.col, br.row, br.col, s);
+    } else {
+      // setTLBR(t, l, b, r, s)
+      this.model = {
+        top: Math.min(t, b),
+        left: Math.min(l, r),
+        bottom: Math.max(t, b),
+        right: Math.max(l, r),
+        sheetName: s,
+      };
+    }
+  }
+
+  decode(argv) {
+    switch (argv.length) {
+      case 5: // [t,l,b,r,s]
+        this.setTLBR(argv[0], argv[1], argv[2], argv[3], argv[4]);
+        break;
+      case 4: // [t,l,b,r]
+        this.setTLBR(argv[0], argv[1], argv[2], argv[3]);
+        break;
+
+      case 3: // [tl,br,s]
+        this.setTLBR(argv[0], argv[1], argv[2]);
+        break;
+      case 2: // [tl,br]
+        this.setTLBR(argv[0], argv[1]);
+        break;
+
+      case 1: {
+        const value = argv[0];
+        if (value instanceof Range) {
+          // copy constructor
+          this.model = {
+            top: value.model.top,
+            left: value.model.left,
+            bottom: value.model.bottom,
+            right: value.model.right,
+            sheetName: value.sheetName,
+          };
+        } else if (value instanceof Array) {
+          // an arguments array
+          this.decode(value);
+        } else if (value.top && value.left && value.bottom && value.right) {
+          // a model
+          this.model = {
+            top: value.top,
+            left: value.left,
+            bottom: value.bottom,
+            right: value.right,
+            sheetName: value.sheetName,
+          };
+        } else {
+          // [sheetName!]tl:br
+          const tlbr = colCache.decodeEx(value);
+          if (tlbr.top) {
+            this.model = {
+              top: tlbr.top,
+              left: tlbr.left,
+              bottom: tlbr.bottom,
+              right: tlbr.right,
+              sheetName: tlbr.sheetName,
+            };
+          } else {
+            this.model = {
+              top: tlbr.row,
+              left: tlbr.col,
+              bottom: tlbr.row,
+              right: tlbr.col,
+              sheetName: tlbr.sheetName,
+            };
+          }
+        }
+        break;
+      }
+
+      case 0:
+        this.model = {
+          top: 0,
+          left: 0,
+          bottom: 0,
+          right: 0,
+        };
+        break;
+
+      default:
+        throw new Error(`Invalid number of arguments to _getDimensions() - ${argv.length}`);
+    }
+  }
+
+  get top() {
+    return this.model.top || 1;
+  }
+
+  set top(value) {
+    this.model.top = value;
+  }
+
+  get left() {
+    return this.model.left || 1;
+  }
+
+  set left(value) {
+    this.model.left = value;
+  }
+
+  get bottom() {
+    return this.model.bottom || 1;
+  }
+
+  set bottom(value) {
+    this.model.bottom = value;
+  }
+
+  get right() {
+    return this.model.right || 1;
+  }
+
+  set right(value) {
+    this.model.right = value;
+  }
+
+  get sheetName() {
+    return this.model.sheetName;
+  }
+
+  set sheetName(value) {
+    this.model.sheetName = value;
+  }
+
+  get _serialisedSheetName() {
+    const {sheetName} = this.model;
+    if (sheetName) {
+      if (/^[a-zA-Z0-9]*$/.test(sheetName)) {
+        return `${sheetName}!`;
+      }
+      return `'${sheetName}'!`;
+    }
+    return '';
+  }
+
+  expand(top, left, bottom, right) {
+    if (!this.model.top || top < this.top) this.top = top;
+    if (!this.model.left || left < this.left) this.left = left;
+    if (!this.model.bottom || bottom > this.bottom) this.bottom = bottom;
+    if (!this.model.right || right > this.right) this.right = right;
+  }
+
+  expandRow(row) {
+    if (row) {
+      const {dimensions, number} = row;
+      if (dimensions) {
+        this.expand(number, dimensions.min, number, dimensions.max);
+      }
+    }
+  }
+
+  expandToAddress(addressStr) {
+    const address = colCache.decodeEx(addressStr);
+    this.expand(address.row, address.col, address.row, address.col);
+  }
+
+  get tl() {
+    return colCache.n2l(this.left) + this.top;
+  }
+
+  get $t$l() {
+    return `$${colCache.n2l(this.left)}$${this.top}`;
+  }
+
+  get br() {
+    return colCache.n2l(this.right) + this.bottom;
+  }
+
+  get $b$r() {
+    return `$${colCache.n2l(this.right)}$${this.bottom}`;
+  }
+
+  get range() {
+    return `${this._serialisedSheetName + this.tl}:${this.br}`;
+  }
+
+  get $range() {
+    return `${this._serialisedSheetName + this.$t$l}:${this.$b$r}`;
+  }
+
+  get shortRange() {
+    return this.count > 1 ? this.range : this._serialisedSheetName + this.tl;
+  }
+
+  get $shortRange() {
+    return this.count > 1 ? this.$range : this._serialisedSheetName + this.$t$l;
+  }
+
+  get count() {
+    return (1 + this.bottom - this.top) * (1 + this.right - this.left);
+  }
+
+  toString() {
+    return this.range;
+  }
+
+  intersects(other) {
+    if (other.sheetName && this.sheetName && other.sheetName !== this.sheetName) return false;
+    if (other.bottom < this.top) return false;
+    if (other.top > this.bottom) return false;
+    if (other.right < this.left) return false;
+    if (other.left > this.right) return false;
+    return true;
+  }
+
+  contains(addressStr) {
+    const address = colCache.decodeEx(addressStr);
+    return this.containsEx(address);
+  }
+
+  containsEx(address) {
+    if (address.sheetName && this.sheetName && address.sheetName !== this.sheetName) return false;
+    return (
+      address.row >= this.top &&
+      address.row <= this.bottom &&
+      address.col >= this.left &&
+      address.col <= this.right
+    );
+  }
+
+  forEachAddress(cb) {
+    for (let col = this.left; col <= this.right; col++) {
+      for (let row = this.top; row <= this.bottom; row++) {
+        cb(colCache.encodeAddress(row, col), row, col);
+      }
+    }
+  }
+}
+
+module.exports = Range;

package/lib/doc/row.js

@@ -0,0 +1,415 @@
+'use strict';
+
+const _ = require('../utils/under-dash');
+
+const Enums = require('./enums');
+const colCache = require('../utils/col-cache');
+const Cell = require('./cell');
+
+class Row {
+  constructor(worksheet, number) {
+    this._worksheet = worksheet;
+    this._number = number;
+    this._cells = [];
+    this.style = {};
+    this.outlineLevel = 0;
+  }
+
+  // return the row number
+  get number() {
+    return this._number;
+  }
+
+  get worksheet() {
+    return this._worksheet;
+  }
+
+  // Inform Streaming Writer that this row (and all rows before it) are complete
+  // and ready to write. Has no effect on Worksheet document
+  commit() {
+    this._worksheet._commitRow(this); // eslint-disable-line no-underscore-dangle
+  }
+
+  // helps GC by breaking cyclic references
+  destroy() {
+    delete this._worksheet;
+    delete this._cells;
+    delete this.style;
+  }
+
+  findCell(colNumber) {
+    return this._cells[colNumber - 1];
+  }
+
+  // given {address, row, col}, find or create new cell
+  getCellEx(address) {
+    let cell = this._cells[address.col - 1];
+    if (!cell) {
+      const column = this._worksheet.getColumn(address.col);
+      cell = new Cell(this, column, address.address);
+      this._cells[address.col - 1] = cell;
+    }
+    return cell;
+  }
+
+  // get cell by key, letter or column number
+  getCell(col) {
+    if (typeof col === 'string') {
+      // is it a key?
+      const column = this._worksheet.getColumnKey(col);
+      if (column) {
+        col = column.number;
+      } else {
+        col = colCache.l2n(col);
+      }
+    }
+    return (
+      this._cells[col - 1] ||
+      this.getCellEx({
+        address: colCache.encodeAddress(this._number, col),
+        row: this._number,
+        col,
+      })
+    );
+  }
+
+  // remove cell(s) and shift all higher cells down by count
+  splice(start, count, ...inserts) {
+    const nKeep = start + count;
+    const nExpand = inserts.length - count;
+    const nEnd = this._cells.length;
+    let i;
+    let cSrc;
+    let cDst;
+
+    if (nExpand < 0) {
+      // remove cells
+      for (i = start + inserts.length; i <= nEnd; i++) {
+        cDst = this._cells[i - 1];
+        cSrc = this._cells[i - nExpand - 1];
+        if (cSrc) {
+          cDst = this.getCell(i);
+          cDst.value = cSrc.value;
+          cDst.style = cSrc.style;
+          // eslint-disable-next-line no-underscore-dangle
+          cDst._comment = cSrc._comment;
+        } else if (cDst) {
+          cDst.value = null;
+          cDst.style = {};
+          // eslint-disable-next-line no-underscore-dangle
+          cDst._comment = undefined;
+        }
+      }
+    } else if (nExpand > 0) {
+      // insert new cells
+      for (i = nEnd; i >= nKeep; i--) {
+        cSrc = this._cells[i - 1];
+        if (cSrc) {
+          cDst = this.getCell(i + nExpand);
+          cDst.value = cSrc.value;
+          cDst.style = cSrc.style;
+          // eslint-disable-next-line no-underscore-dangle
+          cDst._comment = cSrc._comment;
+        } else {
+          this._cells[i + nExpand - 1] = undefined;
+        }
+      }
+    }
+
+    // now add the new values
+    for (i = 0; i < inserts.length; i++) {
+      cDst = this.getCell(start + i);
+      cDst.value = inserts[i];
+      cDst.style = {};
+      // eslint-disable-next-line no-underscore-dangle
+      cDst._comment = undefined;
+    }
+  }
+
+  // Iterate over all non-null cells in this row
+  eachCell(options, iteratee) {
+    if (!iteratee) {
+      iteratee = options;
+      options = null;
+    }
+    if (options && options.includeEmpty) {
+      const n = this._cells.length;
+      for (let i = 1; i <= n; i++) {
+        iteratee(this.getCell(i), i);
+      }
+    } else {
+      this._cells.forEach((cell, index) => {
+        if (cell && cell.type !== Enums.ValueType.Null) {
+          iteratee(cell, index + 1);
+        }
+      });
+    }
+  }
+
+  // ===========================================================================
+  // Page Breaks
+  addPageBreak(lft, rght) {
+    const ws = this._worksheet;
+    const left = Math.max(0, lft - 1) || 0;
+    const right = Math.max(0, rght - 1) || 16838;
+    const pb = {
+      id: this._number,
+      max: right,
+      man: 1,
+    };
+    if (left) pb.min = left;
+
+    ws.rowBreaks.push(pb);
+  }
+
+  // return a sparse array of cell values
+  get values() {
+    const values = [];
+    this._cells.forEach(cell => {
+      if (cell && cell.type !== Enums.ValueType.Null) {
+        values[cell.col] = cell.value;
+      }
+    });
+    return values;
+  }
+
+  // set the values by contiguous or sparse array, or by key'd object literal
+  set values(value) {
+    // this operation is not additive - any prior cells are removed
+    this._cells = [];
+    if (!value) {
+      // empty row
+    } else if (value instanceof Array) {
+      let offset = 0;
+      if (value.hasOwnProperty('0')) {
+        // contiguous array - start at column 1
+        offset = 1;
+      }
+      value.forEach((item, index) => {
+        if (item !== undefined) {
+          this.getCellEx({
+            address: colCache.encodeAddress(this._number, index + offset),
+            row: this._number,
+            col: index + offset,
+          }).value = item;
+        }
+      });
+    } else {
+      // assume object with column keys
+      this._worksheet.eachColumnKey((column, key) => {
+        if (value[key] !== undefined) {
+          this.getCellEx({
+            address: colCache.encodeAddress(this._number, column.number),
+            row: this._number,
+            col: column.number,
+          }).value = value[key];
+        }
+      });
+    }
+  }
+
+  // returns true if the row includes at least one cell with a value
+  get hasValues() {
+    return _.some(this._cells, cell => cell && cell.type !== Enums.ValueType.Null);
+  }
+
+  get cellCount() {
+    return this._cells.length;
+  }
+
+  get actualCellCount() {
+    let count = 0;
+    this.eachCell(() => {
+      count++;
+    });
+    return count;
+  }
+
+  // get the min and max column number for the non-null cells in this row or null
+  get dimensions() {
+    let min = 0;
+    let max = 0;
+    this._cells.forEach(cell => {
+      if (cell && cell.type !== Enums.ValueType.Null) {
+        if (!min || min > cell.col) {
+          min = cell.col;
+        }
+        if (max < cell.col) {
+          max = cell.col;
+        }
+      }
+    });
+    return min > 0
+      ? {
+          min,
+          max,
+        }
+      : null;
+  }
+
+  // =========================================================================
+  // styles
+  _applyStyle(name, value) {
+    this.style[name] = value;
+    this._cells.forEach(cell => {
+      if (cell) {
+        cell[name] = value;
+      }
+    });
+    return value;
+  }
+
+  get numFmt() {
+    return this.style.numFmt;
+  }
+
+  set numFmt(value) {
+    this._applyStyle('numFmt', value);
+  }
+
+  get font() {
+    return this.style.font;
+  }
+
+  set font(value) {
+    this._applyStyle('font', value);
+  }
+
+  get alignment() {
+    return this.style.alignment;
+  }
+
+  set alignment(value) {
+    this._applyStyle('alignment', value);
+  }
+
+  get protection() {
+    return this.style.protection;
+  }
+
+  set protection(value) {
+    this._applyStyle('protection', value);
+  }
+
+  get border() {
+    return this.style.border;
+  }
+
+  set border(value) {
+    this._applyStyle('border', value);
+  }
+
+  get fill() {
+    return this.style.fill;
+  }
+
+  set fill(value) {
+    this._applyStyle('fill', value);
+  }
+
+  get hidden() {
+    return !!this._hidden;
+  }
+
+  set hidden(value) {
+    this._hidden = value;
+  }
+
+  get outlineLevel() {
+    return this._outlineLevel || 0;
+  }
+
+  set outlineLevel(value) {
+    this._outlineLevel = value;
+  }
+
+  get collapsed() {
+    return !!(
+      this._outlineLevel && this._outlineLevel >= this._worksheet.properties.outlineLevelRow
+    );
+  }
+
+  // =========================================================================
+  get model() {
+    const cells = [];
+    let min = 0;
+    let max = 0;
+    this._cells.forEach(cell => {
+      if (cell) {
+        const cellModel = cell.model;
+        if (cellModel) {
+          if (!min || min > cell.col) {
+            min = cell.col;
+          }
+          if (max < cell.col) {
+            max = cell.col;
+          }
+          cells.push(cellModel);
+        }
+      }
+    });
+
+    return this.height || cells.length
+      ? {
+          cells,
+          number: this.number,
+          min,
+          max,
+          height: this.height,
+          style: this.style,
+          hidden: this.hidden,
+          outlineLevel: this.outlineLevel,
+          collapsed: this.collapsed,
+        }
+      : null;
+  }
+
+  set model(value) {
+    if (value.number !== this._number) {
+      throw new Error('Invalid row number in model');
+    }
+    this._cells = [];
+    let previousAddress;
+    value.cells.forEach(cellModel => {
+      switch (cellModel.type) {
+        case Cell.Types.Merge:
+          // special case - don't add this types
+          break;
+        default: {
+          let address;
+          if (cellModel.address) {
+            address = colCache.decodeAddress(cellModel.address);
+          } else if (previousAddress) {
+            // This is a <c> element without an r attribute
+            // Assume that it's the cell for the next column
+            const {row} = previousAddress;
+            const col = previousAddress.col + 1;
+            address = {
+              row,
+              col,
+              address: colCache.encodeAddress(row, col),
+              $col$row: `$${colCache.n2l(col)}$${row}`,
+            };
+          }
+          previousAddress = address;
+          const cell = this.getCellEx(address);
+          cell.model = cellModel;
+          break;
+        }
+      }
+    });
+
+    if (value.height) {
+      this.height = value.height;
+    } else {
+      delete this.height;
+    }
+
+    this.hidden = value.hidden;
+    this.outlineLevel = value.outlineLevel || 0;
+
+    this.style = (value.style && JSON.parse(JSON.stringify(value.style))) || {};
+  }
+}
+
+module.exports = Row;