Struct BarGroup 

pub struct BarGroup { /* private fields */ }

Bars that belong together, such as one quarter’s revenue for each company, with a label: ratatui’s BarGroup. A vertical chart writes the label centred under the group; a horizontal one on the row after it.

use rich_ext::chart::{Bar, BarChart, BarGroup};

let chart = BarChart::new()
    .group(BarGroup::new("Q1").bar(Bar::new("a", 3.0)).bar(Bar::new("b", 5.0)))
    .group(BarGroup::new("Q2").bars([Bar::new("a", 4.0), Bar::new("b", 2.0)]));
assert_eq!(chart.bars().len(), 4);

A stacked group is one bar made of its bars end to end, labelled with the group’s label (see BarChart’s stacked bars).

Implementations

impl BarGroup

pub fn new(label: impl Into<String>) -> Self

A group called label (empty for none), without bars yet.

pub fn stacked(self) -> Self

Draw the group as one bar: its bars end to end, each a part in its own style (chart.series.N by position, or Bar::style), with the group’s label and the total written. Parts above zero stack up from zero and parts below it down from zero.

A chart with a stacked group draws every group that way (other bars are stacks of one) and adds a legend naming the parts (BarChart::legend). With colour each part is its style; without it each part has its own fill (█▓░▒, ⣿⣤⠿⠶ in Braille, #=+: in ASCII). Part boundaries fall on whole cells; with colour the last part ends in a partial cell. Values on the bars (BarChart::values_inside) are not drawn on stacks; the total is written after (or above) each.

use rich::Console;
use rich_ext::chart::{Bar, BarChart, BarGroup};

let console = Console::builder().width(40).color_system(None).build();
let chart = BarChart::new()
    .group(BarGroup::new("Q1").stacked().bar(Bar::new("a", 4.0)).bar(Bar::new("b", 2.0)))
    .group(BarGroup::new("Q2").stacked().bar(Bar::new("a", 3.0)).bar(Bar::new("b", 3.0)))
    .bar_width(12);
assert_eq!(
    console.render_export(&chart),
    "Q1 ████████▓▓▓▓ 6\nQ2 ██████▓▓▓▓▓▓ 6\n█ a  ▓ b         \n"
);

pub fn bar(self, bar: Bar) -> Self

Add a bar.

pub fn bars(self, bars: impl IntoIterator<Item = Bar>) -> Self

Add bars.

Trait Implementations

impl Clone for BarGroup

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BarGroup

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

Formats the value using the given formatter.

impl Default for BarGroup

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BarGroup

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BarGroup