https://github.com/igiagkiozis/plotly

Plotly for Rust
https://github.com/igiagkiozis/plotly

barchart candlestick-chart chart data-visualization data-vizualisation financial financial-analysis plot plotly plotlyjs rust scatter scatterplot statistics

Last synced: about 1 month ago
JSON representation

Plotly for Rust

Host: GitHub
URL: https://github.com/igiagkiozis/plotly
Owner: plotly
License: other
Created: 2020-01-26T10:57:20.000Z (about 5 years ago)
Default Branch: main
Last Pushed: 2024-05-17T03:52:29.000Z (11 months ago)
Last Synced: 2024-05-22T03:14:02.242Z (11 months ago)
Topics: barchart, candlestick-chart, chart, data-visualization, data-vizualisation, financial, financial-analysis, plot, plotly, plotlyjs, rust, scatter, scatterplot, statistics
Language: Rust
Homepage: https://docs.rs/plotly
Size: 45.3 MB
Stars: 978
Watchers: 31
Forks: 94
Open Issues: 37
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-MIT

Awesome Lists containing this project

awesome-yew - Plotly.rs - Rust bindings for the popular [Plotly](https://plotly.com/javascript/) charting library. (Crates / Javascript Library Ports)

README

        


  Plotly.rs

  Plotly for Rust

  

    

        

    

    

        

    

    

        

    

	

        

    

	

        

    

  

  

    Getting Started

     | 

    Recipes

     | 

    API Docs

     | 

    Changelog

  





  

    

  



# Table of Contents

* [Introduction](#introduction)

* [Basic Usage](#basic-usage)

    * [Exporting an Interactive Plot](#exporting-an-interactive-plot)

    * [Exporting Static Images with Kaleido](#exporting-static-images-with-kaleido)

    * [Usage Within a Wasm Environment](#usage-within-a-wasm-environment)

* [Crate Feature Flags](#crate-feature-flags)

* [Contributing](#contributing)

* [Code of Conduct](#code-of-conduct)

* [License](#license)

# Introduction

A plotting library for Rust powered by [Plotly.js](https://plot.ly/javascript/).

Documentation and numerous interactive examples are available in the [Plotly.rs Book](https://plotly.github.io/plotly.rs/content/getting_started.html), the [examples/](https://github.com/plotly/plotly.rs/tree/main/examples) directory and [docs.rs](https://docs.rs/crate/plotly).

For changes since the last version, please consult the [changelog](https://github.com/plotly/plotly.rs/tree/main/CHANGELOG.md).

# Basic Usage

Add this to your `Cargo.toml`:

```toml

[dependencies]

plotly = "0.12"

```

## Exporting a single Interactive Plot

Any figure can be saved as an HTML file using the `Plot.write_html()` method. These HTML files can be opened in any web browser to access the fully interactive figure.

```rust

use plotly::{Plot, Scatter};

let mut plot = Plot::new();

let trace = Scatter::new(vec![0, 1, 2], vec![2, 1, 0]);

plot.add_trace(trace);

plot.write_html("out.html");

```

By default, the Plotly JavaScript library and some [MathJax](https://docs.mathjax.org/en/latest/web/components/index.html) components will always be included via CDN, which results in smaller file-size, but slightly slower first load as the JavaScript libraries have to be downloaded first. Alternatively, to embed the JavaScript libraries (several megabytes in size) directly into the HTML file, `plotly-rs` must be compiled with the feature flag `plotly_embed_js`. With this feature flag the Plotly and MathJax JavaScript libraries are directly embedded in the generated HTML file. It is still possible to use the CDN version, by using the `use_cdn_js` method.

```rust

// <-- Create a `Plot` -->

plot.use_cdn_js();

plot.write_html("out.html");

```

If you only want to view the plot in the browser quickly, use the `Plot.show()` method.

```rust

// <-- Create a `Plot` -->

plot.show(); // The default web browser will open, displaying an interactive plot

```

## Exporting Static Images with Kaleido

To save a plot as a static image, the `kaleido` feature is required as well as installing an **external dependency**.

### Kaleido external dependency

When developing applications for your host, enabling both `kaleido` and `kaleido_download` features will ensure that the `kaleido` binary is downloaded for your system's architecture at compile time. After download, it is unpacked into a specific path, e.g., on Linux this is `/home/USERNAME/.config/kaleido`. With these two features enabled, static images can be exported as described in the next section as long as the application runs on the same machine where it has been compiled on.

When the applications developed with `plotly.rs` are intended for other targets or when the user wants to control where the `kaleido` binary is installed then Kaleido must be manually downloaded and installed. Setting the environment variable `KALEIDO_PATH=/path/installed/kaleido/` will ensure that applications that were built with the `kaleido` feature enabled can locate the `kaleido` executable and use it to generate static images.

Kaleido binaries are available on Github [release page](https://github.com/plotly/Kaleido/releases). It currently supports Linux(`x86_64`), Windows(`x86_64`) and MacOS(`x86_64`/`aarch64`).

## Exporting a Static Images

Enable the `kaleido` feature and opt in for automatic downloading of the `kaleido` binaries by doing the following

```toml

# Cargo.toml

[dependencies]

plotly = { version = "0.12", features = ["kaleido", "kaleido_download"] }

```

Alternatively, enable only the `kaleido` feature and manually install Kaleido.

```toml

# Cargo.toml

[dependencies]

plotly = { version = "0.12", features = ["kaleido"] }

```

With the feature enabled, plots can be saved as any of `png`, `jpeg`, `webp`, `svg`, `pdf` and `eps`. Note that the plot will be a static image, i.e. they will be non-interactive.

Exporting a simple plot looks like this:

```rust

use plotly::{ImageFormat, Plot};

let mut plot = Plot::new();

let trace = Scatter::new(vec![0, 1, 2], vec![2, 1, 0]);

plot.add_trace(trace);

plot.write_image("out.png", ImageFormat::PNG, 800, 600, 1.0);

```

## Usage Within a Wasm Environment

`Plotly.rs` can be used with a Wasm-based frontend framework. The needed dependencies are automatically enabled on `wasm32` targets. Note that the `kaleido` feature is not supported in Wasm enviroments and will throw a compilation error if enabled. 

First, make sure that you have the Plotly JavaScript library in your base HTML template:

```html

 

    

        

        

    

    

```

A simple `Plot` component would look as follows, using `Yew` as an example frontend framework:

```rust

use plotly::{Plot, Scatter};

use yew::prelude::*;

#[function_component(PlotComponent)]

pub fn plot_component() -> Html {

    let p = yew_hooks::use_async::<_, _, ()>({

        let id = "plot-div";

        let mut plot = Plot::new();

        let trace = Scatter::new(vec![0, 1, 2], vec![2, 1, 0]);

        plot.add_trace(trace);

        async move {

            plotly::bindings::new_plot(id, &plot).await;

            Ok(())

        }

    });

    use_effect_with((), move |_| {

        p.run();

        || ()

    });

    html! {

        


    }

}

```

More detailed standalone examples can be found in the [examples/](https://github.com/plotly/plotly.rs/tree/main/examples) directory.

# Crate Feature Flags

The following feature flags are available:

### `kaleido`

Adds plot save functionality to the following formats: `png`, `jpeg`, `webp`, `svg`, `pdf` and `eps`.

Requires `Kaleido` to have been previously installed on the host machine. See the following feature flag and [Kaleido external dependency](#kaleido-external-dependency).

### `kaleido_download`

Enable download and install of Kaleido binary at build time from [Kaleido releases](https://github.com/plotly/Kaleido/releases/) on the host machine.

See [Kaleido external dependency](#kaleido-external-dependency) for more details.

### `plotly_image`

Adds trait implementations so that `image::RgbImage` and `image::RgbaImage` can be used more directly with the `plotly::Image` trace.

### `plotly_ndarray`

Adds support for creating plots directly using [ndarray](https://github.com/rust-ndarray/ndarray) types.

### `plotly_embed_js`

By default, the CDN version of `plotly.js` is used in the library and in the generated HTML files. This feature can be used to opt in for embedding `plotly.min.js` in the generated HTML files. The benefit is that the plot will load faster in the browser.

However, there are two downsides of using this feature flag, one is that the resulting html will be much larger, as a copy of the `plotly.min.js` library is embedded in each HTML file. The second, more relevant, is that a copy of the `plotly.min.js` library needs to be compiled in the `plotly-rs` library itself which increases the size by approx `3.5 Mb`.

When the feature is enabled, users can still opt in for the CDN version by using the method `use_cdn_js`.

Note that when using `Plot::to_inline_html()`, it is assumed that the `plotly.js` library is already in scope within the HTML file, so enabling this feature flag will have no effect.

### `wasm`

Enables compilation for the `wasm32-unknown-unknown` target and provides access to a `bindings` module containing wrappers around functions exported by the plotly.js library.

# Contributing

* If you've spotted a bug or would like to see a new feature, please submit an issue on the [issue tracker](https://github.com/plotly/plotly.rs/issues).

* Pull requests are welcome, see the [contributing guide](https://github.com/plotly/plotly.rs/tree/main/CONTRIBUTING.md) for more information.

# Code of Conduct

See the [Code of Conduct](https://github.com/plotly/plotly.rs/tree/main/CODE_OF_CONDUCT.md) for more information.

# License

`Plotly.rs` is distributed under the terms of the MIT license, see [LICENSE](https://github.com/plotly/plotly.rs/tree/main/LICENSE).