Figure in gnuplot - Rust

pub struct Figure { /* private fields */ }
Expand description

A figure that may contain multiple axes.

Source§
Source

Creates a new figure.

Source

Set the directory where to write the data.

Gnuplot needs to reify the data before it can be plotted. By default, this is done by writing out data files into a temporary directory. This behavior can be restored by passing in Some("".into()).

This can be set to None, in which case the data is written inline, without a temporary directory. Note that this has somewhat spotty support in gnuplot, so should probably be avoided.

Source

Sets the terminal for gnuplot to use, as well as the file to output the figure to. Terminals that spawn a GUI don’t need an output file, so pass an empty string for those.

There are a quite a number of terminals, here are some commonly used ones:

  • wxt - Interactive GUI
  • pdfcairo - Saves the figure as a PDF file
  • epscairo - Saves the figure as a EPS file
  • pngcairo - Saves the figure as a PNG file
  • svg - Saves the figure as a SVG file
  • canvas - Saves the figure as an HTML5 canvas element

As of now you can hack the canvas size in by using “pngcairo size 600, 400” for terminal. Be prepared for that kludge to go away, though.

Source

Set or unset text enhancements

Source

Sets commands to send to gnuplot after all the plotting commands.

Source

Sets commands to send to gnuplot before any plotting commands.

Source

Sets the Gnuplot version.

By default, we assume version 5.0. If show is called, it will attempt to parse Gnuplot’s version string as well.

Source

Returns the Gnuplot version.

Source

Define the layout for the multiple plots

§Arguments
  • rows - Number of rows
  • columns - Number of columns
Source

Set the multiplot title

§Arguments
  • title - Name of the file
Source

Applies a horizontal and vertical scale to each plot

§Arguments
  • scale_x - Horizonal scale applied to each plot
  • scale_y - Vertical scale applied to each plot
Source

Applies a horizontal and vertical offset to each plot

§Arguments
  • offset_x - Horizontal offset applied to each plot
  • offset_y - Horizontal offset applied to each plot
Source

Defines the order in which plots fill the layout. Default is RowsFirst and Downwards.

§Arguments
  • order - Options: RowsFirst, ColumnsFirst
  • direction - Options: Downwards, Upwards
Source

Creates a set of 2D axes

Source

Creates a set of 3D axes

Source

Creates a new page.

Some terminals support multiple pages or frames, e.g. to create an animation. Call this function between sets of plots to indicate that a new page should be started. Note that this is implicit before any axes2d/axes3d calls, so make sure to call this only between pages (not once before every page).

Source

Launch a gnuplot process, if it hasn’t been spawned already by a call to this function, and display the figure on it.

Usually you should prefer using show instead. This method is primarily useful when you wish to call this multiple times, e.g. to redraw an existing plot window.

Source

Launch a gnuplot process, if it hasn’t been spawned already and display the figure on it.

Unlike show_and_keep_running, this also instructs gnuplot to close if you close all of the plot windows. You can use the returned CloseSentinel to wait until this happens.

Source

Save the figure to a png file.

§Arguments
  • filename - Path to the output file (png)
  • width_px - output image width (in pixels)
  • height_px - output image height (in pixels)
Source

Save the figure to a svg file.

§Arguments
  • filename - Path to the output file (svg)
  • width_px - output image width (in pixels)
  • height_px - output image height (in pixels)
Source

Save the figure to a pdf file.

§Arguments
  • filename - Path to the output file (pdf)
  • width_in - output image width (in inches)
  • height_in - output image height (in inches)
Source

Save the figure to an eps file

§Arguments
  • filename - Path to the output file (eps)
  • width_in - output image width (in inches)
  • height_in - output image height (in inches)
Source

Save the figure to a HTML5 canvas file

§Arguments
  • filename - Path to the output file (canvas)
  • width_px - output image width (in pixels)
  • height_px - output image height (in pixels)
Source

Closes the gnuplot process.

This can be useful if you’re your plot output is a file and you need to that it was written.

Source

Clears all axes on this figure.

Source

Echo the commands that if piped to a gnuplot process would display the figure

§Arguments
  • writer - A function pointer that will be called multiple times with the command text and data
Source

Save to a file the the commands that if piped to a gnuplot process would display the figure

§Arguments
  • filename - Name of the file

§
§
§
§
§
§