Struct Legend

pub struct Legend { /* private fields */ }

A structure representing a customizable plot legend.

Example

use plotlars::{Histogram, Legend, Orientation, Plot, Rgb};

let dataset = LazyCsvReader::new("data/penguins.csv")
    .finish()
    .unwrap()
    .select([
        col("species"),
        col("sex").alias("gender"),
        col("flipper_length_mm").cast(DataType::Int16),
        col("body_mass_g").cast(DataType::Int16),
    ])
    .collect()
    .unwrap();

let legend = Legend::new()
    .orientation(Orientation::Horizontal)
    .border_width(1)
    .x(0.78)
    .y(0.825);

Histogram::builder()
    .data(&dataset)
    .x("body_mass_g")
    .group("species")
    .colors(vec![
        Rgb(255, 0, 0),
        Rgb(0, 255, 0),
        Rgb(0, 0, 255),
    ])
    .opacity(0.5)
    .x_title("Body Mass (g)")
    .y_title("Frequency")
    .legend_title("Species")
    .legend(&legend)
    .build()
    .plot();

Implementations

impl Legend

pub fn new() -> Self

Creates a new Legend instance with default values.

pub fn background_color(self, color: Rgb) -> Self

Sets the background color of the legend.

Argument

• color - An Rgb struct representing the background color.

pub fn border_color(self, color: Rgb) -> Self

Sets the border color of the legend.

Argument

• color - An Rgb struct representing the border color.

pub fn border_width(self, width: usize) -> Self

Sets the border width of the legend.

Argument

• width - A usize value representing the width of the border.

pub fn font(self, font: impl Into<String>) -> Self

Sets the font of the legend labels.

Argument

• font - A value that can be converted into a String, representing the font name for the labels.

pub fn orientation(self, orientation: Orientation) -> Self

Sets the orientation of the legend.

Argument

• orientation - An Orientation enum value representing the layout direction of the legend.

pub fn x(self, x: f64) -> Self

Sets the horizontal position of the legend.

Argument

• x - A f64 value representing the horizontal position of the legend.

pub fn y(self, y: f64) -> Self

Sets the vertical position of the legend.

Argument

• y - A f64 value representing the vertical position of the legend.

Trait Implementations

impl Clone for Legend

fn clone(&self) -> Legend

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Legend

fn default() -> Legend

Returns the “default value” for a type.