Struct Axis

pub struct Axis { /* private fields */ }

A structure representing a customizable axis.

Example

use plotlars::{Axis, Plot, Rgb, ScatterPlot, Text, TickDirection};

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 axis = Axis::new()
    .show_line(true)
    .tick_direction(TickDirection::OutSide)
    .value_thousands(true)
    .show_grid(false);

ScatterPlot::builder()
    .data(&dataset)
    .x("body_mass_g")
    .y("flipper_length_mm")
    .group("species")
    .colors(vec![
        Rgb(255, 0, 0),
        Rgb(0, 255, 0),
        Rgb(0, 0, 255),
    ])
    .opacity(0.5)
    .size(20)
    .plot_title(
        Text::from("Scatter Plot")
            .font("Arial")
            .size(20)
            .x(0.045)
    )
    .x_title("body mass (g)")
    .y_title("flipper length (mm)")
    .legend_title("species")
    .x_axis(&axis)
    .y_axis(&axis)
    .build()
    .plot();

Implementations

impl Axis

pub fn new() -> Self

Creates a new Axis instance with default values.

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

Sets the visibility of the axis.

Argument

• bool - A boolean value indicating whether the axis should be visible.

pub fn axis_side(self, side: AxisSide) -> Self

Sets the side of the axis.

Argument

• side - An AxisSide enum value representing the side of the axis.

pub fn axis_position(self, position: f64) -> Self

Sets the position of the axis.

Argument

• position - A f64 value representing the position of the axis.

pub fn axis_type(self, axis_type: AxisType) -> Self

Sets the type of the axis.

Argument

• axis_type - An AxisType enum value representing the type of the axis.

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

Sets the color of the axis values.

Argument

• color - An Rgb struct representing the color of the axis values.

pub fn value_range(self, range: Vec<f64>) -> Self

Sets the range of values displayed on the axis.

Argument

• range - A vector of f64 values representing the range of the axis.

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

Sets whether to use thousands separators for values.

Argument

• bool - A boolean value indicating whether to use thousands separators.

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 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_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_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 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_width(self, width: usize) -> Self

Sets the width of the axis ticks.

Argument

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

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

Sets the color of the axis ticks.

Argument

• color - An Rgb struct representing the color of the ticks.

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

Sets the angle of the axis ticks.

Argument

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

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

Sets the font of the axis tick labels.

Argument

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

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

Sets whether to show the axis line.

Argument

• bool - A boolean value indicating whether the axis line should be visible.

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

Sets the color of the axis line.

Argument

• color - An Rgb struct representing the color of the axis line.

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

Sets the width of the axis line.

Argument

• width - A usize value representing the width of the axis line.

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

Sets whether to show the grid lines on the axis.

Argument

• bool - A boolean value indicating whether the grid lines should be visible.

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

Sets the color of the grid lines on the axis.

Argument

• color - An Rgb struct representing the color of the grid lines.

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

Sets the width of the grid lines on the axis.

Argument

• width - A usize value representing the width of the grid lines.

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

Sets whether to show the zero line on the axis.

Argument

• bool - A boolean value indicating whether the zero line should be visible.

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

Sets the color of the zero line on the axis.

Argument

• color - An Rgb struct representing the color of the zero line.

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

Sets the width of the zero line on the axis.

Argument

• width - A usize value representing the width of the zero line.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Axis

fn default() -> Axis

Returns the “default value” for a type.