kuva 0.1.6

Scientific plotting library in Rust with various backends.
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

//! Figure (multi-plot layout) documentation examples.
//!
//! Generates SVG outputs used in the kuva documentation.
//! Run with:
//!
//! ```bash
//! cargo run --example figure
//! ```
//!
//! SVGs are written to `docs/src/assets/figure/`.

use kuva::plot::{ScatterPlot, LinePlot};
use kuva::backend::svg::SvgBackend;
use kuva::render::figure::Figure;
use kuva::render::layout::Layout;
use kuva::render::plots::Plot;

const OUT: &str = "docs/src/assets/figure";

fn main() {
    std::fs::create_dir_all(OUT).expect("could not create docs/src/assets/figure");
    basic();
    merged();
    tall_panel();
    shared_axes();
    shared_legend();
    figure_size();
    println!("Figure SVGs written to {OUT}/");
}

fn scatter(data: Vec<(f64, f64)>, color: &str, legend: Option<&str>) -> Plot {
    let mut p = ScatterPlot::new().with_data(data).with_color(color).with_size(4.5);
    if let Some(l) = legend { p = p.with_legend(l); }
    Plot::Scatter(p)
}

fn line(data: Vec<(f64, f64)>, color: &str, legend: Option<&str>) -> Plot {
    let mut p = LinePlot::new().with_data(data).with_color(color);
    if let Some(l) = legend { p = p.with_legend(l); }
    Plot::Line(p)
}

/// Basic 1×2 grid with panel labels.
fn basic() {
    let scatter_data = vec![
        (1.0_f64, 2.3), (2.1, 4.1), (3.4, 3.2), (4.2, 5.8),
        (5.0, 5.1), (6.3, 7.2), (7.1, 6.9), (8.5, 8.8),
    ];
    let line_data: Vec<(f64, f64)> = (0..=20)
        .map(|i| { let x = i as f64 * 0.5; (x, x * 0.8 + (x * 0.4).sin() * 1.5) })
        .collect();

    let all_plots = vec![
        vec![scatter(scatter_data, "steelblue", None)],
        vec![line(line_data, "crimson", None)],
    ];

    let layouts: Vec<Layout> = all_plots.iter().zip([
        ("Scatter", "X", "Y"),
        ("Line",    "Time", "Value"),
    ]).map(|(cell, (title, xl, yl))| {
        Layout::auto_from_plots(cell)
            .with_title(title)
            .with_x_label(xl)
            .with_y_label(yl)
    }).collect();

    let scene = Figure::new(1, 2)
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_labels()
        .render();

    std::fs::write(format!("{OUT}/basic.svg"), SvgBackend.render_scene(&scene)).unwrap();
}

/// 2×3 grid with a wide panel spanning the full bottom row.
fn merged() {
    let colors  = ["steelblue", "crimson", "seagreen"];
    let titles  = ["Sample A",  "Sample B", "Sample C"];

    let mut all_plots: Vec<Vec<Plot>> = colors.iter().zip(titles.iter())
        .map(|(color, title)| {
            let data: Vec<(f64, f64)> = (0..12)
                .map(|i| { let x = i as f64; (x, x * 0.9 + (x * 0.7).sin() * 2.0) })
                .collect();
            vec![line(data, color, Some(title))]
        })
        .collect();

    let wide_data: Vec<(f64, f64)> = (0..40)
        .map(|i| { let x = i as f64 * 0.25; (x, (x * 0.5).sin() * 3.0 + x * 0.3) })
        .collect();
    all_plots.push(vec![line(wide_data, "darkorange", None)]);

    let mut layouts: Vec<Layout> = all_plots[..3].iter().zip(titles.iter())
        .map(|(cell, title)| Layout::auto_from_plots(cell).with_title(*title))
        .collect();
    layouts.push(
        Layout::auto_from_plots(&all_plots[3])
            .with_title("Combined")
            .with_x_label("Time")
            .with_y_label("Value"),
    );

    let scene = Figure::new(2, 3)
        .with_structure(vec![
            vec![0], vec![1], vec![2],
            vec![3, 4, 5],
        ])
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_labels()
        .with_cell_size(380.0, 300.0)
        .render();

    std::fs::write(format!("{OUT}/merged.svg"), SvgBackend.render_scene(&scene)).unwrap();
}

