Struct SankeyChart 

pub struct SankeyChart { /* private fields */ }

How much flows from what to what. Each flow names its two ends, and nodes are created as they are named. Ribbons go from the color of their source to that of their target; under the pointer or with the arrow keys, what is connected stands out and the tooltip says how much. A screen reader hears every flow.

If the flows go in a circle there is no way to draw them, and it says which nodes the circle goes through, in place of the diagram. Available with the charts feature, on by default.

use ravenrs_widgets::SankeyChart;

let budget = SankeyChart::new()
    .title("Budget")
    .flow("Salary", "Rent", 1200.0)
    .flow("Salary", "Food", 600.0)
    .flow("Salary", "Savings", 400.0)
    .flow("Savings", "Funds", 400.0);

Implementations

impl SankeyChart

pub fn new() -> Self

An empty diagram, 300 logical pixels tall, as wide as its parent allows.

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

So much flows from source to target. Nothing, or less, draws nothing.

pub fn title(self, title: impl Into<String>) -> Self

A title above the diagram.

pub fn alt(self, text: impl Into<String>) -> Self

Describes the diagram for screen readers, in place of its title. Its flows are read after it.

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

Height in logical pixels (default 300).

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

Fixed size in logical pixels.

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

Which column a node goes to, among those its flows allow.

pub fn format(self, format: impl Fn(f64) -> String + 'static) -> Self

How numbers are written (at most two decimals by default).

pub fn node_color(self, name: impl Into<String>, color: Semantic) -> Self

Gives this node a color of the theme, in place of the next chart color.

pub fn no_gradient(self) -> Self

Ribbons in the color of their source, instead of going to that of their target.

pub fn hide_tooltip(self) -> Self

Says nothing under the pointer and takes no keyboard focus.

pub fn no_appear(self) -> Self

The flows are whole from the first frame, instead of drawing in from the left the first time the chart is painted.

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

Draws the flows in again whenever key changes.

Trait Implementations

impl Clone for SankeyChart

fn clone(&self) -> SankeyChart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SankeyChart

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

Formats the value using the given formatter.

impl Default for SankeyChart

fn default() -> Self

Returns the “default value” for a type.

impl View for SankeyChart

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.