Renaming Chart types. Adding plot charts

nkoepke · nkoepke · commit 807cd1e4505e · 2024-04-05T10:43:39.000+02:00
diff --git a/README.md b/README.md
@@ -29,9 +29,10 @@ class `ConsoleCharts` (data `array`)
   * `pattern` `default false` Every second bar gets a different pattern.
   * `spaced` `default false` Space between bars.
   * `hideLabels` `default false` Hide / Do not display any labels at the axis.
-  * `type` `default "sideways-barchart"` Defines the barchart type. Possible Values are:
-    * `sideways-barchart` (horizontal bars) ![Alt text](./images/bar-chart-horizontal.svg)
-    * `barchart` (vertical bars). ![Alt text](./images/bar-chart.svg)
+  * `type` `default "sideways-bar"` Defines the barchart type. Possible Values are:
+    * `sideways-bar` (horizontal bars) ![Alt text](./images/bar-chart-horizontal.svg)
+    * `bar` (vertical bars). ![Alt text](./images/bar-chart.svg)
+    * `dot` (vertical dot graph) -> no `pattern` option
 * return `string`
 
 ### Helper Methods
@@ -168,7 +169,7 @@ Strawberries │▓▓▓▓▓▓▓▓▓▓▓▓ 12
 
 ```js
 let obj = new ConsoleCharts([{label: "Apples", value: 5}, {label: "Oranges", value: 7}, {label: "Bananas", value: 8}, {label: "Pears", value: 10}, {label: "Grapes", value: 4}, {label: "Pineapples", value: 5}, {label: "Strawberries", value: 12}, {label: "Watermelons", value: 3}, {label: "Mangos", value: 3}, {label: "Lemons", value: 6}, {label: "Limes", value: 4}, {label: "Peaches", value: 10}]);
-console.log(obj.chart({ type: "barchart", spaced: true, pattern: true}));
+console.log(obj.chart({ type: "bar", spaced: true, pattern: true}));
 ```
 
 ```
@@ -202,7 +203,7 @@ console.log(obj.chart({ type: "barchart", spaced: true, pattern: true}));
 
 ```js
 let objV = new ConsoleCharts([{label: "Apples", value: 5}, {label: "Oranges", value: 7}, {label: "Bananas", value: 8}, {label: "Pears", value: 10}, {label: "Grapes", value: 4}, {label: "Pineapples", value: 5}, {label: "Strawberries", value: 12}, {label: "Watermelons", value: 11}, {label: "Mangos", value: 10}, {label: "Lemons", value: 6}, {label: "Limes", value: 4}, {label: "Peaches", value: 10}]);
-console.log(objV.chart({ type: "barchart", spaced: true, pattern: true, hideLabels: true, minHeight: true}));
+console.log(objV.chart({ type: "bar", spaced: true, pattern: true, hideLabels: true, minHeight: true}));
 ```
 
 ```
@@ -218,3 +219,36 @@ console.log(objV.chart({ type: "barchart", spaced: true, pattern: true, hideLabe
  │═ ═ ═ ═ ═ ═ ═ ═ ═ ═ ═ ═ 
  └────────────────────────
 ```
+
+```js
+let arr = new ConsoleCharts([{label: "Apples", value: 5}, {label: "Oranges", value: 7}, {label: "Bananas", value: 8}, {label: "Pears", value: 10}, {label: "Grapes", value: 4}, {label: "Pineapples", value: 5}, {label: "Strawberries", value: 12}, {label: "Watermelons", value: 11}, {label: "Mangos", value: 10}, {label: "Lemons", value: 6}, {label: "Limes", value: 4}, {label: "Peaches", value: 10}]);
+console.log(arr.chart({ type: "dot", spaced: false, hideLabels: false, minHeight: false}));
+```
+
+```
+ │       ·    
+ │   ·    ·  ·
+ │            
+ │  ·         
+ │ ·          
+ │         ·  
+ │·    ·      
+ │    ·     · 
+ │            
+ │            
+ │            
+ │            
+ └────────────  
+  Apples (5)
+   Oranges (7)
+    Bananas (8)
+     Pears (10)
+      Grapes (4)
+       Pineapples (5)
+        Strawberries (12)
+         Watermelons (11)
+          Mangos (10)
+           Lemons (6)
+            Limes (4)
+             Peaches (10)
+```
diff --git a/src/ConsoleCharts.js b/src/ConsoleCharts.js
@@ -28,12 +28,12 @@ class ConsoleCharts {
     chart(options = {}){
         options.minHeight = options.minHeight || false;
         options.pattern = options.pattern || false;
-        options.type = options.type || "sideways-barchart";
+        options.type = options.type || "sideways-bar";
         options.spaced = options.spaced || false;
         options.showLabels = options.hideLabels || false;
         let chart = "\n";
         /* Option variants */
-        if(options.type === "sideways-barchart"){
+        if(options.type === "sideways-bar"){
             // SIDEWAYS BARCHART
             let lines = [];
             let descY = 0; /* It's a variable that will be used to store the length of the longest label. */
@@ -99,7 +99,7 @@ class ConsoleCharts {
             chart += this.#repeatCharacter(" ", descY) + " └" + this.#repeatCharacter("─", (options.minHeight == true ? (max - min + 1) : max));
             return chart;
         }
-        else if(options.type === "barchart"){
+        else if(options.type === "bar"){
             // BARCHART
             let spaced = (options.spaced == true ? " " : "");
             let chart = "", descX = "";
@@ -135,6 +135,42 @@ class ConsoleCharts {
             chart += " └" + this.#repeatCharacter((options.spaced ? "──" : "─"), this.data.length) + "  " + "\n" + descX;
             return chart;
         }
+        else if(options.type === "dot"){
+            // DOTCHART
+            let spaced = (options.spaced ? " " : "");
+            let chart = "", descX = "";
+            let maxHeight = Math.max.apply(Math, this.data.map(function(o) { return o.value; }));
+            let min = Math.min(...this.data.map(function(o){ return o.value; }));
+            for(let i = 0; i < maxHeight; i++){
+                let ln = "";
+                if(options.minHeight && i == 0){
+                    let lnt = "";
+                    for(let j = 0; j < this.data.length; j++){
+                        lnt += "═" + spaced;
+                    }
+                    chart = " │" + lnt + "\n" + chart;
+                }
+                for(let j = 0; j < this.data.length; j++){
+                    if(this.data[j].value == i){
+                        if(options.minHeight != true || i >= min - 1){
+                            ln += "·" + spaced;
+                        }
+                    }
+                    else{
+                        ln += " " + spaced;
+                    }
+                }
+                if(options.minHeight != true || i >= min - 1){
+                    chart = " │" + ln + "\n" + chart;
+                }
+
+                if(options.hideLabels != true){
+                    descX += this.#repeatCharacter((options.spaced ? "  " : " "), i + (options.spaced ? 1 : 2)) + this.data[i].label + " (" + this.data[i].value + ")" + "\n";
+                }
+            }
+            chart += " └" + this.#repeatCharacter((options.spaced ? "──" : "─"), this.data.length) + "  " + "\n" + descX;
+            return chart;
+        }
     }
 
     /**
diff --git a/test/test.js b/test/test.js
