Interface SankeyConfig

Full Sankey diagram configuration.

interface SankeyConfig {
    nodes: readonly SankeyNode[];
    flows: readonly SankeyFlow[];
    summary?: string;
}

Index

Properties

nodes flows summary?

Properties

`Readonly`nodes

nodes: readonly SankeyNode[]

Array of nodes (must have at least two: one source, one target).

`Readonly`flows

flows: readonly SankeyFlow[]

Array of directed flows between nodes.

`Optional` `Readonly`summary

summary?: string

Optional narrative summary.