Skip to content
commit-766c8d6756a1

Interactive Sankey

Weighted movement, splitting, and convergence between named stages.

Purpose
Show how quantities move, split, and converge across named stages.
Use when
Flows between a small set of stages are the main story.
Avoid when
Exact link comparison or many crossings make the layout hard to read.
Equivalent data
Preserve weighted links in adjacent text or a table.
Usage Example
@interactivesankey.Sankey(interactivesankey.Config{
  Label: "Request flow",
  Series: []interactivesankey.Series{{
    Name: "Requests",
    Nodes: []interactivesankey.Node{{Name: "Ingress"}, {Name: "Success"}},
    Links: []interactivesankey.Link{{Source: "Ingress", Target: "Success", Value: 90}},
  }},
  Options: chart.ChartOptions{Title: &chart.TitleOptions{Text: "Request flow"}},
})

Flows

Each link connects declared source and target stages. Use the adjacent values for precise flow comparison.

Go API

v0.0.1

The examples above cover behavior and composition. pkg.go.dev is the canonical reference for exported types, functions, methods, and Go documentation.

github.com/araihu/goshtoso-charts/components/interactive/sankey

Enabled, disabled, hidden, and omitted wrapper behavior, controls, export, and client transitions are shared by every chart. Review chart controls, then compare static/vector and interactive capabilities.

Open v0.0.1 API