Skip to content
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

Fix hover filter to display close period points #5543

Merged
merged 7 commits into from
Apr 10, 2021
Merged

Fix hover filter to display close period points #5543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
97a8aef
fix 5292 - only filter close points of the same trace when unified
archmoj Mar 10, 2021
73290c9
add test for unified hover filtering close points
archmoj Mar 10, 2021
6c5a824
Merge remote-tracking branch 'origin/master' into fix5292-unified-hover
archmoj Mar 16, 2021
1e59d89
display period point in hover if the winning point located inside the…
archmoj Mar 24, 2021
f8c019f
add hover test for M1 bars on M3 bars
archmoj Mar 24, 2021
900ded3
correct end of period
archmoj Mar 24, 2021
4d831e2
Merge remote-tracking branch 'origin/master' into fix5292-unified-hover
archmoj Apr 9, 2021
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
27 changes: 23 additions & 4 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ var Drawing = require('../drawing');
var Color = require('../color');
var dragElement = require('../dragelement');
var Axes = require('../../plots/cartesian/axes');
var alignPeriod = require('../../plots/cartesian/align_period');
var Registry = require('../../registry');

var helpers = require('./helpers');
Expand Down Expand Up @@ -779,8 +780,9 @@ function createHoverText(hoverData, opts, gd) {
var c0 = hoverData[0];
var xa = c0.xa;
var ya = c0.ya;
var commonAttr = hovermode.charAt(0) === 'y' ? 'yLabel' : 'xLabel';
var t0 = c0[commonAttr];
var axLetter = hovermode.charAt(0);
var v0 = c0[axLetter + 'LabelVal'];
var t0 = c0[axLetter + 'Label'];
var t00 = (String(t0) || '').split(' ')[0];
var outerContainerBB = outerContainer.node().getBoundingClientRect();
var outerTop = outerContainerBB.top;
Expand Down Expand Up @@ -978,8 +980,25 @@ function createHoverText(hoverData, opts, gd) {

function filterClosePoints(hoverData) {
return hoverData.filter(function(d) {
return (d.zLabelVal !== undefined) ||
(d[commonAttr] || '').split(' ')[0] === t00;
if(d.zLabelVal !== undefined) return true;
if((d[axLetter + 'Label'] || '').split(' ')[0] === t00) return true;
if(d.trace[axLetter + 'period']) {
var v = d[axLetter + 'LabelVal'];
var ax = d[axLetter + 'a'];
var trace = {};
trace[axLetter + 'period'] = d.trace[axLetter + 'period'];
trace[axLetter + 'period0'] = d.trace[axLetter + 'period0'];

trace[axLetter + 'periodalignment'] = 'start';
var start = alignPeriod(trace, ax, axLetter, [v])[0];

trace[axLetter + 'periodalignment'] = 'end';
var end = alignPeriod(trace, ax, axLetter, [v])[0];

if(v0 >= start && v0 < end) return true;
}

return false;
});
}

Expand Down
249 changes: 249 additions & 0 deletions test/jasmine/tests/hover_label_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4749,6 +4749,255 @@ describe('hovermode: (x|y)unified', function() {
.then(done, done.fail);
});

it('case of scatter points on period bars', function(done) {
Plotly.newPlot(gd, {
data: [
{
type: 'bar',
name: 'bar',
x: [
'2017-04',
'2017-07',
'2017-10',
'2018-01'
],
xperiod: 'M3',
y: [10, 5, 10, 5]
},
{
type: 'scatter',
name: 'scatter',
x: [
'2017-01-01',
'2017-02-01',
'2017-03-01',
'2017-04-01',
'2017-05-01',
'2017-06-01',
'2017-07-01',
'2017-08-01',
'2017-09-01',
'2017-10-01',
'2017-11-01',
'2017-12-01'
],
y: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
}
],
layout: {
hovermode: 'x unified',
showlegend: false,
width: 500,
height: 500,
margin: {
t: 50,
b: 50,
l: 50,
r: 50
}
}
})
.then(function(gd) {
_hover(gd, { xpx: 50, ypx: 250 });
assertLabel({title: 'Feb 1, 2017', items: [
'scatter : 2'
]});

_hover(gd, { xpx: 75, ypx: 250 });
assertLabel({title: 'Mar 1, 2017', items: [
'scatter : 3'
]});

_hover(gd, { xpx: 100, ypx: 250 });
assertLabel({title: 'Apr 1, 2017', items: [
'bar : 10',
'scatter : 4'
]});

_hover(gd, { xpx: 125, ypx: 250 });
assertLabel({title: 'May 1, 2017', items: [
'bar : (Apr 1, 2017, 10)',
'scatter : 5'
]});

_hover(gd, { xpx: 150, ypx: 250 });
assertLabel({title: 'Jun 1, 2017', items: [
'bar : (Apr 1, 2017, 10)',
'scatter : 6'
]});

_hover(gd, { xpx: 175, ypx: 250 });
assertLabel({title: 'Jul 1, 2017', items: [
'bar : 5',
'scatter : 7'
]});

_hover(gd, { xpx: 200, ypx: 250 });
assertLabel({title: 'Aug 1, 2017', items: [
'bar : (Jul 1, 2017, 5)',
'scatter : 8'
]});

_hover(gd, { xpx: 225, ypx: 250 });
assertLabel({title: 'Sep 1, 2017', items: [
'bar : (Jul 1, 2017, 5)',
'scatter : 9'
]});

_hover(gd, { xpx: 250, ypx: 250 });
assertLabel({title: 'Oct 1, 2017', items: [
'bar : 10',
'scatter : 10'
]});

_hover(gd, { xpx: 275, ypx: 250 });
assertLabel({title: 'Nov 1, 2017', items: [
'bar : (Oct 1, 2017, 10)',
'scatter : 11'
]});

_hover(gd, { xpx: 300, ypx: 250 });
assertLabel({title: 'Dec 1, 2017', items: [
'bar : (Oct 1, 2017, 10)',
'scatter : 12'
]});

_hover(gd, { xpx: 350, ypx: 250 });
assertLabel({title: 'Jan 1, 2018', items: [
'bar : 5'
]});
})
.then(done, done.fail);
});

it('case of M1 period bars overlaid on M3 period bars', function(done) {
Plotly.newPlot(gd, {
data: [
{
type: 'bar',
name: 'M3',
xperiod: 'M3',
x: [
'2017-04',
'2017-07',
'2017-10',
'2018-01'
],
y: [10, 5, 10, 5]
},
{
type: 'bar',
name: 'M1',
xperiod: 'M1',
x: [
'2017-01',
'2017-02',
'2017-03',
'2017-04',
'2017-05',
'2017-06',
'2017-07',
'2017-08',
'2017-09',
'2017-10',
'2017-11',
'2017-12'
],
y: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
}
],
layout: {
barmode: 'overlay',
hovermode: 'x unified',
showlegend: false,
width: 500,
height: 500,
margin: {
t: 50,
b: 50,
l: 50,
r: 50
}
}
})
.then(function(gd) {
_hover(gd, { xpx: 25, ypx: 250 });
assertLabel({title: 'Jan 1, 2017', items: [
'M1 : 1'
]});

_hover(gd, { xpx: 50, ypx: 250 });
assertLabel({title: 'Feb 1, 2017', items: [
'M1 : 2'
]});

_hover(gd, { xpx: 75, ypx: 250 });
assertLabel({title: 'Mar 1, 2017', items: [
'M1 : 3'
]});

_hover(gd, { xpx: 100, ypx: 250 });
assertLabel({title: 'Apr 1, 2017', items: [
'M3 : 10',
'M1 : 4'
]});

_hover(gd, { xpx: 125, ypx: 250 });
assertLabel({title: 'May 1, 2017', items: [
'M3 : (Apr 1, 2017, 10)',
'M1 : 5'
]});

_hover(gd, { xpx: 150, ypx: 250 });
assertLabel({title: 'Jun 1, 2017', items: [
'M3 : (Apr 1, 2017, 10)',
'M1 : 6'
]});

_hover(gd, { xpx: 175, ypx: 250 });
assertLabel({title: 'Jul 1, 2017', items: [
'M3 : 5',
'M1 : 7'
]});

_hover(gd, { xpx: 200, ypx: 250 });
assertLabel({title: 'Aug 1, 2017', items: [
'M3 : (Jul 1, 2017, 5)',
'M1 : 8'
]});

_hover(gd, { xpx: 225, ypx: 250 });
assertLabel({title: 'Sep 1, 2017', items: [
'M3 : (Jul 1, 2017, 5)',
'M1 : 9'
]});

_hover(gd, { xpx: 250, ypx: 250 });
assertLabel({title: 'Oct 1, 2017', items: [
'M3 : 10',
'M1 : 10'
]});

_hover(gd, { xpx: 275, ypx: 250 });
assertLabel({title: 'Nov 1, 2017', items: [
'M3 : (Oct 1, 2017, 10)',
'M1 : 11'
]});

_hover(gd, { xpx: 300, ypx: 250 });
assertLabel({title: 'Dec 1, 2017', items: [
'M3 : (Oct 1, 2017, 10)',
'M1 : 12'
]});

_hover(gd, { xpx: 350, ypx: 250 });
assertLabel({title: 'Jan 1, 2018', items: [
'M3 : 5'
]});
})
.then(done, done.fail);
});

it('should have the same traceorder as the legend', function(done) {
var mock = require('@mocks/stacked_area.json');
var mockCopy = Lib.extendDeep({}, mock);
Expand Down