Skip to content

Skip "hoverinfo": "none" trace display for hover modes #5854

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 19 commits into from
Oct 7, 2021
Merged

Skip "hoverinfo": "none" trace display for hover modes #5854

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d2db27d
Skip "hoverinfo": "none"
Domino987 Jul 26, 2021
aee42e0
add draft logs
Jul 26, 2021
0e897b5
improve fitlering of hover data
Jul 26, 2021
6c181f6
Update log
Jul 26, 2021
b116dc1
move filter to unified only
Jul 26, 2021
8f5f3d5
guard for no hover labels
Aug 4, 2021
b08416b
Merge remote-tracking branch 'upstream/master' into patch-2
Aug 4, 2021
b0eb6db
revert changes to hover.js
archmoj Aug 5, 2021
c52953d
do not display points with none hoverinfo in unified modes
archmoj Aug 5, 2021
f41a601
Merge pull request #1 from plotly/pull-5854_dev
Domino987 Aug 5, 2021
3fe967f
Add tribute text
Domino987 Aug 5, 2021
ccd86f0
add test for hoverinfo: none
Domino987 Aug 16, 2021
27d1e12
add early eject for no labels to be drawn
Domino987 Aug 16, 2021
558a61b
return empty array for early eject
Domino987 Aug 16, 2021
897d1f7
fix test of package json
Domino987 Aug 16, 2021
285da63
fix linting
Domino987 Aug 16, 2021
e0cf3a7
Only filter hovermode none for grouped label
Domino987 Aug 25, 2021
5ce3977
move hoverinfo: 'none' down in test
Domino987 Oct 5, 2021
0d9a1be
fix should not display hover for display: none
Domino987 Oct 7, 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
1 change: 1 addition & 0 deletions draftlogs/5854_fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Skip `"hoverinfo": "none"` trace display for hover modes [[#5854](https://github.com/plotly/plotly.js/pull/5854)], with thanks to @Domino987 for the contribution!
29 changes: 17 additions & 12 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -818,6 +818,8 @@ function createHoverText(hoverData, opts, gd) {
var container = opts.container;
var outerContainer = opts.outerContainer;
var commonLabelOpts = opts.commonLabelOpts || {};
// Early exit if no labels are drawn
if(hoverData.length === 0) return [[]];

// opts.fontFamily/Size are used for the common label
// and as defaults for each hover label, though the individual labels
Expand Down Expand Up @@ -1024,9 +1026,9 @@ function createHoverText(hoverData, opts, gd) {
if(helpers.isUnifiedHover(hovermode)) {
// Delete leftover hover labels from other hovermodes
container.selectAll('g.hovertext').remove();

var groupedHoverData = hoverData.filter(function(data) {return data.hoverinfo !== 'none';});
// Return early if nothing is hovered on
if(hoverData.length === 0) return;
if(groupedHoverData.length === 0) return;

// mock legend
var mockLayoutIn = {
Expand All @@ -1048,11 +1050,14 @@ function createHoverText(hoverData, opts, gd) {

// prepare items for the legend
mockLegend.entries = [];
for(var j = 0; j < hoverData.length; j++) {
var texts = getHoverLabelText(hoverData[j], true, hovermode, fullLayout, t0);
for(var j = 0; j < groupedHoverData.length; j++) {
var pt = groupedHoverData[j];
if(pt.hoverinfo === 'none') continue;

var texts = getHoverLabelText(pt, true, hovermode, fullLayout, t0);
var text = texts[0];
var name = texts[1];
var pt = hoverData[j];

pt.name = name;
if(name !== '') {
pt.text = name + ' : ' + text;
Expand Down Expand Up @@ -1087,7 +1092,7 @@ function createHoverText(hoverData, opts, gd) {
var tbb = legendContainer.node().getBoundingClientRect();
var tWidth = tbb.width + 2 * HOVERTEXTPAD;
var tHeight = tbb.height + 2 * HOVERTEXTPAD;
var winningPoint = hoverData[0];
var winningPoint = groupedHoverData[0];
var avgX = (winningPoint.x0 + winningPoint.x1) / 2;
var avgY = (winningPoint.y0 + winningPoint.y1) / 2;
// When a scatter (or e.g. heatmap) point wins, it's OK for the hovelabel to occlude the bar and other points.
Expand All @@ -1102,11 +1107,11 @@ function createHoverText(hoverData, opts, gd) {
lyTop = avgY - HOVERTEXTPAD;
lyBottom = avgY + HOVERTEXTPAD;
} else {
lyTop = Math.min.apply(null, hoverData.map(function(c) { return Math.min(c.y0, c.y1); }));
lyBottom = Math.max.apply(null, hoverData.map(function(c) { return Math.max(c.y0, c.y1); }));
lyTop = Math.min.apply(null, groupedHoverData.map(function(c) { return Math.min(c.y0, c.y1); }));
lyBottom = Math.max.apply(null, groupedHoverData.map(function(c) { return Math.max(c.y0, c.y1); }));
}
} else {
lyTop = lyBottom = Lib.mean(hoverData.map(function(c) { return (c.y0 + c.y1) / 2; })) - tHeight / 2;
lyTop = lyBottom = Lib.mean(groupedHoverData.map(function(c) { return (c.y0 + c.y1) / 2; })) - tHeight / 2;
}

var lxRight, lxLeft;
Expand All @@ -1115,11 +1120,11 @@ function createHoverText(hoverData, opts, gd) {
lxRight = avgX + HOVERTEXTPAD;
lxLeft = avgX - HOVERTEXTPAD;
} else {
lxRight = Math.max.apply(null, hoverData.map(function(c) { return Math.max(c.x0, c.x1); }));
lxLeft = Math.min.apply(null, hoverData.map(function(c) { return Math.min(c.x0, c.x1); }));
lxRight = Math.max.apply(null, groupedHoverData.map(function(c) { return Math.max(c.x0, c.x1); }));
lxLeft = Math.min.apply(null, groupedHoverData.map(function(c) { return Math.min(c.x0, c.x1); }));
}
} else {
lxRight = lxLeft = Lib.mean(hoverData.map(function(c) { return (c.x0 + c.x1) / 2; })) - tWidth / 2;
lxRight = lxLeft = Lib.mean(groupedHoverData.map(function(c) { return (c.x0 + c.x1) / 2; })) - tWidth / 2;
}

var xOffset = xa._offset;
Expand Down
68 changes: 68 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 @@ -4601,6 +4601,74 @@ describe('hovermode: (x|y)unified', function() {
.then(done, done.fail);
});

it('should not display hover for display: none', function(done) {
Copy link
Contributor

Choose a reason for hiding this comment

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

This test fails on CircleCI. Does it pass on your machine?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No it does not and I have problems with the tests in the first place on my machine, since its a windows.
But yes, that should work.

Copy link
Contributor

Choose a reason for hiding this comment

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

The test is not passing.
Please simply replace it with

it('should not display hover for display: none', function(done) {
        Plotly.newPlot(gd, {
            data: [{
                name: 'A',
                y: [1]
            }, {
                name: 'B',
                y: [2],
                hoverinfo: 'none'
            }],
            layout: {
                hovermode: 'x unified',
                showlegend: false,
                width: 500,
                height: 500,
                margin: {
                    t: 50,
                    b: 50,
                    l: 50,
                    r: 50
                }
            }
        })
        .then(function() {
            _hover(gd, { xpx: 200, ypx: 200 });
            assertLabel({title: '0', items: [
                'A : 1'
            ]});
        })
        .then(done, done.fail);
    });

Copy link
Contributor

Choose a reason for hiding this comment

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

@Domino987 Could you please adjust the test as mentioned above? It looks like the only remaining item here.

var x1 = [];
var y1 = [];
var x2 = [];
var y2 = [];
var i, t;

function r100(v) {
return Math.round(v * 100);
}

for(i = 0; i <= 1800; i++) {
t = i / 180 * Math.PI;
x1.push(r100(t / 5));
y1.push(r100(Math.sin(t)));
}

for(i = 0; i <= 360; i++) {
t = i / 180 * Math.PI;
x2.push(r100(t));
y2.push(r100(Math.sin(t)));
}

Plotly.newPlot(gd, {
data: [{
name: 'high',
x: x1,
y: y1,
hoverinfo: 'none'
}, {
name: 'low',
x: x2,
y: y2
}],
layout: {
hovermode: 'x unified',
showlegend: false,
width: 500,
height: 500,
margin: {
t: 50,
b: 50,
l: 50,
r: 50
}
}
})
.then(function() {
_hover(gd, { xpx: 100, ypx: 200 });
assertLabel({title: '157', items: [
'low : 100'
]});
})
.then(function() {
_hover(gd, { xpx: 175, ypx: 200 });
assertLabel({title: '274', items: [
'low : 39'
]});
})
.then(function() {
_hover(gd, { xpx: 350, ypx: 200 });
assertLabel({title: '550', items: [
'low : −71'
]});
})
.then(done, done.fail);
});

it('y unified should work for x/y cartesian traces', function(done) {
var mockCopy = Lib.extendDeep({}, mock);
mockCopy.layout.hovermode = 'y unified';
Expand Down