Struct PlotGrid 

pub struct PlotGrid { /* private fields */ }

A patchwork-style arrangement of plots rendered into one SVG on the plotters-free native path.

• cells fill row-major (or column-major with byrow(false)) across ncol / nrow (default: a near-square grid; a | b is one row, a / b one column);
• widths / heights set relative column widths / row heights;
• title / subtitle / caption annotate the whole grid;
• tag_levels tags panels a, b, … (A, 1, roman, custom) in reading order, through nested grids;
• collect_legends removes the sub-plots’ legends and draws each distinct legend once beside the grid (identical legends are de-duplicated).

Nested grids keep their own layout and annotations; tagging and legend collection are controlled by the outermost grid.

Implementations

impl PlotGrid

pub fn new() -> Self

pub fn add(self, cell: impl Into<GridCell>) -> Self

Append a plot (or a nested grid) as the next cell.

pub fn add_all(self, plots: impl IntoIterator<Item = GGPlot>) -> Self

Append several plots.

pub fn add_spacer(self) -> Self

Append an empty cell (patchwork’s plot_spacer()).

pub fn ncol(self, n: usize) -> Self

Number of columns.

pub fn nrow(self, n: usize) -> Self

Number of rows.

pub fn byrow(self, byrow: bool) -> Self

Fill cells row by row (default) or column by column.

pub fn widths(self, widths: &[f64]) -> Self

Relative column widths (recycled; non-positive / non-finite = 1).

pub fn heights(self, heights: &[f64]) -> Self

Relative row heights (recycled; non-positive / non-finite = 1).

pub fn title(self, title: &str) -> Self

Title over the whole grid.

pub fn subtitle(self, subtitle: &str) -> Self

Subtitle over the whole grid.

pub fn caption(self, caption: &str) -> Self

Caption under the whole grid.

pub fn tag_levels(self, levels: TagLevels) -> Self

Tag the panels (labs(tag) of each sub-plot is replaced).

pub fn tag_affixes(self, prefix: &str, suffix: &str) -> Self

Text around each tag, e.g. ("(", ")") for (a).

pub fn collect_legends(self, collect: bool) -> Self

Collect the sub-plots’ legends into one strip (identical legends are drawn once). Sub-plots with an inside or hidden legend keep it.

pub fn legend_position(self, pos: GridLegendPosition) -> Self

Where collected legends go.

pub fn spacing(self, px: f64) -> Self

Gap between cells, in px (default 0).

pub fn theme(self, theme: Theme) -> Self

Theme for the grid’s own title/subtitle/caption and the collected legends’ text.

pub fn len(&self) -> usize

Number of cells (plots, nested grids and spacers).

pub fn is_empty(&self) -> bool

Whether the grid has no cells.

pub fn render_svg_native(self) -> Result<String, GGError>

Render at 800×600.

pub fn render_svg_native_with_size( self, w: u32, h: u32, ) -> Result<String, GGError>

Render the grid to one standalone SVG document of w×h px. The root carries data-grid="<rows> <cols>" (and no data-plot: each sub-<svg> has its own).

pub fn render_svg_native_with_warnings( self, w: u32, h: u32, ) -> Result<(String, Vec<String>), GGError>

Like render_svg_native_with_size, also returning every sub-plot’s warnings, prefixed panel <tag>: .

pub fn render_svg_native_at( self, x: f64, y: f64, w: u32, h: u32, ) -> Result<String, GGError>

Render as a nested <svg> fragment positioned at (x, y) — for composing the grid into a larger SVG (cf. GGPlot::render_svg_native_at).

Trait Implementations

impl BitOr for PlotGrid

a | b: place side by side (patchwork).

type Output = PlotGrid

The resulting type after applying the | operator.

fn bitor(self, rhs: PlotGrid) -> PlotGrid

Performs the | operation.

impl BitOr<GGPlot> for PlotGrid

a | b: place side by side (patchwork).

type Output = PlotGrid

The resulting type after applying the | operator.

fn bitor(self, rhs: GGPlot) -> PlotGrid

Performs the | operation.

impl BitOr<PlotGrid> for GGPlot

a | b: place side by side (patchwork).

type Output = PlotGrid

The resulting type after applying the | operator.

fn bitor(self, rhs: PlotGrid) -> PlotGrid

Performs the | operation.

impl Default for PlotGrid

fn default() -> Self

Returns the “default value” for a type.

impl Div for PlotGrid

a / b: stack vertically (patchwork).

type Output = PlotGrid

The resulting type after applying the / operator.

fn div(self, rhs: PlotGrid) -> PlotGrid

Performs the / operation.

impl Div<GGPlot> for PlotGrid

a / b: stack vertically (patchwork).

type Output = PlotGrid

The resulting type after applying the / operator.

fn div(self, rhs: GGPlot) -> PlotGrid

Performs the / operation.

impl Div<PlotGrid> for GGPlot

a / b: stack vertically (patchwork).

type Output = PlotGrid

The resulting type after applying the / operator.

fn div(self, rhs: PlotGrid) -> PlotGrid

Performs the / operation.

impl From<PlotGrid> for GridCell

fn from(g: PlotGrid) -> Self

Converts to this type from the input type.