ratatui::widgets

Struct BarChart

Source 
pub struct BarChart<'a> { /* private fields */ }
Expand description

A chart showing values as bars.

Here is a possible BarChart output.

┌─────────────────────────────────┐
│                             ████│
│                        ▅▅▅▅ ████│
│            ▇▇▇▇        ████ ████│
│     ▄▄▄▄   ████ ████   ████ ████│
│▆10▆ █20█   █50█ █40█   █60█ █90█│
│ B1   B2     B1   B2     B1   B2 │
│ Group1      Group2      Group3  │
└─────────────────────────────────┘

A BarChart is composed of a set of Bar which can be set via BarChart::data. Bars can be styled globally (BarChart::bar_style) or individually (Bar::style). There are other methods available to style even more precisely. See Bar to find out about each bar component.

The BarChart widget can also show groups of bars via BarGroup. A BarGroup is a set of Bar, multiple can be added to a BarChart using BarChart::data multiple time as demonstrated in the example below.

The chart can have a Direction (by default the bars are Vertical). This is set using BarChart::direction.

Note: this is the only widget that doesn’t implement Widget for &T because the current implementation modifies the internal state of self. This will be fixed in the future.

§Examples

The following example creates a BarChart with two groups of bars. The first group is added by an array slice (&[(&str, u64)]). The second group is added by a BarGroup instance.

use ratatui::{
    style::{Style, Stylize},
    widgets::{Bar, BarChart, BarGroup, Block},
};

BarChart::default()
    .block(Block::bordered().title("BarChart"))
    .bar_width(3)
    .bar_gap(1)
    .group_gap(3)
    .bar_style(Style::new().yellow().on_red())
    .value_style(Style::new().red().bold())
    .label_style(Style::new().white())
    .data(&[("B0", 0), ("B1", 2), ("B2", 4), ("B3", 3)])
    .data(BarGroup::default().bars(&[Bar::default().value(10), Bar::default().value(20)]))
    .max(4);

Implementations§

Source§

impl<'a> BarChart<'a>

Source

pub fn data(self, data: impl Into<BarGroup<'a>>) -> Self

Add group of bars to the BarChart

§Examples

The following example creates a BarChart with two groups of bars. The first group is added by an array slice (&[(&str, u64)]). The second group is added by a BarGroup instance.

use ratatui::widgets::{Bar, BarChart, BarGroup};

BarChart::default()
    .data(&[("B0", 0), ("B1", 2), ("B2", 4), ("B3", 3)])
    .data(BarGroup::default().bars(&[Bar::default().value(10), Bar::default().value(20)]));
Examples found in repository?
examples/barchart.rs (line 91)
83fn vertical_barchart(temperatures: &[u8]) -> BarChart {
84    let bars: Vec<Bar> = temperatures
85        .iter()
86        .enumerate()
87        .map(|(hour, value)| vertical_bar(hour, value))
88        .collect();
89    let title = Line::from("Weather (Vertical)").centered();
90    BarChart::default()
91        .data(BarGroup::default().bars(&bars))
92        .block(Block::new().title(title))
93        .bar_width(5)
94}
95
96fn vertical_bar(hour: usize, temperature: &u8) -> Bar {
97    Bar::default()
98        .value(u64::from(*temperature))
99        .label(Line::from(format!("{hour:>02}:00")))
100        .text_value(format!("{temperature:>3}°"))
101        .style(temperature_style(*temperature))
102        .value_style(temperature_style(*temperature).reversed())
103}
104
105/// Create a horizontal bar chart from the temperatures data.
106fn horizontal_barchart(temperatures: &[u8]) -> BarChart {
107    let bars: Vec<Bar> = temperatures
108        .iter()
109        .enumerate()
110        .map(|(hour, value)| horizontal_bar(hour, value))
111        .collect();
112    let title = Line::from("Weather (Horizontal)").centered();
113    BarChart::default()
114        .block(Block::new().title(title))
115        .data(BarGroup::default().bars(&bars))
116        .bar_width(1)
117        .bar_gap(0)
118        .direction(Direction::Horizontal)
119}
More examples
Hide additional examples
examples/barchart-grouped.rs (line 105)
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    }
examples/demo2/tabs/weather.rs (line 109)
75fn render_simple_barchart(area: Rect, buf: &mut Buffer) {
76    let data = [
77        ("Sat", 76),
78        ("Sun", 69),
79        ("Mon", 65),
80        ("Tue", 67),
81        ("Wed", 65),
82        ("Thu", 69),
83        ("Fri", 73),
84    ];
85    let data = data
86        .into_iter()
87        .map(|(label, value)| {
88            Bar::default()
89                .value(value)
90                // This doesn't actually render correctly as the text is too wide for the bar
91                // See https://github.com/ratatui/ratatui/issues/513 for more info
92                // (the demo GIFs hack around this by hacking the calculation in bars.rs)
93                .text_value(format!("{value}°"))
94                .style(if value > 70 {
95                    Style::new().fg(Color::Red)
96                } else {
97                    Style::new().fg(Color::Yellow)
98                })
99                .value_style(if value > 70 {
100                    Style::new().fg(Color::Gray).bg(Color::Red).bold()
101                } else {
102                    Style::new().fg(Color::DarkGray).bg(Color::Yellow).bold()
103                })
104                .label(label.into())
105        })
106        .collect_vec();
107    let group = BarGroup::default().bars(&data);
108    BarChart::default()
109        .data(group)
110        .bar_width(3)
111        .bar_gap(1)
112        .render(area, buf);
113}
114
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}
Source

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

