Struct Figure 

pub struct Figure {
    pub title: Option<String>,
    pub x_label: Option<String>,
    pub y_label: Option<String>,
    pub legend_enabled: bool,
    pub grid_enabled: bool,
    pub background_color: Vec4,
    pub x_limits: Option<(f64, f64)>,
    pub y_limits: Option<(f64, f64)>,
    /* private fields */
}

A figure that can contain multiple overlaid plots

Fields

title: Option<String>

Figure-level settings

x_label: Option<String>

y_label: Option<String>

legend_enabled: bool

grid_enabled: bool

background_color: Vec4

x_limits: Option<(f64, f64)>

Axis limits (None = auto-scale)

y_limits: Option<(f64, f64)>

Implementations

impl Figure

pub fn new() -> Self

Create a new empty figure

pub fn with_title<S: Into<String>>(self, title: S) -> Self

Set the figure title

pub fn with_labels<S: Into<String>>(self, x_label: S, y_label: S) -> Self

Set axis labels

pub fn with_limits(self, x_limits: (f64, f64), y_limits: (f64, f64)) -> Self

Set axis limits manually

pub fn with_legend(self, enabled: bool) -> Self

Enable or disable the legend

pub fn with_grid(self, enabled: bool) -> Self

Enable or disable the grid

pub fn with_background_color(self, color: Vec4) -> Self

Set background color

pub fn add_line_plot(&mut self, plot: LinePlot) -> usize

Add a line plot to the figure

pub fn add_scatter_plot(&mut self, plot: ScatterPlot) -> usize

Add a scatter plot to the figure

pub fn add_bar_chart(&mut self, plot: BarChart) -> usize

Add a bar chart to the figure

pub fn add_histogram(&mut self, plot: Histogram) -> usize

Add a histogram to the figure

pub fn add_point_cloud_plot(&mut self, plot: PointCloudPlot) -> usize

Add a point cloud to the figure

pub fn remove_plot(&mut self, index: usize) -> Result<(), String>

Remove a plot by index

pub fn clear(&mut self)

Clear all plots

pub fn len(&self) -> usize

Get the number of plots

pub fn is_empty(&self) -> bool

Check if figure has no plots

pub fn plots(&self) -> impl Iterator<Item = &PlotElement>

Get an iterator over all plots in this figure

pub fn get_plot_mut(&mut self, index: usize) -> Option<&mut PlotElement>

Get a mutable reference to a plot

pub fn bounds(&mut self) -> BoundingBox

Get the combined bounds of all visible plots

pub fn render_data(&mut self) -> Vec<RenderData>

Generate all render data for all visible plots

pub fn legend_entries(&self) -> Vec<LegendEntry>

Get legend entries for all labeled plots

pub fn statistics(&self) -> FigureStatistics

Get figure statistics

Trait Implementations

impl Clone for Figure

fn clone(&self) -> Figure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Figure

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Figure

fn default() -> Self

Returns the “default value” for a type.