Documentation / @ripl/charts / SankeyChartOptions
Interface: SankeyChartOptions<TData>
Defined in: charts/src/charts/sankey.ts:87
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: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 |
iterations? | number | Number of layout relaxation iterations (reserved for tuning node positioning). | - | charts/src/charts/sankey.ts:97 |
links | SankeyLink[] | The directional flows connecting nodes. | - | charts/src/charts/sankey.ts:91 |
nodePadding? | number | Vertical gap between stacked nodes in a column, in pixels. Defaults to 10. | - | charts/src/charts/sankey.ts:95 |
nodes | SankeyNode<TData>[] | The nodes in the diagram. | - | charts/src/charts/sankey.ts:89 |
nodeWidth? | number | Width of each node rectangle in pixels. Defaults to 20. | - | charts/src/charts/sankey.ts:93 |
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 |