Struct SankeyPlot 

pub struct SankeyPlot {

    pub nodes: Vec<SankeyNode>,
    pub links: Vec<SankeyLink>,
    pub alluvia: Vec<SankeyAlluvium>,
    pub axis_names: Option<Vec<String>>,
    pub link_color: SankeyLinkColor,
    pub node_order: SankeyNodeOrder,
    pub node_coloring: SankeyNodeColoring,
    pub node_order_seed: u64,
    pub palette: Option<Vec<String>>,
    pub left_color_cutoff: f64,
    pub link_opacity: f64,
    pub node_width: f64,
    pub node_gap: f64,
    pub legend_label: Option<String>,
    pub flow_labels: bool,
    pub flow_percent: bool,
    pub flow_label_format: TickFormat,
    pub flow_label_unit: Option<String>,
    pub flow_label_min_height: f64,
}

A Sankey diagram: nodes arranged in columns, connected by tapered ribbons.

Fields

nodes: Vec<SankeyNode>

links: Vec<SankeyLink>

alluvia: Vec<SankeyAlluvium>

axis_names: Option<Vec<String>>

link_color: SankeyLinkColor

node_order: SankeyNodeOrder

node_coloring: SankeyNodeColoring

node_order_seed: u64

palette: Option<Vec<String>>

left_color_cutoff: f64

link_opacity: f64

Ribbon fill opacity (default 0.5).

node_width: f64

Node rectangle width in pixels (default 20.0).

node_gap: f64

Minimum gap between nodes in a column in pixels (default 8.0).

legend_label: Option<String>

If set, adds one legend entry per node.

flow_labels: bool

Show the absolute flow value on each ribbon (default false).

flow_percent: bool

Show each flow as a percentage of its source node’s total outflow (default false). Takes priority over flow_labels when both are set.

flow_label_format: TickFormat

Number format for absolute flow labels (default Auto).

flow_label_unit: Option<String>

Optional unit suffix appended to absolute labels, e.g. "reads" → "1 200 reads".

flow_label_min_height: f64

Minimum ribbon height in pixels required to render a label. Set to 0.0 to always show labels regardless of ribbon size (default 8.0).

Implementations

impl SankeyPlot

pub fn new() -> Self

pub fn with_node<S: Into<String>>(self, label: S) -> Self

Declare a node explicitly (no-op if it already exists).

pub fn with_node_color<S: Into<String>, C: Into<String>>( self, label: S, color: C, ) -> Self

Set the color for a node, creating it if absent.

pub fn with_node_column<S: Into<String>>(self, label: S, col: usize) -> Self

Pin a node to a specific column, creating it if absent.

pub fn with_link<S: Into<String>>( self, source: S, target: S, value: impl Into<f64>, ) -> Self

Add a link, auto-creating nodes by label if needed.

pub fn with_link_colored<S: Into<String>, C: Into<String>>( self, source: S, target: S, value: impl Into<f64>, color: C, ) -> Self

Add a link with an explicit per-link color.

pub fn with_links<S, V, I>(self, links: I) -> Self

where S: Into<String>, V: Into<f64>, I: IntoIterator<Item = (S, S, V)>,

Bulk add links from an iterator of (source_label, target_label, value).

pub fn with_axis_names<S, I>(self, axis_names: I) -> Self

where S: Into<String>, I: IntoIterator<Item = S>,

Set display/canonical names for alluvium axes in input order.

pub fn with_alluvium<S, I>(self, strata: I, value: impl Into<f64>) -> Self

where S: Into<String>, I: IntoIterator<Item = S>,

Add a weighted alluvium spanning multiple ordered axes.

pub fn with_alluvia<S, I, J>(self, alluvia: J) -> Self

where S: Into<String>, I: IntoIterator<Item = S>, J: IntoIterator<Item = (I, f64)>,

Bulk add weighted alluvia from an iterator of (strata, value).

pub fn with_gradient_links(self) -> Self

Use gradient ribbons (linearGradient from source to target color).

pub fn with_per_link_colors(self) -> Self

Use per-link colors (falls back to source color if link.color is None).

pub fn with_node_order(self, order: SankeyNodeOrder) -> Self

Choose how nodes are ordered within each column.

pub fn with_node_coloring(self, coloring: SankeyNodeColoring) -> Self

Choose how node colors are assigned when explicit node colors are absent.

pub fn with_node_order_seed(self, seed: u64) -> Self

Set the RNG seed used by crossing-reduction ordering.

pub fn with_crossing_reduction(self) -> Self

Minimize weighted crossings within columns using a wompwomp-style TSP cycle with Fenwick-scored objective evaluation.

pub fn with_neighbornet(self) -> Self

Use the neighbornet backend for alluvium/Sankey ordering.

pub fn with_left_coloring(self) -> Self

Match wompwomp’s left-to-right color propagation.

pub fn with_palette(self, colors: Vec<String>) -> Self

Override the palette used for fallback Sankey node colors.

pub fn with_left_color_cutoff(self, cutoff: f64) -> Self

Set the parent-share threshold used by left coloring. Default: 0.5.

pub fn with_link_opacity(self, opacity: f64) -> Self

pub fn with_node_width(self, width: f64) -> Self

pub fn with_node_gap(self, gap: f64) -> Self

pub fn with_legend<S: Into<String>>(self, label: S) -> Self

pub fn with_flow_labels(self) -> Self

Show the absolute flow value on each ribbon. Combine with with_flow_label_format and with_flow_label_unit as needed.

pub fn with_flow_percent(self) -> Self

Show each flow as a percentage of its source node’s total outflow. Takes priority over with_flow_labels when both are set.

pub fn with_flow_label_format(self, fmt: TickFormat) -> Self

Number format for absolute flow labels (default: TickFormat::Auto). Has no effect when with_flow_percent is active.

pub fn with_flow_label_unit<S: Into<String>>(self, unit: S) -> Self

Append a unit string to each absolute flow label, e.g. "reads" → "1200 reads". Has no effect in percent mode.

pub fn with_flow_label_min_height(self, min_h: f64) -> Self

Minimum ribbon height in pixels required to render a flow label. Set to 0.0 to always show labels regardless of ribbon size (default: 8.0).

Trait Implementations

impl Clone for SankeyPlot

fn clone(&self) -> SankeyPlot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SankeyPlot

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SankeyPlot

fn default() -> Self

Returns the “default value” for a type.

impl From<SankeyPlot> for Plot

fn from(p: SankeyPlot) -> Self

Converts to this type from the input type.