Sunburst terraces
Sunburst terraces
227
| Observation | Value |
|---|---|
| Product/Platform/API | 42 |
| Product/Platform/Storage | 26 |
| Product/Experience/Web | 32 |
| Product/Experience/Mobile | 24 |
| Operations/Support | 29 |
| Operations/Success | 18 |
| Growth/Acquisition | 34 |
| Growth/Retention | 22 |
Usage
Import the component and the stylesheet once. See Getting started to install the package.
import { SunburstTerracesCard } from '@lilt-ui/charts';
import '@lilt-ui/charts/styles.css';<SunburstTerracesCard data={spatialHierarchy} path="path" value="value" />Omit title to leave out the visible title. Set header={false} to remove the whole header, and use aria-label to name a chart inside your own card. legend={false} removes the legend independently. surface="ghost" controls only the visual frame. See Card composition.
Data
Supply leaf-only slash-separated paths, up to eight levels. Branch angles sum known leaf values; missing leaves do not invent area. Zero and missing readings remain in the data table. A path cannot also be an ancestor. Branch selection returns a null datum with a calculated total; leaves return their original row. Terrace height is decorative.
const spatialHierarchy = [
{
"path": "Product/Platform/API",
"value": 42
},
{
"path": "Product/Platform/Storage",
"value": 26
},
{
"path": "Product/Experience/Web",
"value": 32
},
{
"path": "Product/Experience/Mobile",
"value": 24
},
{
"path": "Operations/Support",
"value": 29
},
{
"path": "Operations/Success",
"value": 18
},
{
"path": "Growth/Acquisition",
"value": 34
},
{
"path": "Growth/Retention",
"value": 22
}
];Props
Every prop SunburstTerracesCard accepts, in the order you are likely to reach for them.
| Prop | Type | Description |
|---|---|---|
title | string | Optional visible title. Omit to render no title. Also supplies the accessible name unless aria-label is set. |
header | boolean | Defaults to true. False removes the whole header: title, headline, delta and period controls, with no reserved space. Pass data directly when your app owns period selection. |
aria-label | string | Accessible chart name, independent of the visible title. Falls back to title, then a generic chart name. |
data | Row[] | One row per observation. Omit when using ranges. |
height | number | Minimum plot height, default 360px. Dense data may expand within the scrollable viewport. |
depth | boolean | Lit tiles, solid bars, or spheres. Data positions remain exact; loading keeps the same depth treatment. |
color | string | Override the palette with one CSS color. |
headline | number | Override the resting headline. |
delta | number | Fractional change shown alongside the headline. |
deltaTone | 'default' | 'inverse' | 'neutral' | Use inverse when a decrease is good. |
range | string | Static period label. |
ranges | { id, label, data, headline?, delta? }[] | Period choices with their own data. |
defaultRange | string | Initial period id. |
locale | string | Locale for numbers and dates; defaults to en-US. |
formatValue | (value: number) => string | Custom value formatter. |
badge | ReactNode | Content for the glass tab above the card. |
className | string | Class on the card frame. |
style | CSSProperties | ChartStyle | Inline styles and scoped chart variables. |
onSelectionChange | (selection | null) => void | Reports id, original row (or null for an absent day), value, and pinned state. |
renderReadout | (selection | null) => ReactNode | Consumer-owned readout, including when the header is hidden. |
valueFormat | Intl.NumberFormatOptions | Formats the headline, tiles, and axis, e.g. currency. |
surface | 'elevated' | 'outline' | 'ghost' | Card treatment. Ghost removes the visual frame only; header and legend are independent controls. |
palette | 'iris' | 'cobalt' | 'emerald' | Series colors. Iris by default; explicit series colors still win. |
numberStyle | 'count' | 'pop' | 'slide' | 'roll' | 'flow' | 'scramble' | How the headline animates when its value changes. Count (default) counts to the new value. |
loading | boolean | Shows a neutral loading skeleton, not data. |
loadingStyle | 'shimmer' | 'draw' | 'breathe' | Shimmer sweeps a highlight over still shapes; draw reveals them in order; breathe lets them settle. Follows the selected look, including depth, and respects reduced motion. |
empty | 'dots' | 'shape' | ReactElement | null | What the card shows when the period has no data. Dots (default) gathers a quiet dot field around the message; shape lays the chart’s own outline behind it. Pass `<ChartEmpty>` with your own words, any element of your own, or null for nothing. Both looks stay still, so empty never reads as loading, and the headline reads a dash, never zero. |
motion | 'auto' | 'none' | None turns off decorative motion; reduced motion does this automatically. |
path | text key of Row | Unique leaf path. Separate hierarchy levels with /; do not supply parent-total rows. |
value | numeric key of Row | Nonnegative numeric measurement. Null or undefined is missing. |
tilt | number | Vertical proportion of the projected plane, from 0.4 to 1 (Wind rose: 0.45 to 1). Default 0.62. |
rise | number | Decorative terrace step (0–24px), or Ternary magnitude height (0–80px). Default 12. |
aggregate | 'sum' | 'mean' | 'max' | Fallback resting summary. A family-defined summary (such as located point count, hierarchy total, or mean signed value) takes precedence. Use headline to override that summary. |
onKeyDown | KeyboardEventHandler<HTMLElement> | Keyboard handler on the card frame. Chart inspection also has its own keyboard handling. |
legendSwatch | 'square' | 'dot' | 'line' | Marker beside each group label, where a group legend is present. Defaults to square. |
legend | false | 'tiles' | 'inline' | 'list' | 'pills' | 'bars' | Layout for the group legend where the data produces groups. False hides it; defaults to tiles. |