Skip to content

fix(funnel/waterfall): respect textinfo token order #7752

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

Open
Abineshabee wants to merge 6 commits into
base: master
Choose a base branch
from
Open

fix(funnel/waterfall): respect textinfo token order #7752

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4c418a0
test(funnel): add test for textinfo token order
Abineshabee Apr 13, 2026
c05bb22
fix: correct loop structure and restore hasFlag checks
Abineshabee Apr 13, 2026
4696313
test: ensure robust validation of token order
Abineshabee Apr 13, 2026
4f5d538
test: use DOM text elements instead of calcdata tx
Abineshabee Apr 13, 2026
66add11
fix: respect textinfo token order for funnel, waterfall, pie and sunb…
Abineshabee Apr 16, 2026
b2e22d6
fix: update tests to reflect correct textinfo token order
Abineshabee Apr 17, 2026
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
67 changes: 27 additions & 40 deletions src/traces/bar/plot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1105,52 +1105,39 @@ function calcTextinfo(cd, index, xa, ya) {
var text = [];
var tx;

var hasFlag = function (flag) {
return parts.indexOf(flag) !== -1;
};

if (hasFlag('label')) {
text.push(formatLabel(cd[index].p));
}

if (hasFlag('text')) {
tx = Lib.castOption(trace, cdi.i, 'text');
if (tx === 0 || tx) text.push(tx);
}

if (isWaterfall) {
var delta = +cdi.rawS || cdi.s;
var final = cdi.v;
var initial = final - delta;

if (hasFlag('initial')) text.push(formatNumber(initial));
if (hasFlag('delta')) text.push(formatNumber(delta));
if (hasFlag('final')) text.push(formatNumber(final));
var nPercent = 0;
if(isFunnel) {
if(hasFlag('percent initial')) nPercent++;
if(hasFlag('percent previous')) nPercent++;
if(hasFlag('percent total')) nPercent++;
}
Comment on lines +1109 to 1113
Copy link
Copy Markdown
Contributor

@emilykl emilykl Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer this version from your previous iteration as well, it's easier to understand.

Suggested change
if(isFunnel) {
for(var p = 0; p < parts.length; p++) {
var f = parts[p];
if(f === 'percent initial' || f === 'percent previous' || f === 'percent total') nPercent++;
}
}
if(isFunnel) {
if(hasFlag('percent initial')) nPercent++;
if(hasFlag('percent previous')) nPercent++;
if(hasFlag('percent total')) nPercent++;
hasMultiplePercents = nPercent > 1;
}


if (isFunnel) {
if (hasFlag('value')) text.push(formatNumber(cdi.s));

var nPercent = 0;
if (hasFlag('percent initial')) nPercent++;
if (hasFlag('percent previous')) nPercent++;
if (hasFlag('percent total')) nPercent++;

var hasMultiplePercents = nPercent > 1;

if (hasFlag('percent initial')) {
var hasMultiplePercents = nPercent > 1;
for(var i in parts) {
var part = parts[i];
if(part === 'label') {
text.push(formatLabel(cdi.p));
} else if(part === 'text') {
tx = Lib.castOption(trace, cdi.i, 'text');
if(tx === 0 || tx) text.push(tx);
} else if(isWaterfall && part === 'initial') {
text.push(formatNumber(cdi.v - (+cdi.rawS || cdi.s)));
} else if(isWaterfall && part === 'delta') {
text.push(formatNumber(+cdi.rawS || cdi.s));
} else if(isWaterfall && part === 'final') {
text.push(formatNumber(cdi.v));
} else if(isFunnel && part === 'value') {
text.push(formatNumber(cdi.s));
} else if(isFunnel && part === 'percent initial') {
tx = Lib.formatPercent(cdi.begR);
if (hasMultiplePercents) tx += ' of initial';
if(hasMultiplePercents) tx += ' of initial';
text.push(tx);
}
if (hasFlag('percent previous')) {
} else if(isFunnel && part === 'percent previous') {
tx = Lib.formatPercent(cdi.difR);
if (hasMultiplePercents) tx += ' of previous';
if(hasMultiplePercents) tx += ' of previous';
text.push(tx);
}
if (hasFlag('percent total')) {
} else if(isFunnel && part === 'percent total') {
tx = Lib.formatPercent(cdi.sumR);
if (hasMultiplePercents) tx += ' of total';
if(hasMultiplePercents) tx += ' of total';
text.push(tx);
}
}
Expand Down
30 changes: 14 additions & 16 deletions src/traces/pie/plot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1229,24 +1229,22 @@ function formatSliceLabel(gd, pt, cd0) {
var textinfo = trace.textinfo;
if (!texttemplate && textinfo && textinfo !== 'none') {
var parts = textinfo.split('+');
var hasFlag = function (flag) {
return parts.indexOf(flag) !== -1;
};
var hasLabel = hasFlag('label');
var hasText = hasFlag('text');
var hasValue = hasFlag('value');
var hasPercent = hasFlag('percent');

var separators = fullLayout.separators;
var text;

text = hasLabel ? [pt.label] : [];
if (hasText) {
var tx = helpers.getFirstFilled(trace.text, pt.pts);
if (isValidTextValue(tx)) text.push(tx);
var text = [];
var tx;
for(var i in parts) {
var part = parts[i];
if(part === 'label') {
text.push(pt.label);
} else if(part === 'text') {
tx = helpers.getFirstFilled(trace.text, pt.pts);
if(isValidTextValue(tx)) text.push(tx);
} else if(part === 'value') {
text.push(helpers.formatPieValue(pt.v, separators));
} else if(part === 'percent') {
text.push(helpers.formatPiePercent(pt.v / cd0.vTotal, separators));
}
}
if (hasValue) text.push(helpers.formatPieValue(pt.v, separators));
if (hasPercent) text.push(helpers.formatPiePercent(pt.v / cd0.vTotal, separators));
pt.text = text.join('<br>');
}

Expand Down
73 changes: 27 additions & 46 deletions src/traces/sunburst/plot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -544,58 +544,39 @@ exports.formatSliceLabel = function (pt, entry, trace, cd, fullLayout) {

if (!texttemplate) {
var parts = textinfo.split('+');
var hasFlag = function (flag) {
return parts.indexOf(flag) !== -1;
};
var thisText = [];
var tx;

if (hasFlag('label') && cdi.label) {
thisText.push(cdi.label);
}

if (cdi.hasOwnProperty('v') && hasFlag('value')) {
thisText.push(helpers.formatValue(cdi.v, separators));
var nPercent = 0;
for(var p = 0; p < parts.length; p++) {
var f = parts[p];
if(f === 'percent parent' || f === 'percent entry' || f === 'percent root') nPercent++;
}

if (!isRoot) {
if (hasFlag('current path')) {
var hasMultiplePercents = nPercent > 1;
for(var i in parts) {
var part = parts[i];
if(part === 'label' && cdi.label) {
thisText.push(cdi.label);
} else if(part === 'value' && cdi.hasOwnProperty('v')) {
thisText.push(helpers.formatValue(cdi.v, separators));
} else if(part === 'text') {
tx = Lib.castOption(trace, cdi.i, 'text');
if(Lib.isValidTextValue(tx)) thisText.push(tx);
} else if(!isRoot && part === 'current path') {
thisText.push(helpers.getPath(pt.data));
} else if(!isRoot && part === 'percent parent') {
tx = helpers.formatPercent(val / helpers.getValue(parent), separators);
if(hasMultiplePercents) tx += ' of parent';
thisText.push(tx);
} else if(!isRoot && part === 'percent entry') {
tx = helpers.formatPercent(val / helpers.getValue(entry), separators);
if(hasMultiplePercents) tx += ' of entry';
thisText.push(tx);
} else if(!isRoot && part === 'percent root') {
tx = helpers.formatPercent(val / helpers.getValue(hierarchy), separators);
if(hasMultiplePercents) tx += ' of root';
thisText.push(tx);
}

var nPercent = 0;
if (hasFlag('percent parent')) nPercent++;
if (hasFlag('percent entry')) nPercent++;
if (hasFlag('percent root')) nPercent++;
var hasMultiplePercents = nPercent > 1;

if (nPercent) {
var percent;
var addPercent = function (key) {
tx = helpers.formatPercent(percent, separators);

if (hasMultiplePercents) tx += ' of ' + key;
thisText.push(tx);
};

if (hasFlag('percent parent') && !isRoot) {
percent = val / helpers.getValue(parent);
addPercent('parent');
}
if (hasFlag('percent entry')) {
percent = val / helpers.getValue(entry);
addPercent('entry');
}
if (hasFlag('percent root')) {
percent = val / helpers.getValue(hierarchy);
addPercent('root');
}
}
}

if (hasFlag('text')) {
tx = Lib.castOption(trace, cdi.i, 'text');
if (Lib.isValidTextValue(tx)) thisText.push(tx);
}

return thisText.join('<br>');
Expand Down
21 changes: 21 additions & 0 deletions test/jasmine/tests/funnel_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1757,4 +1757,25 @@ describe('funnel uniformtext', function() {
}))
.then(done, done.fail);
});

it('should respect textinfo token order', function(done) {
Plotly.newPlot(gd, [{
type: 'funnel',
y: ['Awareness', 'Interest', 'Action'],
x: [1000, 700, 400],
textinfo: 'percent initial+value'
}], {})
.then(function() {
var textEls = gd.querySelectorAll('text.bartext');
var textContent = Array.from(textEls).map(function(el) {
return el.textContent;
});
expect(textContent.length).toBe(3);
expect(textContent[0]).toBe('100%1000');
expect(textContent[1]).toBe('70%700');
expect(textContent[2]).toBe('40%400');
Comment on lines +1774 to +1776
Copy link
Copy Markdown
Contributor

@emilykl emilykl Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also check the length of textContent.

Same goes for the other new tests as well.

Suggested change
expect(textContent[0]).toBe('100%1000');
expect(textContent[1]).toBe('70%700');
expect(textContent[2]).toBe('40%400');
expect(textContent.length).toBe(3);
expect(textContent[0]).toBe('100%1000');
expect(textContent[1]).toBe('70%700');
expect(textContent[2]).toBe('40%400');

})
.then(done, done.fail);
});

});
21 changes: 21 additions & 0 deletions test/jasmine/tests/pie_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -909,6 +909,27 @@ describe('Pie traces', function() {
}))
.then(done, done.fail);
});

it('should respect textinfo token order', function(done) {
Plotly.newPlot(gd, [{
type: 'pie',
labels: ['A', 'B', 'C'],
values: [10, 20, 70],
textinfo: 'percent+label',
sort: false
}], {})
.then(function() {
var textEls = gd.querySelectorAll('text.slicetext');
var textContent = Array.from(textEls).map(function(el) {
return el.textContent;
});
expect(textContent.length).toBe(3);
expect(textContent[0]).toBe('10%A');
expect(textContent[1]).toBe('20%B');
expect(textContent[2]).toBe('70%C');
})
.then(done, done.fail);
});
});

describe('Pie texttemplate:', function() {
Expand Down
24 changes: 23 additions & 1 deletion test/jasmine/tests/sunburst_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1173,7 +1173,7 @@ describe('Test sunburst restyle:', function () {
.then(_restyle({ textinfo: 'none' }))
.then(_assert('no textinfo', ['', '', '', '']))
.then(_restyle({ textinfo: 'label+text+value' }))
.then(_assert('show everything', ['Root\n0\nnode0', 'B\n2\nnode2', 'A\n1\nnode1', 'b\n3\nnode3']))
.then(_assert('show everything', ['Root\nnode0\n0', 'B\nnode2\n2', 'A\nnode1\n1', 'b\nnode3\n3']))
.then(_restyle({ textinfo: null }))
.then(_assert('back to dflt', ['Root\nnode0', 'B\nnode2', 'A\nnode1', 'b\nnode3']))
// now change insidetextorientation to 'horizontal'
Expand All @@ -1199,6 +1199,28 @@ describe('Test sunburst restyle:', function () {
.then(_assert('back to dflt', ['Root\nnode0', 'B\nnode2', 'A\nnode1', 'b\nnode3']))
.then(done, done.fail);
});

it('should respect textinfo token order', function(done) {
Plotly.newPlot(gd, [{
type: 'sunburst',
labels: ['Root', 'A', 'B'],
parents: ['', 'Root', 'Root'],
values: [0, 10, 20],
textinfo: 'percent root+value+label'
}], {})
.then(function() {
var layer = d3Select(gd).select('.sunburstlayer');
var textContent = [];
layer.selectAll('text.slicetext').each(function() {
textContent.push(this.textContent);
});
expect(textContent.length).toBe(3);
expect(textContent[0]).toBe('0Root');
expect(textContent[1]).toBe('33%20B');
expect(textContent[2]).toBe('17%10A');
})
.then(done, done.fail);
});
});

describe('Test sunburst tweening:', function () {
Expand Down
2 changes: 1 addition & 1 deletion test/jasmine/tests/treemap_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1442,7 +1442,7 @@ describe('Test treemap restyle:', function () {
.then(_restyle({ textinfo: 'none' }))
.then(_assert('no textinfo', ['Root', 'B', ' ', ' '])) // use one space character instead of a blank string to avoid jumps during transition
.then(_restyle({ textinfo: 'label+text+value' }))
.then(_assert('show everything', ['Root', 'B', 'A\n1\nnode1', 'b\n3\nnode3']))
.then(_assert('show everything', ['Root', 'B', 'A\nnode1\n1', 'b\nnode3\n3']))
.then(_restyle({ textinfo: null }))
.then(_assert('back to dflt', ['Root', 'B', 'A\nnode1', 'b\nnode3']))
.then(done, done.fail);
Expand Down