Skip to content

Fix: Improvements to avoid distortions in sankey diagram links loops #7272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 16, 2024
+158 −109
Merged

Fix: Improvements to avoid distortions in sankey diagram links loops #7272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3747be
Fix: Improvements to avoid distortions in sankey diagram links loops.…
giuseppe-straziota Nov 15, 2024
869548c
Chore: add changelog entry for PR #7272
giuseppe-straziota Nov 15, 2024
9898921
Update draftlogs/7272_fix.md
archmoj Dec 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions draftlogs/7272_fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- Fix distortions in sankey diagram links loops [[#7272](https://github.com/plotly/plotly.js/pull/7272)],
with thanks to @giuseppe-straziota for the contribution!
265 changes: 156 additions & 109 deletions src/traces/sankey/render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,118 +335,165 @@ function createCircularClosedPathString(link, arrowLen) {
var pathString = '';
var offset = link.width / 2;
var coords = link.circularPathData;
if(link.circularLinkType === 'top') {
// Top path
var isSourceBeforeTarget = coords.sourceX + coords.verticalBuffer < coords.targetX;
var isPathOverlapped = (coords.rightFullExtent - coords.rightLargeArcRadius - arrowLen) <= (coords.leftFullExtent - offset)
var diff = Math.abs(coords.rightFullExtent- coords.leftFullExtent - offset) < offset ;
if (link.circularLinkType === 'top') {
pathString =
// start at the left of the target node
'M ' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY + offset) + ' ' +
'L' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY + offset) +
'A' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightSmallArcRadius + offset) + ' 0 0 1 ' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + (coords.targetY - coords.rightSmallArcRadius) +
'L' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + coords.verticalRightInnerExtent +
'A' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent - offset) +
'L' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent - offset) +
'A' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent +
'L' +
(coords.leftFullExtent + offset) + ' ' + (coords.sourceY - coords.leftSmallArcRadius) +
'A' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 1 ' +
coords.leftInnerExtent + ' ' + (coords.sourceY + offset) +
'L' +
coords.sourceX + ' ' + (coords.sourceY + offset) +

// Walking back
'L' +
coords.sourceX + ' ' + (coords.sourceY - offset) +
'L' +
coords.leftInnerExtent + ' ' + (coords.sourceY - offset) +
'A' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftSmallArcRadius - offset) + ' 0 0 0 ' +
(coords.leftFullExtent - offset) + ' ' + (coords.sourceY - coords.leftSmallArcRadius) +
'L' +
(coords.leftFullExtent - offset) + ' ' + coords.verticalLeftInnerExtent +
'A' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftLargeArcRadius - offset) + ' 0 0 0 ' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent + offset) +
'L' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
'A' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightLargeArcRadius - offset) + ' 0 0 0 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent +
'L' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + (coords.targetY - coords.rightSmallArcRadius) +
'A' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 0 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY - offset) +
'L' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY - offset) +
(arrowLen > 0 ? 'L' + coords.targetX + ' ' + (coords.targetY) : '') +
'Z';
// start at the left of the target node
'M ' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY + offset) + ' ' +
'L ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY + offset) +
'A ' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightSmallArcRadius + offset) + ' 0 0 1 ' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + (coords.targetY - coords.rightSmallArcRadius) +
'L ' + (coords.rightFullExtent - offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;

if (isSourceBeforeTarget && isPathOverlapped) {
pathString += ' A ' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.rightFullExtent + offset - arrowLen - (coords.rightLargeArcRadius - offset)) + ' ' +
(coords.verticalRightInnerExtent - (coords.rightLargeArcRadius + offset)) +
' L ' +
(coords.rightFullExtent + offset - (coords.rightLargeArcRadius - offset) - arrowLen) + ' ' +
(coords.verticalRightInnerExtent - (coords.rightLargeArcRadius + offset)) +
' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalRightInnerExtent;
} else if (isSourceBeforeTarget) {
pathString += ' A ' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightLargeArcRadius - offset) + ' 0 0 0 ' +
(coords.rightFullExtent - offset - arrowLen - (coords.rightLargeArcRadius - offset)) + ' ' +
(coords.verticalRightInnerExtent - (coords.rightLargeArcRadius - offset)) +
' L ' +
(coords.leftFullExtent + offset + (coords.rightLargeArcRadius - offset)) + ' ' +
(coords.verticalRightInnerExtent - (coords.rightLargeArcRadius - offset)) +
' A ' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftLargeArcRadius - offset) + ' 0 0 0 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent;
} else {
pathString += ' A ' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent - offset) +
' L ' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent - offset) +
' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftLargeArcRadius + offset) + ' 0 0 1 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent;
}

