Struct Chart

pub struct Chart { /* private fields */ }

The Chart struct contains the configuration for displaying some data.

By default, a chart has a radius of 9, an aspect ratio of 2 and doesn’t show its legend.

Example usage:

use piechart::{Chart, Color, Data};

let data = vec![
    Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
    Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
    Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
];

Chart::new()
    .radius(9)
    .aspect_ratio(3)
    .legend(true)
    .draw(&data);

will result in

Implementations

impl Chart

pub fn new() -> Self

Contructs a new chart initialized with its default values

Examples found in repository

examples/basic.rs (line 12)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "BTC".into(), value: 5977.0, color: None, fill: '•' },
        Data { label: "BCH".into(), value: 3045.0, color: None, fill: '◍' },
        Data { label: "LTC".into(), value: 2030.0, color: None, fill: '.' },
        Data { label: "ETH".into(), value: 2350.0, color: None, fill: '*' },
    ];

    Chart::new().draw(&data);
}

examples/config.rs (line 11)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
        Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
        Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
    ];

    Chart::new()
        .radius(9)
        .aspect_ratio(3)
        .legend(true)
        .draw(&data);
}

examples/comparison.rs (line 11)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "dd1".into(), value: 4.0, color: Some(Color::Red.into()), fill: '•' },
        Data { label: "dd2".into(), value: 2.0, color: Some(Color::Green.into()), fill: '•' },
        Data { label: "dd3".into(), value: 2.6, color: Some(Color::Blue.into()), fill: '•' },
    ];

    let mut chart = Chart::new();

    for a in 0..=12 {
        chart.radius(a);
        chart.draw(&data);
        println!();
    }
}

pub fn radius(&mut self, radius: u16) -> &mut Self

Sets the radius of the pie chart. To choose which size fits the best, you can run a code snippet like this:

let mut chart = Chart::new();
for radius in 0..=12 {
    chart.radius(radius);
    chart.draw(&data);
}

Examples found in repository

examples/config.rs (line 12)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
        Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
        Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
    ];

    Chart::new()
        .radius(9)
        .aspect_ratio(3)
        .legend(true)
        .draw(&data);
}

examples/comparison.rs (line 14)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "dd1".into(), value: 4.0, color: Some(Color::Red.into()), fill: '•' },
        Data { label: "dd2".into(), value: 2.0, color: Some(Color::Green.into()), fill: '•' },
        Data { label: "dd3".into(), value: 2.6, color: Some(Color::Blue.into()), fill: '•' },
    ];

    let mut chart = Chart::new();

    for a in 0..=12 {
        chart.radius(a);
        chart.draw(&data);
        println!();
    }
}

pub fn aspect_ratio(&mut self, aspect_ratio: u16) -> &mut Self

The aspect ratio controls how stretched or squished the circle is. Since terminal columns are more tall than wide a ration of 2 or 3 is the best in most cases.

Examples found in repository

examples/config.rs (line 13)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
        Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
        Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
    ];

    Chart::new()
        .radius(9)
        .aspect_ratio(3)
        .legend(true)
        .draw(&data);
}

pub fn legend(&mut self, legend: bool) -> &mut Self

Specifies whether the chart should render a legend with the labels and their percentages.

Examples found in repository

examples/config.rs (line 14)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
        Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
        Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
    ];

    Chart::new()
        .radius(9)
        .aspect_ratio(3)
        .legend(true)
        .draw(&data);
}

impl Chart

pub fn draw(&self, data: &[Data])

Renders the chart and outputs it onto stdout. The method panics in case of an error. If you want more fine-grained control about error recovery and how the buffer the chart is rendered into the buffer, use Chart::draw_into.

Examples found in repository

examples/basic.rs (line 12)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "BTC".into(), value: 5977.0, color: None, fill: '•' },
        Data { label: "BCH".into(), value: 3045.0, color: None, fill: '◍' },
        Data { label: "LTC".into(), value: 2030.0, color: None, fill: '.' },
        Data { label: "ETH".into(), value: 2350.0, color: None, fill: '*' },
    ];

    Chart::new().draw(&data);
}

examples/config.rs (line 15)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "Chocolate".into(), value: 4.0, color: Some(Color::Blue.into()), fill: '•' },
        Data { label: "Strawberry".into(), value: 2.0, color: Some(Color::Red.into()), fill: '▪' },
        Data { label: "Vanilla".into(), value: 2.6, color: Some(Color::Yellow.into()), fill: '▴' },
    ];

    Chart::new()
        .radius(9)
        .aspect_ratio(3)
        .legend(true)
        .draw(&data);
}

examples/comparison.rs (line 15)

fn main() {
    #[rustfmt::skip]
    let data = vec![
        Data { label: "dd1".into(), value: 4.0, color: Some(Color::Red.into()), fill: '•' },
        Data { label: "dd2".into(), value: 2.0, color: Some(Color::Green.into()), fill: '•' },
        Data { label: "dd3".into(), value: 2.6, color: Some(Color::Blue.into()), fill: '•' },
    ];

    let mut chart = Chart::new();

    for a in 0..=12 {
        chart.radius(a);
        chart.draw(&data);
        println!();
    }
}

pub fn draw_into(&self, f: impl Write, data: &[Data]) -> Result<()>

Same as Chart::draw, but you can supply your own impl Write and you can handle errors gracefully.

Trait Implementations

impl Debug for Chart

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Chart

fn default() -> Self

Returns the “default value” for a type.