grafit-charts

---

Interface: DonutSeriesOptions

Extends

• PieLikeSeriesOptions

Properties

angleField

angleField: string

Key of the value that determines the sector angle.

Inherited from

PieLikeSeriesOptions.angleField

---

angleName?

optional angleName?: string

Inherited from

PieLikeSeriesOptions.angleName

---

calloutLine?

optional calloutLine?: object

Callout line made of two segments; each is configured separately. By default the color is the sector color.

horizontal?

optional horizontal?: CalloutSegmentOptions

Horizontal segment toward the label.

radial?

optional radial?: CalloutSegmentOptions

Radial segment from the sector.

Inherited from

PieLikeSeriesOptions.calloutLine

---

cornerRadius?

optional cornerRadius?: number

Sector corner radius, in px.

Inherited from

PieLikeSeriesOptions.cornerRadius

---

fills?

optional fills?: string[]

Inherited from

PieLikeSeriesOptions.fills

---

id?

optional id?: string

Inherited from

PieLikeSeriesOptions.id

---

innerCircle?

optional innerCircle?: object

fill?

optional fill?: string

---

innerLabels?

optional innerLabels?: DonutInnerLabel[]

Text lines in the center of the ring.

---

innerRadiusRatio?

optional innerRadiusRatio?: number

Inner radius as a fraction of the outer radius (0.6 by default).

---

label?

optional label?: PieLabelOptions

Sector labels: the name and the value of a sector, drawn as one label so the two always read together. placement puts the whole label outside the pie on a callout line or inside the sector.

Inherited from

PieLikeSeriesOptions.label

---

labelField?

optional labelField?: string

Key of the sector name (legend, labels, tooltip).

Inherited from

PieLikeSeriesOptions.labelField

---

labelName?

optional labelName?: Formattable<PartNameParams>

How the value of labelField becomes text — for the legend, the tooltip heading and the name half of a sector label alike. A name is a field value, and the format of that field belongs to the series rather than to each place the name is printed in. label.category overrides it where a label wants something shorter than the legend.

Inherited from

PieLikeSeriesOptions.labelName

---

legendValue?

optional legendValue?: Switchable & object

Values in the legend: "label … value".

Type Declaration

formatter?

optional formatter?: (params) => string

Parameters

params

PieTooltipRendererParams

Returns

string

Inherited from

PieLikeSeriesOptions.legendValue

---

outerRadiusRatio?

optional outerRadiusRatio?: number

Fraction of the available radius used by the chart (0.85 by default).

Inherited from

PieLikeSeriesOptions.outerRadiusRatio

---

rotation?

optional rotation?: number

Initial angle, in degrees.

Inherited from

PieLikeSeriesOptions.rotation

---

sectorSpacing?

optional sectorSpacing?: number

Angular gap between sectors, in px (at the outer radius).

Inherited from

PieLikeSeriesOptions.sectorSpacing

---

showInLegend?

optional showInLegend?: boolean

Inherited from

PieLikeSeriesOptions.showInLegend

---

stroke?

optional stroke?: string

Sector stroke (none by default; use sectorSpacing for gaps).

Inherited from

PieLikeSeriesOptions.stroke

---

strokes?

optional strokes?: string[]

Inherited from

PieLikeSeriesOptions.strokes

---

strokeWidth?

optional strokeWidth?: number

Inherited from

PieLikeSeriesOptions.strokeWidth

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

optional renderer?: (params) => string | TooltipContentData

Parameters

params

PieTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

PieLikeSeriesOptions.tooltip

---

type

type: "donut"

---

visible?

optional visible?: boolean

Inherited from

PieLikeSeriesOptions.visible