Skip to content

docs(legend): update default onClick example for v4 (fixes #12144) #12148

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+6 −9
Open

docs(legend): update default onClick example for v4 (fixes #12144) #12148

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 6 additions & 9 deletions docs/configuration/legend.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,19 +162,16 @@ const chart = new Chart(ctx, {

It can be common to want to trigger different behaviour when clicking an item in the legend. This can be easily achieved using a callback in the config object.

:::tip Updated
Starting from Chart.js v4, use `toggleDataVisibility()` and `update()` instead of the old `show()` / `hide()` methods.
:::
Comment on lines +165 to +167
Copy link
Collaborator

@LeeLenaleee LeeLenaleee Nov 16, 2025

Choose a reason for hiding this comment

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

This can be left out since it is in the V4 docs and is something for the migration guide.


The default legend click handler is:

```javascript
function(e, legendItem, legend) {
const index = legendItem.datasetIndex;
const ci = legend.chart;
if (ci.isDatasetVisible(index)) {
ci.hide(index);
legendItem.hidden = true;
} else {
ci.show(index);
legendItem.hidden = false;
}
Comment on lines -169 to -177
Copy link
Collaborator

@LeeLenaleee LeeLenaleee Nov 16, 2025

Choose a reason for hiding this comment

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

This is the code that is currently in the source file:

Chart.js/src/plugins/plugin.legend.js

Line 645 in 2898a6d

onClick(e, legendItem, legend) {

So this change is not correct.

legend.chart.toggleDataVisibility(legendItem.index);
legend.chart.update();
}
```

Expand Down