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

Ensure winning points of hover are listed first when hoversubplots is set to "axis" and sorting by distance #6963

Merged
merged 5 commits into from
Apr 15, 2024
+71 −5
Merged

Ensure winning points of hover are listed first when hoversubplots is set to "axis" and sorting by distance #6963

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0eaec35
fix (x|y) spike position and ensure main subplot hover points are sor…
archmoj Apr 12, 2024
1ab4e1a
jasmine test
archmoj Apr 12, 2024
337cda0
draftlog
archmoj Apr 12, 2024
bb704dc
Merge remote-tracking branch 'origin/master' into fix6960-hoversubplots
archmoj Apr 14, 2024
5b6998d
comment
archmoj Apr 15, 2024
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
1 change: 1 addition & 0 deletions draftlogs/6963_fix.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Ensure winning points of hover are listed first when hoversubplots is set to "axis" and sorting by distance [[#6963](https://github.com/plotly/plotly.js/pull/6963)]
38 changes: 34 additions & 4 deletions src/components/fx/hover.js
View file
Original file line number Diff line number Diff line change
@@ -53,6 +53,10 @@ var cartesianScatterPoints = {
splom: true
};

function distanceSort(a, b) {
return a.distance - b.distance;
}

// fx.hover: highlight data on hover
// evt can be a mousemove event, or an object with data about what points
// to hover on
@@ -270,15 +274,21 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
var hovermodeHasX = (hovermode || '').charAt(0) === 'x';
var hovermodeHasY = (hovermode || '').charAt(0) === 'y';

var firstXaxis;
var firstYaxis;

if(hasCartesian && (hovermodeHasX || hovermodeHasY) && hoversubplots === 'axis') {
var subplotsLength = subplots.length;
for(var p = 0; p < subplotsLength; p++) {
spId = subplots[p];
if(plots[spId]) {
// 'cartesian' case

firstXaxis = Axes.getFromId(gd, spId, 'x');
firstYaxis = Axes.getFromId(gd, spId, 'y');

var subplotsWith = (
Axes.getFromId(gd, spId, hovermodeHasX ? 'x' : 'y')
hovermodeHasX ? firstXaxis : firstYaxis
)._subplotsWith;

if(subplotsWith && subplotsWith.length) {
@@ -661,6 +671,9 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
var thisSpikeDistance;

for(var i = 0; i < pointsData.length; i++) {
if(firstXaxis && firstXaxis._id !== pointsData[i].xa._id) continue;
if(firstYaxis && firstYaxis._id !== pointsData[i].ya._id) continue;

thisSpikeDistance = pointsData[i].spikeDistance;
if(spikeOnWinning && i === 0) thisSpikeDistance = -Infinity;

@@ -700,9 +713,26 @@ function _hover(gd, evt, subplot, noHoverEvent, eventTarget) {
gd._spikepoints = newspikepoints;

var sortHoverData = function() {
Copy link
Contributor

Choose a reason for hiding this comment

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

@archmoj Could you add a comment here explaining the new sorting logic?

if(hoversubplots !== 'axis') {
hoverData.sort(function(d1, d2) { return d1.distance - d2.distance; });
}
// When sorting keep the points in the main subplot at the top
// then add points in other subplots

var hoverDataInSubplot = hoverData.filter(function(a) {
Copy link
Contributor

Choose a reason for hiding this comment

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

naming suggestion -- should these functions be called hoverDataInMainSubplot and hoverDataNotInMainSubplot then?

return (
(firstXaxis && firstXaxis._id === a.xa._id) &&
(firstYaxis && firstYaxis._id === a.ya._id)
);
});

var hoverDataOutSubplot = hoverData.filter(function(a) {
return !(
(firstXaxis && firstXaxis._id === a.xa._id) &&
(firstYaxis && firstYaxis._id === a.ya._id)
);
});

hoverDataInSubplot.sort(distanceSort);
hoverDataOutSubplot.sort(distanceSort);
hoverData = hoverDataInSubplot.concat(hoverDataOutSubplot);

// move period positioned points and box/bar-like traces to the end of the list
hoverData = orderRangePoints(hoverData, hovermode);
37 changes: 36 additions & 1 deletion test/jasmine/tests/hover_label_test.js
View file
Original file line number Diff line number Diff line change
@@ -2445,6 +2445,12 @@ describe('hover on subplots when hoversubplots is set to *single* and x hovermod
});
});

function assertFirstPointOn(gd, xaxisId, yaxisId) {
// first point should be on the main subplot
expect(gd._hoverdata[0].xaxis._id).toBe(xaxisId);
expect(gd._hoverdata[0].yaxis._id).toBe(yaxisId);
}

describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes', function() {
'use strict';

@@ -2494,6 +2500,9 @@ describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {xval: pos}, subplot);
expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x', 'y');

assertHoverLabelContent({
nums: ['1', '10', '100'],
name: ['trace 0', 'trace 1', 'trace 2'],
@@ -2505,6 +2514,8 @@ describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {xval: pos}, subplot);

assertFirstPointOn(gd, 'x', 'y2');

expect(gd._hoverdata.length).toBe(3);
assertHoverLabelContent({
nums: ['2', '20', '200'],
@@ -2517,6 +2528,8 @@ describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {xval: pos}, subplot);

assertFirstPointOn(gd, 'x', 'y3');

expect(gd._hoverdata.length).toBe(3);
assertHoverLabelContent({
nums: ['3', '30', '300'],
@@ -2530,6 +2543,8 @@ describe('hover on subplots when hoversubplots is set to *axis* and x hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {xval: pos}, subplot);
expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x', 'y');
});
});

@@ -2582,6 +2597,9 @@ describe('hover on subplots when hoversubplots is set to *axis* and y hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {yval: pos}, subplot);
expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x', 'y');

assertHoverLabelContent({
nums: ['1', '10', '100'],
name: ['trace 0', 'trace 1', 'trace 2'],
@@ -2594,6 +2612,9 @@ describe('hover on subplots when hoversubplots is set to *axis* and y hovermodes
Plotly.Fx.hover(gd, {yval: pos}, subplot);

expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x2', 'y');

assertHoverLabelContent({
nums: ['2', '20', '200'],
name: ['trace 0', 'trace 1', 'trace 2'],
@@ -2606,6 +2627,9 @@ describe('hover on subplots when hoversubplots is set to *axis* and y hovermodes
Plotly.Fx.hover(gd, {yval: pos}, subplot);

expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x3', 'y');

assertHoverLabelContent({
nums: ['3', '30', '300'],
name: ['trace 0', 'trace 1', 'trace 2'],
@@ -2618,6 +2642,8 @@ describe('hover on subplots when hoversubplots is set to *axis* and y hovermodes
Lib.clearThrottle();
Plotly.Fx.hover(gd, {yval: pos}, subplot);
expect(gd._hoverdata.length).toBe(3);

assertFirstPointOn(gd, 'x', 'y');
});
});

@@ -2640,6 +2666,7 @@ describe('splom hover on subplots when hoversubplots is set to *axis* and (x|y)
it('splom hoversubplots: *axis*', function() {
Lib.clearThrottle();
Plotly.Fx.hover(gd, {x: 200, y: 200}, 'xy');
assertFirstPointOn(gd, 'x', 'y');
expect(gd._hoverdata.length).toBe(2);
assertHoverLabelContent({
nums: ['100', '100k'],
@@ -2648,14 +2675,15 @@ describe('splom hover on subplots when hoversubplots is set to *axis* and (x|y)
});

Plotly.relayout(gd, 'hovermode', 'x unified');

Lib.clearThrottle();
Plotly.Fx.hover(gd, {x: 200, y: 200}, 'xy');
assertFirstPointOn(gd, 'x', 'y');
expect(gd._hoverdata.length).toBe(2);

Plotly.relayout(gd, 'hovermode', 'y unified');
Lib.clearThrottle();
Plotly.Fx.hover(gd, {x: 200, y: 200}, 'xy');
assertFirstPointOn(gd, 'x', 'y');
expect(gd._hoverdata.length).toBe(2);
});
});
@@ -2696,6 +2724,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should
it('splom *axis* hoversubplots', function() {
Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'xy');
assertFirstPointOn(gd, 'x', 'y');
expect(gd._hoverdata.length).toBe(4);
assertHoverLabelContent({
nums: ['1', '1', '1', '1'],
@@ -2705,6 +2734,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'xy2');
assertFirstPointOn(gd, 'x', 'y2');
expect(gd._hoverdata.length).toBe(3);
assertHoverLabelContent({
nums: ['1', '2', '2'],
@@ -2714,6 +2744,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'xy3');
assertFirstPointOn(gd, 'x', 'y3');
expect(gd._hoverdata.length).toBe(3);
assertHoverLabelContent({
nums: ['1', '2', '2'],
@@ -2723,6 +2754,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'xy4');
assertFirstPointOn(gd, 'x', 'y4');
expect(gd._hoverdata.length).toBe(4);
assertHoverLabelContent({
nums: ['1', '3', '3', '3'],
@@ -2732,6 +2764,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'x2y');
assertFirstPointOn(gd, 'x2', 'y');
expect(gd._hoverdata.length).toBe(4);
assertHoverLabelContent({
nums: ['1', '3', '3', '3'],
@@ -2741,6 +2774,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'x3y');
assertFirstPointOn(gd, 'x3', 'y');
expect(gd._hoverdata.length).toBe(4);
assertHoverLabelContent({
nums: ['1', '3', '3', '3'],
@@ -2750,6 +2784,7 @@ describe('splom hover *axis* hoversubplots splom points on same position should

Lib.clearThrottle();
Plotly.Fx.hover(gd, {}, 'x4y');
assertFirstPointOn(gd, 'x4', 'y');
expect(gd._hoverdata.length).toBe(4);
assertHoverLabelContent({
nums: ['1', '3', '3', '3'],