cg

cli-graph

📈 Easily draw function graphs in text mode.

Showing:

Popularity

Downloads/wk

1.1K

GitHub Stars

36

Maintenance

Last Commit

1yr ago

Contributors

2

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

cli-graph

cli-graph

Support me on Patreon Buy me a book PayPal Ask me anything Travis Version Downloads Get help on Codementor

Buy Me A Coffee

Easily draw function graphs in text mode.

☁️ Installation

# Using npm
npm install --save cli-graph

# Using yarn
yarn add cli-graph

Or you can check out the browser version, online.

📋 Example

// Dependencies
var CliGraph = require("cli-graph");

// Create a new function graph
var g1 = new CliGraph({
    height: 20
  , width: 20
  , center: { y: 18 }
}).setFunctionX(function (x) {
    return x * x / 5;
});
console.log(g1.toString());
// =>
//                     ▲
//                     │
//   •                 │                 •
//                     │
//                     │
//     •               │               •
//                     │
//                     │
//       •             │             •
//                     │
//                     │
//         •           │           •
//                     │
//           •         │         •
//                     │
//             •       │       •
//               •     │     •
//                 •   │   •
// ──────────────────•─•─•────────────────▶
//                     │

// Another function
var g2 = new CliGraph({
    height: 30
  , width: 30
  , marks: {
        hAxis: '-'
      , vAxis: '|'
      , center: '+'
      , point: '.'
  }
});

g2.setFunctionX(function (x) {
    return x;
});

console.log(g2.toString());
// =>
//                               ▲
//                               |                           .
//                               |                         .
//                               |                       .
//                               |                     .
//                               |                   .
//                               |                 .
//                               |               .
//                               |             .
//                               |           .
//                               |         .
//                               |       .
//                               |     .
//                               |   .
//                               | .
// ------------------------------.----------------------------▶
//                             . |
//                           .   |
//                         .     |
//                       .       |
//                     .         |
//                   .           |
//                 .             |
//               .               |
//             .                 |
//           .                   |
//         .                     |
//       .                       |
//     .                         |
//   .                           |

var circle = new CliGraph({ height: 32, width: 32 }).setFunctionX(function (x) {
    return Math.sqrt(200 - x * x);
}).setFunctionX(function (x) {
    return -Math.sqrt(200 - x * x);
}).setFunctionY(function (y) {
    return Math.sqrt(200 - y * y);
}).setFunctionY(function (y) {
    return -Math.sqrt(200 - y * y);
});


console.log(circle.toString());
// =>
//                                 ▲
//                                 │
//                         • • • • • • • • •
//                     • •         │         • •
//                 • •             │             • •
//               •                 │                 •
//             •                   │                   •
//           •                     │                     •
//         •                       │                       •
//         •                       │                       •
//       •                         │                         •
//       •                         │                         •
//     •                           │                           •
//     •                           │                           •
//     •                           │                           •
//     •                           │                           •
// ────•───────────────────────────┼───────────────────────────•──▶
//     •                           │                           •
//     •                           │                           •
//     •                           │                           •
//     •                           │                           •
//       •                         │                         •
//       •                         │                         •
//         •                       │                       •
//         •                       │                       •
//           •                     │                     •
//             •                   │                   •
//               •                 │                 •
//                 • •             │             • •
//                     • •         │         • •
//                         • • • • • • • • •
//                                 │

❓ Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. 🐛
  3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

CliGraph(options)

Creates a new CliGraph instance.

Example:

var g = new CliGraph();

Params

  • Object options: An object containing the following fields:
  • height (Number): The graph height (default: 40).
  • width (Number): The graph width (default: 60).
  • aRatio (Number): The horizontal aspect ratio (default: 2).
  • center (Object): An object containing:
    • x (Number): The x origin (default: width / 2)
    • y (Number): The y origin (default: height / 2)
  • marks (Object): An object containing:
    • hAxis (String): The character for drawing horizontal axis (default "─").
    • vAxis (String): The character for drawing vertical axis (default "│").
    • center (String): The character for axis intersection (default "┼").
    • point (String): The character for drawing points (default "•").
    • rightArrow (String): The character for drawing the right arrow (default "▶").
    • topArrow (String): The character for drawing the top arrow (default "▲").
    • background (String): The background character (default " ").

Return

  • CliGraph The CliGraph instance.

addPoint(x, y, chr)

Adds a point on the x and y coordinates.

Params

  • Number x: The x coordinate.
  • Number y: The y coordinate.
  • String chr: The point character (default: the one provided in defaults).

Return

  • CliGraph The CliGraph instance.

isPoint(x, y, chr)

Checks if on given coordinates there is a point.

Params

  • Number x: The x coordinate.
  • Number y: The y coordinate.
  • String chr: The point character (default: the one provided in defaults).

toString()

Stringifies the graph.

Return

  • String The stringified graph.

setFunctionX(foo, min, max, chr)

Adds the function on the graph, iterating the x axis.

Params

  • Function foo: A function that receives x as the first parameter and returns the y value.
  • Number min: The minimum x (default: the lowest possible value).
  • Number max: The maximum x.(default: the highest possible value).
  • String chr: The point character (default: the one provided in defaults).

Return

  • CliGraph The CliGraph instance.

setFunctionY(foo, min, max, chr)

Adds the function on the graph, iterating the y axis.

Params

  • Function foo: A function that receives y as the first parameter and returns the x value.
  • Number min: The minimum y (default: the lowest possible value).
  • Number max: The maximum y.(default: the highest possible value).
  • String chr: The point character (default: the one provided in defaults).

Return

  • CliGraph The CliGraph instance.

😋 How to contribute

Have an idea? Found a bug? See how to contribute.

💖 Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like 🚀

  • Buy me a book—I love books! I will remember you after years if you buy me one. 😁 📖

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

  • cli-circle
  • datanow
  • ascii-heart

📜 License

MIT © Ionică Bizău

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial