Skip to content

Add 'hovertext' attribute in scatter* traces #1523

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 13 commits into from
Apr 7, 2017
Merged

Add 'hovertext' attribute in scatter* traces #1523

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
b91fd3b
[proof of concept] add 'hovertext' attribute
etpinard Mar 28, 2017
2dc0250
add 'hovertext' to text_chart_arrays mock
etpinard Mar 29, 2017
253a29b
:lock: down 'hovertext' / 'text' logic for scatter traces
etpinard Mar 29, 2017
2b02c5f
add 'hovertext' to scatterternary traces
etpinard Mar 29, 2017
7b6911f
add 'hovertext' to bar traces
etpinard Mar 29, 2017
a7b76ee
add 'hovertext' to scatter3d traces
etpinard Mar 29, 2017
55a51f8
DRY up scattermapbox 'mode' attribute declaration
etpinard Mar 29, 2017
aa6eadf
add 'hoverinfo' to scattermapbox traces
etpinard Mar 29, 2017
b3448f0
Merge branch 'master' into hovertext-on-hover
etpinard Mar 31, 2017
4148cd4
add 'hovertext' attribute to pie traces
etpinard Mar 31, 2017
b760fe8
Merge branch 'master' into hovertext-on-hover
etpinard Apr 7, 2017
a859464
add 'hoverinfo' to scattergeo traces
etpinard Apr 7, 2017
1bf54e2
use d3's .size() instead of diving into selection items
etpinard Apr 7, 2017
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/scatter/arrays_to_calcdata.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ var Lib = require('../../lib');
module.exports = function arraysToCalcdata(cd, trace) {

Lib.mergeArray(trace.text, cd, 'tx');
Lib.mergeArray(trace.hovertext, cd, 'htx');
Lib.mergeArray(trace.customdata, cd, 'data');
Lib.mergeArray(trace.textposition, cd, 'tp');
if(trace.textfont) {
Expand Down
18 changes: 17 additions & 1 deletion src/traces/scatter/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,23 @@ module.exports = {
'If a single string, the same string appears over',
'all the data points.',
'If an array of string, the items are mapped in order to the',
'this trace\'s (x,y) coordinates.'
'this trace\'s (x,y) coordinates.',
'If trace `hoverinfo` contains a *text* flag and *hovertext* is not set,',
'these elements will be seen in the hover labels.'
].join(' ')
},
hovertext: {
valType: 'string',
role: 'info',
dflt: '',
arrayOk: true,
description: [
'Sets hover text elements associated with each (x,y) pair.',
'If a single string, the same string appears over',
'all the data points.',
'If an array of string, the items are mapped in order to the',
'this trace\'s (x,y) coordinates.',
'To be seen, trace `hoverinfo` must contain a *text* flag.'
].join(' ')
},
mode: {
Expand Down
1 change: 1 addition & 0 deletions src/traces/scatter/defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout

coerce('customdata');
coerce('text');
coerce('hovertext');
coerce('mode', defaultMode);
coerce('ids');

Expand Down
4 changes: 3 additions & 1 deletion src/traces/scatter/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,9 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
yLabelVal: di.y
});

if(di.tx) pointData.text = di.tx;
if(di.htx) pointData.text = di.htx;
else if(trace.hovertext) pointData.text = trace.hovertext;
else if(di.tx) pointData.text = di.tx;
Copy link
Contributor Author

@etpinard etpinard Mar 28, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

This is what I came up with:

  • If trace hoverinfo contains a 'text' flag and hovertext is not set the text elements will be seen in the hover labels
  • If trace hoverinfo contains a 'text' flag and hovertext is set, hovertext takes precedence over text i.e. the hoverinfo elements will be seen in the hover labels

else if(trace.text) pointData.text = trace.text;

ErrorBars.hoverInfo(di, trace, pointData);
Expand Down