Skip to content

Provide a default hovertemplate label for attribute "base" in bar traces #5216

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
Oct 17, 2020
Merged

Provide a default hovertemplate label for attribute "base" in bar traces #5216

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
1 change: 1 addition & 0 deletions src/traces/bar/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,7 @@ function hoverOnBars(pointData, xval, yval, hovermode) {

pointData.labelLabel = hoverLabelText(pa, pointData[posLetter + 'LabelVal']);
pointData.valueLabel = hoverLabelText(sa, pointData[sizeLetter + 'LabelVal']);
pointData.baseLabel = hoverLabelText(sa, di.b);

// spikelines always want "closest" distance regardless of hovermode
pointData.spikeDistance = (sizeFn(di) + thisBarPositionFn(di)) / 2 - maxHoverDistance;
Expand Down
46 changes: 46 additions & 0 deletions test/jasmine/tests/bar_test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2495,6 +2495,52 @@ describe('bar hover', function() {
.catch(failTest)
.then(done);
});

it('should provide a default label for base in hovertemplate', function(done) {
gd = createGraphDiv();

function _hover(xpx, ypx) {
return function() {
Fx.hover(gd, {xpx: xpx, ypx: ypx}, 'xy');
Lib.clearThrottle();
};
}

Plotly.plot(gd, {
data: [{
type: 'bar',
orientation: 'h',
base: ['2020-04-06 22:17:00'],
x: [11520000.0],
y: ['test'],
hovertemplate: ['%{base}<br>%{x}']
}],
layout: {
xaxis: { type: 'date', tickprefix: '*', ticksuffix: '*' },
width: 400,
height: 400,
margin: {l: 0, t: 0, r: 0, b: 0},
hovermode: 'closest'
}
})
.then(_hover(200, 200))
.then(function() {
assertHoverLabelContent({
nums: '*Apr 6, 2020, 22:17*\n*Apr 7, 2020, 01:29*',
name: 'trace 0'
});
return Plotly.relayout(gd, 'xaxis.tickformat', '%d');
})
.then(_hover(200, 200))
.then(function() {
assertHoverLabelContent({
nums: '*06*\n*07*',
name: 'trace 0'
});
})
.catch(failTest)
.then(done);
});
});

describe('with special width/offset combinations', function() {
Expand Down