Documentation / @ripl/charts / ForceDirectedChartOptions
Interface: ForceDirectedChartOptions<TData>
Defined in: charts/src/charts/force-directed.ts:98
Options for configuring a ForceDirectedChart.
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 |
centerStrength? | number | Strength pulling all nodes toward the layout centre. | - | charts/src/charts/force-directed.ts:112 |
charge? | number | Force tuning. | - | charts/src/charts/force-directed.ts:106 |
format? | ValueFormatInput | Format applied to node/link values shown as text (e.g. tooltips). | - | charts/src/charts/force-directed.ts:118 |
iterations? | number | Number of simulation iterations run before the layout is drawn. | - | charts/src/charts/force-directed.ts:114 |
linkDistance? | number | Target resting distance between two linked nodes. | - | charts/src/charts/force-directed.ts:108 |
links | ForceNetworkLink[] | The links (edges) connecting pairs of nodes. | - | charts/src/charts/force-directed.ts:102 |
linkStrength? | number | Strength pulling linked nodes toward linkDistance. | - | charts/src/charts/force-directed.ts:110 |
nodeRadius? | number | Base node radius (nodes with a value scale around this). Defaults to 8. | - | charts/src/charts/force-directed.ts:104 |
nodes | ForceNetworkNode<TData>[] | The nodes in the network. | - | charts/src/charts/force-directed.ts:100 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
root? | string | Id of the node the layout springs out from on entry. Defaults to the highest-degree node. | - | charts/src/charts/force-directed.ts:116 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |