Struct Scatter3dPlot 

pub struct Scatter3dPlot { /* private fields */ }

A structure representing a 3D scatter plot.

The Scatter3dPlot struct is designed to create and customize 3D scatter plots with options for data selection, grouping, layout configuration, and aesthetic adjustments. It supports visual differentiation in data groups through varied marker shapes, colors, sizes, opacity levels, and comprehensive layout customization, including titles, axis labels, and legends.

Backend Support

Backend	Supported
Plotly	Yes
Plotters	–

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).
• z - A string slice specifying the column name to be used for the z-axis, adding a third dimension to the scatter plot.
• group - An optional string slice specifying the column name used for grouping data points by category.
• sort_groups_by - Optional comparator fn(&str, &str) -> std::cmp::Ordering to control group ordering. Groups are sorted lexically by default.
• facet - An optional string slice specifying the column name to be used for faceting (creating multiple subplots).
• facet_config - An optional reference to a FacetConfig struct for customizing facet behavior (grid dimensions, scales, gaps, etc.).
• 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 for marker color when group is not specified.
• colors - An optional vector of Rgb values specifying colors for markers when group is specified, enhancing group distinction.
• shape - An optional Shape specifying the shape of markers when group is not specified.
• shapes - An optional vector of Shape values defining multiple marker shapes for different groups.
• plot_title - An optional Text struct specifying the plot title.
• x_title - An optional Text struct for the x-axis title.
• y_title - An optional Text struct for the y-axis title.
• z_title - An optional Text struct for the z-axis title.
• legend_title - An optional Text struct specifying the legend title.
• x_axis - An optional reference to an Axis struct for custom x-axis settings.
• y_axis - An optional reference to an Axis struct for custom y-axis settings.
• z_axis - An optional reference to an Axis struct for custom z-axis settings, adding depth perspective.
• legend - An optional reference to a Legend struct for legend customization, including position and font settings.

Example

use plotlars::{Legend, Plot, Rgb, Scatter3dPlot, Shape};
use polars::prelude::*;

let dataset = LazyCsvReader::new(PlRefPath::new("data/penguins.csv"))
    .finish()
    .unwrap()
    .select([
        col("species"),
        col("sex").alias("gender"),
        col("bill_length_mm").cast(DataType::Float32),
        col("flipper_length_mm").cast(DataType::Int16),
        col("body_mass_g").cast(DataType::Int16),
    ])
    .collect()
    .unwrap();

Scatter3dPlot::builder()
    .data(&dataset)
    .x("body_mass_g")
    .y("flipper_length_mm")
    .z("bill_length_mm")
    .group("species")
    .opacity(0.25)
    .size(8)
    .colors(vec![
        Rgb(178, 34, 34),
        Rgb(65, 105, 225),
        Rgb(255, 140, 0),
    ])
    .shapes(vec![
        Shape::Circle,
        Shape::Square,
        Shape::Diamond,
    ])
    .plot_title("Scatter Plot")
    .legend(
        &Legend::new()
            .x(0.6)
    )
    .build()
    .plot();

Implementations

impl Scatter3dPlot

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

Examples found in repository

examples/plotly_scatter3dplot.rs (line 19)

fn main() {
    let dataset = CsvReader::new("data/penguins.csv")
        .finish()
        .unwrap()
        .lazy()
        .select([
            col("species"),
            col("sex").alias("gender"),
            col("bill_length_mm").cast(DataType::Float32),
            col("flipper_length_mm").cast(DataType::Int16),
            col("body_mass_g").cast(DataType::Int16),
        ])
        .collect()
        .unwrap();

    Scatter3dPlot::builder()
        .data(&dataset)
        .x("body_mass_g")
        .y("flipper_length_mm")
        .z("bill_length_mm")
        .group("species")
        .opacity(0.25)
        .size(8)
        .colors(vec![Rgb(178, 34, 34), Rgb(65, 105, 225), Rgb(255, 140, 0)])
        .shapes(vec![Shape::Circle, Shape::Square, Shape::Diamond])
        .plot_title("Scatter 3D Plot")
        .legend(&Legend::new().x(0.6))
        .build()
        .plot();
}

examples/plotly_faceting.rs (line 490)

fn scatter3d_example() {
    let dataset = CsvReader::new("data/penguins.csv")
        .finish()
        .unwrap()
        .lazy()
        .select([
            col("species"),
            col("sex").alias("gender"),
            col("bill_length_mm").cast(DataType::Float32),
            col("flipper_length_mm").cast(DataType::Int16),
            col("body_mass_g").cast(DataType::Int16),
        ])
        .collect()
        .unwrap();

    let facet_config = FacetConfig::new()
        .cols(3)
        .highlight_facet(true)
        .unhighlighted_color(Rgb(220, 220, 220));

    Scatter3dPlot::builder()
        .data(&dataset)
        .x("body_mass_g")
        .y("flipper_length_mm")
        .z("bill_length_mm")
        .facet("species")
        .facet_config(&facet_config)
        .opacity(0.6)
        .size(6)
        .colors(vec![Rgb(178, 34, 34), Rgb(65, 105, 225), Rgb(255, 140, 0)])
        .plot_title("Penguin Morphological Traits - 3D Faceted Analysis")
        .build()
        .plot();
}

