Fix removing event listeners #541
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The plugin only removed its event listeners if it could access the chart's canvas. However, Chart.js clears its canvas before notifying plugins, so this didn't work: https://github.com/chartjs/Chart.js/blob/v3.3.2/src/core/core.controller.js#L857 I noticed this when I destroyed and recreated a Chart.js object against the same HTML `<canvas>` element; the original chart's event handlers still fired and threw errors because the `getState` object had been removed and no longer had needed information. To address this, I'm now saving the event listener's target as a custom property on the event listener function; that way, `removeHandler` always knows exactly what the target is. I also noticed that `mouseUp` was calling `removeHandler` with incorrect parameters, so I fixed it.
kurkle
approved these changes
Jun 7, 2021
|
Fixes #533? |
|
From a simple local test (with only basic plot features enabled), yes, it looks like it fixes #533. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The plugin only removed its event listeners if it could access the chart's canvas. However, Chart.js clears its canvas before notifying plugins, so this didn't work:
https://github.com/chartjs/Chart.js/blob/v3.3.2/src/core/core.controller.js#L857
I noticed this when I destroyed and recreated a Chart.js object against the same HTML
<canvas>element; the original chart's event handlers still fired and threw errors because thegetStateobject had been removed and no longer had needed information.To address this, I'm now saving the event listener's target as a custom property on the event listener function; that way,
removeHandleralways knows exactly what the target is.I also noticed that
mouseUpwas callingremoveHandlerwith incorrect parameters, so I fixed it.