Struct Sankey 

pub struct Sankey { /* private fields */ }

The Sankey layout generator.

Implementations

impl Sankey

pub fn new() -> Self

Create a generator with the d3-sankey defaults (see Sankey::default).

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

Set the node rectangle width. Defaults to 24.

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

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

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 values map to heights. Defaults to SankeyValueScale::Linear.

pub fn extent(self, x0: f32, y0: f32, x1: f32, y1: f32) -> Self

Set the layout bounds as [[x0, y0], [x1, y1]]. Defaults to [[0, 0], [1, 1]].

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

Equivalent to extent(0., 0., width, height).

pub fn topology( &self, node_count: usize, links: &[SankeyLink], ) -> Result<SankeyGraph, SankeyError>

Compute the topology only: node value, depth, height, layer and horizontal positions, without the vertical placement. Much cheaper than Sankey::layout when only the column structure is needed (e.g. to measure labels before fixing the extent).

node_count is the number of nodes; links reference nodes by index (d3-sankey’s default nodeId). Returns an error if a link references a node out of range or the graph contains a cycle.

pub fn layout( &self, node_count: usize, links: &[SankeyLink], ) -> Result<SankeyGraph, SankeyError>

Compute the full layout: Sankey::topology plus the vertical node placement and link breadths.

pub fn layout_from(&self, graph: SankeyGraph) -> SankeyGraph

Complete the layout for a graph produced by Sankey::topology, avoiding a second topology pass when the extent only becomes known after measuring against the column structure (e.g. label margins).

The topological fields are extent-independent; the horizontal and vertical positions are recomputed for this generator’s extent.

Trait Implementations

impl Default for Sankey

fn default() -> Self

Returns the “default value” for a type.