barchart_grouped/
barchart-grouped.rs

1//! # [Ratatui] `BarChart` example
2//!
3//! The latest version of this example is available in the [examples] folder in the repository.
4//!
5//! Please note that the examples are designed to be run against the `main` branch of the Github
6//! repository. This means that you may not be able to compile with the latest release version on
7//! crates.io, or the one that you have installed locally.
8//!
9//! See the [examples readme] for more information on finding examples that match the version of the
10//! library you are using.
11//!
12//! [Ratatui]: https://github.com/ratatui/ratatui
13//! [examples]: https://github.com/ratatui/ratatui/blob/main/examples
14//! [examples readme]: https://github.com/ratatui/ratatui/blob/main/examples/README.md
15
16use std::iter::zip;
17
18use color_eyre::Result;
19use ratatui::{
20    crossterm::event::{self, Event, KeyCode, KeyEventKind},
21    layout::{Constraint, Direction, Layout},
22    style::{Color, Style, Stylize},
23    text::Line,
24    widgets::{Bar, BarChart, BarGroup, Block},
25    DefaultTerminal, Frame,
26};
27
28fn main() -> Result<()> {
29    color_eyre::install()?;
30    let terminal = ratatui::init();
31    let app_result = App::new().run(terminal);
32    ratatui::restore();
33    app_result
34}
35
36const COMPANY_COUNT: usize = 3;
37const PERIOD_COUNT: usize = 4;
38
39struct App {
40    should_exit: bool,
41    companies: [Company; COMPANY_COUNT],
42    revenues: [Revenues; PERIOD_COUNT],
43}
44
45struct Revenues {
46    period: &'static str,
47    revenues: [u32; COMPANY_COUNT],
48}
49
50struct Company {
51    short_name: &'static str,
52    name: &'static str,
53    color: Color,
54}
55
56impl App {
57    const fn new() -> Self {
58        Self {
59            should_exit: false,
60            companies: fake_companies(),
61            revenues: fake_revenues(),
62        }
63    }
64
65    fn run(mut self, mut terminal: DefaultTerminal) -> Result<()> {
66        while !self.should_exit {
67            terminal.draw(|frame| self.draw(frame))?;
68            self.handle_events()?;
69        }
70        Ok(())
71    }
72
73    fn handle_events(&mut self) -> Result<()> {
74        if let Event::Key(key) = event::read()? {
75            if key.kind == KeyEventKind::Press && key.code == KeyCode::Char('q') {
76                self.should_exit = true;
77            }
78        }
79        Ok(())
80    }
81
82    fn draw(&self, frame: &mut Frame) {
83        use Constraint::{Fill, Length, Min};
84        let vertical = Layout::vertical([Length(1), Fill(1), Min(20)]).spacing(1);
85        let [title, top, bottom] = vertical.areas(frame.area());
86
87        frame.render_widget("Grouped Barchart".bold().into_centered_line(), title);
88        frame.render_widget(self.vertical_revenue_barchart(), top);
89        frame.render_widget(self.horizontal_revenue_barchart(), bottom);
90    }
91
92    /// Create a vertical revenue bar chart with the data from the `revenues` field.
93    fn vertical_revenue_barchart(&self) -> BarChart<'_> {
94        let mut barchart = BarChart::default()
95            .block(Block::new().title(Line::from("Company revenues (Vertical)").centered()))
96            .bar_gap(0)
97            .bar_width(6)
98            .group_gap(2);
99
100        for group in self
101            .revenues
102            .iter()
103            .map(|revenue| revenue.to_vertical_bar_group(&self.companies))
104        {
105            barchart = barchart.data(group);
106        }
107        barchart
108    }
109
110    /// Create a horizontal revenue bar chart with the data from the `revenues` field.
111    fn horizontal_revenue_barchart(&self) -> BarChart<'_> {
112        let title = Line::from("Company Revenues (Horizontal)").centered();
113        let mut barchart = BarChart::default()
114            .block(Block::new().title(title))
115            .bar_width(1)
116            .group_gap(2)
117            .bar_gap(0)
118            .direction(Direction::Horizontal);
119        for group in self
120            .revenues
121            .iter()
122            .map(|revenue| revenue.to_horizontal_bar_group(&self.companies))
123        {
124            barchart = barchart.data(group);
125        }
126        barchart
127    }
128}
129
130/// Generate fake company data
131const fn fake_companies() -> [Company; COMPANY_COUNT] {
132    [
133        Company::new("BAKE", "Bake my day", Color::LightRed),
134        Company::new("BITE", "Bits and Bites", Color::Blue),
135        Company::new("TART", "Tart of the Table", Color::White),
136    ]
137}
138
139/// Some fake revenue data
140const fn fake_revenues() -> [Revenues; PERIOD_COUNT] {
141    [
142        Revenues::new("Jan", [8500, 6500, 7000]),
143        Revenues::new("Feb", [9000, 7500, 8500]),
144        Revenues::new("Mar", [9500, 4500, 8200]),
145        Revenues::new("Apr", [6300, 4000, 5000]),
146    ]
147}
148
149impl Revenues {
150    /// Create a new instance of `Revenues`
151    const fn new(period: &'static str, revenues: [u32; COMPANY_COUNT]) -> Self {
152        Self { period, revenues }
153    }
154
155    /// Create a `BarGroup` with vertical bars for each company
156    fn to_vertical_bar_group<'a>(&self, companies: &'a [Company]) -> BarGroup<'a> {
157        let bars: Vec<Bar> = zip(companies, self.revenues)
158            .map(|(company, revenue)| company.vertical_revenue_bar(revenue))
159            .collect();
160        BarGroup::default()
161            .label(Line::from(self.period).centered())
162            .bars(&bars)
163    }
164
165    /// Create a `BarGroup` with horizontal bars for each company
166    fn to_horizontal_bar_group<'a>(&'a self, companies: &'a [Company]) -> BarGroup<'a> {
167        let bars: Vec<Bar> = zip(companies, self.revenues)
168            .map(|(company, revenue)| company.horizontal_revenue_bar(revenue))
169            .collect();
170        BarGroup::default()
171            .label(Line::from(self.period).centered())
172            .bars(&bars)
173    }
174}
175
176impl Company {
177    /// Create a new instance of `Company`
178    const fn new(short_name: &'static str, name: &'static str, color: Color) -> Self {
179        Self {
180            short_name,
181            name,
182            color,
183        }
184    }
185
186    /// Create a vertical revenue bar for the company
187    ///
188    /// The label is the short name of the company, and will be displayed under the bar
189    fn vertical_revenue_bar(&self, revenue: u32) -> Bar {
190        let text_value = format!("{:.1}M", f64::from(revenue) / 1000.);
191        Bar::default()
192            .label(self.short_name.into())
193            .value(u64::from(revenue))
194            .text_value(text_value)
195            .style(self.color)
196            .value_style(Style::new().fg(Color::Black).bg(self.color))
197    }
198
199    /// Create a horizontal revenue bar for the company
200    ///
201    /// The label is the long name of the company combined with the revenue and will be displayed
202    /// on the bar
203    fn horizontal_revenue_bar(&self, revenue: u32) -> Bar {
204        let text_value = format!("{} ({:.1} M)", self.name, f64::from(revenue) / 1000.);
205        Bar::default()
206            .value(u64::from(revenue))
207            .text_value(text_value)
208            .style(self.color)
209            .value_style(Style::new().fg(Color::Black).bg(self.color))
210    }
211}
barchart_grouped/barchart-grouped.rs

barchart_grouped/
barchart-grouped.rs
