Documentation / @ripl/charts / ArcDiagramChartOptions
Interface: ArcDiagramChartOptions<TData>
Defined in: charts/src/charts/arc-diagram.ts:99
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: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 |
format? | ValueFormatInput | Format applied to link values shown as text (e.g. tooltips). | - | charts/src/charts/arc-diagram.ts:111 |
links | ArcDiagramLink[] | The links drawn as arcs between pairs of nodes. | - | charts/src/charts/arc-diagram.ts:103 |
nodeRadius? | number | Node dot radius (the max radius when sizeByConnections is on). Defaults to 6. | - | charts/src/charts/arc-diagram.ts:105 |
nodes | ArcDiagramNode<TData>[] | The nodes laid out along the axis. | - | charts/src/charts/arc-diagram.ts:101 |
orientation? | ArcDiagramOrientation | Lay the node axis horizontally (default) or vertically (a Y axis with arcs bulging right). | - | charts/src/charts/arc-diagram.ts:107 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
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:109 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |