Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/IonicaBizau/node-cli-graph
:chart_with_upwards_trend: Easily draw function graphs in text mode.
https://github.com/IonicaBizau/node-cli-graph
hacktoberfest
Last synced: 3 months ago
JSON representation
:chart_with_upwards_trend: Easily draw function graphs in text mode.
- Host: GitHub
- URL: https://github.com/IonicaBizau/node-cli-graph
- Owner: IonicaBizau
- License: mit
- Created: 2014-03-23T12:09:33.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-08-09T13:51:59.000Z (almost 4 years ago)
- Last Synced: 2024-03-03T03:42:59.321Z (4 months ago)
- Topics: hacktoberfest
- Language: JavaScript
- Homepage: https://ionicabizau.github.io/node-cli-graph
- Size: 1.32 MB
- Stars: 37
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-ascii - node-cli-graph
README
[](#)
# cli-graph
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://travis-ci.org/IonicaBizau/node-cli-graph/) [](https://www.npmjs.com/package/cli-graph) [](https://www.npmjs.com/package/cli-graph) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
> Easily draw function graphs in text mode.
## :cloud: Installation
```sh
# Using npm
npm install --save cli-graph
# Using yarn
yarn add cli-graph
```
Or you can check out [**the browser version, online**](https://ionicabizau.github.io/node-cli-graph).
## :clipboard: Example
```js
// 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());
// =>
// ▲
// │
// • • • • • • • • •
// • • │ • •
// • • │ • •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// ────•───────────────────────────┼───────────────────────────•──▶
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • │ •
// • • │ • •
// • • │ • •
// • • • • • • • • •
// │
```
## :question: Get Help
There are few ways to get help:
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). 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. :bug:
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
## :memo: Documentation
### `CliGraph(options)`
Creates a new CliGraph instance.
Example:
```js
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.
## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
## :sparkling_heart: 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 :rocket:
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
- [![Support me on Patreon][badge_patreon]][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! :heart:
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
- `cli-circle`
- `datanow`
- `ascii-heart`
## :scroll: License
[MIT][license] © [Ionică Bizău][website]
[license]: /LICENSE
[website]: https://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
[patreon]: https://www.patreon.com/ionicabizau
[amazon]: http://amzn.eu/hRo9sIZ
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW