Documentation / @ripl/charts / ArcDiagramChartOptions
Interface: ArcDiagramChartOptions<TData> ​
Defined in: charts/src/charts/arc-diagram.ts:112
Options for configuring an ArcDiagramChart.
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 link values shown as text (e.g. tooltips). | - | charts/src/charts/arc-diagram.ts:126 |
legend? | ChartLegendInput | Legend configuration. Shown automatically when there is more than one node group; pass false to hide. | - | charts/src/charts/arc-diagram.ts:124 |
links | ArcDiagramLink[] | The links drawn as arcs between pairs of nodes. | - | charts/src/charts/arc-diagram.ts:116 |
nodeRadius? | number | Node dot radius (the max radius when sizeByConnections is on). Defaults to 6. | - | charts/src/charts/arc-diagram.ts:118 |
nodes | ArcDiagramNode<TData>[] | The nodes laid out along the axis. | - | charts/src/charts/arc-diagram.ts:114 |
orientation? | ArcDiagramOrientation | Lay the node axis horizontally (default) or vertically (a Y axis with arcs bulging right). | - | charts/src/charts/arc-diagram.ts:120 |
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 |
sizeByConnections? | boolean | Scale each node's dot by its connection count (degree), like a bubble chart. Defaults to false. | - | charts/src/charts/arc-diagram.ts:122 |
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 |