Skip to content

Handle hover over rangebreaks for bar-like traces #4644

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 1 commit into from
Mar 16, 2020
Merged

Handle hover over rangebreaks for bar-like traces #4644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/traces/bar/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ var Color = require('../../components/color');
var fillText = require('../../lib').fillText;
var getLineWidth = require('./helpers').getLineWidth;
var hoverLabelText = require('../../plots/cartesian/axes').hoverLabelText;
var BADNUM = require('../../constants/numerical').BADNUM;

function hoverPoints(pointData, xval, yval, hovermode) {
var barPointData = hoverOnBars(pointData, xval, yval, hovermode);
Expand Down Expand Up @@ -131,6 +132,9 @@ function hoverOnBars(pointData, xval, yval, hovermode) {
// skip the rest (for this trace) if we didn't find a close point
if(pointData.index === false) return;

// skip points inside axis rangebreaks
if(cd[pointData.index].p === BADNUM) return;

// if we get here and we're not in 'closest' mode, push min/max pos back
// onto the group - even though that means occasionally the mouse will be
// over the hover label.
Expand Down
2 changes: 0 additions & 2 deletions test/jasmine/tests/axes_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4022,8 +4022,6 @@ describe('Test axes', function() {
});

describe('*rangebreaks*', function() {
// TODO adapt `type: 'date'` requirement !!

describe('during doCalcdata', function() {
var gd;

Expand Down
83 changes: 81 additions & 2 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 @@ -2698,8 +2698,8 @@ describe('Hover on axes with rangebreaks', function() {
mouseEvent('mousemove', x, y);
}

function _assert(msg, exp) {
assertHoverLabelContent({ nums: exp.nums, axis: exp.axis }, msg + '| hover label');
function _assert(msg, exp, noHoverLabel) {
if(!noHoverLabel) assertHoverLabelContent({ nums: exp.nums, axis: exp.axis }, msg + '| hover label');
expect(eventData.x).toBe(exp.x, 'event data x');
expect(eventData.y).toBe(exp.y, 'event data y');
}
Expand Down Expand Up @@ -2772,6 +2772,85 @@ describe('Hover on axes with rangebreaks', function() {
.then(done);
});

it('should work when rangebreaks are present on y-axis using hovermode x (case of bar and autorange reversed)', function(done) {
Plotly.plot(gd, [{
type: 'bar',
orientation: 'h',
y: [
'1970-01-01 00:00:00.000',
'1970-01-01 00:00:00.010',
'1970-01-01 00:00:00.050',
'1970-01-01 00:00:00.090',
'1970-01-01 00:00:00.095',
'1970-01-01 00:00:00.100',
'1970-01-01 00:00:00.150',
'1970-01-01 00:00:00.190',
'1970-01-01 00:00:00.200'
],
x: [0, 1, 2, 3, 4, 5, 6, 7, 8]
}], {
yaxis: {
autorange: 'reversed',
rangebreaks: [
{bounds: [
'1970-01-01 00:00:00.011',
'1970-01-01 00:00:00.089'
]},
{bounds: [
'1970-01-01 00:00:00.101',
'1970-01-01 00:00:00.189'
]}
]
},
width: 400,
height: 400,
margin: {l: 10, t: 10, b: 10, r: 10},
hovermode: 'x'
})
.then(function() {
gd.on('plotly_hover', function(d) {
eventData = d.points[0];
});
})
.then(function() { _hover(50, 350); })
.then(function() {
_assert('1st test', {
axis: '1',
nums: 'Jan 1, 1970, 00:00:00.01',
y: '1970-01-01 00:00:00.01',
x: 1
});
})
.then(function() { _hover(200, 200); })
.then(function() {
_assert('2nd test', {
axis: '5',
nums: 'Jan 1, 1970, 00:00:00.1',
y: '1970-01-01 00:00:00.1',
x: 5
});
})
.then(function() { _hover(250, 150); }) // hover over break
.then(function() {
_assert('3rd test', {
// previous values
y: '1970-01-01 00:00:00.1',
x: 5
}, 'noHoverLabel');
})
.then(function() { _hover(350, 50); })
.then(function() {
_assert('4th test', {
axis: '8',
nums: 'Jan 1, 1970, 00:00:00.2',
y: '1970-01-01 00:00:00.2',
x: 8
});
})
.catch(failTest)
.then(done);
});

it('should work when rangebreaks are present on y-axis', function(done) {
Plotly.plot(gd, [{
mode: 'lines', // i.e. no autorange padding
Expand Down