Struct BoxPlot

pub struct BoxPlot { /* private fields */ }

A structure representing a box plot.

Implementations

impl BoxPlot

pub fn builder<'__f0, '__f1, '__f2, '__f3>() -> BoxPlotBuilder<'__f0, '__f1, '__f2, '__f3>

Creates a new BoxPlot.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• values - A string specifying the column name to be used for the y-axis (the dependent variable).
• labels - A string specifying the column name to be used for the x-axis (the independent variable).
• orientation - An optional Orientation enum specifying whether the plot should be horizontal or vertical.
• group - An optional string specifying the column name to be used for grouping data points.
• box_points - An optional boolean indicating whether individual data points should be plotted along with the box plot.
• point_offset - An optional f64 value specifying the horizontal offset for individual data points when box_points is enabled.
• jitter - An optional f64 value indicating the amount of jitter (random noise) to apply to individual data points for visibility.
• opacity - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
• color - An optional Rgb value specifying the color of the markers to be used for the plot.
• colors - An optional vector of Rgb values specifying the colors to be used for the plot.
• 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.
• 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_title - An optional Text struct specifying the title of the legend.
• legend - An optional reference to a Legend struct for customizing the legend of the plot (e.g., positioning, font, etc.).

Returns

Returns an instance of BoxPlot.

Example

let axis_format = Axis::new()
    .value_thousands(true);

let legend_format = Legend::new()
    .border_width(1)
    .x(0.9);

BoxPlot::builder()
    .data(&scatterplot_dataset)
    .labels("species")
    .values("body_mass_g")
    .orientation(Orientation::Vertical)
    .group("gender")
    .box_points(true)
    .point_offset(-1.5)
    .jitter(0.01)
    .opacity(0.1)
    .colors(vec![
        Rgb(0, 191, 255),
        Rgb(57, 255, 20),
        Rgb(255, 105, 180),
    ])
    .plot_title(
        Text::from("Box Plot")
            .font("Arial")
            .size(18)
    )
    .x_title(
        Text::from("species")
            .font("Arial")
            .size(15)
    )
    .y_title(
        Text::from("body mass (g)")
            .font("Arial")
            .size(15)
    )
    .y_axis(&axis_format)
    .legend_title(
        Text::from("gender")
            .font("Arial")
            .size(15)
    )
    .legend(&legend_format)
    .build()
    .plot();

Trait Implementations

impl Plot for BoxPlot

fn get_layout(&self) -> &Layout

fn get_traces(&self) -> &Vec<Box<dyn TracePlotly + 'static>>

fn plot(self)

where Self: Sized,

fn write_html(self, path: impl Into<String>)

where Self: Sized,