Surround the BarChart with a Block.

Examples found in repository?
examples/barchart.rs (line 92)
83fn vertical_barchart(temperatures: &[u8]) -> BarChart {
84    let bars: Vec<Bar> = temperatures
85        .iter()
86        .enumerate()
87        .map(|(hour, value)| vertical_bar(hour, value))
88        .collect();
89    let title = Line::from("Weather (Vertical)").centered();
90    BarChart::default()
91        .data(BarGroup::default().bars(&bars))
92        .block(Block::new().title(title))
93        .bar_width(5)
94}
95
96fn vertical_bar(hour: usize, temperature: &u8) -> Bar {
97    Bar::default()
98        .value(u64::from(*temperature))
99        .label(Line::from(format!("{hour:>02}:00")))
100        .text_value(format!("{temperature:>3}°"))
101        .style(temperature_style(*temperature))
102        .value_style(temperature_style(*temperature).reversed())
103}
104
105/// Create a horizontal bar chart from the temperatures data.
106fn horizontal_barchart(temperatures: &[u8]) -> BarChart {
107    let bars: Vec<Bar> = temperatures
108        .iter()
109        .enumerate()
110        .map(|(hour, value)| horizontal_bar(hour, value))
111        .collect();
112    let title = Line::from("Weather (Horizontal)").centered();
113    BarChart::default()
114        .block(Block::new().title(title))
115        .data(BarGroup::default().bars(&bars))
116        .bar_width(1)
117        .bar_gap(0)
118        .direction(Direction::Horizontal)
119}
More examples
Hide additional examples
examples/barchart-grouped.rs (line 95)
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    }
examples/demo2/tabs/weather.rs (line 128)
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}
Source

pub const fn max(self, max: u64) -> Self

Set the value necessary for a Bar to reach the maximum height.

If not set, the maximum value in the data is taken as reference.

§Examples

This example shows the default behavior when max is not set. The maximum value in the dataset is taken (here, 100).

use ratatui::widgets::BarChart;
BarChart::default().data(&[("foo", 1), ("bar", 2), ("baz", 100)]);
// Renders
//     █
//     █
// f b b

This example shows a custom max value. The maximum height being 2, bar & baz render as the max.

use ratatui::widgets::BarChart;

BarChart::default()
    .data(&[("foo", 1), ("bar", 2), ("baz", 100)])
    .max(2);
// Renders
//   █ █
// █ █ █
// f b b
Source

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

Set the default style of the bar.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

It is also possible to set individually the style of each Bar. In this case the default style will be patched by the individual style

Examples found in repository?
examples/demo2/tabs/weather.rs (line 132)
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}
Source

pub const fn bar_width(self, width: u16) -> Self

Set the width of the displayed bars.

For Horizontal bars this becomes the height of the bar.

If not set, this defaults to 1. The bar label also uses this value as its width.

