Allow tooltipFormat to be a function. Provide a default tooltipFormat #4583
Conversation
benmccann
force-pushed
the
tooltip
branch
2 times, most recently
from
178a5c2 to
3e1d8f4
Compare
benmccann
force-pushed
the
tooltip
branch
2 times, most recently
from
2d18815 to
99215f8
Compare
|
@simonbrunel this PR was on hold while you were working on scriptable options. Now that we have scriptable options for the bubble chart would it make sense to also add one for this option on the time scale? I.e. should I just update this PR to take a |
|
I think so, you should use the |
benmccann
force-pushed
the
tooltip
branch
3 times, most recently
from
2009392 to
93fd0e7
Compare
|
@simonbrunel could you give another look to this PR? I don't think I've necessarily done everything as you've intended, in which case I could use some advice, but hopefully it's at least somewhat closer |
|
@simonbrunel thoughts on this one? |
| var label = data.labels && index < data.labels.length ? data.labels[index] : ''; | ||
| var value = data.datasets[datasetIndex].data[index]; | ||
| var context = { | ||
| chart: chart, | ||
| options: options, |
There was a problem hiding this comment.
I would not add options as part of context because it's confusing: could be the chart options or the scale options. Maybe scale (this) is better if we already expose the scale object publicly somewhere else?!
| tooltipFormat = typeof tooltipFormat === 'function' | ||
| ? tooltipFormat.call(me, context) | ||
| : tooltipFormat; | ||
| return momentDate.format(tooltipFormat); |
There was a problem hiding this comment.
We still need to handle null/undefined tooltipFormat since it's currently supported
| } | ||
|
|
||
| return label; | ||
| momentDate = momentify(me.getRightValue(value), timeOpts); | ||
| tooltipFormat = typeof tooltipFormat === 'function' |
There was a problem hiding this comment.
Could we use helpers.options.resolve() here?
| /** | ||
| * Show the most specific time format by default | ||
| */ | ||
| function defaultTooltipFormat(context) { |
There was a problem hiding this comment.
I understand it's the default you want for the financial chart but I'm not sure about using it as default for all charts. I usually prefer consistency when reading data and IMO having the tooltip display format changing for all values is not a good user experience. I would go for a static default (maybe the most detailed - see comment below) - this would also avoid converting, by default, 2 times the same value to a Moment object (though that's minor).'MMM D, YYYY h:mm:ss.SSS a'
There was a problem hiding this comment.
I slept on it and finally, I think the best default behavior is to keep tooltipFormat undefined and handle this case in getLabelForIndex as: if tooltipFormat is null or undef, use the same display format as the one chosen for the scale labels, so by default, the tooltip displays exactly the same text as the tick label (I remember a ticket or comment requesting that behavior).
There was a problem hiding this comment.
Part of what I was trying to accomplish here was to show more detail in the tooltip than is on the scale as that's a common use of tooltips that I think people expect. E.g. if the scale says "May 11" then it would be nice that when you mouseover with the tooltip that you see "May 11, 2017". I think using the same display format as the one chosen for the scale labels is not a bad choice either. Perhaps we could have some way to toggle between these two behaviors? E.g. define the tooltipFormat as this function, but then if you set it to null then it displays the same as the scale or something like that.
There was a problem hiding this comment.
My issue with that method is that the tooltip displays different formats depending on the current value, which I think it's not a good UX. It can be different from the tick label (more detailed) but should be the same for all the values, so when the user moves his mouse, he always reads the same format.
That's why I would implement the way I described in my second comment since it's simpler, more optimized and I think more expectable as a default.
Though that would be great to have more feedback.
|
@benmccann really sorry for the delay :\ |
Before
After