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.

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

adding hovertemplates to polar bar and scatter and ternary scatter #3398

Merged
merged 4 commits into from
Jan 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions src/traces/barpolar/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

'use strict';

var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
var extendFlat = require('../../lib/extend').extendFlat;
var scatterPolarAttrs = require('../scatterpolar/attributes');
var barAttrs = require('../bar/attributes');
Expand Down Expand Up @@ -69,6 +70,7 @@ module.exports = {
marker: barAttrs.marker,

hoverinfo: scatterPolarAttrs.hoverinfo,
hovertemplate: hovertemplateAttrs(),

selected: barAttrs.selected,
unselected: barAttrs.unselected
Expand Down
1 change: 1 addition & 0 deletions src/traces/barpolar/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
coerce('width');

coerce('text');
coerce('hovertemplate');
// coerce('hovertext');

// var textPosition = coerce('textposition');
Expand Down
1 change: 1 addition & 0 deletions src/traces/barpolar/hover.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ module.exports = function hoverPoints(pointData, xval, yval) {
var _cdi = Lib.extendFlat({}, cdi, {r: cdi.s, theta: cdi.p});
fillHoverText(cdi, trace, pointData);
makeHoverPointText(_cdi, trace, subplot, pointData);
pointData.hovertemplate = trace.hovertemplate;
pointData.color = getTraceColor(trace, cdi);
pointData.xLabelVal = pointData.yLabelVal = undefined;

Expand Down
2 changes: 2 additions & 0 deletions src/traces/scatterpolar/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

'use strict';

var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
var extendFlat = require('../../lib/extend').extendFlat;
var scatterAttrs = require('../scatter/attributes');
var plotAttrs = require('../../plots/attributes');
Expand Down Expand Up @@ -130,6 +131,7 @@ module.exports = {
flags: ['r', 'theta', 'text', 'name']
}),
hoveron: scatterAttrs.hoveron,
hovertemplate: hovertemplateAttrs(),

selected: scatterAttrs.selected,
unselected: scatterAttrs.unselected
Expand Down
1 change: 1 addition & 0 deletions src/traces/scatterpolar/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ function supplyDefaults(traceIn, traceOut, defaultColor, layout) {
coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');
coerce('text');
coerce('hovertext');
if(traceOut.hoveron !== 'fills') coerce('hovertemplate');

if(subTypes.hasLines(traceOut)) {
handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce);
Expand Down
45 changes: 24 additions & 21 deletions src/traces/scatterpolar/hover.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,41 +32,44 @@ function hoverPoints(pointData, xval, yval, hovermode) {
newPointData.xLabelVal = undefined;
newPointData.yLabelVal = undefined;
makeHoverPointText(cdi, trace, subplot, newPointData);

newPointData.hovertemplate = trace.hovertemplate;
return scatterPointData;
}

function makeHoverPointText(cdi, trace, subplot, pointData) {

var radialAxis = subplot.radialAxis;
var angularAxis = subplot.angularAxis;
var hoverinfo = cdi.hi || trace.hoverinfo;
var parts = hoverinfo.split('+');
var text = [];

radialAxis._hovertitle = 'r';
angularAxis._hovertitle = 'θ';

var hoverinfo = cdi.hi || trace.hoverinfo;
var text = [];
function textPart(ax, val) {
text.push(ax._hovertitle + ': ' + Axes.tickText(ax, val, 'hover').text);
}

if(parts.indexOf('all') !== -1) parts = ['r', 'theta', 'text'];
if(parts.indexOf('r') !== -1) {
textPart(radialAxis, radialAxis.c2l(cdi.r));
}
if(parts.indexOf('theta') !== -1) {
var theta = cdi.theta;
textPart(
angularAxis,
angularAxis.thetaunit === 'degrees' ? Lib.rad2deg(theta) : theta
);
}
if(parts.indexOf('text') !== -1 && pointData.text) {
text.push(pointData.text);
delete pointData.text;
}
if(!trace.hovertemplate) {
var parts = hoverinfo.split('+');

if(parts.indexOf('all') !== -1) parts = ['r', 'theta', 'text'];
if(parts.indexOf('r') !== -1) {
textPart(radialAxis, radialAxis.c2l(cdi.r));
}
if(parts.indexOf('theta') !== -1) {
var theta = cdi.theta;
textPart(
angularAxis,
angularAxis.thetaunit === 'degrees' ? Lib.rad2deg(theta) : theta
);
}
if(parts.indexOf('text') !== -1 && pointData.text) {
text.push(pointData.text);
delete pointData.text;
}

pointData.extraText = text.join('<br>');
pointData.extraText = text.join('<br>');
}
}

module.exports = {
Expand Down
1 change: 1 addition & 0 deletions src/traces/scatterpolargl/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ module.exports = {

text: scatterPolarAttrs.text,
hovertext: scatterPolarAttrs.hovertext,
hovertemplate: scatterPolarAttrs.hovertemplate,

line: scatterGlAttrs.line,
connectgaps: scatterGlAttrs.connectgaps,
Expand Down
1 change: 1 addition & 0 deletions src/traces/scatterpolargl/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout
coerce('mode', len < PTS_LINESONLY ? 'lines+markers' : 'lines');
coerce('text');
coerce('hovertext');
if(traceOut.hoveron !== 'fills') coerce('hovertemplate');

if(subTypes.hasLines(traceOut)) {
handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce);
Expand Down
2 changes: 2 additions & 0 deletions src/traces/scatterternary/attributes.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

'use strict';

var hovertemplateAttrs = require('../../components/fx/hovertemplate_attributes');
var scatterAttrs = require('../scatter/attributes');
var plotAttrs = require('../../plots/attributes');
var colorAttributes = require('../../components/colorscale/attributes');
Expand Down Expand Up @@ -147,4 +148,5 @@ module.exports = {
flags: ['a', 'b', 'c', 'text', 'name']
}),
hoveron: scatterAttrs.hoveron,
hovertemplate: hovertemplateAttrs(),
};
1 change: 1 addition & 0 deletions src/traces/scatterternary/defaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ module.exports = function supplyDefaults(traceIn, traceOut, defaultColor, layout

coerce('text');
coerce('hovertext');
if(traceOut.hoveron !== 'fills') coerce('hovertemplate');

var defaultMode = len < constants.PTS_LINESONLY ? 'lines+markers' : 'lines';
coerce('mode', defaultMode);
Expand Down
17 changes: 8 additions & 9 deletions src/traces/scatterternary/hover.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,19 +52,18 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
var trace = newPointData.trace;
var ternary = newPointData.subplot;
var hoverinfo = cdi.hi || trace.hoverinfo;
var parts = hoverinfo.split('+');
var text = [];

function textPart(ax, val) {
text.push(ax._hovertitle + ': ' + Axes.tickText(ax, val, 'hover').text);
}

if(parts.indexOf('all') !== -1) parts = ['a', 'b', 'c'];
if(parts.indexOf('a') !== -1) textPart(ternary.aaxis, cdi.a);
if(parts.indexOf('b') !== -1) textPart(ternary.baxis, cdi.b);
if(parts.indexOf('c') !== -1) textPart(ternary.caxis, cdi.c);

if(!trace.hovertemplate) {
var parts = hoverinfo.split('+');
if(parts.indexOf('all') !== -1) parts = ['a', 'b', 'c'];
if(parts.indexOf('a') !== -1) textPart(ternary.aaxis, cdi.a);
if(parts.indexOf('b') !== -1) textPart(ternary.baxis, cdi.b);
if(parts.indexOf('c') !== -1) textPart(ternary.caxis, cdi.c);
}
newPointData.extraText = text.join('<br>');

newPointData.hovertemplate = trace.hovertemplate;
return scatterPointData;
};
16 changes: 16 additions & 0 deletions test/jasmine/tests/barpolar_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,22 @@ describe('Test barpolar hover:', function() {
extraText: 'r: 1<br>θ: 0°',
color: '#1f77b4'
}
}, {
desc: 'hovertemplate',
traces: [{
r: [1, 2, 3],
theta: [0, 90, 180],
hovertemplate: 'tpl',
}],
xval: 1,
yval: 0,
exp: {
index: 0,
x: 263.33,
y: 200,
hovertemplate: 'tpl',
color: '#1f77b4'
}
}, {
desc: 'with custom text scalar',
traces: [{
Expand Down
8 changes: 8 additions & 0 deletions test/jasmine/tests/scatterpolar_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,14 @@ describe('Test scatterpolar hover:', function() {
desc: 'base',
nums: 'r: 4.022892\nθ: 128.342°',
name: 'Trial 3'
}, {
desc: 'with hovertemplate',
patch: function(fig) {
fig.data[2].hovertemplate = 'template %{r} %{theta}';
return fig;
},
nums: 'template 4.02289202968 128.342009045',
name: 'Trial 3'
}, {
desc: '(no labels - out of sector)',
patch: function(fig) {
Expand Down
8 changes: 8 additions & 0 deletions test/jasmine/tests/scatterpolargl_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ describe('Test scatterpolargl hover:', function() {
desc: 'base',
nums: 'r: 3.886013\nθ: 125.2822°',
name: 'Trial 3'
}, {
desc: 'with hovertemplate',
patch: function(fig) {
fig.data[2].hovertemplate = 'template %{r} %{theta}';
return fig;
},
nums: 'template 3.88601339194 125.282157112',
name: 'Trial 3'
}, {
desc: '(no labels - out of sector)',
patch: function(fig) {
Expand Down
16 changes: 16 additions & 0 deletions test/jasmine/tests/scatterternary_test.js
Original file line number Diff line number Diff line change
Expand Up @@ -402,6 +402,22 @@ describe('scatterternary hover', function() {
.then(done);
});

it('should pass along hovertemplate on hover', function(done) {
var xval = 0.42;
var yval = 0.37;
var hovermode = 'closest';
var scatterPointData;
Plotly.restyle(gd, {
hovertemplate: 'tpl'
})
.then(function() {
scatterPointData = _hover(gd, xval, yval, hovermode);
expect(scatterPointData[0].hovertemplate).toEqual('tpl');
})
.catch(failTest)
.then(done);
});

});

describe('Test scatterternary *cliponaxis*', function() {
Expand Down