Struct LineGauge 

pub struct LineGauge { /* private fields */ }

LineGauge, also known as progress bars, provides a component which shows a line which is some percent filled.

It is possible to set the style for the progress bar and the text shown above it.

Read more in LineGauge.

If a multi-line Guage is necessary, use Gauge instead.

Implementations

impl LineGauge

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 inactive(self, s: Style) -> Self

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

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 label<S: Into<String>>(self, s: S) -> Self

Set a label text for the Gauge.

pub fn progress(self, p: f64) -> Self

Set the initial progress.

pub fn line_style<F: Into<SpanStatic>, U: Into<SpanStatic>>( self, filled: F, unfilled: U, ) -> Self

Set custom Style & Symbols for the filled & unfilled styles.

By default ratatui uses HORIZONTAL for both.

Trait Implementations

impl Component for LineGauge

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 state(&self) -> State

Get current state from component

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)

impl Default for LineGauge

fn default() -> LineGauge

Returns the “default value” for a type.