Skip to content

Commit 0e189dd

Browse files
authored
fix: updated type for doughnut offset (#11051)
1 parent be049a3 commit 0e189dd

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

docs/charts/doughnut.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The doughnut/pie chart allows a number of properties to be specified for each da
116116
| [`hoverBorderJoinStyle`](#interactions) | `'round'`\|`'bevel'`\|`'miter'` | Yes | Yes | `undefined`
117117
| [`hoverBorderWidth`](#interactions) | `number` | Yes | Yes | `undefined`
118118
| [`hoverOffset`](#interactions) | `number` | Yes | Yes | `0`
119-
| [`offset`](#styling) | `number` | Yes | Yes | `0`
119+
| [`offset`](#styling) | `number`\|`number[]` | Yes | Yes | `0`
120120
| [`rotation`](#general) | `number` | - | - | `undefined`
121121
| [`spacing`](#styling) | `number` | - | - | `0`
122122
| [`weight`](#styling) | `number` | - | - | `1`

src/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ export interface DoughnutControllerDatasetOptions
260260
/**
261261
* Arc offset (in pixels).
262262
*/
263-
offset: number;
263+
offset: number | number[];
264264

265265
/**
266266
* Starting angle to draw this dataset from.
@@ -313,7 +313,7 @@ export interface DoughnutControllerChartOptions {
313313
/**
314314
* Arc offset (in pixels).
315315
*/
316-
offset: number;
316+
offset: number | number[];
317317

318318
/**
319319
* The outer radius of the chart. String ending with '%' means percentage of maximum radius, number means pixels.
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
import { Chart, ChartMeta, Element } from '../../../src/types.js';
2+
3+
const chart = new Chart('id', {
4+
type: 'doughnut',
5+
data: {
6+
datasets: [{
7+
data: [10, 20, 40, 50, 5],
8+
label: 'Dataset 1',
9+
backgroundColor: [
10+
'red',
11+
'orange',
12+
'yellow',
13+
'green',
14+
'blue'
15+
]
16+
}],
17+
labels: [
18+
'Item 1',
19+
'Item 2',
20+
'Item 3',
21+
'Item 4',
22+
'Item 5'
23+
],
24+
},
25+
options: {
26+
spacing: 50,
27+
offset: [0, 50, 0, 0, 0],
28+
}
29+
});

0 commit comments

Comments
 (0)