Struct BarGraph 

pub struct BarGraph<'g> { /* private fields */ }

A widget for displaying a bar graph.

The bars can be colored using a gradient, and can be rendered using either solid blocks or braille characters for a more granular appearance.

Example

use tui_bar_graph::{BarGraph, BarStyle, ColorMode};

let data = vec![0.0, 0.1, 0.2, 0.3, 0.4, 0.5];
let bar_graph = BarGraph::new(data)
    .with_gradient(colorgrad::preset::turbo())
    .with_bar_style(BarStyle::Braille)
    .with_color_mode(ColorMode::VerticalGradient);
frame.render_widget(bar_graph, area);

Implementations

impl<'g> BarGraph<'g>

pub fn new(data: Vec<f64>) -> Self

Creates a new bar graph with the given data.

pub fn with_gradient(self, gradient: impl Gradient + 'g) -> Self

Sets the gradient to use for coloring the bars.

See the colorgrad crate for information on creating gradients. Note that the default domain (range) of the gradient is [0, 1], so you may need to scale your data to fit this range, or modify the gradient’s domain to fit your data.

pub fn with_max(self, max: impl Into<Option<f64>>) -> Self

Sets the maximum value to display.

Values greater than this will be clamped to this value. If None, the maximum value is calculated from the data.

pub fn with_min(self, min: impl Into<Option<f64>>) -> Self

Sets the minimum value to display.

Values less than this will be clamped to this value. If None, the minimum value is calculated from the data.

pub const fn with_color_mode(self, color: ColorMode) -> Self

Sets the color mode for the bars.

The default is ColorMode::VerticalGradient.

• Solid: Each bar has a single color based on its value.
• Gradient: Each bar is gradient-colored from bottom to top.

pub const fn with_bar_style(self, style: BarStyle) -> Self

Sets the style of the bars.

The default is BarStyle::Braille.

• Solid: Render bars using the full block character ‘█’.
• Quadrant: Render bars using quadrant block characters for a more granular representation.
• Octant: Render bars using octant block characters for a more granular representation.
• Braille: Render bars using braille characters for a more granular representation.

Octant and Braille offer the same level of granularity, but Braille is more widely supported by fonts.

Trait Implementations

impl Widget for BarGraph<'_>

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.