Plugin hooks and jsdoc enhancements #3819
Conversation
etimberg
left a comment
etimberg
left a comment
There was a problem hiding this comment.
I didn't notice anything major but I still need to run this code
src/core/core.controller.js
Outdated
| me.clear(); | ||
|
|
||
| Chart.plugins.notify(me, 'beforeDraw', [easingDecimal]); | ||
| plugins.notify(me, 'beforeDraw', [easingDecimal]); |
There was a problem hiding this comment.
so this can't be cancelled like the other plugins?
| * Plugin extension methods. | ||
| * @interface Chart.PluginBase | ||
| * Plugin extension hooks. | ||
| * @interface IPlugin |
There was a problem hiding this comment.
We should mention IPlugin#onEvent as well
etimberg
left a comment
etimberg
left a comment
There was a problem hiding this comment.
I tested out these changes. I tried all chart types using the sample files and did not notice any issues. I also tested using all of the chartjs-plugin-annotation and chartjs-plugin-zoom samples. No issues were observed.
|
Looks like there is a test failure regarding plugins |
|
Will need to change https://github.com/chartjs/Chart.js/blob/master/src/core/core.legend.js#L529 otherwise legend click handling stops working |
Make all `before` hooks cancellable (except `beforeInit`), meaning that if any plugin return explicitly `false`, the current action is not performed. Ensure that `init` hooks are called before `update` hooks and add associated calling order unit tests. Deprecate `Chart.PluginBase` in favor of `IPlugin` (no more an inheritable class) and document plugin hooks (also rename `extension` by `hook`).
simonbrunel
force-pushed
the
plugin-enhancements
branch
from
67e8ed3 to
60aa596
Compare
|
Looks good, the legend is working again :) |
2 participants
Make all
beforehooks cancellable (exceptbeforeInit), meaning that if any plugin return explicitlyfalse, the current action is not performed. Ensure thatinithooks are called beforeupdatehooks and add associated calling order unit tests. DeprecateChart.PluginBasein favor ofIPlugin(no more an inheritable class) and document plugin hooks (also renameextensionbyhook).Depends on #3818