Mirrors/Chart.js
1
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2024-10-06 04:09:08 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document plugin event handling (#8828)

Browse Source
This commit is contained in:
Evert Timberg 2021-04-04 23:48:59 -04:00 committed by GitHub
parent e1ddaa8992
commit ac0a86b95d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/developers/event_flowchart.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 37 KiB

2
docs/developers/plugin_flowcharts.drawio
View File

File diff suppressed because one or more lines are too long

6
docs/developers/plugins.md
View File

@ -141,3 +141,9 @@ Plugins are notified during throughout the update process.
Plugins can interact with the chart throughout the render process. The rendering process is documented in the flowchart below. Each of the green processes is a plugin notification. The red lines indicate how cancelling part of the render process can occur when a plugin returns `false` from a hook. Not all hooks are cancelable, however, in general most `before*` hooks can be cancelled.
![Chart.js render pipeline flowchart](./render_flowchart.png)
### Event Handling
Plugins can interact with the chart during the event handling process. The event handling flow is documented in the flowchart below. Each of the green processes is a plugin notification. If a plugin makes changes that require a re-render, the plugin can set `args.changed` to `true` to indicate that a render is needed. The built-in tooltip plugin uses this method to indicate when the tooltip has changed.
![Chart.js event handling flowchart](./event_flowchart.png)