Examples found in repository?
examples/barchart.rs (line 93)
83fn vertical_barchart(temperatures: &[u8]) -> BarChart {
84    let bars: Vec<Bar> = temperatures
85        .iter()
86        .enumerate()
87        .map(|(hour, value)| vertical_bar(hour, value))
88        .collect();
89    let title = Line::from("Weather (Vertical)").centered();
90    BarChart::default()
91        .data(BarGroup::default().bars(&bars))
92        .block(Block::new().title(title))
93        .bar_width(5)
94}
95
96fn vertical_bar(hour: usize, temperature: &u8) -> Bar {
97    Bar::default()
98        .value(u64::from(*temperature))
99        .label(Line::from(format!("{hour:>02}:00")))
100        .text_value(format!("{temperature:>3}°"))
101        .style(temperature_style(*temperature))
102        .value_style(temperature_style(*temperature).reversed())
103}
104
105/// Create a horizontal bar chart from the temperatures data.
106fn horizontal_barchart(temperatures: &[u8]) -> BarChart {
107    let bars: Vec<Bar> = temperatures
108        .iter()
109        .enumerate()
110        .map(|(hour, value)| horizontal_bar(hour, value))
111        .collect();
112    let title = Line::from("Weather (Horizontal)").centered();
113    BarChart::default()
114        .block(Block::new().title(title))
115        .data(BarGroup::default().bars(&bars))
116        .bar_width(1)
117        .bar_gap(0)
118        .direction(Direction::Horizontal)
119}
More examples
Hide additional examples
examples/barchart-grouped.rs (line 97)
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    }
examples/demo2/tabs/weather.rs (line 110)
75fn render_simple_barchart(area: Rect, buf: &mut Buffer) {
76    let data = [
77        ("Sat", 76),
78        ("Sun", 69),
79        ("Mon", 65),
80        ("Tue", 67),
81        ("Wed", 65),
82        ("Thu", 69),
83        ("Fri", 73),
84    ];
85    let data = data
86        .into_iter()
87        .map(|(label, value)| {
88            Bar::default()
89                .value(value)
90                // This doesn't actually render correctly as the text is too wide for the bar
91                // See https://github.com/ratatui/ratatui/issues/513 for more info
92                // (the demo GIFs hack around this by hacking the calculation in bars.rs)
93                .text_value(format!("{value}°"))
94                .style(if value > 70 {
95                    Style::new().fg(Color::Red)
96                } else {
97                    Style::new().fg(Color::Yellow)
98                })
99                .value_style(if value > 70 {
100                    Style::new().fg(Color::Gray).bg(Color::Red).bold()
101                } else {
102                    Style::new().fg(Color::DarkGray).bg(Color::Yellow).bold()
103                })
104                .label(label.into())
105        })
106        .collect_vec();
107    let group = BarGroup::default().bars(&data);
108    BarChart::default()
109        .data(group)
110        .bar_width(3)
111        .bar_gap(1)
112        .render(area, buf);
113}
Source

pub const fn bar_gap(self, gap: u16) -> Self

Set the gap between each bar.

If not set, this defaults to 1. The bar label will never be larger than the bar itself, even if the gap is sufficient.

§Example

This shows two bars with a gap of 3. Notice the labels will always stay under the bar.

use ratatui::widgets::BarChart;

BarChart::default()
    .data(&[("foo", 1), ("bar", 2)])
    .bar_gap(3);
// Renders
//     █
// █   █
// f   b
Examples found in repository?
examples/barchart.rs (line 117)
106fn horizontal_barchart(temperatures: &[u8]) -> BarChart {
107    let bars: Vec<Bar> = temperatures
108        .iter()
109        .enumerate()
110        .map(|(hour, value)| horizontal_bar(hour, value))
111        .collect();
112    let title = Line::from("Weather (Horizontal)").centered();
113    BarChart::default()
114        .block(Block::new().title(title))
115        .data(BarGroup::default().bars(&bars))
116        .bar_width(1)
117        .bar_gap(0)
118        .direction(Direction::Horizontal)
119}
More examples
Hide additional examples
examples/barchart-grouped.rs (line 96)
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    }
examples/demo2/tabs/weather.rs (line 111)
75fn render_simple_barchart(area: Rect, buf: &mut Buffer) {
76    let data = [
77        ("Sat", 76),
78        ("Sun", 69),
79        ("Mon", 65),
80        ("Tue", 67),
81        ("Wed", 65),
82        ("Thu", 69),
83        ("Fri", 73),
84    ];
85    let data = data
86        .into_iter()
87        .map(|(label, value)| {
88            Bar::default()
89                .value(value)
90                // This doesn't actually render correctly as the text is too wide for the bar
91                // See https://github.com/ratatui/ratatui/issues/513 for more info
92                // (the demo GIFs hack around this by hacking the calculation in bars.rs)
93                .text_value(format!("{value}°"))
94                .style(if value > 70 {
95                    Style::new().fg(Color::Red)
96                } else {
97                    Style::new().fg(Color::Yellow)
98                })
99                .value_style(if value > 70 {
100                    Style::new().fg(Color::Gray).bg(Color::Red).bold()
101                } else {
102                    Style::new().fg(Color::DarkGray).bg(Color::Yellow).bold()
103                })
104                .label(label.into())
105        })
106        .collect_vec();
107    let group = BarGroup::default().bars(&data);
108    BarChart::default()
109        .data(group)
110        .bar_width(3)
111        .bar_gap(1)
112        .render(area, buf);
113}
114
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}
Source