pathString += ' L ' +
(coords.leftFullExtent + offset) + ' ' + (coords.sourceY - coords.leftSmallArcRadius) +
' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 1 ' +
coords.leftInnerExtent + ' ' + (coords.sourceY + offset) +
' L ' +
coords.sourceX + ' ' + (coords.sourceY + offset) +

// Walking back
' L ' +
coords.sourceX + ' ' + (coords.sourceY - offset) +
' L ' +
coords.leftInnerExtent + ' ' + (coords.sourceY - offset) +
' A ' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftSmallArcRadius - offset) + ' 0 0 0 ' +
(coords.leftFullExtent - offset) + ' ' + (coords.sourceY - coords.leftSmallArcRadius) +
' L ' +
(coords.leftFullExtent - offset) + ' ' + coords.verticalLeftInnerExtent;

if (isSourceBeforeTarget && isPathOverlapped) {
pathString += ' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 0 ' +
(coords.leftFullExtent - offset) + ' ' + (coords.verticalFullExtent + offset) +
'L' + (coords.rightFullExtent + offset - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 0 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
} else if (isSourceBeforeTarget) {
pathString += ' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 1 ' +
(coords.leftFullExtent + offset) + ' ' + (coords.verticalFullExtent - offset) +
' L ' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + (coords.verticalFullExtent - offset) +
' A ' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 1 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
} else {
pathString += ' A ' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftLargeArcRadius - offset) + ' 0 0 0 ' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent + offset) +
' L ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
' A ' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightLargeArcRadius - offset) + ' 0 0 0 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
}

