Documentation / @ripl/charts / FunnelChartOptions
Interface: FunnelChartOptions<TData> ​
Defined in: charts/src/charts/funnel.ts:76
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:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
borderRadius? | number | Corner radius in pixels applied to each segment. Defaults to 4. | - | charts/src/charts/funnel.ts:92 |
colorBy? | keyof TData | ((item) => string) | Optional per-item color accessor; falls back to the generated palette. | - | charts/src/charts/funnel.ts:86 |
data | TData[] | The dataset rendered as funnel segments, top to bottom. | - | charts/src/charts/funnel.ts:78 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | Format applied to segment values shown as text (e.g. tooltips). | - | charts/src/charts/funnel.ts:94 |
gap? | number | Vertical gap in pixels between segments. Defaults to 4. | - | charts/src/charts/funnel.ts:90 |
key | keyof TData | ((item) => string) | Accessor for each item's unique key (used for color assignment and data joins). | - | charts/src/charts/funnel.ts:80 |
label | keyof TData | ((item) => string) | Accessor for each segment's display label. | - | charts/src/charts/funnel.ts:84 |
legend? | ChartLegendInput | Legend configuration. Shown by default; pass false to hide. | - | charts/src/charts/funnel.ts:88 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
value | NumericAccessor<TData> | Accessor for each segment's numeric value (drives its width). | - | charts/src/charts/funnel.ts:82 |