Documentation / @ripl/charts / FunnelChartOptions
Interface: FunnelChartOptions<TData>
Defined in: charts/src/charts/funnel.ts:63
Options for configuring a FunnelChart.
Extends
Type Parameters
| Type Parameter | Default type |
|---|---|
TData | unknown |
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
borderRadius? | number | Corner radius in pixels applied to each segment. Defaults to 4. | - | charts/src/charts/funnel.ts:77 |
color? | keyof TData | ((item) => string) | Accessor for an explicit per-segment colour; falls back to the generated palette. | - | charts/src/charts/funnel.ts:73 |
data | TData[] | The dataset rendered as funnel segments, top to bottom. | - | charts/src/charts/funnel.ts:65 |
format? | ValueFormatInput | Format applied to segment values shown as text (e.g. tooltips). | - | charts/src/charts/funnel.ts:79 |
gap? | number | Vertical gap in pixels between segments. Defaults to 4. | - | charts/src/charts/funnel.ts:75 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key (used for colour assignment and data joins). | - | charts/src/charts/funnel.ts:67 |
label | keyof TData | ((item) => string) | Accessor for each segment's display label. | - | charts/src/charts/funnel.ts:71 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
value | NumericAccessor<TData> | Accessor for each segment's numeric value (drives its width). | - | charts/src/charts/funnel.ts:69 |