Struct plotly::plot::Plot

pub struct Plot { /* fields omitted */ }

Plot is a container for structs that implement the Trace trait. Optionally a Layout can also be specified. Its function is to serialize Traces and the Layout in html format and display and/or persist the resulting plot.

Examples

extern crate plotly;
use plotly::common::Mode;
use plotly::{Plot, Scatter};

fn line_and_scatter_plot() {
    let trace1 = Scatter::new(vec![1, 2, 3, 4], vec![10, 15, 13, 17])
        .name("trace1")
        .mode(Mode::Markers);
    let trace2 = Scatter::new(vec![2, 3, 4, 5], vec![16, 5, 11, 9])
        .name("trace2")
        .mode(Mode::Lines);
    let trace3 = Scatter::new(vec![1, 2, 3, 4], vec![12, 9, 15, 12]).name("trace3");

    let mut plot = Plot::new();
    plot.add_trace(trace1);
    plot.add_trace(trace2);
    plot.add_trace(trace3);
    plot.show();
}

fn main() -> std::io::Result<()> {
    line_and_scatter_plot();
    Ok(())
}

Methods

impl Plot

pub fn new() -> Plot

Create a new Plot.

pub fn add_trace(&mut self, trace: Box<dyn Trace>)

Add a Trace to the Plot.

pub fn set_layout(&mut self, layout: Layout)

Set the Layout to be used by Plot.

pub fn show(&self)

Renders the contents of the Plot and displays them in the system default browser.

This will serialize the Traces and Layout in an html page which is saved in the temp directory. For example on Linux it will generate a file plotly_<22 random characters>.html in the /tmp directory.

pub fn show_png(&self, width: usize, height: usize)

Renders the contents of the Plot, creates a png raster and displays it in the system default browser.

To save the resulting png right-click on the resulting image and select Save As....

pub fn show_jpeg(&self, width: usize, height: usize)

Renders the contents of the Plot, creates a jpeg raster and displays it in the system default browser.

To save the resulting png right-click on the resulting image and select Save As....

pub fn to_html<P: AsRef<Path>>(&self, filename: P)

Renders the contents of the Plot and displays it in the system default browser.

In contrast to Plot::show() this will save the resulting html in a user specified location instead of the system temp directory.