Struct SubplotGrid 

pub struct SubplotGrid { /* private fields */ }

A structure representing a subplot grid layout.

The SubplotGrid struct facilitates the creation of multi-plot layouts arranged in a grid configuration. Plots are automatically arranged in rows and columns in row-major order (left-to-right, top-to-bottom). Each subplot retains its own title, axis labels, and legend, providing flexibility for displaying multiple related visualizations in a single figure.

Features

• Automatic grid layout with configurable rows and columns
• Individual subplot titles (extracted from plot titles)
• Independent axis labels for each subplot
• Configurable horizontal and vertical spacing
• Overall figure title
• Sparse grid support (fewer plots than grid capacity)

Implementations

impl SubplotGrid

pub fn regular<'f1, 'f2>() -> SubplotGridRegularBuilder<'f1, 'f2>

Creates a subplot grid layout.

Arranges plots in a row * column grid with automatic positioning. Plots are placed in row-major order (left-to-right, top-to-bottom). Each subplot retains its individual title (from the plot’s plot_title), axis labels, and legend.

Arguments

• plots - Vector of plot references to arrange in the grid. Plots are positioned in row-major order.
• rows - Number of rows in the grid (default: 1).
• cols - Number of columns in the grid (default: 1).
• title - Overall title for the entire subplot figure (optional).
• h_gap - Horizontal spacing between columns (range: 0.0 to 1.0, default: 0.1).
• v_gap - Vertical spacing between rows (range: 0.0 to 1.0, default: 0.1).

pub fn irregular<'f1, 'f2>() -> SubplotGridIrregularBuilder<'f1, 'f2>

Creates an irregular grid subplot layout with custom row/column spanning.

Allows plots to span multiple rows and/or columns, enabling dashboard-style layouts and asymmetric grid arrangements. Each plot explicitly specifies its position and span.

Arguments

• plots - Vector of tuples (plot, row, col, rowspan, colspan) where:
  • plot: Reference to the plot
  • row: Starting row (0-indexed)
  • col: Starting column (0-indexed)
  • rowspan: Number of rows to span (minimum 1)
  • colspan: Number of columns to span (minimum 1)
• rows - Total number of rows in the grid (default: 1).
• cols - Total number of columns in the grid (default: 1).
• title - Overall title for the subplot figure (optional).
• h_gap - Horizontal spacing between columns (range: 0.0 to 1.0, default: 0.1).
• v_gap - Vertical spacing between rows (range: 0.0 to 1.0, default: 0.1).

impl SubplotGrid

pub fn plot(&self)

Display the subplot grid in the default browser or Jupyter notebook.

pub fn write_html(&self, path: impl Into<String>)

Write the subplot grid to an HTML file.

pub fn to_json(&self) -> Result<String, Error>

Serialize the subplot grid to a JSON string.

pub fn to_html(&self) -> String

Render the subplot grid as a standalone HTML string.

pub fn to_inline_html(&self, plot_div_id: Option<&str>) -> String

Render the subplot grid as an inline HTML snippet (no DOCTYPE/head).

Trait Implementations

impl Clone for SubplotGrid

fn clone(&self) -> SubplotGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for SubplotGrid

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.