Struct PieChart 

pub struct PieChart<'a> { /* private fields */ }

A widget that displays a pie chart.

A PieChart displays data as slices of a circle, where each slice represents a proportion of the total.

Examples

use ratatui::style::Color;
use tui_piechart::{PieChart, PieSlice};

let slices = vec![
    PieSlice::new("Rust", 45.0, Color::Red),
    PieSlice::new("Go", 30.0, Color::Blue),
    PieSlice::new("Python", 25.0, Color::Green),
];
let piechart = PieChart::new(slices);

Implementations

impl<'a> PieChart<'a>

pub fn new(slices: Vec<PieSlice<'a>>) -> Self

Creates a new PieChart with the given slices.

Examples

use ratatui::style::Color;
use tui_piechart::{PieChart, PieSlice};

let slices = vec![
    PieSlice::new("Rust", 45.0, Color::Red),
    PieSlice::new("Go", 30.0, Color::Blue),
];
let piechart = PieChart::new(slices);

pub fn slices(self, slices: Vec<PieSlice<'a>>) -> Self

Sets the slices of the pie chart.

Examples

use ratatui::style::Color;
use tui_piechart::{PieChart, PieSlice};

let slices = vec![
    PieSlice::new("Rust", 45.0, Color::Red),
];
let piechart = PieChart::default().slices(slices);

pub fn block(self, block: Block<'a>) -> Self

Wraps the pie chart with the given block.

Examples

use ratatui::style::Color;
use ratatui::widgets::Block;
use tui_piechart::{PieChart, PieSlice};

let slices = vec![PieSlice::new("Rust", 45.0, Color::Red)];
let piechart = PieChart::new(slices)
    .block(Block::bordered().title("Statistics"));

pub fn style<S: Into<Style>>(self, style: S) -> Self

Sets the base style of the widget.

Examples

use ratatui::style::{Color, Style};
use tui_piechart::PieChart;

let piechart = PieChart::default()
    .style(Style::default().fg(Color::White));

pub const fn show_legend(self, show: bool) -> Self

Sets whether to show the legend.

Examples

use tui_piechart::PieChart;

let piechart = PieChart::default().show_legend(true);

pub const fn show_percentages(self, show: bool) -> Self

Sets whether to show percentages on slices.

Examples

use tui_piechart::PieChart;

let piechart = PieChart::default().show_percentages(true);

pub const fn pie_char(self, c: char) -> Self

Sets the character used to draw the pie chart.

You can use any Unicode character for custom visualization.

Examples

Using a predefined symbol:

use tui_piechart::{PieChart, symbols};

let piechart = PieChart::default()
    .pie_char(symbols::PIE_CHAR_BLOCK);

Using a custom character:

use tui_piechart::PieChart;

let piechart = PieChart::default().pie_char('█');

pub const fn legend_marker(self, marker: &'a str) -> Self

Sets the marker used for legend items.

You can use any string (including Unicode characters) for custom markers.

Examples

Using a predefined symbol:

use tui_piechart::{PieChart, symbols};

let piechart = PieChart::default()
    .legend_marker(symbols::LEGEND_MARKER_CIRCLE);

Using custom markers:

use tui_piechart::PieChart;

// Simple arrow
let piechart = PieChart::default().legend_marker("→");

// Or any Unicode character
let piechart = PieChart::default().legend_marker("★");

// Or even multi-character strings
let piechart = PieChart::default().legend_marker("-->");

pub const fn resolution(self, resolution: Resolution) -> Self

Sets the rendering resolution mode.

Different resolution modes provide varying levels of detail:

• Standard: Regular characters (1 dot per cell)
• Braille: 2×4 patterns (8 dots per cell, 8x resolution)

Examples

use tui_piechart::{PieChart, Resolution};

let standard = PieChart::default().resolution(Resolution::Standard);
let braille = PieChart::default().resolution(Resolution::Braille);

pub const fn high_resolution(self, enabled: bool) -> Self

Sets whether to use high resolution rendering with braille patterns.

This is a convenience method that sets the resolution to Braille when enabled, or Standard when disabled. For more control, use resolution.

Examples

use tui_piechart::PieChart;

let piechart = PieChart::default().high_resolution(true);

pub const fn legend_position(self, position: LegendPosition) -> Self

Sets the position of the legend relative to the pie chart.

Examples

use tui_piechart::{PieChart, LegendPosition};

let piechart = PieChart::default()
    .legend_position(LegendPosition::Right);

pub const fn legend_layout(self, layout: LegendLayout) -> Self

Sets the layout mode for the legend.

Examples

use tui_piechart::{PieChart, LegendLayout};

// Single horizontal row
let piechart = PieChart::default()
    .legend_layout(LegendLayout::Horizontal);

// Vertical stacking (default)
let piechart = PieChart::default()
    .legend_layout(LegendLayout::Vertical);

pub const fn legend_alignment(self, alignment: LegendAlignment) -> Self

Sets the alignment of legend items within the legend area.

Examples

use tui_piechart::{PieChart, LegendAlignment};

// Center-align legend items
let piechart = PieChart::default()
    .legend_alignment(LegendAlignment::Center);

// Right-align legend items
let piechart = PieChart::default()
    .legend_alignment(LegendAlignment::Right);

Trait Implementations

impl<'a> Clone for PieChart<'a>

fn clone(&self) -> PieChart<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PieChart<'a>

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

Formats the value using the given formatter.

impl Default for PieChart<'_>

fn default() -> Self

Returns a default PieChart widget.

The default widget has:

• No slices
• No block
• Default style
• Legend shown
• Percentages shown
• Default pie character (●)
• Default legend marker (■)

impl<'a> PartialEq for PieChart<'a>

fn eq(&self, other: &PieChart<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Styled for PieChart<'_>

type Item = PieChart<'_>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self::Item

Sets the style of the object.

impl Widget for &PieChart<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Widget for PieChart<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl<'a> StructuralPartialEq for PieChart<'a>