Skip to content

Axis labels could be applied in the hovering popup #3317

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

Closed
wants to merge 12 commits into from
Closed

Axis labels could be applied in the hovering popup #3317

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
61f61b0
fix for issue-2618
archmoj Dec 10, 2018
fa82506
bypass ternary case
archmoj Dec 10, 2018
7955cba
fix for pie scatterpolar and scattergeo cases
archmoj Dec 10, 2018
6230dd5
fix for heatmaps
archmoj Dec 10, 2018
bcefabb
added hovertitle new attribute on axes
archmoj Dec 11, 2018
4ee4fa2
Merge remote-tracking branch 'origin/master' into issue-2618
archmoj Jan 3, 2019
7495533
apply hovertitle text and set defaults based on major version
archmoj Jan 4, 2019
703eaaf
latitude
archmoj Jan 4, 2019
b73403a
removed circular dependencies by using a const and added new baseline
archmoj Jan 4, 2019
fd8cb47
removed dflt of hovertitle and used dfltHoverTitle in coerce etc
archmoj Jan 7, 2019
202c210
updated baseline
archmoj Jan 7, 2019
61ca8ce
hovertitle for polar still not working
archmoj Jan 7, 2019
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
38 changes: 35 additions & 3 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ var Registry = require('../../registry');
var helpers = require('./helpers');
var constants = require('./constants');

var MAJOR_VERSION = 1; // i.e. Plotly version
Copy link
Contributor

Choose a reason for hiding this comment

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

Nop. Please don't include version-specific logic. Write code for v1.x, we'll patch this up in a v2 branch when we get there.


// hover labels for multiple horizontal bars get tilted by some angle,
// then need to be offset differently if they overlap
var YANGLE = constants.YANGLE;
Expand Down Expand Up @@ -934,10 +936,40 @@ function createHoverText(hoverData, opts, gd) {
}
}

var xLetter = 'x';
var yLetter = 'y';
var zLetter = 'z';

if(gd._fullLayout.scene) {
xLetter = (MAJOR_VERSION < 2) ? 'x' :
gd._fullLayout.scene.xaxis.title.text || 'x';
yLetter = (MAJOR_VERSION < 2) ? 'y' :
gd._fullLayout.scene.yaxis.title.text || 'y';
zLetter = (MAJOR_VERSION < 2) ? 'z' :
gd._fullLayout.scene.zaxis.title.text || 'z';
xLetter = (gd._fullLayout.scene.xaxis.hovertitle === '') ? xLetter :
gd._fullLayout.scene.xaxis.hovertitle || xLetter;
yLetter = (gd._fullLayout.scene.yaxis.hovertitle === '') ? yLetter :
gd._fullLayout.scene.yaxis.hovertitle || yLetter;
zLetter = (gd._fullLayout.scene.zaxis.hovertitle === '') ? zLetter :
gd._fullLayout.scene.zaxis.hovertitle || zLetter;
}
else if(!gd._fullLayout.ternary && !gd._fullLayout.title) {
xLetter = (MAJOR_VERSION < 2) ? 'x' :
gd._fullLayout.xaxis.title.text || 'x';
yLetter = (MAJOR_VERSION < 2) ? 'y' :
gd._fullLayout.yaxis.title.text || 'y';

xLetter = (gd._fullLayout.xaxis.hovertitle === '') ? xLetter :
gd._fullLayout.xaxis.hovertitle || xLetter;
yLetter = (gd._fullLayout.yaxis.hovertitle === '') ? yLetter :
gd._fullLayout.yaxis.hovertitle || yLetter;
}

