Struct Figure

pub struct Figure { /* private fields */ }

Plot container

Implementations

impl Figure

pub fn new() -> Figure

Creates an empty figure

pub fn box_width(&mut self, width: f64) -> &mut Figure

Changes the box width of all the box related plots (bars, candlesticks, etc)

Note The default value is 0

Panics

Panics if width is a negative value

pub fn font<S>(&mut self, font: S) -> &mut Figure

where S: Into<Cow<'static, str>>,

Changes the font

pub fn font_size(&mut self, size: f64) -> &mut Figure

Changes the size of the font

Panics

Panics if size is a non-positive value

pub fn output<S>(&mut self, output: S) -> &mut Figure

where S: Into<Cow<'static, Path>>,

Changes the output file

Note The default output file is output.plot

pub fn figure_size(&mut self, width: usize, height: usize) -> &mut Figure

Changes the figure size

pub fn terminal(&mut self, terminal: Terminal) -> &mut Figure

Changes the output terminal

Note By default, the terminal is set to Svg

pub fn title<S>(&mut self, title: S) -> &mut Figure

where S: Into<Cow<'static, str>>,

Sets the title

pub fn draw(&mut self) -> Result<Child>

Spawns a drawing child process

NOTE: stderr, stdin, and stdout are piped

pub fn dump<W>(&mut self, sink: &mut W) -> Result<&mut Figure>

where W: Write,

Dumps the script required to produce the figure into sink

pub fn save(&self, path: &Path) -> Result<&Figure>

Saves the script required to produce the figure to path

pub fn configure_axis<F: FnOnce(&mut AxisProperties) -> &mut AxisProperties>( &mut self, axis: Axis, configure: F, ) -> &mut Figure

Configures an axis.

pub fn configure_key<F: FnOnce(&mut KeyProperties) -> &mut KeyProperties>( &mut self, configure: F, ) -> &mut Figure

Configures the key (legend).

Trait Implementations

impl Clone for Figure

fn clone(&self) -> Figure

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<X, WM, BM, BH, WH> Plot<Candlesticks<X, WM, BM, BH, WH>> for Figure

where BH: IntoIterator, BH::Item: Data, BM: IntoIterator, BM::Item: Data, WH: IntoIterator, WH::Item: Data, WM: IntoIterator, WM::Item: Data, X: IntoIterator, X::Item: Data,

type Properties = Properties

The properties associated to the plot

fn plot<F>( &mut self, candlesticks: Candlesticks<X, WM, BM, BH, WH>, configure: F, ) -> &mut Figure

where F: FnOnce(&mut Properties) -> &mut Properties,

Plots some data with some configuration

impl<X, Y> Plot<Curve<X, Y>> for Figure

where X: IntoIterator, X::Item: Data, Y: IntoIterator, Y::Item: Data,

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, curve: Curve<X, Y>, configure: F) -> &mut Figure

where F: FnOnce(&mut Properties) -> &mut Properties,

Plots some data with some configuration

impl<X, Y, L, H> Plot<ErrorBar<X, Y, L, H>> for Figure

where H: IntoIterator, H::Item: Data, L: IntoIterator, L::Item: Data, X: IntoIterator, X::Item: Data, Y: IntoIterator, Y::Item: Data,

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, e: ErrorBar<X, Y, L, H>, configure: F) -> &mut Figure

where F: FnOnce(&mut Properties) -> &mut Properties,

Plots some data with some configuration

impl<X, Y1, Y2> Plot<FilledCurve<X, Y1, Y2>> for Figure

where X: IntoIterator, X::Item: Data, Y1: IntoIterator, Y1::Item: Data, Y2: IntoIterator, Y2::Item: Data,

type Properties = Properties

The properties associated to the plot

fn plot<F>(&mut self, fc: FilledCurve<X, Y1, Y2>, configure: F) -> &mut Figure

where F: FnOnce(&mut Properties) -> &mut Properties,

Plots some data with some configuration