Skip to content

Fix for displaying narrow bars in interactive mode #4568

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 8 commits into from
Feb 12, 2020
Merged

Fix for displaying narrow bars in interactive mode #4568

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4972429
fix issue 4567 - display narrow bars
archmoj Feb 10, 2020
c71ca70
should not force x1=x0 and y1=y0
archmoj Feb 11, 2020
7f3fb34
add test to ensure narrow bars are displayed similar to v1.52.1 and b…
archmoj Feb 11, 2020
c1ee8c2
add comment regarding not showing zero span bars
archmoj Feb 11, 2020
4c323bc
force x1=x0 and y1=y0 again but only with transition
archmoj Feb 11, 2020
8ebc030
add comment for transitioning empty bars
archmoj Feb 11, 2020
c83839f
revise blank bar logic
archmoj Feb 11, 2020
494775b
add transition tests for blank bars - as currently pass on master too
archmoj Feb 11, 2020
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
46 changes: 28 additions & 18 deletions src/traces/bar/plot.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,7 @@ function plot(gd, plotinfo, cdModule, traceLayer, opts, makeOnCompleteCallback)
}

var isHorizontal = (trace.orientation === 'h');
var withTransition = hasTransition(opts);

var pointGroup = Lib.ensureSingle(plotGroup, 'g', 'points');

Expand Down Expand Up @@ -149,16 +150,21 @@ function plot(gd, plotinfo, cdModule, traceLayer, opts, makeOnCompleteCallback)
);

