@gatekeeper_technology/excel-utils 1.0.7 → 1.0.9

package/README.md

@@ -1,6 +1,13 @@
 # Gatekeeper's Excel Utils
 
 ## Changelog
+### [1.00.09] 24-08-2022
+### Added
+- Ability to load data into worksheet with row offset.
+### [1.00.08] 24-08-2022
+### Added
+- Ability to get worksheet by name.
+- Ability to get worksheet by index.
 ### [1.00.07] 24-08-2022
 ### Fixed
 - Fixed bug where workbook_creator class was not exported properly. 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gatekeeper_technology/excel-utils",
-    "version": "1.0.7",
+    "version": "1.0.9",
     "description": "Gatekeeper's excel Utils - shared in NPM",
     "author": "David Holtzhausen",
     "main": "index.js",

package/workbook_creator.js

@@ -62,6 +62,23 @@ let WorkbookCreator = class {
         return worksheet;
     }
 
+    /**
+     * Load data into worksheet 
+     * @param {ExcelJS.Worksheet} worksheet Worksheet
+     * @param {string[][]} data Data array
+     * @param {number} offset Number of rows to skip before writing data
+     * @returns {ExcelJS.Worksheet} The created workbook
+     */
+    loadDataIntoWorksheetWithRowOffset(worksheet, data, row_offset) {
+        for (let _row_data of data.entries()) {
+            // Get a row object. If it doesn't already exist, a new empty one will be returned
+            let row = worksheet.getRow(row_offset + 1);
+            row.values = _row_data;
+        }
+
+        return worksheet;
+    }
+
     /**
      * Save workbook as XLSX
      * @param {ExcelJS.Workbook} workbook Workbook
@@ -124,6 +141,26 @@ let WorkbookCreator = class {
         };
     }
 
+    /**
+     * Gets worksheet with specified name within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {string} worksheet_name
+     * @returns {ExcelJS.Worksheet} Worksheet with specified name
+     */
+    getWorksheetByName(workbook, worksheet_name) {
+        return workbook.getWorksheet(worksheet_name);
+    }
+
+    /**
+     * Gets worksheet at specified index within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {number} index
+     * @returns {ExcelJS.Worksheet} Worksheet at specified index
+     */
+     getWorksheetByIndex(workbook, worksheet_index) {
+        return workbook.worksheets[worksheet_index];
+    }
+
 }
 
 module.exports = WorkbookCreator;