Added hxl.Source.exportArray(). Fixes #13

HXLStandard · Mar 29, 2019 · 972d171 · 972d171
1 parent f057799
commit 972d171
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,6 @@
 2019-04-01 Release 1.1:
+	- added hxl.Source.exportArray() to export data as an array
+	  including hashtags (and optionally, headers)
 	- fix bug with null columns when there's no hashtag
 	- start adding data typing methods
 

diff --git a/hxl.js b/hxl.js
@@ -454,10 +454,25 @@ hxl.classes.Source.prototype.getDisplayTags = function () {
     return this.columns.map(col => { return col.displayTag; });
 }
 
+/**
+ * Export the whole dataset, include hashtags.
+ *
+ * @param skipHeaders: if truthy, exclude the text headers
+ * @return {array} an array of arrays forming a parseable HXL dataset
+ */
+hxl.classes.Source.prototype.exportArray = function(skipHeaders) {
+    var exported = [];
+    if (!skipHeaders) {
+        exported.push(this.headers);
+    }
+    exported.push(this.displayTags);
+    return exported.concat(this.rawData);
+};
+
 /**
  * Get the minimum value for a column
  *
- * Uses a < comparison, ignoring empty cells. This method is
+ * Uses a less-than comparison, ignoring empty cells. This method is
  * especially useful for setting ranges in a chart or other
  * visualisation.
  *
@@ -492,7 +507,7 @@ hxl.classes.Source.prototype.getMin = function(pattern) {
 /**
  * Get the maximum value for a column
  *
- * Uses a > comparison, ignoring empty cells. This method is especially
+ * Uses a greater-than comparison, ignoring empty cells. This method is especially
  * useful for setting ranges in a chart or other visualisation.
  *
  * <pre>
@@ -934,6 +949,7 @@ hxl.classes.Dataset.prototype._isTagRow = function(rawRow) {
 }
 
 
+
 ////////////////////////////////////////////////////////////////////////
 // hxl.classes.Column
 ////////////////////////////////////////////////////////////////////////

diff --git a/test/test-dataset.js b/test/test-dataset.js
@@ -34,6 +34,12 @@ QUnit.test("columns", function(assert) {
     assert.deepEqual(this.dataset.columns.map(function (col) { return col.displayTag; }), this.test_data[2]);
 });
 
+QUnit.test("dataset export", function(assert) {
+    assert.deepEqual(this.dataset.exportArray(), this.test_data.slice(1));
+    assert.deepEqual(this.dataset.exportArray(false), this.test_data.slice(1));
+    assert.deepEqual(this.dataset.exportArray(true), this.test_data.slice(2));
+});
+
 QUnit.test("partly-tagged dataset", function(assert) {
     // confirm no null columns when not tagged
     var dataset = hxl.wrap([