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.

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

Update tooltip content and styling on update() #6181

Closed
wants to merge 6 commits into from
Closed

Update tooltip content and styling on update() #6181

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3357e05
Update tooltip content and styling on update()
Apr 2, 2019
fb8ac49
Restore clear lastActive
Apr 2, 2019
167af95
Fix typos
Apr 23, 2019
7d4fb13
Implemented @nagix suggestions
Jun 5, 2019
d6f5b0b
Change click check, @kurkle request
Sep 12, 2019
f8407a3
Fix show/hide dataset, review @kurkle
Sep 18, 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
54 changes: 41 additions & 13 deletions src/core/core.controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,8 +488,7 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
// after update.
me.tooltip.initialize();

// Last active contains items that were previously in the tooltip.
// When we reset the tooltip, we need to clear it
// Last active contains items that were previously hovered.
me.lastActive = [];

// Do this before render so that any plugins that need final scale updates can use it
Expand All @@ -504,6 +503,11 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
} else {
me.render(config);
}

// Replay last event from before update
if (me._lastEvent) {
me.eventHandler(me._lastEvent);
}
},

/**
Expand Down Expand Up @@ -659,14 +663,26 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
*/
transition: function(easingValue) {
var me = this;
var options = me.options || {};
var hoverOptions = options.hover;
var i, ilen;

for (var i = 0, ilen = (me.data.datasets || []).length; i < ilen; ++i) {
for (i = 0, ilen = (me.data.datasets || []).length; i < ilen; ++i) {
if (me.isDatasetVisible(i)) {
me.getDatasetMeta(i).controller.transition(easingValue);
}
}

me.tooltip.transition(easingValue);

if (me._lastEvent && me.animating) {
// If, during animation, element under mouse changes, lets react to that.
Evertvdw marked this conversation as resolved.
Show resolved Hide resolved
me.active = me.getElementsAtEventForMode(me._lastEvent, hoverOptions.mode, hoverOptions);
Copy link
Contributor

Choose a reason for hiding this comment

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

Why not simply calling eventHandler but duplicating code in handleEvent? I think other logic such as calling the onHover callback is also needed.

Copy link
Author

Choose a reason for hiding this comment

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

That is probably right, I replaced these lines now with a call to eventHandler.

if (!helpers.arrayEquals(me.active, me.lastActive)) {
me._updateHoverStyles();
me.lastActive = me.active;
}
}
},

/**
Expand Down Expand Up @@ -918,6 +934,25 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
}
},

/**
* @private
*/
_updateHoverStyles: function() {
var me = this;
var options = me.options || {};
var hoverOptions = options.hover;

// Remove styling for last active (even if it may still be active)
if (me.lastActive.length) {
me.updateHoverStyle(me.lastActive, hoverOptions.mode, false);
}

// Built in hover styling
Evertvdw marked this conversation as resolved.
Show resolved Hide resolved
if (me.active.length && hoverOptions.mode) {
benmccann marked this conversation as resolved.
Show resolved Hide resolved
me.updateHoverStyle(me.active, hoverOptions.mode, true);
}
},

/**
* @private
*/
Expand Down Expand Up @@ -985,8 +1020,10 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
// Find Active Elements for hover and tooltips
if (e.type === 'mouseout') {
me.active = [];
me._lastEvent = null;
} else {
me.active = me.getElementsAtEventForMode(e, hoverOptions.mode, hoverOptions);
me._lastEvent = e;
Copy link
Contributor

Choose a reason for hiding this comment

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

If 'click' event is picked here, this issue will occur.

Copy link
Author

Choose a reason for hiding this comment

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

I cannot reproduce that issue in the codepen I have provided with the PR code, I think that issue there was with refiring the actual click event.

Copy link
Contributor

Choose a reason for hiding this comment

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

I see this issue when clicking the legend in your codepen.

}

// Invoke onHover hook
Expand All @@ -1000,16 +1037,7 @@ helpers.extend(Chart.prototype, /** @lends Chart */ {
}
}

// Remove styling for last active (even if it may still be active)
if (me.lastActive.length) {
me.updateHoverStyle(me.lastActive, hoverOptions.mode, false);
}

// Built in hover styling
if (me.active.length && hoverOptions.mode) {
me.updateHoverStyle(me.active, hoverOptions.mode, true);
}

me._updateHoverStyles();
changed = !helpers.arrayEquals(me.active, me.lastActive);

// Remember Last Actives
Expand Down
25 changes: 22 additions & 3 deletions src/core/core.tooltip.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ defaults._set('global', {
labelColor: function(tooltipItem, chart) {
var meta = chart.getDatasetMeta(tooltipItem.datasetIndex);
var activeElement = meta.data[tooltipItem.index];
var view = activeElement._view;
var view = activeElement.$previousStyle || activeElement._view;
return {
borderColor: view.borderColor,
backgroundColor: view.backgroundColor
Expand Down Expand Up @@ -492,8 +492,25 @@ function getBeforeAfterBodyLines(callback) {

var exports = Element.extend({
initialize: function() {
this._model = getBaseModel(this._options);
this._lastActive = [];
var me = this;
me._model = getBaseModel(me._options);
me._view = {};
me._lastActive = [];
},

transition: function(easingValue) {
var me = this;
var options = me._options;

if (me._lastEvent && me._chart.animating) {
etimberg marked this conversation as resolved.
Show resolved Hide resolved
// Lets react to changes during animation
Evertvdw marked this conversation as resolved.
Show resolved Hide resolved
me._active = me._chart.getElementsAtEventForMode(me._lastEvent, options.mode, options);
me.update(true);
me.pivot();
me._lastActive = me.active;
}

Element.prototype.transition.call(me, easingValue);
},

// Get the title
Expand Down Expand Up @@ -967,8 +984,10 @@ var exports = Element.extend({
// Find Active Elements for tooltips
if (e.type === 'mouseout') {
me._active = [];
me._lastEvent = null;
} else {
me._active = me._chart.getElementsAtEventForMode(e, options.mode, options);
me._lastEvent = e;
Copy link
Contributor

Choose a reason for hiding this comment

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

Same as above.

}

// Remember Last Actives
Expand Down
8 changes: 4 additions & 4 deletions test/specs/core.controller.tests.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1121,7 +1121,7 @@ describe('Chart', function() {
expect(chart.tooltip._options).toEqual(jasmine.objectContaining(newTooltipConfig));
});

it ('should reset the tooltip on update', function() {
it('should update the tooltip on update', function() {
var chart = acquireChart({
type: 'line',
data: {
Expand Down Expand Up @@ -1151,10 +1151,10 @@ describe('Chart', function() {
expect(chart.lastActive).toEqual([point]);
expect(tooltip._lastActive).toEqual([point]);

// Update and confirm tooltip is reset
// Update and confirm tooltip is updated
chart.update();
expect(chart.lastActive).toEqual([]);
expect(tooltip._lastActive).toEqual([]);
expect(chart.lastActive).toEqual([point]);
expect(tooltip._lastActive).toEqual([point]);
});

it ('should update the metadata', function() {
Expand Down