From cbbbee9c584bc8305671a3d197d7be1fd76b3705 Mon Sep 17 00:00:00 2001 From: Jacco van den Berg Date: Wed, 1 Jun 2022 20:10:25 +0200 Subject: [PATCH] clarify api docs --- docs/developers/api.md | 30 ++++++++++++++++++++++++++++++ docs/developers/updates.md | 4 ++++ 2 files changed, 34 insertions(+) diff --git a/docs/developers/api.md b/docs/developers/api.md index beec9fdaa05..12b78663128 100644 --- a/docs/developers/api.md +++ b/docs/developers/api.md @@ -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. @@ -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. @@ -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. diff --git a/docs/developers/updates.md b/docs/developers/updates.md index 76aac266e2f..abacad4db06 100644 --- a/docs/developers/updates.md +++ b/docs/developers/updates.md @@ -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'); +```