Skip to main content

Chart

Struct Chart 

Source
pub struct Chart {
    pub states: ChartStates,
    /* private fields */
}
Expand description

A component to display a chart on a cartesian coordinate system. The 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: ChartStates

Implementations§

Source§

impl Chart

Source

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

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

Source

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

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

Source

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

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

Source

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!

Source

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

Add a border to the component.

Source

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

Add a title to the component.

Source

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

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

Source

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

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

Source

pub fn data(self, data: impl IntoIterator<Item = ChartDataset>) -> Self

Builder-Style function to set the initial data

Source

pub fn x_bounds(self, bounds: (f64, f64)) -> Self

Set the bounds for the X-axis.

Source

pub fn y_bounds(self, bounds: (f64, f64)) -> Self

Set the bounds for the Y-axis.

Source

pub fn x_labels(self, labels: &[&str]) -> Self

Set labels for the X-Axis, see Axis::labels.

Source

pub fn y_labels(self, labels: &[&str]) -> Self

Set labels for the Y-Axis, see Axis::labels.

Source

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

Set a specific style for the X-Axis.

Source

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

Set a specific style for the Y-Axis.

Source

pub fn x_title<S: Into<String>>(self, t: S) -> Self

Give the X axis a title

Source

pub fn y_title<S: Into<String>>(self, t: S) -> Self

Give the Y axis a title

Trait Implementations§

Source§

impl Component for Chart

Source§

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

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

Query attribute of component properties. Read more
Source§

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

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

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

fn state(&self) -> State

Get current state from component
Source§

impl Default for Chart

Source§

fn default() -> Chart

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

Auto Trait Implementations§

§

impl Freeze for Chart

§

impl !RefUnwindSafe for Chart

§

impl Send for Chart

§

impl Sync for Chart

§

impl Unpin for Chart

§

impl UnsafeUnpin for Chart

§

impl !UnwindSafe for Chart

Blanket Implementations§

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> 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<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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.