Mirrors/Chart.js
2
0
Fork 0
mirror of https://github.com/chartjs/Chart.js.git synced 2026-03-05 16:04:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add API to change data visibility (#6907)

Browse Source
This commit is contained in:
Evert Timberg
2020-01-06 17:16:00 -05:00
committed by GitHub
parent eb116fa331
commit 9cb65d2c97
3 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/developers/api.md
View File

@@ -147,3 +147,21 @@ Extensive examples of usage are available in the [Chart.js tests](https://github
var meta = myChart.getDatasetMeta(0);
var x = meta.data[0].x;
```
## setDatasetVisibility(datasetIndex, visibility)
Sets the visibility for a given dataset. This can be used to build a chart legend in HTML. During click on one of the HTML items, you can call `setDatasetVisibility` to change the appropriate dataset.
```javascript
chart.setDatasetVisibility(1, false); // hides dataset at index 1
chart.update(); // chart now renders with dataset hidden
```
## setDataVisibility(datasetIndex, index, visibility)
Like [setDatasetVisibility](#setdatasetvisibility) except that it hides only a single item in the dataset. **Note** this only applies to polar area and doughnut charts at the moment. It will have no affect on line, bar, radar, or scatter charts.
```javascript
chart.setDataVisibility(0, 2, false); // hides the item in dataset 0, at index 2
chart.update(); // chart now renders with item hidden
```