Struct BarPlot

pub struct BarPlot { /* private fields */ }

A structure representing a bar plot.

The BarPlot struct allows for the creation and customization of bar plots with various options for data, layout, and aesthetics. It supports both vertical and horizontal orientations, grouping of data, error bars, and customizable markers and colors.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• labels - A string slice specifying the column name to be used for the x-axis (independent variable).
• values - A string slice specifying the column name to be used for the y-axis (dependent variable).
• orientation - An optional Orientation enum specifying whether the plot should be horizontal or vertical.
• group - An optional string slice specifying the column name to be used for grouping data points.
• error - An optional string slice specifying the column name containing error values for the y-axis data.
• color - An optional Rgb value specifying the color of the markers to be used for the plot. This is used when group is not specified.
• colors - An optional vector of Rgb values specifying the colors to be used for the plot. This is used when group is specified to differentiate between groups.
• plot_title - An optional Text struct specifying the title of the plot.
• x_title - An optional Text struct specifying the title of the x-axis.
• y_title - An optional Text struct specifying the title of the y-axis.
• legend_title - An optional Text struct specifying the title of the legend.
• x_axis - An optional reference to an Axis struct for customizing the x-axis.
• y_axis - An optional reference to an Axis struct for customizing the y-axis.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Example

use plotlars::{BarPlot, Legend, Orientation, Plot, Rgb, Text};

let dataset = df![
        "animal" => &["giraffe", "giraffe", "orangutan", "orangutan", "monkey", "monkey"],
        "gender" => &vec!["female", "male", "female", "male", "female", "male"],
        "value" => &vec![20.0f32, 25.0, 14.0, 18.0, 23.0, 31.0],
        "error" => &vec![1.0, 0.5, 1.5, 1.0, 0.5, 1.5],
    ]
    .unwrap();

BarPlot::builder()
    .data(&dataset)
    .labels("animal")
    .values("value")
    .orientation(Orientation::Vertical)
    .group("gender")
    .error("error")
    .colors(vec![
        Rgb(255, 127, 80),
        Rgb(64, 224, 208),
    ])
    .plot_title(
        Text::from("Bar Plot")
            .font("Arial")
            .size(18)
    )
    .x_title(
        Text::from("animal")
            .font("Arial")
            .size(15)
    )
    .y_title(
        Text::from("value")
            .font("Arial")
            .size(15)
    )
    .legend_title(
        Text::from("gender")
            .font("Arial")
            .size(15)
    )
    .legend(
        &Legend::new()
            .orientation(Orientation::Horizontal)
            .y(1.0)
            .x(0.4)
    )
    .build()
    .plot();

Implementations

impl BarPlot

pub fn builder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7, 'f8>() -> BarPlotBuilder<'f1, 'f2, 'f3, 'f4, 'f5, 'f6, 'f7, 'f8>

Trait Implementations

impl Clone for BarPlot

fn clone(&self) -> BarPlot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Serialize for BarPlot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.