# Interface: DoughnutControllerDatasetOptions
# Hierarchy
ScriptableAndArrayOptions<ArcOptions,ScriptableContext<"doughnut">>ScriptableAndArrayOptions<ArcHoverOptions,ScriptableContext<"doughnut">>AnimationOptions<"doughnut">↳
DoughnutControllerDatasetOptions
# Properties
# animation
• animation: false | AnimationSpec<"doughnut"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }
# Inherited from
AnimationOptions.animation
# Defined in
types/index.d.ts:1757 (opens new window)
# animations
• animations: AnimationsSpec<"doughnut">
# Inherited from
AnimationOptions.animations
# Defined in
types/index.d.ts:1767 (opens new window)
# backgroundColor
• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.backgroundColor
# Defined in
types/index.d.ts:1817 (opens new window)
# borderAlign
• borderAlign: ScriptableAndArray<"center" | "inner", ScriptableContext<"doughnut">>
Arc stroke alignment.
# Inherited from
ScriptableAndArrayOptions.borderAlign
# Defined in
types/index.d.ts:1843 (opens new window)
# borderColor
• borderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.borderColor
# Defined in
types/index.d.ts:1816 (opens new window)
# borderDash
• borderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>
Line dash. See MDN.
Default
[]
# Inherited from
ScriptableAndArrayOptions.borderDash
# Defined in
types/index.d.ts:1848 (opens new window)
# borderDashOffset
• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>
Line dash offset. See MDN.
Default
0.0
# Inherited from
ScriptableAndArrayOptions.borderDashOffset
# Defined in
types/index.d.ts:1853 (opens new window)
# borderJoinStyle
• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"doughnut">>
Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.
# Inherited from
ScriptableAndArrayOptions.borderJoinStyle
# Defined in
types/index.d.ts:1857 (opens new window)
# borderRadius
• borderRadius: ScriptableAndArray<number | ArcBorderRadius, ScriptableContext<"doughnut">>
Sets the border radius for arcs
Default
0
# Inherited from
ScriptableAndArrayOptions.borderRadius
# Defined in
types/index.d.ts:1863 (opens new window)
# borderWidth
• borderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.borderWidth
# Defined in
types/index.d.ts:1815 (opens new window)
# circular
• circular: ScriptableAndArray<boolean, ScriptableContext<"doughnut">>
If false, Arc will be flat.
Default
true
# Inherited from
ScriptableAndArrayOptions.circular
# Defined in
types/index.d.ts:1874 (opens new window)
# circumference
• circumference: number
Sweep to allow arcs to cover.
Default
360
# Defined in
types/index.d.ts:257 (opens new window)
# clip
• clip: number | false | ChartArea
How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}
# Inherited from
# Defined in
types/index.d.ts:75 (opens new window)
# hidden
• hidden: boolean
Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.
Default
false
# Inherited from
ControllerDatasetOptions.hidden
# Defined in
types/index.d.ts:93 (opens new window)
# hoverBackgroundColor
• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverBackgroundColor
# Defined in
types/index.d.ts:1823 (opens new window)
# hoverBorderColor
• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderColor
# Defined in
types/index.d.ts:1822 (opens new window)
# hoverBorderDash
• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderDash
# Defined in
types/index.d.ts:1883 (opens new window)
# hoverBorderDashOffset
• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderDashOffset
# Defined in
types/index.d.ts:1884 (opens new window)
# hoverBorderWidth
• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverBorderWidth
# Defined in
types/index.d.ts:1821 (opens new window)
# hoverOffset
• hoverOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>
# Inherited from
ScriptableAndArrayOptions.hoverOffset
# Defined in
types/index.d.ts:1885 (opens new window)
# indexAxis
• indexAxis: "x" | "y"
The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.
Default
'x'
# Inherited from
ControllerDatasetOptions.indexAxis
# Defined in
types/index.d.ts:71 (opens new window)
# label
• label: string
The label for the dataset which appears in the legend and tooltips.
# Inherited from
ControllerDatasetOptions.label
# Defined in
types/index.d.ts:79 (opens new window)
# normalized
• normalized: boolean
Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.
# Inherited from
ControllerDatasetOptions.normalized
# Defined in
types/index.d.ts:63 (opens new window)
# offset
• offset: number | number[]
Arc offset (in pixels).
# Overrides
ScriptableAndArrayOptions.offset
# Defined in
types/index.d.ts:262 (opens new window)
# order
• order: number
The drawing order of dataset. Also affects order for stacking, tooltip and legend.
# Inherited from
ControllerDatasetOptions.order
# Defined in
types/index.d.ts:83 (opens new window)
# parsing
• parsing: false | { [key: string]: string; }
How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.
# Inherited from
ControllerDatasetOptions.parsing
# Defined in
types/index.d.ts:54 (opens new window)
# rotation
• rotation: number
Starting angle to draw this dataset from.
Default
0
# Defined in
types/index.d.ts:268 (opens new window)
# spacing
• spacing: number
Similar to the offset option, but applies to all arcs. This can be used to to add spaces
between arcs
Default
0
# Overrides
ScriptableAndArrayOptions.spacing
# Defined in
types/index.d.ts:281 (opens new window)
# stack
• stack: string
The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).
# Inherited from
ControllerDatasetOptions.stack
# Defined in
types/index.d.ts:88 (opens new window)
# transitions
• transitions: TransitionsSpec<"doughnut">
# Inherited from
AnimationOptions.transitions
# Defined in
types/index.d.ts:1768 (opens new window)
# weight
• weight: number
The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.
Default
1