/// 2×2 grid with a tall left panel spanning both rows.
fn tall_panel() {
    // cell indices for a 2×2 grid:
    //   0  1
    //   2  3
    // group [0,2] → tall left; [1] → top-right; [3] → bottom-right
    let tall_data: Vec<(f64, f64)> = (0..30)
        .map(|i| { let x = i as f64 * 0.3; (x, x * 0.6 + (x * 0.8).cos() * 2.5) })
        .collect();
    let top_right: Vec<(f64, f64)> = (1..=8).map(|i| (i as f64, i as f64 * 1.2 + 0.5)).collect();
    let bot_right: Vec<(f64, f64)> = (1..=8).map(|i| (i as f64, i as f64 * 0.6 + 1.0)).collect();

    let all_plots = vec![
        vec![line(tall_data, "steelblue", None)],
        vec![scatter(top_right, "crimson", None)],
        vec![scatter(bot_right, "seagreen", None)],
    ];

    let layouts = vec![
        Layout::auto_from_plots(&all_plots[0])
            .with_title("Full Series").with_x_label("Time").with_y_label("Value"),
        Layout::auto_from_plots(&all_plots[1]).with_title("Period 1"),
        Layout::auto_from_plots(&all_plots[2]).with_title("Period 2"),
    ];

    let scene = Figure::new(2, 2)
        .with_structure(vec![vec![0, 2], vec![1], vec![3]])
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_labels()
        .with_cell_size(420.0, 320.0)
        .render();

    std::fs::write(format!("{OUT}/tall_panel.svg"), SvgBackend.render_scene(&scene)).unwrap();
}

/// 2×2 grid demonstrating shared Y axis per row.
fn shared_axes() {
    let make = |offset: f64, color: &str| -> Vec<Plot> {
        let data: Vec<(f64, f64)> = (0..10)
            .map(|i| { let x = i as f64; (x, x * 1.1 + offset + (x * 0.5).sin()) })
            .collect();
        vec![scatter(data, color, None)]
    };

    let all_plots = vec![
        make(0.0,  "steelblue"),
        make(1.5,  "steelblue"),
        make(10.0, "crimson"),
        make(11.0, "crimson"),
    ];

    let layouts = vec![
        Layout::auto_from_plots(&all_plots[0]).with_title("Group A — rep 1").with_y_label("Value"),
        Layout::auto_from_plots(&all_plots[1]).with_title("Group A — rep 2"),
        Layout::auto_from_plots(&all_plots[2]).with_title("Group B — rep 1").with_x_label("X").with_y_label("Value"),
        Layout::auto_from_plots(&all_plots[3]).with_title("Group B — rep 2").with_x_label("X"),
    ];

    let scene = Figure::new(2, 2)
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_shared_y(0)
        .with_shared_y(1)
        .with_cell_size(420.0, 320.0)
        .render();

    std::fs::write(format!("{OUT}/shared_axes.svg"), SvgBackend.render_scene(&scene)).unwrap();
}

/// 2×3 grid sized to a fixed total width × height via with_figure_size.
fn figure_size() {
    let colors = ["steelblue", "crimson", "seagreen", "darkorange", "mediumpurple", "teal"];
    let titles = ["Alpha", "Beta", "Gamma", "Delta", "Epsilon", "Zeta"];

    let all_plots: Vec<Vec<Plot>> = colors.iter().zip(titles.iter())
        .map(|(color, title)| {
            let data: Vec<(f64, f64)> = (0..10)
                .map(|i| { let x = i as f64; (x, x * 0.8 + (x * 0.6 + title.len() as f64).sin() * 2.0) })
                .collect();
            vec![scatter(data, color, None)]
        })
        .collect();

    let layouts: Vec<Layout> = all_plots.iter().zip(titles.iter())
        .map(|(cell, title)| {
            Layout::auto_from_plots(cell).with_title(*title)
        })
        .collect();

    let scene = Figure::new(2, 3)
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_labels()
        .with_title("Fixed 900 × 560 figure — cells auto-sized")
        .with_figure_size(900.0, 560.0)
        .render();

    std::fs::write(format!("{OUT}/figure_size.svg"), SvgBackend.render_scene(&scene)).unwrap();
}

/// 1×2 grid with a shared legend collected from all panels.
fn shared_legend() {
    let make_panel = |x_offset: f64| -> Vec<Plot> {
        let ctrl: Vec<(f64, f64)> = (0..8)
            .map(|i| { let x = i as f64 + x_offset; (x, x * 0.9 + 1.0) })
            .collect();
        let trt: Vec<(f64, f64)> = (0..8)
            .map(|i| { let x = i as f64 + x_offset; (x, x * 1.4 + 0.5) })
            .collect();
        vec![
            scatter(ctrl, "steelblue", Some("Control")),
            scatter(trt,  "crimson",   Some("Treatment")),
        ]
    };

    let all_plots = vec![make_panel(0.0), make_panel(0.5)];

    let layouts = vec![
        Layout::auto_from_plots(&all_plots[0])
            .with_title("Experiment 1").with_x_label("Time").with_y_label("Response"),
        Layout::auto_from_plots(&all_plots[1])
            .with_title("Experiment 2").with_x_label("Time"),
    ];

    let scene = Figure::new(1, 2)
        .with_plots(all_plots)
        .with_layouts(layouts)
        .with_shared_legend()
        .with_cell_size(420.0, 340.0)
        .render();

    std::fs::write(format!("{OUT}/shared_legend.svg"), SvgBackend.render_scene(&scene)).unwrap();
}