excel4node/distribution/lib/drawing/drawing.js

Library to create Formatted Excel Files.

"use strict";

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
var CTMarker = require('../classes/ctMarker.js');
var Point = require('../classes/point.js');
var EMU = require('../classes/emu.js');
var Drawing = /*#__PURE__*/function () {
  /**
   * Element representing an Excel Drawing superclass
   * @property {String} anchorType Proprty for type of anchor. One of 'absoluteAnchor', 'oneCellAnchor', 'twoCellAnchor'
   * @property {CTMarker} anchorFrom Property for the top left corner position of drawing
   * @property {CTMarker} anchorTo Property for the bottom left corner position of drawing
   * @property {String} editAs Property that states how to interact with the Drawing in Excel. One of 'absolute', 'oneCell', 'twoCell'
   * @property {Point} _position Internal property for position on Excel Worksheet when drawing type is absoluteAnchor
   * @returns {Drawing} Excel Drawing 
   */
  function Drawing() {
    _classCallCheck(this, Drawing);
    this._anchorType = null;
    this._anchorFrom = null;
    this._anchorTo = null;
    this._editAs = null;
    this._position = null;
  }
  _createClass(Drawing, [{
    key: "anchorType",
    get: function get() {
      return this._anchorType;
    },
    set: function set(type) {
      var types = ['absoluteAnchor', 'oneCellAnchor', 'twoCellAnchor'];
      if (types.indexOf(type) < 0) {
        throw new TypeError('Invalid option for anchor type. anchorType must be one of ' + types.join(', '));
      }
      this._anchorType = type;
    }
  }, {
    key: "editAs",
    get: function get() {
      return this._editAs;
    },
    set: function set(val) {
      var types = ['absolute', 'oneCell', 'twoCell'];
      if (types.indexOf(val) < 0) {
        throw new TypeError('Invalid option for editAs. editAs must be one of ' + types.join(', '));
      }
      this._editAs = val;
    }
  }, {
    key: "anchorFrom",
    get: function get() {
      return this._anchorFrom;
    },
    set: function set(obj) {
      if (obj !== undefined && obj instanceof Object) {
        this._anchorFrom = new CTMarker(obj.col - 1, obj.colOff, obj.row - 1, obj.rowOff);
      }
    }
  }, {
    key: "anchorTo",
    get: function get() {
      return this._anchorTo;
    },
    set: function set(obj) {
      if (obj !== undefined && obj instanceof Object) {
        this._anchorTo = new CTMarker(obj.col - 1, obj.colOff, obj.row - 1, obj.rowOff);
      }
    }

    /**
     * @alias Drawing.achor
     * @desc Sets the postion and anchor properties of the Drawing
     * @func Drawing.achor
     * @param {String} type Anchor type of drawing
     * @param {Object} from Properties for achorFrom property
     * @param {Number} from.col Left edge of drawing will align with left edge of this column
     * @param {String} from.colOff Offset. Drawing will be shifted to the right the specified amount. Float followed by measure [0-9]+(\.[0-9]+)?(mm|cm|in|pt|pc|pi). i.e '10.5mm'
     * @param {Number} from.row Top edge of drawing will align with top edge of this row
     * @param {String} from.rowOff Offset. Drawing will be shifted down the specified amount. Float followed by measure [0-9]+(\.[0-9]+)?(mm|cm|in|pt|pc|pi). i.e '10.5mm'
     * @param {Object} to Properties for anchorTo property
     * @param {Number} to.col Left edge of drawing will align with left edge of this column
     * @param {String} to.colOff Offset. Drawing will be shifted to the right the specified amount. Float followed by measure [0-9]+(\.[0-9]+)?(mm|cm|in|pt|pc|pi). i.e '10.5mm'
     * @param {Number} to.row Top edge of drawing will align with top edge of this row
     * @param {String} to.rowOff Offset. Drawing will be shifted down the specified amount. Float followed by measure [0-9]+(\.[0-9]+)?(mm|cm|in|pt|pc|pi). i.e '10.5mm'
     * @returns {Drawing} Excel Drawing with attached methods
     */
  }, {
    key: "anchor",
    value: function anchor(type, from, to) {
      if (type === 'twoCellAnchor') {
        if (from === undefined || to === undefined) {
          throw new TypeError('twoCellAnchor requires both from and two markers');
        }
        this.editAs = 'oneCell';
      }
      this.anchorType = type;
      this.anchorFrom = from;
      this.anchorTo = to;
      return this;
    }

    /**
     * @alias Drawing.position
     * @desc The position of the top left corner of the image on the Worksheet
     * @func Drawing.position
     * @param {ST_PositiveUniversalMeasure} cx Postion from left of Worksheet edge
     * @param {ST_PositiveUniversalMeasure} cy Postion from top of Worksheet edge
     */
  }, {
    key: "position",
    value: function position(cx, cy) {
      this.anchorType = 'absoluteAnchor';
      var thisCx = new EMU(cx);
      var thisCy = new EMU(cy);
      this._position = new Point(thisCx.value, thisCy.value);
    }
  }]);
  return Drawing;
}();
module.exports = Drawing;
//# sourceMappingURL=drawing.js.map