Documentation / @ripl/charts / SankeyChartOptions
Interface: SankeyChartOptions<TData> ​
Defined in: charts/src/charts/sankey.ts:109
Options for configuring a SankeyChart.
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 |
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 node and link values shown as text (e.g. tooltips). | - | charts/src/charts/sankey.ts:123 |
iterations? | number | Number of layout relaxation iterations (reserved for tuning node positioning). | - | charts/src/charts/sankey.ts:119 |
legend? | ChartLegendInput | Legend configuration. Shown automatically when there is more than one node; pass false to hide. | - | charts/src/charts/sankey.ts:121 |
links | SankeyLink[] | The directional flows connecting nodes. | - | charts/src/charts/sankey.ts:113 |
nodePadding? | number | Vertical gap between stacked nodes in a column, in pixels. Defaults to 10. | - | charts/src/charts/sankey.ts:117 |
nodes | SankeyNode<TData>[] | The nodes in the diagram. | - | charts/src/charts/sankey.ts:111 |
nodeWidth? | number | Width of each node rectangle in pixels. Defaults to 20. | - | charts/src/charts/sankey.ts:115 |
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 |