Struct plotpy::Plot

pub struct Plot { /* fields omitted */ }

Driver structure that calls Python

Example

// import
use plotpy::*;
use std::path::Path;

// directory to save figures
const OUT_DIR: &str = "/tmp/plotpy/doc_tests";

// generate (x,y) points
let x = &[1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0];
let y = &[1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0];

// configure and draw curve
let mut curve = Curve::new();
curve.label = "line".to_string();
curve.draw(x, y);

// configure plot
let mut plot = Plot::new();
plot.title_all_subplots("four views of the same curve");
plot.subplot_vertical_gap(0.50);

// add curve to subplot
plot.subplot(2, 2, 1);
plot.title("first");
plot.add(&curve);
plot.legend();
plot.grid_and_labels("x", "y");

// add curve to subplot
plot.subplot(2, 2, 2);
plot.title("second");
plot.add(&curve);
plot.legend();
plot.grid_and_labels("x", "y");

// add curve to subplot
plot.subplot(2, 2, 3);
plot.title("third");
plot.add(&curve);
plot.legend();
plot.grid_and_labels("x", "y");

// add curve to subplot
plot.subplot(2, 2, 4);
plot.title("fourth");
plot.add(&curve);
plot.grid_and_labels("x", "y");
plot.equal();
plot.legend();
plot.xrange(2.0, 8.0);
plot.yrange(2.0, 8.0);

// save figure
let path = Path::new(OUT_DIR).join("doc_plot.svg");
plot.save(&path)?;

Implementations

impl Plot

pub fn new() -> Self

Creates new Plot object

pub fn add(&mut self, graph: &dyn GraphMaker)

Adds new graph entity

pub fn save(&self, figure_path: &Path) -> Result<(), &'static str>

Calls python3 and saves the python script and figure

pub fn title(&mut self, title: &str)

Adds a title to the plot or sub-plot

pub fn title_all_subplots(&mut self, title: &str)

Adds a title to all sub-plots

pub fn subplot(&mut self, row: i32, col: i32, index: i32)

Configures subplots

Arguments

• row - number of rows in the subplot grid
• col - number of columns in the subplot grid
• index - activate current subplot; indices start at one [1-based]

pub fn subplot_horizontal_gap(&mut self, value: f64)

Sets the horizontal gap between subplots

pub fn subplot_vertical_gap(&mut self, value: f64)

Sets the vertical gap between subplots

pub fn subplot_gap(&mut self, horizontal: f64, vertical: f64)

Sets the horizontal and vertical gap between subplots

pub fn equal(&mut self)

Sets same scale for both axes

pub fn hide_axes(&mut self)

Hides axes

pub fn range(&mut self, xmin: f64, xmax: f64, ymin: f64, ymax: f64)

Sets axes limits

pub fn range_vec(&mut self, limits: &[f64])

Sets x and y limits

pub fn xmin(&mut self, xmin: f64)

Sets minimum x

pub fn xmax(&mut self, xmax: f64)

Sets maximum x

pub fn ymin(&mut self, ymin: f64)

Sets minimum y

pub fn ymax(&mut self, ymax: f64)

Sets maximum y

pub fn xrange(&mut self, xmin: f64, xmax: f64)

Sets x-range (i.e. limits)

pub fn yrange(&mut self, ymin: f64, ymax: f64)

Sets y-range (i.e. limits)

pub fn xnticks(&mut self, num: i32)

pub fn ynticks(&mut self, num: i32)

pub fn xlabel(&mut self, label: &str)

Adds x-label

pub fn ylabel(&mut self, label: &str)

Adds y-label

pub fn labels(&mut self, xlabel: &str, ylabel: &str)

Adds labels

pub fn grid_and_labels(&mut self, xlabel: &str, ylabel: &str)

Adds grid and labels

pub fn clear_current_figure(&mut self)

Clears current figure

pub fn legend(&mut self)

Adds legend to plot (see Legend for further options)

pub fn camera(&mut self, elev: f64, azimuth: f64)

Sets camera in 3d graph. Sets the elevation and azimuth of the axes.

Input

• elev – is the elevation angle in the z plane
• azimuth – is the azimuth angle in the x,y plane