rstk 0.3.0

A Rust binding for the Tk graphics toolkit. Tk is suitable for creating simple GUI programs or interactive graphical displays. This library supports a large portion of the Tk API, in a generally rust-like style.
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

//! Histogram - a bar chart where area, not height, represents frequency.
//!

use crate::canvas;
use crate::chart::plotchart;
use crate::widget;
use crate::wish;

/// Refers to a histogram
#[derive(Clone, Debug, PartialEq)]
pub struct TkHistogram {
    pub id: String,
}

/// Intermediate definition for a histogram
#[derive(Clone, Debug, PartialEq)]
pub struct TkHistogramDefinition {
    canvas_id: String,
    x_axis: (f64, f64, f64),
    y_axis: (f64, f64, f64),
    x_labels: Option<String>,
    y_labels: Option<String>,
}

/// Methods to set options for histogram - call 'plot' method at
/// end to finally create the chart.
impl TkHistogramDefinition {
    /// Adds custom labels for the x-axis.
    ///
    /// This will replace the step value for the x-axis.
    /// Labels which are numbers will be placed according to the given scale, 
    /// and otherwise are evenly distributed.
    pub fn x_labels(&mut self, labels: &[&str]) -> &mut Self {
        self.x_labels = Some(widget::strings_list(labels));
        self
    }

    /// Adds custom labels for the y-axis.
    ///
    /// This will replace the step value for the y-axis.
    /// Labels which are numbers will be placed according to the given scale, 
    /// and otherwise are evenly distributed.
    pub fn y_labels(&mut self, labels: &[&str]) -> &mut Self {
        self.y_labels = Some(widget::strings_list(labels));
        self
    }

    /// Completes the definition of a histogram and creates the chart.
    pub fn plot(&self) -> TkHistogram {
        // if a labels set is defined, ignore the relevant step value.
        let x_str;
        if self.x_labels.is_none() {
            x_str = format!("{{{} {} {}}}", self.x_axis.0, self.x_axis.1, self.x_axis.2);
        } else { 
            x_str = format!("{{{} {}}}", self.x_axis.0, self.x_axis.1);
        };
        let y_str;
        if self.y_labels.is_none() {
            y_str = format!("{{{} {} {}}}", self.y_axis.0, self.y_axis.1, self.y_axis.2);
        } else { 
            y_str = format!("{{{} {}}}", self.y_axis.0, self.y_axis.1);
        };
        let id = wish::next_var();
        let mut msg = format!(
            "global {}; set {} [::Plotchart::createHistogram {} {} {} ",
            id, id, &self.canvas_id, &x_str, &y_str);

        if let Some(labels) = &self.x_labels {
            msg.push_str(&format!("-xlabels {{{}}} ", labels));
        }
        if let Some(labels) = &self.y_labels {
            msg.push_str(&format!("-ylabels {{{}}} ", labels));
        }

        msg.push_str("]");
        wish::tell_wish(&msg);

        TkHistogram { id }
    }
}

/// Creates a histogram.
///
/// Constructor creates an instance of a histogram definition in given canvas.
///
/// Options must be added and then 'plot' called to finally
/// create the chart.
pub fn make_histogram(
    canvas: &canvas::TkCanvas,
    x_axis: (f64, f64, f64),
    y_axis: (f64, f64, f64),
) -> TkHistogramDefinition {
    TkHistogramDefinition {
        canvas_id: String::from(&canvas.id),
        x_axis,
        y_axis,
        x_labels: None,
        y_labels: None,
    }
}

impl plotchart::TkPlotchart for TkHistogram {
    /// Returns the widget's id reference - used within tk
    fn id(&self) -> &str {
        &self.id
    }
}

impl plotchart::TkChartSeries for TkHistogram {}

impl TkHistogram {
    /// Plots a single bar - the x-value defines the right-hand side of the bar.
    pub fn plot(&self, series: &str, (x, y): (f64, f64)) {
        let msg = format!(
            "global {}; ${} plot {} {} {}",
            &self.id, &self.id, series, x, y
        );
        wish::tell_wish(&msg);
    }

    /// Plots a single bar, accumulating the previous values.
    /// The x-value defines the right-hand side of the bar.
    pub fn plot_cumulative(&self, series: &str, (x, y): (f64, f64)) {
        let msg = format!(
            "global {}; ${} plotcumulative {} {} {}",
            &self.id, &self.id, series, x, y
        );
        wish::tell_wish(&msg);
    }

    /// Sets display-style of histogram.
    pub fn series_style(&self, series: &str, value: plotchart::HistogramStyle) {
        let msg = format!("global {}; ${} dataconfig {} -style {}",
                          &self.id, &self.id, series, value);
        wish::tell_wish(&msg);
    }
}