Add index to legendItem interface (#10436)

* Add index to legendItem interface for doughnut, pie and polarArea charts. Make datasetIndex optional since the before named charts dont include it.

* Remove test to check if datasetIndex has been set in generateLabels function for legend

diff --git a/types/index.esm.d.ts b/types/index.esm.d.ts
index d95c91fd12f5edeb6d3aaf71a7b81440a047f20f..3edb09464ba9a097e3d9747de50092a519c1247b 100644 (file)
--- a/types/index.esm.d.ts
+++ b/types/index.esm.d.ts
@@ -2165,7 +2165,12 @@ export interface LegendItem {
   /**
    * Index of the associated dataset
    */
-  datasetIndex: number;
+  datasetIndex?: number;
+
+  /**
+   * Index the associated label in the labels array
+   */
+  index?: number
 
   /**
    * Fill style of the legend box

diff --git a/types/tests/plugins/defaults.ts b/types/tests/plugins/defaults.ts
index ceab8af91884fe4ec73ea601db2361f87721bcf2..ec54b34ffa14081967bfcb5930d49483273a5f5b 100644 (file)
--- a/types/tests/plugins/defaults.ts
+++ b/types/tests/plugins/defaults.ts
@@ -9,10 +9,3 @@ defaults.plugins.legend.labels.generateLabels = function(chart) {
     text: 'test'
   }];
 };
-
-// @ts-expect-error Type '{ text: string; }[]' is not assignable to type 'LegendItem[]'.
-defaults.plugins.legend.labels.generateLabels = function(chart) {
-  return [{
-    text: 'test'
-  }];
-};