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

Support hovertemplate on hoveron: fills #6121

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Support hovertemplate on hoveron: fills #6121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3844fe1
Support hovertemplate on hoveron: fills
fredricj Feb 16, 2022
a0a1bce
Adjust codestyle
fredricj Feb 23, 2022
424bcdf
Add test for hovertemplate on scatter with hoveron: fills + mode: lines
fredricj Feb 27, 2025
32f75ca
Use the original if-statement with additional test for mode=='lines'
fredricj Feb 27, 2025
5c5c197
Create 6121_add.md
fredricj Feb 27, 2025
37f7568
Merge branch 'master' into scatter-hoveron-fills
fredricj Feb 27, 2025
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/6121_add.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Add support for hovertemplate when mode=lines on scatter traces [[#6121](https://github.com/plotly/plotly.js/pull/6121)]
2 changes: 1 addition & 1 deletion src/traces/scatter/defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
dfltHoverOn.push('fills');
}
coerce('hoveron', dfltHoverOn.join('+') || 'points');
if(traceOut.hoveron !== 'fills') coerce('hovertemplate');
if(traceOut.hoveron !== 'fills' || traceOut.mode === 'lines') coerce('hovertemplate');
var errorBarsSupplyDefaults = Registry.getComponentMethod('errorbars', 'supplyDefaults');
errorBarsSupplyDefaults(traceIn, traceOut, lineColor || markerColor || defaultColor, {axis: 'y'});
errorBarsSupplyDefaults(traceIn, traceOut, lineColor || markerColor || defaultColor, {axis: 'x', inherit: 'y'});
Expand Down
7 changes: 5 additions & 2 deletions src/traces/scatter/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,10 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
else if(Color.opacity((trace.line || {}).color)) {
color = trace.line.color;
}

var hovertemplate = false;
if(trace.mode === 'lines') {
hovertemplate = trace.hovertemplate;
}
Lib.extendFlat(pointData, {
// never let a 2D override 1D type as closest point
// also: no spikeDistance, it's not allowed for fills
Expand All @@ -248,7 +251,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
y0: hoverLabelCoords.y0,
y1: hoverLabelCoords.y1,
color: color,
hovertemplate: false
hovertemplate: hovertemplate,
});

delete pointData.index;
Expand Down
24 changes: 24 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 @@ -2164,6 +2164,30 @@ describe('hover info', function() {
})
.then(done, done.fail);
});

it('should work when hoveron: fills and mode: lines', function(done) {
var gd = document.getElementById('graph');
Plotly.newPlot(gd, [{
'x': ['0', '390', '390', '0', '0'],
'y': ['0', '0', '390', '390', '0'],
'hovertemplate': 'Test<extra></extra>',
'markers': 'lines',
'type': 'scatter',
'mode': 'lines',
'fill': 'toself',
'hoveron': 'fills'
}], mockCopy.layout
)
.then(function() {
Fx.hover('graph', evt, 'xy');

assertHoverLabelContent({
nums: 'Test',
name: ''
});
})
.then(done, done.fail);
});
});

it('should work with trace.name linked to layout.meta', function(done) {
Expand Down