Struct PieChart 

pub struct PieChart { /* private fields */ }

A structure representing a pie chart.

The PieChart struct allows for the creation and customization of pie charts, supporting features such as labels, hole size for donut-style charts, slice pulling, rotation, faceting, and customizable plot titles. It is ideal for visualizing proportions and distributions in categorical data.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• labels - A string slice specifying the column name to be used for slice labels.
• facet - An optional string slice specifying the column name to be used for creating facets (small multiples).
• facet_config - An optional reference to a FacetConfig struct for customizing facet layout and behavior.
• hole - An optional f64 value specifying the size of the hole in the center of the pie chart. A value of 0.0 creates a full pie chart, while a value closer to 1.0 creates a thinner ring.
• pull - An optional f64 value specifying the fraction by which each slice should be pulled out from the center.
• rotation - An optional f64 value specifying the starting angle (in degrees) of the first slice.
• colors - An optional vector of Rgb values specifying colors for consistent slice colors across facets.
• plot_title - An optional Text struct specifying the title of the plot.
• legend_title - An optional Text struct specifying the title of the legend.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Example

Basic Pie Chart with Customization

use plotlars::{PieChart, Plot, Text};
use polars::prelude::*;

let dataset = LazyCsvReader::new(PlPath::new("data/penguins.csv"))
    .finish()
    .unwrap()
    .select([col("species")])
    .collect()
    .unwrap();

PieChart::builder()
    .data(&dataset)
    .labels("species")
    .hole(0.4)
    .pull(0.01)
    .rotation(20.0)
    .plot_title(
        Text::from("Pie Chart")
            .font("Arial")
            .size(18)
            .x(0.485)
    )
    .build()
    .plot();

Implementations

impl PieChart

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5>() -> PieChartBuilder<'f1, 'f2, 'f3, 'f4, 'f5>

Examples found in repository

examples/piechart.rs (line 12)

fn main() {
    let dataset = LazyCsvReader::new(PlPath::new("data/penguins.csv"))
        .finish()
        .unwrap()
        .select([col("species")])
        .collect()
        .unwrap();

    PieChart::builder()
        .data(&dataset)
        .labels("species")
        .hole(0.4)
        .pull(0.01)
        .rotation(20.0)
        .plot_title(Text::from("Pie Chart").font("Arial").size(18).x(0.485))
        .build()
        .plot();
}

examples/faceting.rs (line 407)

fn piechart_example() {
    let dataset = CsvReadOptions::default()
        .with_has_header(true)
        .try_into_reader_with_file_path(Some("data/industry_region.csv".into()))
        .unwrap()
        .finish()
        .unwrap();

    let facet_config = FacetConfig::new()
        .cols(3)
        .scales(FacetScales::Free)
        .h_gap(0.08)
        .v_gap(0.12)
        .title_style(Text::from("").size(13).color(Rgb(60, 60, 60)));

    PieChart::builder()
        .data(&dataset)
        .labels("category")
        .facet("region")
        .facet_config(&facet_config)
        .colors(vec![
            Rgb(192, 57, 43),
            Rgb(39, 174, 96),
            Rgb(41, 128, 185),
            Rgb(243, 156, 18),
        ])
        .rotation(25.0)
        .pull(0.02)
        .plot_title(Text::from("Industry Analysis").size(18))
        .build()
        .plot();
}

Trait Implementations

impl Clone for PieChart

fn clone(&self) -> PieChart

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Serialize for PieChart

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl PlotHelper for PieChart