Struct GuideColourbar 

pub struct GuideColourbar {
    pub bar_width: Option<f64>,
    pub bar_height: Option<f64>,
    pub nbin: usize,
    pub display: ColourbarDisplay,
    pub frame: Option<bool>,
    pub ticks: bool,
    pub steps: bool,
    pub even_steps: bool,
    pub show_limits: bool,
}

Options of a continuous colour / fill legend — ggplot2’s guide_colourbar(), or guide_coloursteps() when steps is set (#409). Apply with GGPlot::guide_colourbar.

Fields

bar_width: Option<f64>

The bar’s horizontal extent in px (barwidth); None = the theme’s key size (long side 8 keys).

bar_height: Option<f64>

The bar’s vertical extent in px (barheight).

nbin: usize

Colour samples along the bar (nbin).

display: ColourbarDisplay

Gradient or separate rectangles (display).

frame: Option<bool>

Draw the outline round the bar (frame); None = the theme’s legend.frame (legend_bar_border).

ticks: bool

Draw tick marks at the breaks (ticks).

steps: bool

guide_coloursteps(): one solid block per interval between breaks.

even_steps: bool

Coloursteps: every block the same length (even.steps, default true), instead of proportional to its value range.

show_limits: bool

Coloursteps: label the two outer limits too (show.limits).

Implementations

impl GuideColourbar

pub fn new() -> Self

guide_colourbar() with its defaults.

pub fn steps() -> Self

guide_coloursteps(): stepped blocks, even steps, no ticks.

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

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

pub fn with_nbin(self, nbin: usize) -> Self

pub fn with_display(self, display: ColourbarDisplay) -> Self

pub fn with_frame(self, frame: bool) -> Self

pub fn with_ticks(self, ticks: bool) -> Self

pub fn with_even_steps(self, even: bool) -> Self

pub fn with_show_limits(self, show: bool) -> Self

Trait Implementations

impl Clone for GuideColourbar

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 GuideColourbar

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

Formats the value using the given formatter.

impl Default for GuideColourbar

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for GuideColourbar

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for GuideColourbar