Struct SankeyDiagram

pub struct SankeyDiagram { /* private fields */ }

A structure representing a Sankey diagram.

The SankeyDiagram struct enables the creation of Sankey diagrams, which visualize flows between discrete nodes with link widths proportional to the magnitude of the flow. It offers extensive configuration options for flow orientation, node arrangement, spacing, thickness, and coloring, as well as axis and title customization. Users can specify a single uniform color or per-item colors for both nodes and links, adjust padding between nodes, set node thickness, and supply custom titles and axis labels to produce clear, publication-quality flow visualizations.

Arguments

• data – A reference to the DataFrame containing the data to be plotted.
• sources – A string slice naming the column in data that contains the source node for each flow.
• targets – A string slice naming the column in data that contains the target node for each flow.
• values – A string slice naming the column in data that contains the numeric value of each flow.
• orientation – An optional Orientation enum to set the overall direction of the diagram (e.g. Orientation::Horizontal or Orientation::Vertical).
• arrangement – An optional Arrangement enum to choose the node-layout algorithm (e.g. Arrangement::Snap, Arrangement::Perpendicular, etc.).
• pad – An optional usize specifying the padding (in pixels) between adjacent nodes.
• thickness – An optional usize defining the uniform thickness (in pixels) of all nodes.
• node_color – An optional Rgb value to apply a single uniform color to every node.
• node_colors – An optional Vec<Rgb> supplying individual colors for each node in order.
• link_color – An optional Rgb value to apply a single uniform color to every link.
• link_colors – An optional Vec<Rgb> supplying individual colors for each link in order.
• plot_title – An optional Text struct for setting the overall title of the plot.

Example

use polars::prelude::*;
use plotlars::{Arrangement, SankeyDiagram, Orientation, Plot, Rgb, Text};

let dataset = df![
        "source" => ["A1", "A2", "A1", "B1", "B2", "B2"],
        "target" => &["B1", "B2", "B2", "C1", "C1", "C2"],
        "value" => &[8, 4, 2, 8, 4, 2],
    ]
    .unwrap();

SankeyDiagram::builder()
    .data(&dataset)
    .sources("source")
    .targets("target")
    .values("value")
    .orientation(Orientation::Horizontal)
    .arrangement(Arrangement::Freeform)
    .node_colors(vec![
        Rgb(222, 235, 247),
        Rgb(198, 219, 239),
        Rgb(158, 202, 225),
        Rgb(107, 174, 214),
        Rgb( 66, 146, 198),
        Rgb( 33, 113, 181),
    ])
    .link_colors(vec![
        Rgb(222, 235, 247),
        Rgb(198, 219, 239),
        Rgb(158, 202, 225),
        Rgb(107, 174, 214),
        Rgb( 66, 146, 198),
        Rgb( 33, 113, 181),
    ])
    .pad(20)
    .thickness(30)
    .plot_title(
        Text::from("Sankey Diagram")
            .font("Arial")
            .size(18)
    )
    .build()
    .plot();

Implementations

impl SankeyDiagram

pub fn builder<'f1, 'f2, 'f3, 'f4>() -> SankeyDiagramBuilder<'f1, 'f2, 'f3, 'f4>

Trait Implementations

impl Clone for SankeyDiagram

fn clone(&self) -> SankeyDiagram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Serialize for SankeyDiagram

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

where __S: Serializer,

Serialize this value into the given Serde serializer.