Documentation / @ripl/charts / ChordChartOptions
Interface: ChordChartOptions ​
Defined in: charts/src/charts/chord.ts:83
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: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 flow values shown as text (e.g. tooltips). | - | charts/src/charts/chord.ts:103 |
groups | string[] | Group names, one per row/column of the matrix, rendered as outer arcs. | - | charts/src/charts/chord.ts:85 |
legend? | ChartLegendInput | Legend configuration (true/false, a position, or detailed legend options). | - | charts/src/charts/chord.ts:101 |
matrix | number[][] | Square flow matrix where matrix[i][j] is the flow from group i to group j. | - | charts/src/charts/chord.ts:87 |
padAngle? | number | Angular gap (in radians) between adjacent outer arcs, taken out of the ring before the arcs are sized, so it also shifts where the ribbons attach. Deprecated Use ChordChartOptions.padWidth for a gap of constant width. Still honored when padWidth is not set, so existing charts keep their look. | - | charts/src/charts/chord.ts:97 |
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 |
padWidth? | number | Gap between adjacent outer arcs, in logical pixels. Arcs face each other with parallel edges a constant distance apart, and the ring is not resized, so the ribbons keep their attachment points. Defaults to 2; pass 0 for touching arcs. Takes precedence over the deprecated padAngle. | - | charts/src/charts/chord.ts:99 |
palette? | string[] | Explicit color per group; falls back to the generated palette when omitted. | - | charts/src/charts/chord.ts:89 |
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 |