grafit-charts

---

Interface: SunburstSeriesOptions

Extends

• StandaloneSeriesBaseOptions

Properties

childrenField?

optional childrenField?: string

---

cornerRadius?

optional cornerRadius?: number

Sector corner radius.

---

fills?

optional fills?: string[]

Inherited from

StandaloneSeriesBaseOptions.fills

---

id?

optional id?: string

Inherited from

StandaloneSeriesBaseOptions.id

---

itemStyler?

optional itemStyler?: Styler<HierarchyItemStylerParams, HierarchyItemStyle>

Style of one sector by its datum — any ring, not only the branches. The color a sector is styled with is the fill the sectors outside it are handed. Undefined leaves the sector its branch color; a partial style is laid over it. A hovered sector lifts from the styled color. The legend keeps the palette.

---

label?

optional label?: Switchable & FontOptions & object

Sector labels (disabled by default; color is auto-contrast).

Type Declaration

formatter?

optional formatter?: (params) => string

Parameters

params

depth

number

label

string

value

number

Returns

string

---

labelField?

optional labelField?: string

---

name?

optional name?: string

Name of what the value of a node measures — the label of the tooltip row. Without it the row is named by the data key the value came from, which is the name of a column, not of a measure.

Inherited from

StandaloneSeriesBaseOptions.name

---

sectorSpacing?

optional sectorSpacing?: number

Constant-width gap between sectors (px), same as pie.

---

showInLegend?

optional showInLegend?: boolean

Inherited from

StandaloneSeriesBaseOptions.showInLegend

---

sizeField?

optional sizeField?: string

---

stroke?

optional stroke?: string

Sector stroke (by default a 1px background-colored stroke when sectorSpacing is zero).

---

strokeWidth?

optional strokeWidth?: number

---

tooltip?

optional tooltip?: Switchable & object

Type Declaration

renderer?

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

Parameters

params

NodeTooltipRendererParams

Returns

string | TooltipContentData

Inherited from

StandaloneSeriesBaseOptions.tooltip

---

type

type: "sunburst"

---

visible?

optional visible?: boolean

Inherited from

StandaloneSeriesBaseOptions.visible