Interface: SankeyTraceLink

The links.

Properties

Property	Type	Default value	Description
arrowlen?	number	0	Length of the arrowhead at the target end of every link, in CSS px (at most half the gap between the nodes); 0 draws no arrowheads. Minimum: 0
color?	PerPointColor	undefined	Link color, or one per link. Default: translucent black on light paper, translucent white on dark paper.
colorscales?	readonly SankeyTraceLinkConcentrationscales[]	undefined	Concentration colorscales: links labeled label are colored by their share of the flow between their two nodes (the links sharing the source and target), mapped from cmin–cmax through colorscale. Hover labels then show the concentration.
customdata?	DataColumn	undefined	Extra data per link for %{customdata} and events.
flow?	SankeyTraceLinkFlow	undefined	Flow particles (a Holochart extension): dots streaming along every link from its source to its target, spread across its width, as many as its size and density call for. Off unless link.flow is set (flow: {} turns them on). They dim with links outside a hover highlight, and hold still under prefers-reduced-motion: reduce.
hovercolor?	PerPointColor	undefined	Link color while it (or a node it connects) is hovered, or one per link. Default: the link color 0.2 more opaque (brightened on dark paper, darkened on light paper when already that opaque).
hoverinfo?	"none" | "all" | "skip"	"all"	Hover of the links: labels ('all'), highlighting without labels ('none') or no hover and no events ('skip'). Default: the trace hoverinfo.
hovertemplate?	string	undefined	Template of the link hover labels: %{label}, %{value} (formatted with valueformat and valuesuffix), %{source.label}, %{target.label}, %{flow.labelConcentration}, %{customdata}, … <extra>…</extra> replaces the value box.
label?	DataColumn	undefined	Link labels: shown in hover labels, links with the same label highlight together, and a label names the link.colorscales entry of the link.
line?	SankeyTraceLinkLine	undefined	Outlines of the links.
source?	DataColumn	undefined	Source node index of every link.
target?	DataColumn	undefined	Target node index of every link.
value?	DataColumn	undefined	Flow of every link, which sets its width. Links without a positive value are dropped.