// display zeros if line.width > 0
if(isBlank && shouldDisplayZeros && helpers.getLineWidth(trace, di) && (isHorizontal ? x1 - x0 === 0 : y1 - y0 === 0)) {
if(isBlank && shouldDisplayZeros &&
helpers.getLineWidth(trace, di) &&
(isHorizontal ? x0 === x1 : y0 === y1)) {
isBlank = false;
}
di.isBlank = isBlank;

if(isBlank && isHorizontal) x1 = x0;
if(isBlank && !isHorizontal) y1 = y0;

var spansHorizontal = isHorizontal && (x0 !== x1);
var spansVertical = !isHorizontal && (y0 !== y1);
// for empty bars, ensure start and end positions are equal when having transition
if(isBlank && withTransition) {
if(isHorizontal) {
x1 = x0;
} else {
y1 = y0;
}
}

// in waterfall mode `between` we need to adjust bar end points to match the connector width
if(adjustPixel && !isBlank) {
Expand All @@ -185,16 +191,24 @@ function plot(gd, plotinfo, cdModule, traceLayer, opts, makeOnCompleteCallback)
mc = di.mc || trace.marker.color;
}

var offset = d3.round((lw / 2) % 1, 2);

function roundWithLine(v) {
var offset = d3.round((lw / 2) % 1, 2);

// if there are explicit gaps, don't round,
// it can make the gaps look crappy
return (opts.gap === 0 && opts.groupgap === 0) ?
d3.round(Math.round(v) - offset, 2) : v;
}

function expandToVisible(v, vc) {
function expandToVisible(v, vc, hideZeroSpan) {
if(hideZeroSpan && v === vc) {
// should not expand zero span bars
// when start and end positions are identical
// i.e. for vertical when y0 === y1
// and for horizontal when x0 === x1
return v;
}

// if it's not in danger of disappearing entirely,
// round more precisely
return Math.abs(v - vc) >= 2 ? roundWithLine(v) :
Expand All @@ -215,14 +229,10 @@ function plot(gd, plotinfo, cdModule, traceLayer, opts, makeOnCompleteCallback)
var op = Color.opacity(mc);
var fixpx = (op < 1 || lw > 0.01) ? roundWithLine : expandToVisible;

if(spansHorizontal) {
x0 = fixpx(x0, x1);
x1 = fixpx(x1, x0);
}
if(spansVertical) {
y0 = fixpx(y0, y1);
y1 = fixpx(y1, y0);
}
x0 = fixpx(x0, x1, isHorizontal);
x1 = fixpx(x1, x0, isHorizontal);
y0 = fixpx(y0, y1, !isHorizontal);
y1 = fixpx(y1, y0, !isHorizontal);
}

var sel = transition(Lib.ensureSingle(bar, 'path'), fullLayout, opts, makeOnCompleteCallback);
Expand All @@ -231,7 +241,7 @@ function plot(gd, plotinfo, cdModule, traceLayer, opts, makeOnCompleteCallback)
.attr('d', 'M' + x0 + ',' + y0 + 'V' + y1 + 'H' + x1 + 'V' + y0 + 'Z')
.call(Drawing.setClipUrl, plotinfo.layerClipId, gd);

if(!fullLayout.uniformtext.mode && hasTransition(opts)) {
if(!fullLayout.uniformtext.mode && withTransition) {
var styleFns = Drawing.makePointStyleFns(trace);
Drawing.singlePointStyle(di, sel, trace, styleFns, gd);
}
Expand Down
Binary file added test/image/baselines/bar_show_narrow.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
166 changes: 166 additions & 0 deletions test/image/mocks/bar_show_narrow.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
{
"data": [
{
"type": "bar",
"width": 0.001,
"x": [
"A",
"B",
"C",
"D"
],
"y": [
0.001,
0.01,
0.1,
1
]
},
{
"type": "bar",
"width": 0.001,
"x": [
"A",
"B",
"C",
"D"
],
"y": [
0.001,
0.01,
0.1,
1
],
"xaxis": "x2",
"yaxis": "y2"
},
{
"type": "bar",
"width": 0.001,
"orientation": "h",
"x": [
0.001,
0.01,
0.1,
1
],
"y": [
"A",
"B",
"C",
"D"
],
"text": [
0,
null,
0.001,
1
],
"xaxis": "x3",
"yaxis": "y3"
},
{
"type": "bar",
"width": 0.001,
"orientation": "h",
"x": [
0.001,
0.01,
0.1,
1
],
"y": [
"A",
"B",
"C",
"D"
],
"xaxis": "x4",
"yaxis": "y4"
}
],
"layout": {
"showlegend": false,
"width": 800,
"height": 800,
"dragmode": "pan",
"xaxis": {
"domain": [
0,
0.48
]
},
"xaxis2": {
"autorange": "reversed",
"anchor": "y2",
"domain": [
0.52,
1
]
},
"xaxis3": {
"range": [
-0.01,
1
],
"zeroline": false,
"anchor": "y3",
"domain": [
0,
0.48
]
},
"xaxis4": {
"range": [
-0.01,
1
],
"zeroline": false,
"autorange": "reversed",
"anchor": "y4",
"domain": [
0.52,
1
]
},
"yaxis": {
"range": [
-0.01,
1
],
"zeroline": false,
"domain": [
0,
0.48
]
},
"yaxis2": {
"range": [
-0.01,
1
],
"zeroline": false,
"autorange": "reversed",
"anchor": "x2",
"domain": [
0.52,
1
]
},
"yaxis3": {
"anchor": "x3",
"domain": [
0.52,
1
]
},
"yaxis4": {
"autorange": "reversed",
"anchor": "x4",
"domain": [
0,
0.48
]
}
}
}
63 changes: 48 additions & 15 deletions test/jasmine/tests/bar_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2026,24 +2026,24 @@ describe('A bar plot', function() {
.then(done);
});

function getArea(path) {
var pos = path
.substr(1, path.length - 2)
.replace('V', ',')
.replace('H', ',')
.replace('V', ',')
.split(',');
var dx = +pos[0];
var dy = +pos[1];
dy -= +pos[2];
dx -= +pos[3];

return Math.abs(dx * dy);
}

it('should not show up null and zero bars as thin bars', function(done) {
var mock = Lib.extendDeep({}, require('@mocks/bar_hide_nulls.json'));

function getArea(path) {
var pos = path
.substr(1, path.length - 2)
.replace('V', ',')
.replace('H', ',')
.replace('V', ',')
.split(',');
var dx = +pos[0];
var dy = +pos[1];
dy -= +pos[2];
dx -= +pos[3];

return Math.abs(dx * dy);
}

Plotly.plot(gd, mock)
.then(function() {
var nodes = gd.querySelectorAll('g.point > path');
Expand Down Expand Up @@ -2076,6 +2076,39 @@ describe('A bar plot', function() {
.catch(failTest)
.then(done);
});

describe('show narrow bars', function() {
['initial zoom', 'after zoom out'].forEach(function(zoomStr) {
it(zoomStr, function(done) {
var mock = Lib.extendDeep({}, require('@mocks/bar_show_narrow.json'));

if(zoomStr === 'after zoom out') {
mock.layout.xaxis.range = [-14.9, 17.9];
mock.layout.xaxis2.range = [17.9, -14.9];
mock.layout.xaxis3.range = [-3.9, 4.9];
mock.layout.xaxis4.range = [4.9, -3.9];

mock.layout.yaxis.range = [-3.9, 4.9];
mock.layout.yaxis2.range = [4.9, -3.9];
mock.layout.yaxis3.range = [-14.9, 17.9];
mock.layout.yaxis4.range = [17.9, -14.9];
}

Plotly.plot(gd, mock)
.then(function() {
var nodes = gd.querySelectorAll('g.point > path');
expect(nodes.length).toBe(16, '# of bars');

for(var i = 0; i < 16; i++) {
var d = nodes[i].getAttribute('d');
expect(getArea(d) > 0).toBe(true, 'item:' + i);
}
})
.catch(failTest)
.then(done);
});
});
});
});

describe('bar visibility toggling:', function() {
Expand Down