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.

Backend Support

Backend	Supported
Plotly	Yes
Plotters	–

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(PlRefPath::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>

impl PieChart

pub fn try_new( data: &DataFrame, labels: &str, facet: Option<&str>, facet_config: Option<&FacetConfig>, hole: Option<f64>, pull: Option<f64>, rotation: Option<f64>, colors: Option<Vec<Rgb>>, plot_title: Option<Text>, legend_title: Option<Text>, legend: Option<&Legend>, ) -> Result<Self, PlotlarsError>

pub fn try_builder<'f1, 'f2, 'f3, 'f4, 'f5>() -> PieChartTryBuilder<'f1, 'f2, 'f3, 'f4, 'f5>

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 Plot for PieChart

fn ir_traces(&self) -> &[TraceIR]

fn ir_layout(&self) -> &LayoutIR