Struct GuideLegend 

pub struct GuideLegend {
    pub title: Option<String>,
    pub ncol: Option<usize>,
    pub nrow: Option<usize>,
    pub reverse: bool,
    pub byrow: bool,
    pub max_rows: Option<usize>,
}

Configuration for legend guides. Analogous to R’s guide_legend() and guides().

Fields

title: Option<String>

Override the legend title. None = use scale name.

ncol: Option<usize>

Number of columns in the legend layout.

nrow: Option<usize>

Number of rows in the legend layout.

reverse: bool

Reverse the order of legend keys.

byrow: bool

Fill an explicit nrow/ncol grid row-major instead of ggplot2’s default column-major (B3-2; R’s guide_legend(byrow = TRUE)).

max_rows: Option<usize>

Cap on the number of rows an auto-wrapped horizontal legend may grow to (B3-2); entries beyond the cap collapse into a trailing “+N more” label. None (the default) uses 1 + floor(total_height / 3 / key_height). Some(0) is invalid (see validated, internal) and is treated as Some(1).

Implementations

impl GuideLegend

pub fn new() -> Self

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

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

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

pub fn reverse(self) -> Self

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

Fill an explicit grid row-major (left-to-right, top-to-bottom) instead of ggplot2’s default column-major.

pub fn with_max_rows(self, max_rows: usize) -> Self

Cap the number of rows an auto-wrapped horizontal legend may grow to.

Trait Implementations

impl Clone for GuideLegend

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GuideLegend

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

Formats the value using the given formatter.

impl Default for GuideLegend

fn default() -> Self

Returns the “default value” for a type.