plotkit 1.0.0

A matplotlib-shaped, publication-quality plotting library for Rust
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

# Installation

plotkit targets a recent stable Rust toolchain (edition 2021, Rust 1.75+).

Add it with `cargo add`:

```bash
cargo add plotkit
```

or edit `Cargo.toml` directly:

```toml
[dependencies]
plotkit = "1"
```

By default the `png` and `svg` features are enabled, so PNG rasterization and
SVG vector output work with no extra configuration.

## Optional features

Enable additional backends and integrations through Cargo features:

```bash
cargo add plotkit --features pdf,jupyter,ndarray,polars
```

```toml
[dependencies]
plotkit = { version = "1", features = ["pdf", "jupyter", "ndarray", "polars"] }
```

| Feature   | Default | Description                                              |
|-----------|:-------:|----------------------------------------------------------|
| `png`     |   yes   | PNG rasterization (the default raster backend)           |
| `svg`     |   yes   | SVG vector output                                        |
| `pdf`     |   no    | PDF vector output and `to_pdf_bytes`                     |
| `jupyter` |   no    | Inline display in Evcxr (Rust Jupyter) notebooks         |
| `ndarray` |   no    | Plot directly from `ndarray::Array1` / `ArrayView1`      |
| `polars`  |   no    | Plot directly from Polars `Series` and `DataFrame`       |

To opt out of the defaults (for example, an SVG-only build) disable default
features and re-enable just what you need:

```toml
[dependencies]
plotkit = { version = "1", default-features = false, features = ["svg"] }
```

## Importing

Most code pulls in the prelude, which re-exports the common types
(`Figure`, `Axes`, `Theme`, `Colormap`, `Scale`, `Color`, `Marker`, …) and the
`pyplot`-style free functions:

```rust
use plotkit::prelude::*;
```

The `FigureExt` trait (providing `fig.save`, `fig.to_png_bytes`,
`fig.to_svg_string`, and `fig.to_pdf_bytes`) is included in the prelude as
well.