When to use it. Flow volumes between nodes: energy from panels to loads, requests through services, budget through categories. Nodes stack into columns (sources left, sinks right — computed from the link graph), ribbons run between them with thickness ∝ value and a color gradient from source to target. Tapping a node with the node's in/out totals.
Type
sankey
Also titled
Sankey
Default size
3 rows × 4 columns
Symbol
arrow.triangle.branch
Docs
Docs complete
Search for it as
flow
funnel
diagram
sources
links
breakdown
Rendered by the app
Fields
14 fields you can set on a sankey control. Every control also takes the shared fields (id, position, span, sync, action).
Fields
Field
Type
Default
What it does
haptichaptic
choiceone of 10
—
Buzz when you touch it
Gives a small physical tap when you interact, on phones that support it.
noneno vibration
lighta faint tap
mediuma normal tap
heavya strong thump
softa gentle cushioned tap
rigida crisp hard tap
selectiona tiny tick like scrolling a picker
successa pattern that feels like done
warninga pattern that feels like careful
errora sharp pattern that feels like failed
Titlelabel
text
—
The heading above the chart
Shows this text as the header above the diagram.
sankeyConfigsankeyConfig
object
—
All the chart settings in one place
Holds the optional look and tap settings for the diagram.
Colortint
color
#667eea
The main colour
Colours the first node and seeds the colours of the others.
formatValueformatValue
text
—
How numbers are written
Formats the throughput numbers shown next to node labels and the selection readout.
Node colorssankeyConfig.colors
string[]
—
The colours nodes cycle through
Gives each node a colour in turn; a colour set on a node itself wins.
Flow strengthsankeyConfig.linkOpacity
number0–1step 0.05
0.32
How solid the flow bands are
Sets how see-through the ribbons are, from 0 invisible to 1 solid; selected ones brighten.
nodeActionsankeyConfig.nodeAction
object
—
What happens when you tap a node
Runs this action when a node is tapped, passing its name and in and out totals.
Node spacingsankeyConfig.nodeSpacing
number0–40 ptstep 1
10
Gap between boxes
Sets the smallest vertical gap between nodes in a column, 0 to 40 points.
Cell roundnesssankeyConfig.cellCornerRadius
number0–30 ptstep 1
—
How round the boxes are
Rounds the node bars, 0 to 30 points; unset it is a third of the node width.
Node widthsankeyConfig.nodeWidth
number1–40 ptstep 1
10
How thick the boxes are
Sets the width of each node bar, 1 to 40 points.
scrubsankeyConfig.scrub
on / off
false(off)
Slide your finger across nodes
Lets a drag move the spotlight from node to node with a tick each step; a tap still fires the action.
LabelssankeyConfig.showLabels
on / off
true(on)
Show node names
Shows or hides the node names beside the bars.
Value labelssankeyConfig.showValues
on / off
false(off)
Show the numbers
Shows or hides each node's throughput value next to its name.
Theme fields
Restyle one control by setting these in its theme object; a layout's theme sets them for every control.
Theme fields
Field
Type
Default
What it does
secondaryColortheme.secondaryColor
color
#FFFFFF99
Faint text colour
Colours the faintest text and ink.
Emits and receives
What this control sends when you use it, and what it can show or follow when data arrives.
Emits
Emits
Sends
When
Type
What it sends
When you tap a nodenode
tap
json
the tapped node's name with its total flow in and out
Sends only when the tap selects a node, not when it clears the selection
Example: {"name": "Item 1", "in": 3, "out": 2}
Receives
Receives
Takes
From
Type
What it does
nodesshow
hub, mqtt, http, store
json
nodes, and links between them each with an amount
nodes are re-stacked into columns and the ribbons resize to their new amounts