Struct ColorBar

pub struct ColorBar { /* private fields */ }

A structure representing a color bar component for visualizations.

Example

use plotlars::{ColorBar, HeatMap, Orientation, Palette, Plot, Text, ValueExponent};

let dataset = LazyCsvReader::new("data/heatmap.csv")
    .finish()
    .unwrap()
    .collect()
    .unwrap();

HeatMap::builder()
    .data(&dataset)
    .x("x")
    .y("y")
    .z("z")
    .color_bar(
        &ColorBar::new()
            .orientation(Orientation::Horizontal)
            .length(290)
            .value_exponent(ValueExponent::None)
            .separate_thousands(true)
            .tick_length(5)
            .tick_step(2500.0)
            .tick_angle(90.0)
            .y(-0.6)
    )
    .color_scale(Palette::Viridis)
    .build()
    .plot();

Implementations

impl ColorBar

pub fn new() -> Self

Creates a new ColorBar instance with default settings.

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

Sets the background color of the color bar.

Arguments

• color - An Rgb value representing the desired background color.

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

Sets the border color of the color bar.

Arguments

• color - An Rgb value representing the desired border color.

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

Sets the width of the color bar’s border.

Arguments

• width - A usize value specifying the border width in pixels.

pub fn tick_step(self, step: f64) -> Self

Sets the step size between ticks on the color bar.

Arguments

• step - A f64 value representing the step size between ticks.

pub fn value_exponent(self, exponent: ValueExponent) -> Self

Sets the exponent format for values on the axis.

Argument

• exponent - A ValueExponent enum value representing the exponent format.

pub fn length(self, length: usize) -> Self

Sets the length of the color bar.

Arguments

• length - A usize value specifying the length in pixels.

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

Sets the number of ticks on the color bar.

Arguments

• n - A usize value representing the number of ticks.

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

Sets the orientation of the color bar.

Arguments

• orientation - An Orientation enum value specifying the orientation (e.g., horizontal or vertical).

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

Sets the outline color of the color bar.

Arguments

• color - An Rgb value representing the desired outline color.

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

Sets the outline width of the color bar.

Arguments

• width - A usize value specifying the outline width in pixels.

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

Specifies whether to separate thousands in tick labels.

Arguments

• separate_thousands - A bool indicating whether to separate thousands.

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

Sets the width of the color bar.

Arguments

• width - A usize value specifying the width in pixels.

pub fn tick_angle(self, angle: f64) -> Self

Sets the angle of the tick labels on the color bar.

Arguments

• angle - A f64 value representing the angle in degrees.

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

Sets the color of the ticks on the color bar.

Arguments

• color - An Rgb value representing the tick color.

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

Sets the font of the tick labels on the color bar.

Arguments

• font - A string representing the font family.

pub fn tick_length(self, length: usize) -> Self

Sets the length of the axis ticks.

Argument

• length - A usize value representing the length of the ticks.

pub fn tick_labels(self, labels: Vec<impl Into<String>>) -> Self

Sets the tick labels for the axis.

Argument

• labels - A vector of values that can be converted into String, representing the tick labels.

pub fn tick_values(self, values: Vec<f64>) -> Self

Sets the tick values for the axis.

Argument

• values - A vector of f64 values representing the tick values.

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

Sets the width of the ticks on the color bar.

Arguments

• width - A usize value specifying the tick width in pixels.

pub fn tick_direction(self, direction: TickDirection) -> Self

Sets the direction of the axis ticks.

Argument

• direction - A TickDirection enum value representing the direction of the ticks.

pub fn title<T: Into<Text>>(self, title: T) -> Self

Sets the title of the color bar.

Arguments

• title - A value that can be converted into Text, representing the title.

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

Sets the x-coordinate position of the text.

Argument

• x - A f64 value specifying the horizontal position.

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

Sets the y-coordinate position of the text.

Argument

• y - A f64 value specifying the vertical position.

Trait Implementations

impl Clone for ColorBar

fn clone(&self) -> ColorBar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for ColorBar

fn default() -> ColorBar

Returns the “default value” for a type.