]> git.ipfire.org Git - thirdparty/Chart.js.git/commitdiff
fix: updated type for doughnut offset (#11051)
authorMichiel Lankamp <mlankamp@users.noreply.github.com>
Fri, 13 Jan 2023 08:06:33 +0000 (09:06 +0100)
committerGitHub <noreply@github.com>
Fri, 13 Jan 2023 08:06:33 +0000 (10:06 +0200)
docs/charts/doughnut.md
src/types/index.d.ts
test/types/controllers/doughnut_spacing_offset.ts [new file with mode: 0644]

index 20b16f308889e45b8bc2476af99988de7204f5ca..f9f29d5214b95ed671b7368b374af58f2c758aab 100644 (file)
@@ -116,7 +116,7 @@ The doughnut/pie chart allows a number of properties to be specified for each da
 | [`hoverBorderJoinStyle`](#interactions) | `'round'`\|`'bevel'`\|`'miter'` | Yes | Yes | `undefined`
 | [`hoverBorderWidth`](#interactions) | `number` | Yes | Yes | `undefined`
 | [`hoverOffset`](#interactions) | `number` | Yes | Yes | `0`
-| [`offset`](#styling) | `number` | Yes | Yes | `0`
+| [`offset`](#styling) | `number`\|`number[]` | Yes | Yes | `0`
 | [`rotation`](#general) | `number` | - | - | `undefined`
 | [`spacing`](#styling) | `number` | - | - | `0`
 | [`weight`](#styling) | `number` | - | - | `1`
index d462f360017604f1a4262e4b809926296e7d2188..28de6bd681811d64ee5db45e3e9a2927b0391d3f 100644 (file)
@@ -260,7 +260,7 @@ export interface DoughnutControllerDatasetOptions
   /**
    * Arc offset (in pixels).
    */
-  offset: number;
+  offset: number | number[];
 
   /**
    * Starting angle to draw this dataset from.
@@ -313,7 +313,7 @@ export interface DoughnutControllerChartOptions {
   /**
    * Arc offset (in pixels).
    */
-  offset: number;
+  offset: number | number[];
 
   /**
    * The outer radius of the chart. String ending with '%' means percentage of maximum radius, number means pixels.
diff --git a/test/types/controllers/doughnut_spacing_offset.ts b/test/types/controllers/doughnut_spacing_offset.ts
new file mode 100644 (file)
index 0000000..228f8f0
--- /dev/null
@@ -0,0 +1,29 @@
+import { Chart, ChartMeta, Element } from '../../../src/types.js';
+
+const chart = new Chart('id', {
+  type: 'doughnut',
+  data: {
+    datasets: [{
+      data: [10, 20, 40, 50, 5],
+      label: 'Dataset 1',
+      backgroundColor: [
+        'red',
+        'orange',
+        'yellow',
+        'green',
+        'blue'
+      ]
+    }],
+    labels: [
+      'Item 1',
+      'Item 2',
+      'Item 3',
+      'Item 4',
+      'Item 5'
+    ],
+  },
+  options: {
+    spacing: 50,
+    offset: [0, 50, 0, 0, 0],
+  }
+});