Skip to content

ArrayOk hoverinfo fixups #2055

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
Oct 5, 2017
Merged

ArrayOk hoverinfo fixups #2055

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
4cf489e
introduce assertHoverLabelContent custom assertion
etpinard Oct 3, 2017
90e2de1
replace hover-label test boiler-plate with assertHoverLabelContent
etpinard Oct 3, 2017
c89c895
move scattergeo & choropleth hover label test trace module suits
etpinard Oct 3, 2017
b24759d
fix scattercarpet 'y' hover format + add tests
etpinard Oct 3, 2017
0a77239
fixes #2044 - add hoverinfo arrayOk support to ...
etpinard Oct 3, 2017
85d7061
allow choropleth trace to have (trace-wide) string 'text' values
etpinard Oct 3, 2017
bc8294d
add Lib.extractOption
etpinard Oct 4, 2017
b637179
add fillHoverText routine
etpinard Oct 4, 2017
294714b
improve assertHoverLabelContent API
etpinard Oct 4, 2017
2fe641d
replace ' = ' for ': ' in scattercarpet hover label prefixes
etpinard Oct 4, 2017
7f2604a
use extractOption in choropleth hover
etpinard Oct 4, 2017
6a44a9a
fix panning on text chart with invalid array values
etpinard Oct 4, 2017
3931273
make extractOption less opinionated
etpinard Oct 5, 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
8 changes: 3 additions & 5 deletions src/components/drawing/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,12 +443,10 @@ drawing.tryColorscale = function(marker, prefix) {
var TEXTOFFSETSIGN = {start: 1, end: -1, middle: 0, bottom: 1, top: -1};
drawing.textPointStyle = function(s, trace, gd) {
s.each(function(d) {
var p = d3.select(this),
text = d.tx || trace.text;
var p = d3.select(this);
var text = Lib.extractOption(d, trace, 'tx', 'text');

if(!text || Array.isArray(text)) {
// isArray test handles the case of (intentionally) missing
// or empty text within a text array
if(!text) {
p.remove();
return;
}
Expand Down
26 changes: 12 additions & 14 deletions src/components/fx/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1028,24 +1028,22 @@ function alignHoverText(hoverLabels, rotateLabels) {
}

function cleanPoint(d, hovermode) {
var index = d.index;
var trace = d.trace || {};
var cd0 = d.cd[0];
var cd = d.cd[d.index] || {};
var cd = d.cd[index] || {};

var getVal = Array.isArray(index) ?
function(calcKey, traceKey) {
return Lib.castOption(cd0, index, calcKey) ||
Lib.extractOption({}, trace, '', traceKey);
} :
function(calcKey, traceKey) {
return Lib.extractOption(cd, trace, calcKey, traceKey);
};

function fill(key, calcKey, traceKey) {
var val;

if(cd[calcKey]) {
val = cd[calcKey];
} else if(cd0[calcKey]) {
var arr = cd0[calcKey];
if(Array.isArray(arr) && Array.isArray(arr[d.index[0]])) {
val = arr[d.index[0]][d.index[1]];
}
} else {
val = Lib.nestedProperty(trace, traceKey).get();
}

var val = getVal(calcKey, traceKey);
if(val) d[key] = val;
}

Expand Down
21 changes: 21 additions & 0 deletions src/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,27 @@ lib.castOption = function(trace, ptNumber, astr, fn) {
}
};

/** Extract option from calcdata item, correctly falling back to
* trace value if not found.
*
* @param {object} calcPt : calcdata[i][j] item
* @param {object} trace : (full) trace object
* @param {string} calcKey : calcdata key
* @param {string} traceKey : aka trace attribute string
* @return {any}
*/
lib.extractOption = function(calcPt, trace, calcKey, traceKey) {
var calcVal = calcPt[calcKey];
if(calcVal || calcVal === 0) return calcVal;

// fallback to trace value,
// must check if value isn't itself an array
// which means the trace attribute has a corresponding
// calcdata key, but its value is falsy
var traceVal = lib.nestedProperty(trace, traceKey).get();
if(!Array.isArray(traceVal)) return traceVal;
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice, I like it. Thanks for accepting 0.

not super happy with the name

meh, it's a very specific concept that we probably don't want to go into any more detail with in the name. Seems fine to me.

not super happy about it being on Lib

It definitely belongs next to castOption but yeah, if we make a common/ that might be more appropriate for these.

Also a style question: I just noticed all over this file we start the docs immediately after /**, I thought the convention was to leave that first line blank and start on the next line?

Copy link
Contributor Author

@etpinard etpinard Oct 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

Also a style question: I just noticed all over this file we start the docs immediately after /**, I thought the convention was to leave that first line blank and start on the next line?

image

from http://usejsdoc.org/howto-commonjs-modules.html

So, I think both are acceptable.

Copy link
Collaborator

Choose a reason for hiding this comment

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

perhaps overly pedantic, but I read that as /** Single-line description */ or

/**
 * Multiline still looks like it always
 * leaves the first line blank.
 */

};

/** Returns target as set by 'target' transform attribute
*
* @param {object} trace : full trace object
Expand Down
8 changes: 2 additions & 6 deletions src/traces/bar/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
var Fx = require('../../components/fx');
var ErrorBars = require('../../components/errorbars');
var Color = require('../../components/color');

var fillHoverText = require('../scatter/fill_hover_text');

module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
var cd = pointData.cd;
Expand Down Expand Up @@ -99,11 +99,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
pointData.xLabelVal = di.p;
}

if(di.htx) pointData.text = di.htx;
else if(trace.hovertext) pointData.text = trace.hovertext;
else if(di.tx) pointData.text = di.tx;
else if(trace.text) pointData.text = trace.text;

fillHoverText(di, trace, pointData);
ErrorBars.hoverInfo(di, trace, pointData);

return [pointData];
Expand Down
6 changes: 2 additions & 4 deletions src/traces/choropleth/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ module.exports = extendFlat({
editType: 'calc',
description: 'Sets the color values.'
},
text: {
valType: 'data_array',
editType: 'calc',
text: extendFlat({}, ScatterGeoAttrs.text, {
description: 'Sets the text elements associated with each location.'
},
}),
marker: {
line: {
color: ScatterGeoMarkerLineAttrs.color,
Expand Down
18 changes: 11 additions & 7 deletions src/traces/choropleth/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

'use strict';

var Lib = require('../../lib');
var Axes = require('../../plots/cartesian/axes');
var attributes = require('./attributes');

Expand Down Expand Up @@ -53,17 +54,17 @@ module.exports = function hoverPoints(pointData, xval, yval) {
};

function makeHoverInfo(pointData, trace, pt, axis) {
var hoverinfo = trace.hoverinfo;
var hoverinfo = pt.hi || trace.hoverinfo;

var parts = (hoverinfo === 'all') ?
attributes.hoverinfo.flags :
hoverinfo.split('+');

var hasName = (parts.indexOf('name') !== -1),
hasLocation = (parts.indexOf('location') !== -1),
hasZ = (parts.indexOf('z') !== -1),
hasText = (parts.indexOf('text') !== -1),
hasIdAsNameLabel = !hasName && hasLocation;
var hasName = (parts.indexOf('name') !== -1);
var hasLocation = (parts.indexOf('location') !== -1);
var hasZ = (parts.indexOf('z') !== -1);
var hasText = (parts.indexOf('text') !== -1);
var hasIdAsNameLabel = !hasName && hasLocation;

var text = [];

Expand All @@ -79,7 +80,10 @@ function makeHoverInfo(pointData, trace, pt, axis) {
}

if(hasZ) text.push(formatter(pt.z));
if(hasText) text.push(pt.tx);
if(hasText) {
var tx = Lib.extractOption(pt, trace, 'tx', 'text');
if(tx && tx !== '') text.push(tx);
Copy link
Collaborator

Choose a reason for hiding this comment

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

'' is already falsey, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Strictly speaking, I think this should be:

if(tx !== undefined && tx !== '') {
  text.push(tx);
}

as Lib.extractOption returns undefined for all falsy values except 0 in calcdata. But, trace.text is allowed to be '' (which is the default by the way).

To make this easier to maintain (and remember 🙂 ), I'm thinking either

  • (1) we could remove the dflt: '' line in the text (and hovertext) attribute declarations. This leads to a slight change in behavior (but might more consistent) as now:
{
   text: 'on-chart text',
   hovertext: ''
}

would use '' for the hover label text field (i.e. not show anything). On master, hovertext: '' is ignored and 'on-chart text' shows in the hover labels.

  • (2) we could make Lib.extractOption return undefined when trace.text: '', making it a little more opinionated (I think this only makes sense for string attributes).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Here's what I came up with 3931273

I made Lib.extractOption less opinionated, and made scatter/fill_hover_text handle falsy but valid text values.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, I like it. There are some edge cases this makes a little weird - eg trying to make one point have text but no hovertext, while all the others have both - but there are ways to get what you want (in that example using hoverinfo as an array) and I don't see any way to make everything more intuitive. So lets keep this, it's nice clean logic, will make sense to people, and will do what people expect 99.9% of the time.

}

pointData.extraText = text.join('<br>');
}
36 changes: 36 additions & 0 deletions src/traces/scatter/fill_hover_text.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/**
* Copyright 2012-2017, Plotly, Inc.
* All rights reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

'use strict';

var Lib = require('../../lib');

/** Fill hover 'pointData' container with 'correct' hover text value
*
* - 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
*
* @param {object} calcPt
* @param {object} trace
* @param {object || array} contOut (mutated here)
*/
module.exports = function fillHoverText(calcPt, trace, contOut) {
var fill = Array.isArray(contOut) ?
function(v) { contOut.push(v); } :
function(v) { contOut.text = v; };

var htx = Lib.extractOption(calcPt, trace, 'htx', 'hovertext');
if(htx && htx !== '') return fill(htx);

var tx = Lib.extractOption(calcPt, trace, 'tx', 'text');
if(tx && tx !== '') return fill(tx);
};
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice! 🌴 Does this really belong in scatter though? Perhaps in fx?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have no strong opinion here. This routine felt similar to

https://github.com/plotly/plotly.js/blob/master/src/traces/scatter/arrays_to_calcdata.js

that's why I put it in traces/scatter/

Copy link
Collaborator

Choose a reason for hiding this comment

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

That's fine, we certainly have a long history of traces pulling from each other, particularly from scatter, and there is something nice about it being in the traces dir. Perhaps at some point we introduce a traces/common dir for stuff like this but leave it as is for now.

8 changes: 2 additions & 6 deletions src/traces/scatter/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
* LICENSE file in the root directory of this source tree.
*/


'use strict';

var Lib = require('../../lib');
var Fx = require('../../components/fx');
var ErrorBars = require('../../components/errorbars');
var getTraceColor = require('./get_trace_color');
var Color = require('../../components/color');
var fillHoverText = require('./fill_hover_text');

var MAXDIST = Fx.constants.MAXDIST;

Expand Down Expand Up @@ -73,11 +73,7 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
yLabelVal: di.y
});

if(di.htx) pointData.text = di.htx;
else if(trace.hovertext) pointData.text = trace.hovertext;
else if(di.tx) pointData.text = di.tx;
else if(trace.text) pointData.text = trace.text;

fillHoverText(di, trace, pointData);
ErrorBars.hoverInfo(di, trace, pointData);

return [pointData];
Expand Down
25 changes: 17 additions & 8 deletions src/traces/scattercarpet/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,27 @@ module.exports = function hoverPoints(pointData, xval, yval, hovermode) {
newPointData.yLabelVal = undefined;
// TODO: nice formatting, and label by axis title, for a, b, and c?

var trace = newPointData.trace,
carpet = trace._carpet,
hoverinfo = trace.hoverinfo.split('+'),
text = [];
var trace = newPointData.trace;
var carpet = trace._carpet;
var hoverinfo = cdi.hi || trace.hoverinfo;
var parts = hoverinfo.split('+');
var text = [];

function textPart(ax, val) {
text.push(((ax.labelprefix && ax.labelprefix.length > 0) ? ax.labelprefix : (ax._hovertitle + ': ')) + val.toFixed(3) + ax.labelsuffix);
var prefix;

if(ax.labelprefix && ax.labelprefix.length > 0) {
prefix = ax.labelprefix.replace(/ = $/, '');
} else {
prefix = ax._hovertitle;
}

text.push(prefix + ': ' + val.toFixed(3) + ax.labelsuffix);
}

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

var ij = carpet.ab2ij([cdi.a, cdi.b]);
var i0 = Math.floor(ij[0]);
Expand Down
35 changes: 15 additions & 20 deletions src/traces/scattergeo/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ var Axes = require('../../plots/cartesian/axes');
var BADNUM = require('../../constants/numerical').BADNUM;

var getTraceColor = require('../scatter/get_trace_color');
var fillHoverText = require('../scatter/fill_hover_text');
var attributes = require('./attributes');


module.exports = function hoverPoints(pointData, xval, yval) {
var cd = pointData.cd;
var trace = cd[0].trace;
Expand Down Expand Up @@ -71,39 +71,34 @@ module.exports = function hoverPoints(pointData, xval, yval) {
};

function getExtraText(trace, pt, axis) {
var hoverinfo = trace.hoverinfo;
var hoverinfo = pt.hi || trace.hoverinfo;

var parts = (hoverinfo === 'all') ?
var parts = hoverinfo === 'all' ?
attributes.hoverinfo.flags :
hoverinfo.split('+');

var hasLocation = parts.indexOf('location') !== -1 && Array.isArray(trace.locations),
hasLon = (parts.indexOf('lon') !== -1),
hasLat = (parts.indexOf('lat') !== -1),
hasText = (parts.indexOf('text') !== -1);

var hasLocation = parts.indexOf('location') !== -1 && Array.isArray(trace.locations);
var hasLon = (parts.indexOf('lon') !== -1);
var hasLat = (parts.indexOf('lat') !== -1);
var hasText = (parts.indexOf('text') !== -1);
var text = [];

function format(val) {
return Axes.tickText(axis, axis.c2l(val), 'hover').text + '\u00B0';
}

if(hasLocation) text.push(pt.loc);
else if(hasLon && hasLat) {
if(hasLocation) {
text.push(pt.loc);
} else if(hasLon && hasLat) {
text.push('(' + format(pt.lonlat[0]) + ', ' + format(pt.lonlat[1]) + ')');
} else if(hasLon) {
text.push('lon: ' + format(pt.lonlat[0]));
} else if(hasLat) {
text.push('lat: ' + format(pt.lonlat[1]));
}
else if(hasLon) text.push('lon: ' + format(pt.lonlat[0]));
else if(hasLat) text.push('lat: ' + format(pt.lonlat[1]));

if(hasText) {
var tx;

if(pt.htx) tx = pt.htx;
else if(trace.hovertext) tx = trace.hovertext;
else if(pt.tx) tx = pt.tx;
else if(trace.text) tx = trace.text;

if(!Array.isArray(tx)) text.push(tx);
fillHoverText(pt, trace, text);
}

return text.join('<br>');
Expand Down
31 changes: 14 additions & 17 deletions src/traces/scattermapbox/hover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

var Fx = require('../../components/fx');
var getTraceColor = require('../scatter/get_trace_color');
var fillHoverText = require('../scatter/fill_hover_text');
var BADNUM = require('../../constants/numerical').BADNUM;

module.exports = function hoverPoints(pointData, xval, yval) {
Expand Down Expand Up @@ -66,13 +67,14 @@ module.exports = function hoverPoints(pointData, xval, yval) {
};

function getExtraText(trace, di) {
var hoverinfo = trace.hoverinfo.split('+'),
isAll = (hoverinfo.indexOf('all') !== -1),
hasLon = (hoverinfo.indexOf('lon') !== -1),
hasLat = (hoverinfo.indexOf('lat') !== -1);
var hoverinfo = di.hi || trace.hoverinfo;
var parts = hoverinfo.split('+');
var isAll = parts.indexOf('all') !== -1;
var hasLon = parts.indexOf('lon') !== -1;
var hasLat = parts.indexOf('lat') !== -1;

var lonlat = di.lonlat,
text = [];
var lonlat = di.lonlat;
var text = [];

// TODO should we use a mock axis to format hover?
// If so, we'll need to make precision be zoom-level dependent
Expand All @@ -82,19 +84,14 @@ function getExtraText(trace, di) {

if(isAll || (hasLon && hasLat)) {
text.push('(' + format(lonlat[0]) + ', ' + format(lonlat[1]) + ')');
} else if(hasLon) {
text.push('lon: ' + format(lonlat[0]));
} else if(hasLat) {
text.push('lat: ' + format(lonlat[1]));
}
else if(hasLon) text.push('lon: ' + format(lonlat[0]));
else if(hasLat) text.push('lat: ' + format(lonlat[1]));

if(isAll || hoverinfo.indexOf('text') !== -1) {
var tx;

if(di.htx) tx = di.htx;
else if(trace.hovertext) tx = trace.hovertext;
else if(di.tx) tx = di.tx;
else if(trace.text) tx = trace.text;

if(!Array.isArray(tx)) text.push(tx);
if(isAll || parts.indexOf('text') !== -1) {
fillHoverText(di, trace, text);
}

return text.join('<br>');
Expand Down
Loading