IonicaBizau/node-cli-pie

:bar_chart: Generate pie charts in terminal and text mode.

cli-pie

Generate pie charts in terminal and text mode.

☁️ Installation

# Using npm
npm install --save cli-pie

# Using yarn
yarn add cli-pie

📋 Example

// Dependencies
var Pie = require("cli-pie");

// Generate a new pie, with radius 5 characters
var p = new Pie(5, [
    { label: "Water", value: 70, color: [ 0, 0, 255] }
  , { label: "Land", value: 30, color: [255, 240, 0] }
], {
    legend: true
});

// Stringify
console.log(p.toString());

// Stringify, after disabling the ansi styles
p.options.no_ansi = true;
console.log(p.toString());

// Add a new item
p.add({
    label: "Test"
  , value: 20
});

// Enable the ansi styles
p.options.no_ansi = false;
console.log(p.toString());

// Disable the ansi styles and reset colors
p.options.no_ansi = true;
p.colors = {};
console.log(p.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

CliPie(r, data, options)

Creates a new instance of CliPie.

Params

• Number r: The radius value.
• Array data: An array of objects in the following format:
• Object options: An object containing the following fields:
• flat (Boolean): If true, flat colors will be used (default: true).
• chr (String): The character to draw the pie (default: " ").
• no_ansi (Boolean): If true, ansi styles will not be used.
• legend (Boolean): If true, a legend is added next to the pie.
• display_total (Boolean): If true, the total is added to the legend.
• total_label (String): The label for the total (default: Total)
• circle_opts (Object): The options passed to the cli-circle module, which uses the cli-graph module to build the graph.

Return

• CliPie The CliPie instance.

CLiPie.Item(obj)

CliPie.Item Creates a new CliPie.Item instance.

Params

• Object obj: The CliPie.Item data containing:
• value (Number): The item value.
• label (String): The item label.
• color (String): The item color (used in ansi graphs).
• letter (String): The item letter (used on non-ansi graphs).

Return

• CliPieItem The CliPieItem containing:

add(item)

Adds new items in the cli pie.

Params

• Object item: The item data.

Return

• CliPie The CliPie instance.

textColor(text, color, fg, bg)

Adds foreground or/and background color(s) to the provided text.

Params

• String text: The text to color.
• String color: The color value.
• Boolean fg: If true, the function will modify the foreground color of the text (default: true).
• Boolean bg: If true, the function will modify the background color of the text.

Return

• String The colored text.

uniqueColor(cColor)

Generates an unique color.

Params

• String cColor: The provided color.

Return

• String The unique color.

toString()

Stringifies the pie.

Return

• String The stringified pie.

😋 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 🚀

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

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

• —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. ✨

• git-stats
• gh-polyglot
• real-votes-admin
• learn-memory-statistics-cli
• dupie
• free-pie
• cabdriver
• how-dep
• @tool3/kpods
• pie-my-vulns
• github-stats

📜 License

MIT © Ionică Bizău