pathString += ' L ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + (coords.targetY - coords.rightSmallArcRadius) +
' A ' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 0 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY - offset) +
' L ' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY - offset) +
(arrowLen > 0 ? ' L ' + coords.targetX + ' ' + coords.targetY : '') +
'Z';
} else {
// Bottom path
pathString =
// start at the left of the target node
'M ' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY - offset) + ' ' +
'L' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY - offset) +
'A' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightSmallArcRadius + offset) + ' 0 0 0 ' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + (coords.targetY + coords.rightSmallArcRadius) +
'L' +
(coords.rightFullExtent - offset - arrowLen) + ' ' + coords.verticalRightInnerExtent +
'A' +
(coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
'L' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent + offset) +
'A' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftLargeArcRadius + offset) + ' 0 0 0 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent +
'L' +
(coords.leftFullExtent + offset) + ' ' + (coords.sourceY + coords.leftSmallArcRadius) +
'A' +
(coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 0 ' +
coords.leftInnerExtent + ' ' + (coords.sourceY - offset) +
'L' +
coords.sourceX + ' ' + (coords.sourceY - offset) +

// Walking back
'L' +
coords.sourceX + ' ' + (coords.sourceY + offset) +
'L' +
coords.leftInnerExtent + ' ' + (coords.sourceY + offset) +
'A' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.leftFullExtent - offset) + ' ' + (coords.sourceY + coords.leftSmallArcRadius) +
'L' +
(coords.leftFullExtent - offset) + ' ' + coords.verticalLeftInnerExtent +
'A' +
(coords.leftLargeArcRadius - offset) + ' ' + (coords.leftLargeArcRadius - offset) + ' 0 0 1 ' +
coords.leftInnerExtent + ' ' + (coords.verticalFullExtent - offset) +
'L' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent - offset) +
'A' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightLargeArcRadius - offset) + ' 0 0 1 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent +
'L' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + (coords.targetY + coords.rightSmallArcRadius) +
'A' +
(coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY + offset) +
'L' +
(coords.targetX - arrowLen) + ' ' + (coords.targetY + offset) +
(arrowLen > 0 ? 'L' + coords.targetX + ' ' + (coords.targetY) : '') +
'Z';
'M ' + (coords.targetX - arrowLen) + ' ' + (coords.targetY - offset) + ' ' +
' L ' + (coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY - offset) +
' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightSmallArcRadius + offset) + ' 0 0 0 ' + (coords.rightFullExtent - offset - arrowLen) + ' ' + (coords.targetY + coords.rightSmallArcRadius) +
' L ' + (coords.rightFullExtent - offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;

if (isSourceBeforeTarget && isPathOverlapped) {
pathString += ' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' +
(coords.rightInnerExtent - offset - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
' L ' + (coords.rightFullExtent + offset - arrowLen - (coords.rightLargeArcRadius - offset)) + ' ' + (coords.verticalFullExtent + offset) +
' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent;
} else if (isSourceBeforeTarget) {
pathString += ' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.rightFullExtent - arrowLen - offset - (coords.rightLargeArcRadius - offset)) + ' ' + (coords.verticalFullExtent - offset) +
' L ' + (coords.leftFullExtent + offset + (coords.rightLargeArcRadius - offset)) + ' ' + (coords.verticalFullExtent - offset) +
' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent;
} else {
pathString += ' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' + (coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent + offset) +
' L ' + coords.leftInnerExtent + ' ' + (coords.verticalFullExtent + offset) +
' A ' + (coords.leftLargeArcRadius + offset) + ' ' + (coords.leftLargeArcRadius + offset) + ' 0 0 0 ' + (coords.leftFullExtent + offset) + ' ' + coords.verticalLeftInnerExtent;
}

pathString += ' L ' + (coords.leftFullExtent + offset) + ' ' + (coords.sourceY + coords.leftSmallArcRadius) +
' A ' + (coords.leftLargeArcRadius + offset) + ' ' + (coords.leftSmallArcRadius + offset) + ' 0 0 0 ' + coords.leftInnerExtent + ' ' + (coords.sourceY - offset) +
' L ' + coords.sourceX + ' ' + (coords.sourceY - offset) +

// Walking back
' L ' + coords.sourceX + ' ' + (coords.sourceY + offset) +
' L ' + coords.leftInnerExtent + ' ' + (coords.sourceY + offset) +
' A ' + (coords.leftLargeArcRadius - offset) + ' ' + (coords.leftSmallArcRadius - offset) + ' 0 0 1 ' + (coords.leftFullExtent - offset) + ' ' + (coords.sourceY + coords.leftSmallArcRadius) +
' L ' + (coords.leftFullExtent - offset) + ' ' + coords.verticalLeftInnerExtent;

if (isSourceBeforeTarget && isPathOverlapped) {
pathString +=
' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.leftFullExtent - offset - (coords.rightLargeArcRadius - offset)) + ' ' + (coords.verticalFullExtent - offset) +
' L ' + (coords.rightFullExtent + offset - arrowLen + (coords.rightLargeArcRadius - offset)) + ' ' + (coords.verticalFullExtent - offset) +
' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' +
(coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
} else if (isSourceBeforeTarget) {
pathString += ' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' + (coords.leftFullExtent + offset) + ' ' + (coords.verticalFullExtent + offset) +
' L ' + (coords.rightFullExtent - arrowLen - offset) + ' ' + (coords.verticalFullExtent + offset) +
' A ' + (coords.rightLargeArcRadius + offset) + ' ' + (coords.rightLargeArcRadius + offset) + ' 0 0 0 ' + (coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
} else {
pathString += ' A ' + (coords.leftLargeArcRadius - offset) + ' ' + (coords.leftLargeArcRadius - offset) + ' 0 0 1 ' + coords.leftInnerExtent + ' ' + (coords.verticalFullExtent - offset) +
' L ' + (coords.rightInnerExtent - arrowLen) + ' ' + (coords.verticalFullExtent - offset) +
' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightLargeArcRadius - offset) + ' 0 0 1 ' + (coords.rightFullExtent + offset - arrowLen) + ' ' + coords.verticalRightInnerExtent;
}

pathString += ' L ' + (coords.rightFullExtent + offset - arrowLen) + ' ' + (coords.targetY + coords.rightSmallArcRadius) +
' A ' + (coords.rightLargeArcRadius - offset) + ' ' + (coords.rightSmallArcRadius - offset) + ' 0 0 1 ' + (coords.rightInnerExtent - arrowLen) + ' ' + (coords.targetY + offset) +
' L ' + (coords.targetX - arrowLen) + ' ' + (coords.targetY + offset) + (arrowLen > 0 ? ' L ' + coords.targetX + ' ' + coords.targetY : '') + 'Z';
}
return pathString;
}
Expand Down