examples/plotly_subplot_grid.rs (line 267)

fn mixed_grid_example() {
    // 2D cartesian scatter (baseline)
    let penguins = CsvReader::new("data/penguins.csv")
        .finish()
        .unwrap()
        .lazy()
        .select([
            col("species"),
            col("bill_length_mm"),
            col("flipper_length_mm"),
            col("body_mass_g"),
        ])
        .collect()
        .unwrap();

    let scatter_2d = ScatterPlot::builder()
        .data(&penguins)
        .x("bill_length_mm")
        .y("flipper_length_mm")
        .group("species")
        .opacity(0.65)
        .size(10)
        .plot_title(Text::from("Penguins 2D").y(1.3))
        .build();

    // 3D scene subplot
    let scatter_3d = Scatter3dPlot::builder()
        .data(&penguins)
        .x("bill_length_mm")
        .y("flipper_length_mm")
        .z("body_mass_g")
        .group("species")
        .opacity(0.35)
        .size(6)
        .plot_title(Text::from("Penguins 3D").y(1.45))
        .build();

    // Polar subplot
    let polar_df = CsvReader::new("data/product_comparison_polar.csv")
        .finish()
        .unwrap();

    let polar = ScatterPolar::builder()
        .data(&polar_df)
        .theta("angle")
        .r("score")
        .group("product")
        .mode(Mode::LinesMarkers)
        .size(10)
        .plot_title(Text::from("Product Comparison (Polar)").y(1.5).x(0.72))
        .legend(&Legend::new().x(0.8))
        .build();

    // Domain-based subplot (Sankey)
    let sankey_df = CsvReader::new("data/energy_transition.csv")
        .finish()
        .unwrap();

    let sankey = SankeyDiagram::builder()
        .data(&sankey_df)
        .sources("source")
        .targets("target")
        .values("value")
        .orientation(Orientation::Horizontal)
        .arrangement(Arrangement::Freeform)
        .plot_title(Text::from("Energy Flow").y(1.2))
        .build();

    // Mapbox subplot
    let map_df = CsvReader::new("data/cities.csv").finish().unwrap();

    let scatter_map = ScatterMap::builder()
        .data(&map_df)
        .latitude("latitude")
        .longitude("longitude")
        .group("city")
        .zoom(4)
        .center([50.0, 5.0])
        .opacity(0.8)
        .plot_title(Text::from("Cities (Mapbox)").y(1.2))
        .build();

    // Geo subplot
    let geo_df = CsvReader::new("data/world_cities.csv").finish().unwrap();

    let scatter_geo = ScatterGeo::builder()
        .data(&geo_df)
        .lat("lat")
        .lon("lon")
        .group("continent")
        .mode(Mode::Markers)
        .size(10)
        .color(Rgb(255, 140, 0))
        .shape(Shape::Circle)
        .plot_title(Text::from("Global Cities (Geo)").x(0.65).y(1.2))
        .legend(&Legend::new().x(0.8))
        .build();

    SubplotGrid::regular()
        .plots(vec![
            &scatter_2d,
            &scatter_3d,
            &polar,
            &sankey,
            &scatter_map,
            &scatter_geo,
        ])
        .rows(2)
        .cols(3)
        .h_gap(0.12)
        .v_gap(0.22)
        .title(
            Text::from("Mixed Subplot Grid")
                .size(16)
                .font("Arial Black")
                .y(0.95),
        )
        .build()
        .plot();
}

impl Scatter3dPlot

pub fn try_new( data: &DataFrame, x: &str, y: &str, z: &str, group: Option<&str>, sort_groups_by: Option<fn(&str, &str) -> Ordering>, facet: Option<&str>, facet_config: Option<&FacetConfig>, opacity: Option<f64>, size: Option<usize>, color: Option<Rgb>, colors: Option<Vec<Rgb>>, shape: Option<Shape>, shapes: Option<Vec<Shape>>, plot_title: Option<Text>, legend: Option<&Legend>, ) -> Result<Scatter3dPlot, PlotlarsError>

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

Trait Implementations

impl Clone for Scatter3dPlot

fn clone(&self) -> Scatter3dPlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Plot for Scatter3dPlot

fn ir_traces(&self) -> &[TraceIR]

fn ir_layout(&self) -> &LayoutIR