Struct ScatterPlot 

pub struct ScatterPlot { /* private fields */ }

A structure representing a scatter plot.

The ScatterPlot struct facilitates the creation and customization of scatter plots with various options for data selection, grouping, layout configuration, and aesthetic adjustments. It supports grouping of data, customization of marker shapes, colors, sizes, opacity settings, and comprehensive layout customization including titles, axes, and legends.

Arguments

• data - A reference to the DataFrame containing the data to be plotted.
• x - A string slice specifying the column name to be used for the x-axis (independent variable).
• y - A string slice specifying the column name to be used for the y-axis (dependent variable).
• group - An optional string slice specifying the column name to be used for grouping data points.
• opacity - An optional f64 value specifying the opacity of the plot markers (range: 0.0 to 1.0).
• size - An optional usize specifying the size of the markers.
• color - An optional Rgb value specifying the color of the markers. This is used when group is not specified.
• colors - An optional vector of Rgb values specifying the colors for the markers. This is used when group is specified to differentiate between groups.
• shape - An optional Shape specifying the shape of the markers. This is used when group is not specified.
• shapes - An optional vector of Shape values specifying multiple shapes for the markers when plotting multiple 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 polars::prelude::*;
use plotlars::{Axis, Legend, Plot, Rgb, ScatterPlot, Shape, Text, TickDirection};

let dataset = LazyCsvReader::new(PlPath::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);

ScatterPlot::builder()
    .data(&dataset)
    .x("body_mass_g")
    .y("flipper_length_mm")
    .group("species")
    .opacity(0.5)
    .size(12)
    .colors(vec![
        Rgb(178, 34, 34),
        Rgb(65, 105, 225),
        Rgb(255, 140, 0),
    ])
    .shapes(vec![
        Shape::Circle,
        Shape::Square,
        Shape::Diamond,
    ])
    .plot_title(
        Text::from("Scatter Plot")
            .font("Arial")
            .size(20)
            .x(0.065)
    )
    .x_title("body mass (g)")
    .y_title("flipper length (mm)")
    .legend_title("species")
    .x_axis(
        &axis.clone()
            .value_range(vec![2500.0, 6500.0])
    )
    .y_axis(
        &axis.clone()
            .value_range(vec![170.0, 240.0])
    )
    .legend(
        &Legend::new()
            .x(0.85)
            .y(0.15)
    )
    .build()
    .plot();

Implementations

impl ScatterPlot

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

Examples found in repository

examples/scatterplot.rs (line 23)

fn main() {
    let dataset = LazyCsvReader::new(PlPath::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);

    ScatterPlot::builder()
        .data(&dataset)
        .x("body_mass_g")
        .y("flipper_length_mm")
        .group("species")
        .opacity(0.5)
        .size(12)
        .colors(vec![Rgb(178, 34, 34), Rgb(65, 105, 225), Rgb(255, 140, 0)])
        .shapes(vec![Shape::Circle, Shape::Square, Shape::Diamond])
        .plot_title(Text::from("Scatter Plot").font("Arial").size(20).x(0.065))
        .x_title("body mass (g)")
        .y_title("flipper length (mm)")
        .legend_title("species")
        .x_axis(&axis.clone().value_range(vec![2500.0, 6500.0]))
        .y_axis(&axis.clone().value_range(vec![170.0, 240.0]))
        .legend(&Legend::new().x(0.85).y(0.15))
        .build()
        .plot();
}

Trait Implementations

impl Clone for ScatterPlot

fn clone(&self) -> ScatterPlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for ScatterPlot

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

where __S: Serializer,

Serialize this value into the given Serde serializer.