Struct gnuplot::Figure[][src]

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

A figure that may contain multiple axes.

Implementations

Creates a new figure.

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.

Set or unset text enhancements

pub fn set_post_commands<'l>(
    &'l mut self,
    post_commands: &str
) -> &'l mut Figure
[src]

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

Sets commands to send to gnuplot before any plotting commands.

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.

Returns the Gnuplot version.

Define the layout for the multiple plots

Arguments

  • rows - Number of rows
  • columns - Number of columns

Set the multiplot title

Arguments

  • title - Name of the file

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

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

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

Arguments

  • order - Options: RowsFirst, ColumnsFirst
  • direction - Options: Downwards, Upwards

Creates a set of 2D axes

Creates a set of 3D axes

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).

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.

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.

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)

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)

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)

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)

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)

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.

Clears all axes on this figure.

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

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

Arguments

  • filename - Name of the file

Trait Implementations

Executes the destructor for this type. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.