Skip to content
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.

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

Clarify api docs #10392

Merged
merged 1 commit into from Jun 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/developers/api.md
Expand Up @@ -113,6 +113,14 @@ function clickHandler(evt) {
}
```

## .getSortedVisibleDatasetMetas()

Returns an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.

```javascript
const visibleMetas = chart.getSortedVisibleDatasetMetas();
```

## .getDatasetMeta(index)

Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart.
Expand All @@ -126,6 +134,14 @@ const meta = myChart.getDatasetMeta(0);
const x = meta.data[0].x;
```

## getVisibleDatasetCount

Returns the amount of datasets that are currently not hidden.

```javascript
const numberOfVisibleDatasets = chart.getVisibleDatasetCount();
```

## 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.
Expand Down Expand Up @@ -191,3 +207,17 @@ Finds the chart instance from the given key. If the key is a `string`, it is int
```javascript
const chart = Chart.getChart("canvas-id");
```

## Static: register(chartComponentLike)

Used to register plugins, axis types or chart types globally to all your charts.

```javascript
import { Chart, Tooltip, LinearScale, PointElement, BubbleController } from 'chart.js';

Chart.register(Tooltip, LinearScale, PointElement, BubbleController);
```

## Static: unregister(chartComponentLike)

Used to unregister plugins, axis types or chart types globally from all your charts.
4 changes: 4 additions & 0 deletions docs/developers/updates.md
Expand Up @@ -100,3 +100,7 @@ Code sample for updating options can be found in [toggle-scale-type.html](https:
## Preventing Animations

Sometimes when a chart updates, you may not want an animation. To achieve this you can call `update` with `'none'` as mode.

```javascript
myChart.update('none');
```