👋📊

Author: Florian Hämmerle

.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+
+node_modules

example.mjs

@@ -0,0 +1,23 @@
+import { PlainChart } from ".";
+
+//
+// simple bar chart
+//
+const chart = new PlainChart([1, 2, 3, 4, 5, 10, 7, 8, 0, 1, 4, 3], 10);
+console.log(chart.render());
+
+//
+// sine wave
+//
+const values = range(0, 4 * Math.PI, 100).map(x => Math.sin(x) + 1.2);
+const chart2 = new PlainChart(values, 10, PlainChart.scatter);
+console.log(chart2.render());
+
+function range(start, end, count) {
+  const step = (end - start) / count;
+  const values = [];
+  for (let i = 0; i < count; i++) {
+    values.push(start + i * step);
+  }
+  return values;
+}

license

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 BTD - Better Things Digital GmbH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@betterthings/plainchart",
+  "version": "0.0.0",
+  "description": "A text-based, no-dependencies, open-source charting utility in JavaScript.",
+  "main": "plainchart.mjs",
+  "keywords": [
+    "chart",
+    "plainchart",
+    "plain",
+    "text"
+  ],
+  "author": {
+    "name": "BTD - Better Things Digital GmbH",
+    "email": "[email protected]",
+    "url": "https://betterthings.digital"
+  },
+  "contributors": [
+    {
+      "name": "Florian Hämmerle",
+      "email": "[email protected]"
+    }
+  ],
+  "license": "MIT"
+}

plainchart.mjs

@@ -0,0 +1,45 @@
+export class PlainChart {
+  constructor(values, height = 10, style) {
+    if (height <= 0) {
+      throw new Error("height must be above zero");
+    }
+
+    this.values = values;
+    this.height = height;
+    this.max = Math.max(...values);
+
+    const columns = [];
+    values.forEach(value => {
+      const cells = [];
+      for (let y = 1; y < this.height + 1; y += 1) {
+        cells.push(
+          style ? style(this, value, y) : PlainChart.bar(this, value, y)
+        );
+      }
+      columns.push(cells);
+    });
+
+    this.rows = [];
+    for (let i = 0; i < this.height; i += 1) {
+      this.rows.push(columns.map(c => c[i]));
+    }
+    this.rows = this.rows.reverse();
+  }
+
+  y(value) {
+    const _y = this.max != 0 ? Math.round((value * this.height) / this.max) : 0;
+    return _y <= this.height ? _y : this.height;
+  }
+
+  static bar(chart, value, y) {
+    return y <= chart.y(value) ? "▌" : " ";
+  }
+
+  static scatter(chart, value, y) {
+    return y == chart.y(value) ? "×" : " ";
+  }
+
+  render(newLine = "\n") {
+    return this.rows.map(r => r.join("")).join(newLine);
+  }
+}

readme.md

@@ -0,0 +1,56 @@
+# PlainChart
+
+A text-based, no-dependencies, open-source charting utility in JavaScript.
+It is inspired by the Python library [`plainchart`](https://github.com/gduverger/plainchart).
+
+## Usage
+
+```javascript
+import PlainChart from "@betterthings/plainchart";
+const chart = new PlainChart([3, 1, 4, 1, 5, 9, 2, 6, 5, 3, 5, 9]);
+console.log(chart.render());
+
+/*
+
+     ▌     ▌
+     ▌     ▌
+     ▌     ▌
+     ▌ ▌   ▌
+    ▌▌ ▌▌ ▌▌
+    ▌▌ ▌▌ ▌▌
+  ▌ ▌▌ ▌▌ ▌▌
+▌ ▌ ▌▌ ▌▌▌▌▌
+▌ ▌ ▌▌▌▌▌▌▌▌
+▌▌▌▌▌▌▌▌▌▌▌▌
+
+*/
+```
+
+Take a look at [`example.mjs`](example.mjs) to see how to generate something like this:
+
+```
+         ××××××××                                          ××××××××
+      ×××        ×××                                    ×××        ×××
+    ××              ××                                ××              ××
+  ××                  ××                            ××                  ××
+ ×                      ×                          ×                      ×
+×                        ××                      ××                        ××                      ×
+                           ××                  ××                            ××                  ××
+                             ××              ××                                ××              ××
+                               ×××        ×××                                    ×××        ×××
+                                  ××××××××                                          ××××××××
+```
+
+## Example
+
+```sh
+node --experimental-modules example.mjs
+```
+
+## Contribute
+
+Please feel free to open an issue to propose a new feature or point out a bug. You can also fork the PlainChart repository and submit a pull request.
+
+## Authors
+
+- Florian Hämmerle ([@lusbuab](https://twitter.com/lusbuab)) - [Better Things Digital](https://betterthings.digital)