if(d.zLabel !== undefined) {
if(d.xLabel !== undefined) text += 'x: ' + d.xLabel + '<br>';
if(d.yLabel !== undefined) text += 'y: ' + d.yLabel + '<br>';
text += (text ? 'z: ' : '') + d.zLabel;
if(d.xLabel !== undefined) text += xLetter + ': ' + d.xLabel + '<br>';
if(d.yLabel !== undefined) text += yLetter + ': ' + d.yLabel + '<br>';
text += (text ? zLetter + ': ' : '') + d.zLabel;
}
else if(showCommonLabel && d[hovermode + 'Label'] === t0) {
text = d[(hovermode === 'x' ? 'y' : 'x') + 'Label'] || '';
Expand Down
5 changes: 4 additions & 1 deletion src/plots/cartesian/axis_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,10 @@ module.exports = function handleAxisDefaults(containerIn, containerOut, coerce,

handleCategoryOrderDefaults(containerIn, containerOut, coerce, options);

if(axType !== 'category' && !options.noHover) coerce('hoverformat');
if(axType !== 'category' && !options.noHover) {
coerce('hoverformat');
coerce('hovertitle');
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we give this a default value? By implementing something like:

coerce('hovertitle', options.dfltHoverTitle);

Each handleAxisDefaults caller would have to pass another options key, but this would make the chart editor devs (aka RCE) much happier (as the default value will be automatically filled in the RCE panels) and the logic in Fx.hover simpler.

}

if(!visible) return containerOut;

Expand Down
9 changes: 9 additions & 0 deletions src/plots/cartesian/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -593,6 +593,15 @@ module.exports = {
'*%H~%M~%S.%2f* would display *09~15~23.46*'
].join(' ')
},
hovertitle: {
valType: 'string',
dflt: '',
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this line. The hovertitle default isn't blank. As it depends on which axis where coercing, we can't declare a default value here, so the best thing we can do is to not declare any default value.

role: 'info',
editType: 'none',
description: [
'Sets axis title(s) to be displayed in the hovering popup'
].join(' ')
},
// lines and grids
showline: {
valType: 'boolean',
Expand Down
1 change: 1 addition & 0 deletions src/plots/gl3d/layout/axis_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ module.exports = overrideAll({
tickformat: axesAttrs.tickformat,
tickformatstops: axesAttrs.tickformatstops,
hoverformat: axesAttrs.hoverformat,
hovertitle: axesAttrs.hovertitle,
// lines and grids
showline: axesAttrs.showline,
linecolor: axesAttrs.linecolor,
Expand Down
2 changes: 2 additions & 0 deletions src/plots/polar/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ var radialAxisAttrs = {
// might need a 'titleside' and even 'titledirection' down the road

hoverformat: axesAttrs.hoverformat,
hovertitle: axesAttrs.hovertitle,

uirevision: {
valType: 'any',
Expand Down Expand Up @@ -234,6 +235,7 @@ var angularAxisAttrs = {
},

hoverformat: axesAttrs.hoverformat,
hovertitle: axesAttrs.hovertitle,

uirevision: {
valType: 'any',
Expand Down
1 change: 1 addition & 0 deletions src/plots/ternary/layout_attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ var ternaryAxesAttrs = {
tickformat: axesAttrs.tickformat,
tickformatstops: axesAttrs.tickformatstops,
hoverformat: axesAttrs.hoverformat,
hovertitle: axesAttrs.hovertitle,
// lines and grids
showline: extendFlat({}, axesAttrs.showline, {dflt: true}),
linecolor: axesAttrs.linecolor,
Expand Down
1 change: 1 addition & 0 deletions src/plots/ternary/layout_defaults.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,5 +126,6 @@ function handleAxisDefaults(containerIn, containerOut, options, ternaryLayoutOut
});

coerce('hoverformat');
coerce('hovertitle');
coerce('layer');
}
Binary file modified test/image/baselines/gl3d_surface_after_heatmap.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 42 additions & 11 deletions test/image/mocks/gl3d_surface_after_heatmap.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,59 @@
"data": [
{
"type": "heatmap",
"x": [0, 1, 2],
"y": [0, 1, 2],
"x": [0, 1, 2, 3, 4],
Copy link
Contributor

Choose a reason for hiding this comment

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

Why did you patch this mock?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was a new mock added quite recently. I thought we could expand a bit to allow interactivelytesting hovertitle on gl3d & gl2d.

"y": [0, 1, 2, 3, 4],
"z": [
[0, 1, 0],
[1, 0, 1],
[0, 1, 0]
[0, 1, 0, 1, 0],
[1, 0.25, 0.75, 0.25, 1],
[0, 0.75, 0.25, 0.75, 0],
[1, 0.25, 0.75, 0.25, 1],
[0, 1, 0, 1, 0]
]
},
{
"type": "surface",
"x": [0, 1, 2],
"y": [0, 1, 2],
"x": [0, 1, 2, 3, 4],
"y": [0, 1, 2, 3, 4],
"z": [
[0, 1, 0],
[1, 0, 1],
[0, 1, 0]
[0, 1, 0, 1, 0],
[1, 0.25, 0.75, 0.25, 1],
[0, 0.75, 0.25, 0.75, 0],
[1, 0.25, 0.75, 0.25, 1],
[0, 1, 0, 1, 0]
]
}
],
"layout": {
"title": "Surface 3d plot on top of 2d heatmap!",
"width": 600,
"height": 400
"height": 400,
"scene": {
"xaxis": {
"hovertitle": "lon",
"title": {
"text": "Longitude"
}
},
"yaxis": {
"hovertitle": "lat",
"title": {
"text": "Latitude"
}
},
"zaxis": {
"hovertitle": "alt",
"title": {
"text": "Altitude"
}
},
"camera": {
"eye": {
"x": 2,
"y": 2,
"z": 2
}
}
}
}
}