Repository navigation
Conversation
|
If you are interested in this please let me know. #7870 was just merged into |
|
@wf-r go for it. You'll need to change the target branch to v4.0. |
I think I am not allowed to do it (or I don't find the option). Can you do this, please? |
|
Please have a look at this. |
…ominant-baseline, use block-shift like node labels), thread _d3locale/_meta/fallback through texttemplateString, and dedupe the orientation counter-transform into a shared uprightTransform helper.Also make opted-out traces free of per-link work by short-circuiting linkTextGetter to null.
|
I'm done for today. Things one could discuss:
|
… group (fixes z-order with entering link paths), thread the label selection through updateShapes/attachDragHandler/startForce instead of DOM-querying every drag frame, and build each link's model once via a shared linkModels cache instead of duplicating it for paths and labels; exiting labels now fade out like links, and per-link texttemplate lookups use pointNumber instead of the loop index. Also switch link.texttemplate to the shared texttemplateAttrs() helper for a standard description and %{meta} support. More details in draftlog.
|
|
I'm back, sorry I was busy with other work.
You are right,
Sankey nodes and links do a while the link label just does So if we e.g. filter links we get a slightly different behaviour between link label and link itself. |
|
This got closed by accident! I still want to get the work merged, but the v4.0 branch got deleted and now I can't change the base branch of the PR. I'll see if there's another way to get this open again. |
|
@wf-r are you still interested in finishing this PR? |
Yes, very much so. My last status was that it is ready for review (yet this was 3 months ago, so orobably an update to the current state of main would be in order). |
|
Ah, my comments never got added. I now see they all say pending. Sorry about that! I'll get my review fixed up and post an update. |
# Conflicts: # src/traces/sankey/constants.js
camdecoster
left a comment
There was a problem hiding this comment.
This is a good start. Could you please make a few changes?
| valueformat: { | ||
| valType: 'string', | ||
| dflt: '', | ||
| description: [ | ||
| 'Sets the value formatting rule for the permanent link labels,', | ||
| 'using d3 formatting mini-languages. Falls back to the trace-level', | ||
| '`valueformat` when empty.' | ||
| ].join(' ') | ||
| }, | ||
| valuesuffix: { | ||
| valType: 'string', | ||
| dflt: '', | ||
| description: [ | ||
| 'Adds a unit to follow the value in the permanent link labels.', | ||
| 'Falls back to the trace-level `valuesuffix` when empty.' | ||
| ].join(' ') | ||
| }, |
There was a problem hiding this comment.
Let's remove these in favor of relying on the trace attributes.
| function linkModels(d) { | ||
| if(!d._linkModels) { | ||
| d._linkModels = d.graph.links | ||
| .filter(function(l) {return l.value;}) |
There was a problem hiding this comment.
It's okay to use ES6 syntax. esbuild transpiles it.
| .filter(function(l) {return l.value;}) | |
| .filter((l) => l.value) |
| @@ -0,0 +1,4 @@ | |||
| - Add permanent on-diagram link labels to the Sankey trace via new `link.textinfo`, `link.texttemplate`, `link.texttemplatefallback`, `link.textfont`, `link.valueformat`, and `link.valuesuffix` attributes [[#7888](https://github.com/plotly/plotly.js/pull/7888)]. | |||
There was a problem hiding this comment.
| - Add permanent on-diagram link labels to the Sankey trace via new `link.textinfo`, `link.texttemplate`, `link.texttemplatefallback`, `link.textfont`, `link.valueformat`, and `link.valuesuffix` attributes [[#7888](https://github.com/plotly/plotly.js/pull/7888)]. | |
| - Add Sankey trace link labels [[#7888](https://github.com/plotly/plotly.js/pull/7888)] |
| }) | ||
| .attr('transform', linkLabelTransform); | ||
|
|
||
| sankeyLinkLabel.exit().remove(); |
There was a problem hiding this comment.
The labels don't fade in/out properly during transitions like the links do. Could you update this section to match the way links fade?
| midX = (l.circularPathData.leftInnerExtent + l.circularPathData.rightInnerExtent) / 2; | ||
| midY = l.circularPathData.verticalFullExtent; | ||
| } else { | ||
| midX = (l.source.x1 + l.target.x0) / 2; |
There was a problem hiding this comment.
Could you please remove all of these new mocks (and baselines) and update the sankey_circular_with_arrows family of mocks to test the new label functionality?
|
|
||
| Lib.coerceFont(coerce, 'textfont', layout.font, { autoShadowDflt: true }); | ||
|
|
||
| // permanent link text labels (opt-in via link.textinfo / link.texttemplate) |
There was a problem hiding this comment.
| // permanent link text labels (opt-in via link.textinfo / link.texttemplate) |
| source: l.source.label, | ||
| target: l.target.label, |
There was a problem hiding this comment.
Let's update this to maintain the current pattern used in hovertemplate:
| source: l.source.label, | |
| target: l.target.label, | |
| source: l.source, | |
| target: l.target, |


Add permanent text labels to Sankey links
What
Adds persistent, always-visible text labels to Sankey links, analogous to the existing node
labels. Five new attributes under
link:link.textinfo"label","value","none"link.texttemplatetextinfowhen setlink.textfontlink.valueformatlink.valuesuffixWhy
Link information is currently hover-only, making Sankey diagrams unsuitable for static export
(PNG/SVG/print) wherever flow values or names need to be visible at all times. There is
long-standing community interest in this — see #4746.
External SVG overlays (the current workaround) are fragile: they break on node drags, require
timing hacks after layout transitions, and are excluded from
toImageexport. Native labelssolve all three problems.
How
Labels are rendered as real SVG
<text>elements inside the.sankeygroup, immediately afterthe link paths. This means:
handvlayouts with no extra handling.updateShapeshook — no separate drag listenerneeded.
toImage/PNG/SVG export — no overlay required.For circular (backward) links the label anchor reuses the same
circularPathDatamidpoint asthe hover label, so the position is consistent. Vertical centering on the anchor uses
dominant-baseline="central".Template rendering follows the established
funnel/piepattern viaLib.texttemplateString.Available template variables:
%{label},%{value},%{valueLabel}(formatted value +suffix),
%{source},%{target},%{customdata}.Backward compatibility
Fully backward compatible. All new attributes default to
textinfo: 'none'/texttemplate: '',so existing figures render identically. No existing tests or baselines are affected.
Related