Skip to content

Commit 8230da5

Browse files
etpinardetpinard
authored
Merge pull request #4269 from plotly/fix-rehover-on-exiting-subplots
Do not attempt to re-hover on exiting subplots
2 parents b3c1e7a + f6a47b2 commit 8230da5

File tree

5 files changed

+132
-19
lines changed

5 files changed

+132
-19
lines changed

‎src/components/fx/hover.js

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -224,24 +224,20 @@ function _hover(gd, evt, subplot, noHoverEvent) {
224224
for(var i = 0; i < len; i++) {
225225
var spId = subplots[i];
226226

227-
// 'cartesian' case
228-
var plotObj = plots[spId];
229-
if(plotObj) {
227+
if(plots[spId]) {
228+
// 'cartesian' case
230229
supportsCompare = true;
231-
232-
// TODO make sure that fullLayout_plots axis refs
233-
// get updated properly so that we don't have
234-
// to use Axes.getFromId in general.
235-
236-
xaArray[i] = Axes.getFromId(gd, plotObj.xaxis._id);
237-
yaArray[i] = Axes.getFromId(gd, plotObj.yaxis._id);
238-
continue;
230+
xaArray[i] = plots[spId].xaxis;
231+
yaArray[i] = plots[spId].yaxis;
232+
} else if(fullLayout[spId] && fullLayout[spId]._subplot) {
233+
// other subplot types
234+
var _subplot = fullLayout[spId]._subplot;
235+
xaArray[i] = _subplot.xaxis;
236+
yaArray[i] = _subplot.yaxis;
237+
} else {
238+
Lib.warn('Unrecognized subplot: ' + spId);
239+
return;
239240
}
240-
241-
// other subplot types
242-
var _subplot = fullLayout[spId]._subplot;
243-
xaArray[i] = _subplot.xaxis;
244-
yaArray[i] = _subplot.yaxis;
245241
}
246242

247243
var hovermode = evt.hovermode || fullLayout.hovermode;

‎src/plots/cartesian/graph_interact.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ exports.initInteractions = function initInteractions(gd) {
5959
// This is on `gd._fullLayout`, *not* fullLayout because the reference
6060
// changes by the time this is called again.
6161
gd._fullLayout._rehover = function() {
62-
if(gd._fullLayout._hoversubplot === subplot) {
62+
if((gd._fullLayout._hoversubplot === subplot) && gd._fullLayout._plots[subplot]) {
6363
Fx.hover(gd, evt, subplot);
6464
}
6565
};

‎src/plots/mapbox/mapbox.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,7 @@ proto.initFx = function(calcData, fullLayout) {
475475
self.yaxis.p2c = function() { return evt.lngLat.lat; };
476476

477477
gd._fullLayout._rehover = function() {
478-
if(gd._fullLayout._hoversubplot === self.id) {
478+
if(gd._fullLayout._hoversubplot === self.id && gd._fullLayout[self.id]) {
479479
Fx.hover(gd, evt, self.id);
480480
}
481481
};

‎test/jasmine/tests/hover_label_test.js

Lines changed: 85 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,41 @@ function touch(path, options) {
3636
return;
3737
}
3838

39+
describe('Fx.hover:', function() {
40+
var gd;
41+
42+
beforeEach(function() { gd = createGraphDiv(); });
43+
44+
afterEach(destroyGraphDiv);
45+
46+
it('should warn when passing subplot ids that are not part of the graph', function(done) {
47+
spyOn(Lib, 'warn');
48+
49+
var data = [
50+
{y: [1], hoverinfo: 'y'}
51+
];
52+
53+
var layout = {
54+
xaxis: {domain: [0, 0.5]},
55+
xaxis2: {anchor: 'y2', domain: [0.5, 1]},
56+
yaxis2: {anchor: 'x2'},
57+
width: 400,
58+
height: 200,
59+
margin: {l: 0, t: 0, r: 0, b: 0},
60+
showlegend: false
61+
};
62+
63+
Plotly.plot(gd, data, layout)
64+
.then(function() {
65+
Fx.hover(gd, {xpx: 300, ypx: 100}, 'x2y2');
66+
expect(gd._hoverdata).toBe(undefined, 'did not generate hoverdata');
67+
expect(Lib.warn).toHaveBeenCalledWith('Unrecognized subplot: x2y2');
68+
})
69+
.catch(failTest)
70+
.then(done);
71+
});
72+
});
73+
3974
describe('hover info', function() {
4075
'use strict';
4176

@@ -2150,7 +2185,6 @@ describe('hover info on stacked subplots', function() {
21502185
});
21512186
});
21522187

2153-
21542188
describe('hover on many lines+bars', function() {
21552189
'use strict';
21562190

@@ -2607,6 +2641,56 @@ describe('hover updates', function() {
26072641
})
26082642
.then(done);
26092643
});
2644+
2645+
it('should not attempt to rehover over exiting subplots', function(done) {
2646+
spyOn(Fx, 'hover').and.callThrough();
2647+
2648+
var data = [
2649+
{y: [1], hoverinfo: 'y'},
2650+
{y: [2], hoverinfo: 'y', xaxis: 'x2', yaxis: 'y2'}
2651+
];
2652+
2653+
var data2 = [
2654+
{y: [1], hoverinfo: 'y'}
2655+
];
2656+
2657+
var layout = {
2658+
xaxis: {domain: [0, 0.5]},
2659+
xaxis2: {anchor: 'y2', domain: [0.5, 1]},
2660+
yaxis2: {anchor: 'x2'},
2661+
width: 400,
2662+
height: 200,
2663+
margin: {l: 0, t: 0, r: 0, b: 0},
2664+
showlegend: false
2665+
};
2666+
2667+
var gd = createGraphDiv();
2668+
var onPt2 = [300, 100];
2669+
var offPt2 = [250, 100];
2670+
2671+
Plotly.react(gd, data, layout)
2672+
.then(function() {
2673+
assertLabelsCorrect(onPt2, [303, 100], '2', 'after 1st draw [on-pt]');
2674+
assertLabelsCorrect(offPt2, null, null, 'after 1st draw [off-pt]');
2675+
expect(Fx.hover).toHaveBeenCalledTimes(2);
2676+
})
2677+
.then(function() {
2678+
var promise = Plotly.react(gd, data2, layout);
2679+
assertLabelsCorrect(onPt2, null, null, '2', 'before react() resolves [on-pt]');
2680+
assertLabelsCorrect(offPt2, null, null, 'before react() resolves [off-pt]');
2681+
// N.B. no calls from Plots.rehover() as x2y2 subplot got removed!
2682+
expect(Fx.hover).toHaveBeenCalledTimes(2);
2683+
return promise;
2684+
})
2685+
.then(function() {
2686+
expect(Fx.hover).toHaveBeenCalledTimes(2);
2687+
assertLabelsCorrect(onPt2, null, null, '2', 'after react() resolves [on-pt]');
2688+
assertLabelsCorrect(offPt2, null, null, 'after react() resolves [off-pt]');
2689+
expect(Fx.hover).toHaveBeenCalledTimes(2);
2690+
})
2691+
.catch(failTest)
2692+
.then(done);
2693+
});
26102694
});
26112695

26122696
describe('Test hover label custom styling:', function() {

‎test/jasmine/tests/mapbox_test.js

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
var Plotly = require('@lib');
22
var Lib = require('@src/lib');
3+
var Fx = require('@src/components/fx');
34

45
var constants = require('@src/plots/mapbox/constants');
56
var supplyLayoutDefaults = require('@src/plots/mapbox/layout_defaults');
@@ -1155,6 +1156,38 @@ describe('@noCI, mapbox plots', function() {
11551156
.then(done);
11561157
}, LONG_TIMEOUT_INTERVAL);
11571158

1159+
it('@gl should not attempt to rehover over exiting subplots', function(done) {
1160+
spyOn(Fx, 'hover').and.callThrough();
1161+
1162+
function countHoverLabels() {
1163+
return d3.select('.hoverlayer').selectAll('g').size();
1164+
}
1165+
1166+
Promise.resolve()
1167+
.then(function() {
1168+
return _mouseEvent('mousemove', pointPos, function() {
1169+
expect(countHoverLabels()).toEqual(1);
1170+
expect(Fx.hover).toHaveBeenCalledTimes(1);
1171+
expect(Fx.hover.calls.argsFor(0)[2]).toBe('mapbox');
1172+
Fx.hover.calls.reset();
1173+
});
1174+
})
1175+
.then(function() { return Plotly.deleteTraces(gd, [0, 1]); })
1176+
.then(delay(10))
1177+
.then(function() {
1178+
return _mouseEvent('mousemove', pointPos, function() {
1179+
expect(countHoverLabels()).toEqual(0);
1180+
// N.B. no additional calls from Plots.rehover()
1181+
// (as 'mapbox' subplot is gone),
1182+
// just one on the fallback xy subplot
1183+
expect(Fx.hover).toHaveBeenCalledTimes(1);
1184+
expect(Fx.hover.calls.argsFor(0)[2]).toBe('xy');
1185+
});
1186+
})
1187+
.catch(failTest)
1188+
.then(done);
1189+
}, LONG_TIMEOUT_INTERVAL);
1190+
11581191
it('@gl should respond drag / scroll / double-click interactions', function(done) {
11591192
var relayoutCnt = 0;
11601193
var doubleClickCnt = 0;

0 commit comments

Comments
 (0)