kuva 0.1.0

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

# Series Plot

A series plot displays an ordered sequence of y-values against their sequential index on the x-axis. It is the simplest way to visualise a **time series**, signal trace, or any 1D ordered measurement. Three rendering styles are available: line, point, or both.

**Import path:** `kuva::plot::SeriesPlot`

---

## Basic usage

Pass an iterable of numeric values to `.with_data()`. The x-axis is assigned automatically as `0, 1, 2, …`.

```rust,no_run
use kuva::plot::SeriesPlot;
use kuva::backend::svg::SvgBackend;
use kuva::render::render::render_multiple;
use kuva::render::layout::Layout;
use kuva::render::plots::Plot;

let data: Vec<f64> = (0..80)
    .map(|i| (i as f64 * std::f64::consts::TAU / 80.0).sin())
    .collect();

let series = SeriesPlot::new()
    .with_data(data)
    .with_color("steelblue")
    .with_line_style();

let plots = vec![Plot::Series(series)];
let layout = Layout::auto_from_plots(&plots)
    .with_title("Series Plot — Line Style")
    .with_x_label("Sample")
    .with_y_label("Amplitude");

let svg = SvgBackend.render_scene(&render_multiple(plots, layout));
std::fs::write("series.svg", svg).unwrap();
```

<img src="../assets/series/basic.svg" alt="Series plot — single sine wave, line style" width="560">

---

## Display styles

Three styles control how values are rendered. Call the corresponding method instead of setting a field directly.

| Method | Style | Renders |
|--------|-------|---------|
| `.with_line_style()` | `Line` | Polyline connecting consecutive points |
| `.with_point_style()` | `Point` | Circle at each value **(default)** |
| `.with_line_point_style()` | `Both` | Polyline and circles |

<img src="../assets/series/style_line.svg" alt="Line style" width="380">
<img src="../assets/series/style_point.svg" alt="Point style" width="380">

<img src="../assets/series/style_both.svg" alt="Both style" width="380">

---

## Multiple series

Place multiple `SeriesPlot` instances in the same `plots` vector to overlay them on one canvas. All series share the same axes; they align automatically when they have the same number of values.

```rust,no_run
# use kuva::plot::SeriesPlot;
# use kuva::render::plots::Plot;
let s1 = SeriesPlot::new()
    .with_data(sin_data)
    .with_color("steelblue")
    .with_line_style()
    .with_legend("sin(t)");

let s2 = SeriesPlot::new()
    .with_data(cos_data)
    .with_color("firebrick")
    .with_line_style()
    .with_legend("cos(t)");

let s3 = SeriesPlot::new()
    .with_data(damped)
    .with_color("seagreen")
    .with_line_style()
    .with_stroke_width(1.5)
    .with_legend("e^(−t/2)·sin(t)");

let plots = vec![Plot::Series(s1), Plot::Series(s2), Plot::Series(s3)];
```

<img src="../assets/series/multi.svg" alt="Multiple series — sin, cos, and damped oscillation" width="560">

Each series has its own color and legend entry. The legend is drawn automatically when any series has a `legend_label`.

---

## Custom stroke and point size

`.with_stroke_width(f)` sets the line thickness; `.with_point_radius(f)` sets the circle size. These only affect the relevant style — `stroke_width` applies to `Line` and `Both`; `point_radius` applies to `Point` and `Both`.

```rust,no_run
# use kuva::plot::SeriesPlot;
# use kuva::render::plots::Plot;
let series = SeriesPlot::new()
    .with_data(data)
    .with_color("darkorchid")
    .with_line_point_style()
    .with_stroke_width(1.5)
    .with_point_radius(4.0)
    .with_legend("signal");
```

<img src="../assets/series/styled.svg" alt="Series with custom stroke width 1.5 and point radius 4.0" width="560">

---

## API reference

| Method | Description |
|--------|-------------|
| `SeriesPlot::new()` | Create with defaults (`Point` style, `"black"`, radius `3.0`, width `2.0`) |
| `.with_data(iter)` | Load y-values; x positions are sequential indices |
| `.with_color(s)` | CSS color for lines and points (default `"black"`) |
| `.with_line_style()` | Polyline only |
| `.with_point_style()` | Circles only **(default)** |
| `.with_line_point_style()` | Polyline and circles |
| `.with_stroke_width(f)` | Line thickness in pixels (default `2.0`) |
| `.with_point_radius(f)` | Circle radius in pixels (default `3.0`) |
| `.with_legend(s)` | Add a legend entry with this label |