Struct SankeyChart 

pub struct SankeyChart<T: 'static> { /* private fields */ }

A Sankey diagram, layout modeled after d3-sankey.

Links reference nodes by their index in the node list; map string ids to indices before constructing.

Implementations

impl<T> SankeyChart<T>

pub fn new<I, L>(nodes: I, links: L) -> Self

where I: IntoIterator<Item = T>, L: IntoIterator<Item = SankeyLink>,

Create a chart from nodes and links; links reference nodes by their index in nodes (map string ids to indices before constructing).

pub fn id(self, id: impl Into<ElementId>) -> Self

Name this chart’s ElementId, replacing the default taken from the construction site.

Pass one where a single construction site renders several of these charts as siblings: they share the default id, and with it one hover state and one path cache. The id must be unique among those siblings.

pub fn interactive(self, interactive: bool) -> Self

Turn this chart’s interactive layer on or off. On by default.

The layer is the hitbox under the cursor and what it drives: the hovered node’s links stand out from the rest, and a tooltip shows its label and throughput. Turn it off for a chart that only decorates, or one an element above it wants the cursor for: without a hitbox it neither answers the mouse nor takes the hover from what sits over it.

pub fn appear(self, appear: bool) -> Self

Draw the data in the first time this chart is painted. On by default.

The theme sets how long it takes, and the system’s reduced-motion setting skips it. Turn it off for a chart that is painted again and again as it scrolls in and out of view, such as one in each row of a long list, where it would draw in every time.

pub fn appear_key(self, key: impl Hash) -> Self

Draw the data in again whenever key changes, such as the symbol or period a chart shows.

Without one the data draws in once, and later data paints in place.

pub fn node_width(self, node_width: f32) -> Self

Set the node rectangle width. Defaults to 10.

pub fn node_padding(self, node_padding: f32) -> Self

Set the vertical gap between nodes in a column. Defaults to 16.

pub fn node_align(self, align: SankeyAlign) -> Self

Set the node alignment. Defaults to SankeyAlign::Justify.

pub fn iterations(self, iterations: usize) -> Self

Set the number of relaxation passes. Defaults to 6.

pub fn value_scale(self, value_scale: SankeyValueScale) -> Self

Set how flow values map to node heights.

Defaults to SankeyValueScale::Linear. Use SankeyValueScale::Sqrt to keep a dominant flow from dwarfing the small ones without pre-transforming the data; labels still receive the raw values.

pub fn node_corner_radius(self, radius: impl Into<Pixels>) -> Self

Set the corner radius of the node rectangles. Defaults to 0.

pub fn node_color<H>(self, color: impl Fn(&T) -> H + 'static) -> Self

where H: Into<Hsla> + 'static,

Set the color of each node.

Defaults to cycling the theme chart palette by node index.

pub fn node_label(self, label: impl Fn(&T) -> SharedString + 'static) -> Self

Set the name label of each node, drawn in muted foreground. No name label is drawn unless set.

pub fn value_label( self, label: impl Fn(&T, f64) -> SharedString + 'static, ) -> Self

Set the value label of each node, drawn above the name label. No value label is drawn unless set.

The closure receives the datum and the node’s raw computed throughput (max of incoming and outgoing flow, in unscaled units).

pub fn labels( self, labels: impl Fn(&T, f64) -> Vec<SankeyLabel> + 'static, ) -> Self

Set fully custom node labels, one SankeyLabel per line, top to bottom. Takes precedence over node_label/value_label when set; unset by default.

The closure receives the datum and the node’s raw computed throughput (max of incoming and outgoing flow, in unscaled units).

pub fn tooltip_name(self, name: impl Fn(&T) -> SharedString + 'static) -> Self

Name the node under the cursor in the hover tooltip’s row, beside its throughput. Unset, the row carries no name at all.

A sankey shows one number per node, so the node’s own name is what the row wants; without it the row reads as a swatch and a number with a gap between them. The alternative was to title the tooltip from node_label, but that also draws the name beside the node — and a chart drawing its text through labels sets neither.

pub fn tooltip_value( self, value: impl Fn(&T, f64) -> SharedString + 'static, ) -> Self

Set the text of the hover tooltip’s row, the node’s throughput.

value_label supplies it when this is unset, and the raw number when neither is set — which is what a chart drawing its text through labels gets, however carefully it formats the value it draws.

pub fn link_opacity(self, opacity: f32) -> Self

Set the opacity of the link ribbons. Defaults to 0.3.

pub fn min_link_width(self, width: f32) -> Self

Set the minimum ribbon thickness, so tiny flows stay visible. Defaults to 1.

pub fn label_gap(self, gap: f32) -> Self

Set the gap between a node and its labels. Defaults to 6.

Trait Implementations

impl<T: 'static> IntoElement for SankeyChart<T>

type Element = PlotElement<SankeyChart<T>>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl<T> Plot for SankeyChart<T>

fn prepaint( &mut self, bounds: Bounds<Pixels>, window: &mut Window, cx: &mut App, ) -> Vec<AnyElement>

Resolve the placement for the frame, reusing the last one while nothing that shapes it has changed. Measuring the labels needs the window, which tooltip_state does not have, so this runs here rather than in paint.

fn paint(&mut self, bounds: Bounds<Pixels>, window: &mut Window, cx: &mut App)

fn id(&self) -> Option<ElementId>

A stable element id that keeps this plot’s state across frames.

fn interactive(&self) -> bool

Whether a plot with an Plot::id tracks hover and shows its tooltip.

fn appear(&mut self, appear: PlotAppear, _window: &mut Window, _cx: &mut App)

Receive how far the plot’s data marks have appeared this frame, before Plot::hover and Plot::paint run.

fn appear_generation(&self) -> Option<u64>

Opt in to appear motion: Some draws the plot in the first time its id is painted, and again whenever the value changes, such as when a chart switches to another symbol or period.

fn tooltip_state( &self, position: Point<Pixels>, _bounds: Bounds<Pixels>, _cx: &App, ) -> Option<TooltipState>

Map the cursor to the tooltip state to display.

fn hover( &mut self, hover: Option<&PlotHover>, _window: &mut Window, _cx: &mut App, )

Receive the hovered datum this frame, before Plot::tooltip and Plot::paint run.

fn tooltip( &self, state: &TooltipState, cursor: Point<Pixels>, bounds: Bounds<Pixels>, _window: &mut Window, cx: &mut App, ) -> Option<AnyElement>

Render the tooltip overlay for the active TooltipState.