Documentation / @ripl/charts / ChordChartOptions
Interface: ChordChartOptions
Defined in: charts/src/charts/chord.ts:77
Options for configuring a ChordChart.
Extends
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 |
colors? | string[] | Explicit colour per group; falls back to the generated palette when omitted. | - | charts/src/charts/chord.ts:83 |
format? | ValueFormatInput | Format applied to flow values shown as text (e.g. tooltips). | - | charts/src/charts/chord.ts:89 |
labels | string[] | Group labels, one per row/column of the matrix, rendered as outer arcs. | - | charts/src/charts/chord.ts:79 |
legend? | ChartLegendInput | Legend configuration (true/false, a position, or detailed legend options). | - | charts/src/charts/chord.ts:87 |
matrix | number[][] | Square flow matrix where matrix[i][j] is the flow from group i to group j. | - | charts/src/charts/chord.ts:81 |
padAngle? | number | Angular gap (in radians) between adjacent outer arcs. Defaults to 0.04. | - | charts/src/charts/chord.ts:85 |
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 |