Struct Bar

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

A bar to be shown by the BarChart widget.

Here is an explanation of a Bar’s components.

███                          ┐
█2█  <- text_value or value  │ bar
foo  <- label                ┘

Note that every element can be styled individually.

Example

The following example creates a bar with the label “Bar 1”, a value “10”, red background and a white value foreground.

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

Bar::default()
    .label("Bar 1".into())
    .value(10)
    .style(Style::new().red())
    .value_style(Style::new().red().on_white())
    .text_value("10°C".to_string());

Implementations

impl<'a> Bar<'a>

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

Set the value of this bar.

The value will be displayed inside the bar.

See also

Bar::value_style to style the value. Bar::text_value to set the displayed value.

pub fn label(self, label: Line<'a>) -> Self

Set the label of the bar.

For Vertical bars, display the label under the bar. For Horizontal bars, display the label in the bar. See BarChart::direction to set the direction.

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

Set the 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>).

This will apply to every non-styled element. It can be seen and used as a default value.

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

Set the style of the value.

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

See also

Bar::value to set the value.

pub fn text_value(self, text_value: String) -> Self

Set the text value printed in the bar.

If text_value is not set, then the ToString representation of value will be shown on the bar.

See also

Bar::value to set the value.

Trait Implementations

impl<'a> Clone for Bar<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Bar<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Bar<'a>

fn default() -> Bar<'a>

Returns the “default value” for a type.

impl<'a> Hash for Bar<'a>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Bar<'a>

fn eq(&self, other: &Bar<'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<'a> Eq for Bar<'a>

impl<'a> StructuralPartialEq for Bar<'a>