Skip to content

histogram: in hover labels, harmonize start/end values of shared bins #4662

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 2 commits into from
Mar 19, 2020
Merged

histogram: in hover labels, harmonize start/end values of shared bins #4662

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec448f2
histogram: in hover labels, harmonize start/end values of shared bins
antoinerg Mar 16, 2020
c387f9b
histogram: improve code readability of calc
antoinerg Mar 19, 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
8 changes: 8 additions & 0 deletions src/traces/bar/cross_trace_calc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,14 @@ function crossTraceCalc(gd, plotinfo) {
} else {
calcTracesVert.push(calcTraces[i]);
}

if(fullTrace._computePh) {
var cd = gd.calcdata[i];
for(var j = 0; j < cd.length; j++) {
if(typeof cd[j].ph0 === 'function') cd[j].ph0 = cd[j].ph0();
if(typeof cd[j].ph1 === 'function') cd[j].ph1 = cd[j].ph1();
}
}
}
}

Expand Down
23 changes: 20 additions & 3 deletions src/traces/histogram/calc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,20 @@ function calc(gd, trace) {
};
}

if(!gd._fullLayout._roundFnOpts) gd._fullLayout._roundFnOpts = {};
var groupName = trace['_' + mainData + 'bingroup'];
var roundFnOpts = {leftGap: Infinity, rightGap: Infinity};
if(groupName) {
if(!gd._fullLayout._roundFnOpts[groupName]) gd._fullLayout._roundFnOpts[groupName] = roundFnOpts;
roundFnOpts = gd._fullLayout._roundFnOpts[groupName];
Copy link
Contributor

Choose a reason for hiding this comment

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

Non-blocking,
We could rewrite this:

if(!gd._fullLayout._roundFnOpts[groupName]) {
  gd._fullLayout._roundFnOpts[groupName] = roundFnOpts;
}
roundFnOpts = gd._fullLayout._roundFnOpts[groupName];

to make it easier to read 3 gd._fullLayout._roundFnOpts[groupName].

}

// bin the data
// and make histogram-specific pt-number-to-cd-index map object
var nMax = size.length;
var uniqueValsPerBin = true;
var leftGap = Infinity;
var rightGap = Infinity;
var leftGap = roundFnOpts.leftGap;
var rightGap = roundFnOpts.rightGap;
var ptNumber2cdIndex = {};
for(i = 0; i < pos0.length; i++) {
var posi = pos0[i];
Expand All @@ -124,10 +132,17 @@ function calc(gd, trace) {
rightGap = Math.min(rightGap, binEdges[n + 1] - posi);
}
}
roundFnOpts.leftGap = leftGap;
roundFnOpts.rightGap = rightGap;

var roundFn;
if(!uniqueValsPerBin) {
roundFn = getBinSpanLabelRound(leftGap, rightGap, binEdges, pa, calendar);
roundFn = function(v, isRightEdge) {
return function() {
var roundFnOpts = gd._fullLayout._roundFnOpts[groupName];
return getBinSpanLabelRound(roundFnOpts.leftGap, roundFnOpts.rightGap, binEdges, pa, calendar)(v, isRightEdge);
Copy link
Contributor

Choose a reason for hiding this comment

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

This line is getting little too long. Maybe:

return getBinSpanLabelRound(
  roundFnOpts.leftGap, 
  roundFnOpts.rightGap, 
  binEdges, pa, calendar
)(v, isRightEdge);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done in c387f9b

};
};
}

// average and/or normalize the data, if needed
Expand Down Expand Up @@ -173,6 +188,8 @@ function calc(gd, trace) {
if(uniqueValsPerBin) {
cdi.ph0 = cdi.ph1 = (inputPoints[i].length) ? pos0[inputPoints[i][0]] : pos[i];
} else {
// Defer evaluation of ph(0|1) in crossTraceCalc
trace._computePh = true;
cdi.ph0 = roundFn(binEdges[i]);
cdi.ph1 = roundFn(binEdges[i + 1], true);
}
Expand Down
18 changes: 18 additions & 0 deletions test/jasmine/tests/histogram_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -585,6 +585,7 @@ describe('Test histogram', function() {
// even though -0 === 0
out.forEach(function(cdi) {
for(var key in cdi) {
if(typeof cdi[key] === 'function') cdi[key] = cdi[key]();
if(cdi[key] === 0) cdi[key] = 0;
}
});
Expand Down Expand Up @@ -861,6 +862,23 @@ describe('Test histogram', function() {
expect(calcPositions(trace2, [trace1])).toEqual([5, 7]);
});

it('harmonizes start/end value of bins when all traces are autobinned', function(done) {
var mock = require('@mocks/histogram_overlay-bingroup');
var gd = createGraphDiv();
Plotly.newPlot(gd, mock)
.then(function(gd) {
destroyGraphDiv();
var cd0 = gd.calcdata[0];
var cd1 = gd.calcdata[1];
for(var i = 0; i < cd0.length && i < cd1.length; i++) {
expect(cd0[i].ph0).toBe(cd1[i].ph0);
expect(cd0[i].ph1).toBe(cd1[i].ph1);
}
})
.catch(failTest)
.then(done);
});

it('autobins all data as one', function() {
// all integers, so all autobins should get shifted to start 0.5 lower
// than they otherwise would.
Expand Down