Mixins / foldkit-mixins-ui

DonutData

interface · packages/mixins-ui/src/chart/donut.ts:12

interface DonutData {
  readonly slices: ReadonlyArray<Slice>
  readonly totalLabel?: string | undefined
  readonly valueLabel?: string | undefined
  readonly hole?: number | undefined
}

What a donut reads: its parts, and the words around its total.

Members

DonutData.slices

property · packages/mixins-ui/src/chart/donut.ts:14

readonly slices: ReadonlyArray<Slice>

Up to five parts.

DonutData.totalLabel

property · packages/mixins-ui/src/chart/donut.ts:16

readonly totalLabel?: string | undefined

Says what the hole's total is; default Total.

DonutData.valueLabel

property · packages/mixins-ui/src/chart/donut.ts:18

readonly valueLabel?: string | undefined

Heads the values' column in the table; default Value.

DonutData.hole

property · packages/mixins-ui/src/chart/donut.ts:20

readonly hole?: number | undefined

How far in the ring's hole reaches, from 0 (a pie, with no total drawn) to just under 1; default 0.62.