Documentation / @ripl/charts / ForceDirectedChartOptions
Interface: ForceDirectedChartOptions<TData> ​
Defined in: charts/src/charts/force-directed.ts:109
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: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 |
centerStrength? | number | Strength pulling all nodes toward the layout center. | - | charts/src/charts/force-directed.ts:123 |
charge? | number | Force tuning. | - | charts/src/charts/force-directed.ts:117 |
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 node/link values shown as text (e.g. tooltips). | - | charts/src/charts/force-directed.ts:131 |
iterations? | number | Number of simulation iterations run before the layout is drawn. | - | charts/src/charts/force-directed.ts:125 |
legend? | ChartLegendInput | Legend configuration. Shown automatically when there is more than one node group; pass false to hide. | - | charts/src/charts/force-directed.ts:129 |
linkDistance? | number | Target resting distance between two linked nodes. | - | charts/src/charts/force-directed.ts:119 |
links | ForceNetworkLink[] | The links (edges) connecting pairs of nodes. | - | charts/src/charts/force-directed.ts:113 |
linkStrength? | number | Strength pulling linked nodes toward linkDistance. | - | charts/src/charts/force-directed.ts:121 |
nodeRadius? | number | Base node radius (nodes with a value scale around this). Defaults to 8. | - | charts/src/charts/force-directed.ts:115 |
nodes | ForceNetworkNode<TData>[] | The nodes in the network. | - | charts/src/charts/force-directed.ts:111 |
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 |
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:127 |
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 |