Skip to content

Commit 15c5321

Browse files
committed
Documentation update for graph.config.js
1 parent b328f6f commit 15c5321

File tree

2 files changed

+2
-1
lines changed

2 files changed

+2
-1
lines changed

docs/DOCUMENTATION.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -362,7 +362,6 @@ const graph = {
362362
- If value is negative, nodes will repel each other. Most of the times this is what we want, so nodes don"t overlap. (optional, default `-100`)
363363
- `d3.linkLength` **[number][96]** the length of each link from the center of the nodes it joins. (optional, default `100`)
364364
- `d3.linkStrength` **[number][96]** [see d3-force link.strength][107]
365-
- `d3.disableLinkForce` **[number][96]** when setting this value to true, the nodes will stay at the position chosen by the user, and no other d3 simulation will be done. (optional, default `false`)
366365
<br/> (optional, default `1`)
367366
- `node` **[Object][99]** node object is explained in next section. ⬇️<h2 id="config-node"><a href="#config-node">#</a> Node level configurations</h2>
368367
- `node.color` **[string][98]** 🔍🔍🔍 this is the color that will be applied to the node if no **color property**

src/components/graph/graph.config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@
9999
* - If value is negative, nodes will repel each other. Most of the times this is what we want, so nodes don"t overlap.
100100
* @param {number} [d3.linkLength=100] - the length of each link from the center of the nodes it joins.
101101
* @param {number} [d3.linkStrength=1] - <a target="_blank" href="https://github.com/d3/d3-force#link_strength">see d3-force link.strength</a>
102+
* @param {number} [d3.disableLinkForce=false] - ⚠️EXPERIMENTAL⚠️ it completely disables d3 force link and simulation to re-trigger so that one can obtain
103+
* precise render of node positions as described by the author <a target="_blank" href="https://github.com/antoninklopp">@antoninklopp</a> in <a target="_blank" href="https://github.com/danielcaldas/react-d3-graph/pull/278">the Pull Request description</a>.
102104
* </br>
103105
* @param {Object} node node object is explained in next section. ⬇️
104106
* <h2 id="config-node"><a href="#config-node">#</a> Node level configurations</h2>

0 commit comments

Comments
 (0)