pub const fn bar_set(self, bar_set: Set) -> Self

The bar::Set to use for displaying the bars.

If not set, the default is bar::NINE_LEVELS.

Source

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

Set the default value style of the bar.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

It is also possible to set individually the value style of each Bar. In this case the default value style will be patched by the individual value style

§See also

Bar::value_style to set the value style individually.

Examples found in repository?
examples/demo2/tabs/weather.rs (line 133)
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}
Source

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

Set the default label style of the groups and bars.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

It is also possible to set individually the label style of each Bar or BarGroup. In this case the default label style will be patched by the individual label style

§See also

Bar::label to set the label style individually.

Source

pub const fn group_gap(self, gap: u16) -> Self

Set the gap between BarGroup.

Examples found in repository?
examples/barchart-grouped.rs (line 98)
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    }
Source

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

Set the style of the entire chart.

style accepts any type that is convertible to Style (e.g. Style, Color, or your own type that implements Into<Style>).

The style will be applied to everything that isn’t styled (borders, bars, labels, …).

Source

pub const fn direction(self, direction: Direction) -> Self

Set the direction of the bars.

Vertical bars are the default.

§Examples

Vertical bars

  █
█ █
f b

Horizontal bars

█foo██

█bar██
Examples found in repository?
examples/barchart.rs (line 118)
106fn horizontal_barchart(temperatures: &[u8]) -> BarChart {
107    let bars: Vec<Bar> = temperatures
108        .iter()
109        .enumerate()
110        .map(|(hour, value)| horizontal_bar(hour, value))
111        .collect();
112    let title = Line::from("Weather (Horizontal)").centered();
113    BarChart::default()
114        .block(Block::new().title(title))
115        .data(BarGroup::default().bars(&bars))
116        .bar_width(1)
117        .bar_gap(0)
118        .direction(Direction::Horizontal)
119}
More examples
Hide additional examples
examples/barchart-grouped.rs (line 118)
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    }
examples/demo2/tabs/weather.rs (line 129)
115fn render_horizontal_barchart(area: Rect, buf: &mut Buffer) {
116    let bg = Color::Rgb(32, 48, 96);
117    let data = [
118        Bar::default().text_value("Winter 37-51".into()).value(51),
119        Bar::default().text_value("Spring 40-65".into()).value(65),
120        Bar::default().text_value("Summer 54-77".into()).value(77),
121        Bar::default()
122            .text_value("Fall 41-71".into())
123            .value(71)
124            .value_style(Style::new().bold()), // current season
125    ];
126    let group = BarGroup::default().label("GPU".into()).bars(&data);
127    BarChart::default()
128        .block(Block::new().padding(Padding::new(0, 0, 2, 0)))
129        .direction(Direction::Horizontal)
130        .data(group)
131        .bar_gap(1)
132        .bar_style(Style::new().fg(bg))
133        .value_style(Style::new().bg(bg).fg(Color::Gray))
134        .render(area, buf);
135}

Trait Implementations§

Source§

impl<'a> Clone for BarChart<'a>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for BarChart<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> Default for BarChart<'a>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> Hash for BarChart<'a>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<'a> PartialEq for BarChart<'a>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<'a> Styled for BarChart<'a>

Source§

type Item = BarChart<'a>

Source§

fn style(&self) -> Style

Returns the style of the object.
Source§

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

Sets the style of the object. Read more
Source§

impl Widget for BarChart<'_>

Source§

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.
Source§

impl WidgetRef for BarChart<'_>

Source§

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

Available on crate feature unstable-widget-ref only.
Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.
Source§

impl<'a> Eq for BarChart<'a>

Source§

impl<'a> StructuralPartialEq for BarChart<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for BarChart<'a>

§

