Struct tui::widgets::Chart

pub struct Chart<'a> { /* fields omitted */ }

A widget to plot one or more dataset in a cartesian coordinate system

Examples

let datasets = vec![
    Dataset::default()
        .name("data1")
        .marker(symbols::Marker::Dot)
        .graph_type(GraphType::Scatter)
        .style(Style::default().fg(Color::Cyan))
        .data(&[(0.0, 5.0), (1.0, 6.0), (1.5, 6.434)]),
    Dataset::default()
        .name("data2")
        .marker(symbols::Marker::Braille)
        .graph_type(GraphType::Line)
        .style(Style::default().fg(Color::Magenta))
        .data(&[(4.0, 5.0), (5.0, 8.0), (7.66, 13.5)]),
];
Chart::new(datasets)
    .block(Block::default().title("Chart"))
    .x_axis(Axis::default()
        .title(Span::styled("X Axis", Style::default().fg(Color::Red)))
        .style(Style::default().fg(Color::White))
        .bounds([0.0, 10.0])
        .labels(["0.0", "5.0", "10.0"].iter().cloned().map(Span::from).collect()))
    .y_axis(Axis::default()
        .title(Span::styled("Y Axis", Style::default().fg(Color::Red)))
        .style(Style::default().fg(Color::White))
        .bounds([0.0, 10.0])
        .labels(["0.0", "5.0", "10.0"].iter().cloned().map(Span::from).collect()));

Implementations

impl<'a> Chart<'a>

pub fn new(datasets: Vec<Dataset<'a>>) -> Chart<'a>

pub fn block(self, block: Block<'a>) -> Chart<'a>

pub fn style(self, style: Style) -> Chart<'a>

pub fn x_axis(self, axis: Axis<'a>) -> Chart<'a>

pub fn y_axis(self, axis: Axis<'a>) -> Chart<'a>

pub fn hidden_legend_constraints(
    self,
    constraints: (Constraint, Constraint)
) -> Chart<'a>

Set the constraints used to determine whether the legend should be shown or not.

Examples

let constraints = (
    Constraint::Ratio(1, 3),
    Constraint::Ratio(1, 4)
);
// Hide the legend when either its width is greater than 33% of the total widget width
// or if its height is greater than 25% of the total widget height.
let _chart: Chart = Chart::new(vec![])
    .hidden_legend_constraints(constraints);

Trait Implementations

impl<'a> Clone for Chart<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Chart<'a>

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

Formats the value using the given formatter.

impl<'a> Widget for Chart<'a>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.