Skip to content

Commit 6fb3fb4

Browse files
committed
document that link.line.(width|color) is not supported with circularity
1 parent f63e2b5 commit 6fb3fb4

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

src/traces/sankey/attributes.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,8 @@ var attrs = module.exports = overrideAll({
177177
dflt: colorAttrs.defaultLine,
178178
arrayOk: true,
179179
description: [
180-
'Sets the color of the `line` around each `link`.'
180+
'Sets the color of the `line` around each `link`.',
181+
'Note that in the presence of circular links this attribute is ignored.'
181182
].join(' ')
182183
},
183184
width: {
@@ -187,7 +188,8 @@ var attrs = module.exports = overrideAll({
187188
dflt: 0,
188189
arrayOk: true,
189190
description: [
190-
'Sets the width (in px) of the `line` around each `link`.'
191+
'Sets the width (in px) of the `line` around each `link`.',
192+
'Note that in the presence of circular links this attribute is ignored.'
191193
].join(' ')
192194
}
193195
},

src/traces/sankey/render.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ function linkPath() {
128128
var curvature = 0.5;
129129
function path(d) {
130130
if(d.circular) {
131-
return d.link.path;
131+
return d.link.path; // TODO: turn this into a closed path to support link.line.(width|color)
132132
} else {
133133
var x0 = d.link.source.x1;
134134
var x1 = d.link.target.x0;

0 commit comments

Comments
 (0)