impl<'a> RefUnwindSafe for BarChart<'a>

§

impl<'a> Send for BarChart<'a>

§

impl<'a> Sync for BarChart<'a>

§

impl<'a> Unpin for BarChart<'a>

§

impl<'a> UnwindSafe for BarChart<'a>

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<'a, T, U> Stylize<'a, T> for U
where U: Styled<Item = T>,

Source§

fn bg<C>(self, color: C) -> T
where C: Into<Color>,

Source§

fn fg<C>(self, color: C) -> T
where C: Into<Color>,

Source§

fn add_modifier(self, modifier: Modifier) -> T

Source§

fn remove_modifier(self, modifier: Modifier) -> T

Source§

fn reset(self) -> T

Source§

fn black(self) -> T

Sets the foreground color to black.
Source§

fn on_black(self) -> T

Sets the background color to black.
Source§

fn red(self) -> T

Sets the foreground color to red.
Source§

fn on_red(self) -> T

Sets the background color to red.
Source§

fn green(self) -> T

Sets the foreground color to green.
Source§

fn on_green(self) -> T

Sets the background color to green.
Source§

fn yellow(self) -> T

Sets the foreground color to yellow.
Source§

fn on_yellow(self) -> T

Sets the background color to yellow.
Source§

fn blue(self) -> T

Sets the foreground color to blue.
Source§

fn on_blue(self) -> T

Sets the background color to blue.
Source§

fn magenta(self) -> T

Sets the foreground color to magenta.
Source§

fn on_magenta(self) -> T

Sets the background color to magenta.
Source§

fn cyan(self) -> T

Sets the foreground color to cyan.
Source§

fn on_cyan(self) -> T

Sets the background color to cyan.
Source§

fn gray(self) -> T

Sets the foreground color to gray.
Source§

fn on_gray(self) -> T

Sets the background color to gray.
Source§

fn dark_gray(self) -> T

Sets the foreground color to dark_gray.
Source§

fn on_dark_gray(self) -> T

Sets the background color to dark_gray.
Source§

fn light_red(self) -> T

Sets the foreground color to light_red.
Source§

fn on_light_red(self) -> T

Sets the background color to light_red.
Source§

fn light_green(self) -> T

Sets the foreground color to light_green.
Source§

fn on_light_green(self) -> T

Sets the background color to light_green.
Source§

fn light_yellow(self) -> T

Sets the foreground color to light_yellow.
Source§

fn on_light_yellow(self) -> T

Sets the background color to light_yellow.
Source§

fn light_blue(self) -> T

Sets the foreground color to light_blue.
Source§

fn on_light_blue(self) -> T

Sets the background color to light_blue.
Source§

fn light_magenta(self) -> T

Sets the foreground color to light_magenta.
Source§

fn on_light_magenta(self) -> T

Sets the background color to light_magenta.
Source§

fn light_cyan(self) -> T

Sets the foreground color to light_cyan.
Source§

fn on_light_cyan(self) -> T

Sets the background color to light_cyan.
Source§

fn white(self) -> T

Sets the foreground color to white.
Source§

fn on_white(self) -> T

Sets the background color to white.
Source§

fn bold(self) -> T

Adds the BOLD modifier.
Source§

fn not_bold(self) -> T

Removes the BOLD modifier.
Source§

fn dim(self) -> T

Adds the DIM modifier.
Source§

fn not_dim(self) -> T

Removes the DIM modifier.
Source§

fn italic(self) -> T

Adds the ITALIC modifier.
Source§

fn not_italic(self) -> T

Removes the ITALIC modifier.
Source§

fn underlined(self) -> T

Adds the UNDERLINED modifier.
Source§

fn not_underlined(self) -> T

Removes the UNDERLINED modifier.
Adds the SLOW_BLINK modifier.
Removes the SLOW_BLINK modifier.
Adds the RAPID_BLINK modifier.
Removes the RAPID_BLINK modifier.
Source§

fn reversed(self) -> T

Adds the REVERSED modifier.
Source§

fn not_reversed(self) -> T

Removes the REVERSED modifier.
Source§

fn hidden(self) -> T

Adds the HIDDEN modifier.
Source§

fn not_hidden(self) -> T

Removes the HIDDEN modifier.
Source§

fn crossed_out(self) -> T

Adds the CROSSED_OUT modifier.
Source§

fn not_crossed_out(self) -> T

Removes the CROSSED_OUT modifier.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.