Struct BarChart 

pub struct BarChart {
    pub states: BarChartStates,
    /* private fields */
}

A component to display a chart with bars. The bar chart can work both in “active” and “disabled” mode.

Disabled mode

When in disabled mode, the chart won’t be interactive, so you won’t be able to move through data using keys. If you have more data than the maximum amount of bars that can be displayed, you’ll have to update data to display the remaining entries.

Active mode

While in active mode (default) you can put as many entries as you wish. You can move with Cmd::Move or Cmd::GoTo.

Fields

states: BarChartStates

Implementations

impl BarChart

pub fn foreground(self, fg: Color) -> Self

Set the main foreground color. This may get overwritten by individual text styles.

pub fn background(self, bg: Color) -> Self

Set the main background color. This may get overwritten by individual text styles.

pub fn modifiers(self, m: TextModifiers) -> Self

Set the main text modifiers. This may get overwritten by individual text styles.

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

Set the main style. This may get overwritten by individual text styles.

This option will overwrite any previous foreground, background and modifiers!

pub fn borders(self, b: Borders) -> Self

Add a border to the component.

pub fn title<T: Into<Title>>(self, title: T) -> Self

Add a title to the component.

pub fn disabled(self, disabled: bool) -> Self

Set whether this component should appear “disabled” (or also known as “locked”).

pub fn inactive(self, s: Style) -> Self

Set a custom style for the border when the component is unfocused.

pub fn data(self, data: &[(&str, u64)]) -> Self

Set the initial Dataset

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

Set a custom gap between bars, see BarChart::bar_gap.

pub fn bar_style(self, s: Style) -> Self

Set a custom style for all bars.

pub fn label_style(self, s: Style) -> Self

Set a custom style for all bar labels.

pub fn max_bars(self, l: usize) -> Self

Set the max amount of bars to display.

By default the data length.

pub fn value_style(self, s: Style) -> Self

Set a custom style for all values.

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

Set the width of each bar.

Trait Implementations

impl Component for BarChart

fn view(&mut self, render: &mut Frame<'_>, area: Rect)

Based on the current properties and states, renders the component in the provided area frame. Render can also mutate the component state if this is required

fn query<'a>(&'a self, attr: Attribute) -> Option<QueryResult<'a>>

Query attribute of component properties.

fn attr(&mut self, attr: Attribute, value: AttrValue)

Set attribute to properties. query describes the name, while attr the value it’ll take

fn perform(&mut self, cmd: Cmd) -> CmdResult

Perform a command on the component. The command will may change the component state. The method returns the result of the command applied (what changed if any)

fn state(&self) -> State

Get current state from component

impl Default for BarChart

fn default() -> BarChart

Returns the “default value” for a type.