tui-realm-stdlib 4.0.0

Standard components library for tui-realm.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

use tuirealm::props::{LineStatic, Style};
use tuirealm::ratatui::symbols::Marker;
use tuirealm::ratatui::widgets::{Dataset as TuiDataset, GraphType};

/// Dataset describes a set of data for a chart.
///
/// This mainly exists to map to ratatui's [`Dataset`](TuiDataset), which does not allow owned data.
#[derive(Clone, Debug)]
pub struct ChartDataset {
    pub name: LineStatic,
    pub marker: Marker,
    pub graph_type: GraphType,
    pub style: Style,
    data: Vec<(f64, f64)>,
}

impl Default for ChartDataset {
    fn default() -> Self {
        Self {
            name: LineStatic::default(),
            marker: Marker::Dot,
            graph_type: GraphType::Scatter,
            style: Style::default(),
            data: Vec::default(),
        }
    }
}

impl ChartDataset {
    /// Set a name for the dataset.
    pub fn name<S: Into<LineStatic>>(mut self, name: S) -> Self {
        self.name = name.into();
        self
    }

    /// Set the [`Marker`] type for the dataset.
    pub fn marker(mut self, m: Marker) -> Self {
        self.marker = m;
        self
    }

    /// Set the [`GraphType`] for the dataset.
    pub fn graph_type(mut self, g: GraphType) -> Self {
        self.graph_type = g;
        self
    }

    /// Set Style for the dataset.
    ///
    /// This style is used for the data points and the legenend (if not overwritten by the text's style).
    ///
    /// Read more in [`Dataset::style`](TuiDataset::style).
    pub fn style(mut self, s: Style) -> Self {
        self.style = s;
        self
    }

    /// Set the data for this dataset.
    pub fn data(mut self, data: Vec<(f64, f64)>) -> Self {
        self.data = data;
        self
    }

    /// Push a new point to the back of this dataset.
    pub fn push(&mut self, point: (f64, f64)) {
        self.data.push(point);
    }

    /// Pop the last point from this dataset.
    pub fn pop(&mut self) {
        self.data.pop();
    }

    /// Pop the first point in this dataset.
    pub fn pop_front(&mut self) {
        if !self.data.is_empty() {
            self.data.remove(0);
        }
    }

    /// Get a reference to the data.
    pub fn get_data(&self) -> &[(f64, f64)] {
        &self.data
    }

    /// Create ratatui [`Dataset`](TuiDataset) from the current [`ChartDataset`].
    ///
    /// Only elements from `start` are included.
    pub fn as_tuichart<'a>(&'a self, start: usize) -> TuiDataset<'a> {
        // Prepare data storage
        TuiDataset::default()
            .name(self.name.clone())
            .marker(self.marker)
            .graph_type(self.graph_type)
            .style(self.style)
            .data(&self.get_data()[start..])
    }
}

impl PartialEq for ChartDataset {
    fn eq(&self, other: &Self) -> bool {
        self.name == other.name && self.data == other.data
    }
}

impl<'a> From<&'a ChartDataset> for TuiDataset<'a> {
    fn from(data: &'a ChartDataset) -> TuiDataset<'a> {
        data.as_tuichart(0)
    }
}

#[cfg(test)]
mod test {

    use pretty_assertions::assert_eq;
    use tuirealm::ratatui::style::Color;

    use super::*;

    #[test]
    fn dataset() {
        let mut dataset: ChartDataset = ChartDataset::default()
            .name("Avg temperatures")
            .graph_type(GraphType::Scatter)
            .marker(Marker::Braille)
            .style(Style::default().fg(Color::Cyan))
            .data(vec![
                (0.0, -1.0),
                (1.0, 1.0),
                (2.0, 3.0),
                (3.0, 7.0),
                (4.0, 11.0),
                (5.0, 15.0),
                (6.0, 17.0),
                (7.0, 17.0),
                (8.0, 13.0),
                (9.0, 9.0),
                (10.0, 4.0),
                (11.0, 0.0),
            ]);
        assert_eq!(dataset.name.to_string(), "Avg temperatures");
        assert_eq!(dataset.style.fg.unwrap_or(Color::Reset), Color::Cyan);
        assert_eq!(dataset.get_data().len(), 12);
        // mut
        dataset.push((12.0, 1.0));
        assert_eq!(dataset.get_data().len(), 13);
        dataset.pop();
        assert_eq!(dataset.get_data().len(), 12);
        dataset.pop_front();
        assert_eq!(dataset.get_data().len(), 11);
        // From
        let _: TuiDataset = TuiDataset::from(&dataset);
    }
}