{"id":22778899,"url":"https://github.com/vasturiano/r3f-forcegraph","last_synced_at":"2025-04-13T09:51:21.405Z","repository":{"id":267356749,"uuid":"900841612","full_name":"vasturiano/r3f-forcegraph","owner":"vasturiano","description":"Force-directed graph as a React Three Fiber component","archived":false,"fork":false,"pushed_at":"2025-03-20T22:54:52.000Z","size":396,"stargazers_count":17,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-20T23:31:27.730Z","etag":null,"topics":["3d","data-visualization","force-directed-graphs","react-three-fiber","threejs","webgl"],"latest_commit_sha":null,"homepage":"https://vasturiano.github.io/r3f-forcegraph/example/large-graph/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vasturiano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-09T15:12:28.000Z","updated_at":"2025-03-20T22:54:54.000Z","dependencies_parsed_at":"2024-12-09T22:22:01.991Z","dependency_job_id":"646104f1-88de-43b8-861f-b35b403fbe01","html_url":"https://github.com/vasturiano/r3f-forcegraph","commit_stats":null,"previous_names":["vasturiano/r3f-forcegraph"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fr3f-forcegraph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fr3f-forcegraph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fr3f-forcegraph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fr3f-forcegraph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vasturiano","download_url":"https://codeload.github.com/vasturiano/r3f-forcegraph/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248695300,"owners_count":21146952,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["3d","data-visualization","force-directed-graphs","react-three-fiber","threejs","webgl"],"created_at":"2024-12-11T20:07:06.479Z","updated_at":"2025-04-13T09:51:21.399Z","avatar_url":"https://github.com/vasturiano.png","language":"HTML","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=L398E7PKP47E8\u0026currency_code=USD\u0026source=url","https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=L398E7PKP47E8\u0026currency_code=USD\u0026source=url)!"],"categories":[],"sub_categories":[],"readme":"React-Three-Fiber Force-Directed Graph\n======================================\n\n[![NPM package][npm-img]][npm-url]\n[![Build Size][build-size-img]][build-size-url]\n[![NPM Downloads][npm-downloads-img]][npm-downloads-url]\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"//vasturiano.github.io/r3f-forcegraph/example/large-graph/\"\u003e\u003cimg width=\"80%\" src=\"https://vasturiano.github.io/r3f-forcegraph/example/preview.png\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n[React-Three-Fiber](https://github.com/pmndrs/react-three-fiber) bindings for the [three-forcegraph](https://github.com/vasturiano/three-forcegraph) ThreeJS component.\n\n#### Check out the examples:\n* [Basic](https://vasturiano.github.io/r3f-forcegraph/example/basic/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/basic/index.html))\n* [Larger Graph](https://vasturiano.github.io/r3f-forcegraph/example/large-graph/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/large-graph/index.html))\n* [Directional arrows](https://vasturiano.github.io/r3f-forcegraph/example/directional-links-arrows/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/directional-links-arrows/index.html))\n* [Directional moving particles](https://vasturiano.github.io/r3f-forcegraph/example/directional-links-particles/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/directional-links-particles/index.html))\n* [Text as nodes](https://vasturiano.github.io/r3f-forcegraph/example/text-nodes/index.html) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/text-nodes/index.html))\n* [Highlight nodes/links](https://vasturiano.github.io/r3f-forcegraph/example/highlight/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/highlight/index.html))\n* [Click to expand/collapse nodes](https://vasturiano.github.io/r3f-forcegraph/example/expandable-nodes/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/expandable-nodes/index.html))\n* [Node collision detection](https://vasturiano.github.io/r3f-forcegraph/example/collision-detection/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/collision-detection/index.html))\n* [Force-directed tree (DAG mode)](https://vasturiano.github.io/r3f-forcegraph/example/tree/) ([source](https://github.com/vasturiano/r3f-forcegraph/blob/master/example/tree/index.html))\n\n## Quick start\n\n```js\nimport R3fForceGraph from 'r3f-forcegraph';\n```\nor using a *script* tag\n```html\n\u003cscript src=\"//cdn.jsdelivr.net/npm/r3f-forcegraph\"\u003e\u003c/script\u003e\n```\nthen\n```jsx\nuseFrame(() =\u003e fgRef.current.tickFrame());\n\n...\n\n\u003cCanvas\u003e\n  \u003cR3fForceGraph\n    ref={fgRef}\n    graphData={myData}\n  /\u003e\n\u003c/Canvas\u003e\n```\n\n## API reference\n\n### Data input\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003egraphData\u003c/b\u003e | \u003ci\u003eobject\u003c/i\u003e | `{ nodes: [], links: [] }` | Graph data structure (see below for syntax details). Can also be used to apply incremental updates. |\n| \u003cb\u003enodeId\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e | `id` | Node object accessor attribute for unique node id (used in link objects source/target). |\n| \u003cb\u003elinkSource\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e | `source` | Link object accessor attribute referring to id of source node. |\n| \u003cb\u003elinkTarget\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e | `target` | Link object accessor attribute referring to id of target node. |\n\n### Node styling\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003enodeRelSize\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 4 | Ratio of sphere volume (cubic px) per value unit. |\n| \u003cb\u003enodeVal\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `val` | Node object accessor function, attribute or a numeric constant for the node numeric value (affects node size). |\n| \u003cb\u003enodeVisibility\u003c/b\u003e| \u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `true` | Node object accessor function, attribute or a boolean constant for whether to display the node. |\n| \u003cb\u003enodeColor\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `color` | Node object accessor function or attribute for node color. |\n| \u003cb\u003enodeAutoColorBy\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | | Node object accessor function or attribute to automatically group colors by. Only affects nodes without a color attribute. |\n| \u003cb\u003enodeOpacity\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0.75 | Nodes sphere opacity, between [0,1]. |\n| \u003cb\u003enodeResolution\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 8 | Geometric resolution of each node's sphere, expressed in how many slice segments to divide the circumference. Higher values yield smoother spheres. Only applicable to 3D modes. |\n| \u003cb\u003enodeThreeObject\u003c/b\u003e | \u003ci\u003eObject3d\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | *default 3D node object is a sphere, sized according to `val` and styled according to `color`.* | Node object accessor function or attribute for generating a custom 3d object to render as graph nodes. Should return an instance of [ThreeJS Object3d](https://threejs.org/docs/index.html#api/core/Object3D). If a \u003ci\u003efalsy\u003c/i\u003e value is returned, the default 3d object type will be used instead for that node. |\n| \u003cb\u003enodeThreeObjectExtend\u003c/b\u003e | \u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `false` | Node object accessor function, attribute or a boolean value for whether to replace the default node when using a custom `nodeThreeObject` (`false`) or to extend it (`true`). |\n| \u003cb\u003enodePositionUpdate\u003c/b\u003e | \u003ci\u003efunc(nodeObject, coords, node)\u003c/i\u003e | | Custom function to call for updating the position of nodes at every render iteration. It receives the respective node `ThreeJS Object3d`, the coordinates of the node (`{x,y,z}` each), and the node's `data`. If the function returns a truthy value, the regular position update function will not run for that node. |\n\n### Link styling\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003elinkVisibility\u003c/b\u003e| \u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `true` | Link object accessor function, attribute or a boolean constant for whether to display the link line. |\n| \u003cb\u003elinkColor\u003c/b\u003e| \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `color` | Link object accessor function or attribute for line color. |\n| \u003cb\u003elinkAutoColorBy\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | | Link object accessor function or attribute to automatically group colors by. Only affects links without a color attribute. |\n| \u003cb\u003elinkOpacity\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0.2 | Line opacity of links, between [0,1]. |\n| \u003cb\u003elinkWidth\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 1 | Link object accessor function, attribute or a numeric constant for the link line width. |\n| \u003cb\u003elinkResolution\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 6 | Geometric resolution of each link 3D line, expressed in how many radial segments to divide the cylinder. Higher values yield smoother cylinders. Applicable only to links with positive width. |\n| \u003cb\u003elinkCurvature\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0 | Link object accessor function, attribute or a numeric constant for the curvature radius of the link line. A value of `0` renders a straight line. `1` indicates a radius equal to half of the line length, causing the curve to approximate a semi-circle. For self-referencing links (`source` equal to `target`) the curve is represented as a loop around the node, with length proportional to the curvature value. |\n| \u003cb\u003elinkCurveRotation\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0 | Link object accessor function, attribute or a numeric constant for the rotation along the line axis to apply to the curve. Has no effect on straight lines. At `0` rotation, the curve is oriented in the direction of the intersection with the `XY` plane. The rotation angle (in radians) will rotate the curved line clockwise around the \"start-to-end\" axis from this reference orientation. |\n| \u003cb\u003elinkMaterial\u003c/b\u003e | \u003ci\u003eMaterial\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | *default link material is [MeshLambertMaterial](https://threejs.org/docs/#api/materials/MeshLambertMaterial) styled according to `color` and `opacity`.* | Link object accessor function or attribute for specifying a custom material to style the graph links with. Should return an instance of [ThreeJS Material](https://threejs.org/docs/#api/materials/Material). If a \u003ci\u003efalsy\u003c/i\u003e value is returned, the default material will be used instead for that link. |\n| \u003cb\u003elinkThreeObject\u003c/b\u003e | \u003ci\u003eObject3d\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | *default 3D link object is a line or cylinder, sized according to `width` and styled according to `material`.* | Link object accessor function or attribute for generating a custom 3d object to render as graph links. Should return an instance of [ThreeJS Object3d](https://threejs.org/docs/index.html#api/core/Object3D). If a \u003ci\u003efalsy\u003c/i\u003e value is returned, the default 3d object type will be used instead for that link. |\n| \u003cb\u003elinkThreeObjectExtend\u003c/b\u003e | \u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `false` | Link object accessor function, attribute or a boolean value for whether to replace the default link when using a custom `linkThreeObject` (`false`) or to extend it (`true`). |\n| \u003cb\u003elinkPositionUpdate\u003c/b\u003e | \u003ci\u003efunc(linkObject, { start, end }, link)\u003c/i\u003e | | Custom function to call for updating the position of links at every render iteration. It receives the respective link `ThreeJS Object3d`, the `start` and `end` coordinates of the link (`{x,y,z}` each), and the link's `data`. If the function returns a truthy value, the regular position update function will not run for that link. |\n| \u003cb\u003elinkDirectionalArrowLength\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0 | Link object accessor function, attribute or a numeric constant for the length of the arrow head indicating the link directionality. The arrow is displayed directly over the link line, and points in the direction of `source` \u003e `target`. A value of `0` hides the arrow. |\n| \u003cb\u003elinkDirectionalArrowColor\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `color` | Link object accessor function or attribute for the color of the arrow head. |\n| \u003cb\u003elinkDirectionalArrowRelPos\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0.5 | Link object accessor function, attribute or a numeric constant for the longitudinal position of the arrow head along the link line, expressed as a ratio between `0` and `1`, where `0` indicates immediately next to the `source` node, `1` next to the `target` node, and `0.5` right in the middle. |\n| \u003cb\u003elinkDirectionalArrowResolution\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 8 | Geometric resolution of the arrow head, expressed in how many slice segments to divide the cone base circumference. Higher values yield smoother arrows. |\n| \u003cb\u003elinkDirectionalParticles\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0 | Link object accessor function, attribute or a numeric constant for the number of particles (small spheres) to display over the link line. The particles are distributed equi-spaced along the line, travel in the direction `source` \u003e `target`, and can be used to indicate link directionality. |\n| \u003cb\u003elinkDirectionalParticleSpeed\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0.01 | Link object accessor function, attribute or a numeric constant for the directional particles speed, expressed as the ratio of the link length to travel per frame. Values above `0.5` are discouraged. |\n| \u003cb\u003elinkDirectionalParticleWidth\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e, \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | 0.5 | Link object accessor function, attribute or a numeric constant for the directional particles width. Values are rounded to the nearest decimal for indexing purposes. |\n| \u003cb\u003elinkDirectionalParticleColor\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e or \u003ci\u003efunc\u003c/i\u003e | `color` | Link object accessor function or attribute for the directional particles color. |\n| \u003cb\u003elinkDirectionalParticleResolution\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 4 | Geometric resolution of each 3D directional particle, expressed in how many slice segments to divide the circumference. Higher values yield smoother particles. |\n\n| Method | Arguments | Description |\n| --- | :--: | --- |\n| \u003cb\u003eemitParticle\u003c/b\u003e | (\u003ci\u003elink\u003c/i\u003e) | An alternative mechanism for generating particles, this method emits a non-cyclical single particle within a specific link. The emitted particle shares the styling (speed, width, color) of the regular particle props. A valid `link` object that is included in `graphData` should be passed as a single parameter. |\n\n### Force engine configuration\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003enumDimensions\u003c/b\u003e | \u003ci\u003e1\u003c/i\u003e, \u003ci\u003e2\u003c/i\u003e or \u003ci\u003e3\u003c/i\u003e | 3 | Number of dimensions to run the force simulation on. |\n| \u003cb\u003eforceEngine\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e | `d3` | Which force-simulation engine to use ([*d3*](https://github.com/vasturiano/d3-force-3d) or [*ngraph*](https://github.com/anvaka/ngraph.forcelayout)). |\n| \u003cb\u003edagMode\u003c/b\u003e | \u003ci\u003estring\u003c/i\u003e | *-* | Apply layout constraints based on the graph directionality. Only works correctly for [DAG](https://en.wikipedia.org/wiki/Directed_acyclic_graph) graph structures (without cycles). Choice between `td` (top-down), `bu` (bottom-up), `lr` (left-to-right), `rl` (right-to-left), `zout` (near-to-far), `zin` (far-to-near), `radialout` (outwards-radially) or `radialin` (inwards-radially). |\n| \u003cb\u003edagLevelDistance\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | *auto-derived from the number of nodes* | If `dagMode` is engaged, this specifies the distance between the different graph depths. |\n| \u003cb\u003edagNodeFilter\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | `node =\u003e true` | Node accessor function to specify nodes to ignore during the DAG layout processing. This accessor method receives a node object and should return a `boolean` value indicating whether the node is to be included. Excluded nodes will be left unconstrained and free to move in any direction. |\n| \u003cb\u003eonDagError\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback to invoke if a cycle is encountered while processing the data structure for a DAG layout. The loop segment of the graph is included for information, as an array of node ids. By default an exception will be thrown whenever a loop is encountered. You can override this method to handle this case externally and allow the graph to continue the DAG processing. Strict graph directionality is not guaranteed if a loop is encountered and the result is a best effort to establish a hierarchy. |\n| \u003cb\u003ed3AlphaMin\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0 | Sets the [simulation alpha min](https://github.com/vasturiano/d3-force-3d#simulation_alphaMin) parameter. Only applicable if using the d3 simulation engine. |\n| \u003cb\u003ed3AlphaDecay\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0.0228 | Sets the [simulation intensity decay](https://github.com/vasturiano/d3-force-3d#simulation_alphaDecay) parameter. Only applicable if using the d3 simulation engine. |\n| \u003cb\u003ed3AlphaTarget\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0 | Sets the [simulation alpha target](https://github.com/vasturiano/d3-force-3d#simulation_alphaTarget) parameter, only applicable if using the d3 simulation engine. |\n| \u003cb\u003ed3VelocityDecay\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0.4 | Nodes' [velocity decay](https://github.com/vasturiano/d3-force-3d#simulation_velocityDecay) that simulates the medium resistance. Only applicable if using the d3 simulation engine. |\n| \u003cb\u003engraphPhysics\u003c/b\u003e | \u003ci\u003eobject\u003c/i\u003e | *-* | Specify custom physics configuration for ngraph, according to its [configuration object](https://github.com/anvaka/ngraph.forcelayout#configuring-physics) syntax. Only applicable if using the ngraph simulation engine. |\n| \u003cb\u003ewarmupTicks\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 0 | Number of layout engine cycles to dry-run at ignition before starting to render. |\n| \u003cb\u003ecooldownTicks\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | Infinity | How many build-in frames to render before stopping and freezing the layout engine. |\n| \u003cb\u003ecooldownTime\u003c/b\u003e | \u003ci\u003enumber\u003c/i\u003e | 15000 | How long (ms) to render for before stopping and freezing the layout engine. |\n| \u003cb\u003eonEngineTick\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function invoked at every tick of the simulation engine. |\n| \u003cb\u003eonEngineStop\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function invoked when the simulation engine stops and the layout is frozen. |\n\n| Method | Arguments | Description |\n| --- | :--: | --- |\n| \u003cb\u003ed3Force\u003c/b\u003e | (\u003ci\u003estring\u003c/i\u003e, [\u003ci\u003efunc\u003c/i\u003e]) | Access to the internal forces that control the d3 simulation engine. Follows the same interface as `d3-force-3d`'s [simulation.force](https://github.com/vasturiano/d3-force-3d#simulation_force). Three forces are included by default: `'link'` (based on [forceLink](https://github.com/vasturiano/d3-force-3d#forceLink)), `'charge'` (based on [forceManyBody](https://github.com/vasturiano/d3-force-3d#forceManyBody)) and `'center'` (based on [forceCenter](https://github.com/vasturiano/d3-force-3d#forceCenter)). Each of these forces can be reconfigured, or new forces can be added to the system. Only applicable if using the d3 simulation engine. |\n| \u003cb\u003ed3ReheatSimulation\u003c/b\u003e | () | Reheats the force simulation engine, by setting the `alpha` value to `1`. Only applicable if using the d3 simulation engine. |\n| \u003cb\u003eresetCountdown\u003c/b\u003e | () | Resets the engine countdown timer to the initial value. Useful when you want to keep the engine ticking for a while after the last user interaction. |\n\n### Interaction\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003eonNodeClick\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function for node clicks. The node object and the event object are included as arguments `onNodeClick(node, event)`. |\n| \u003cb\u003eonNodeHover\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function for node mouse over events. The node object (or `null` if there's no node under the pointer line of sight) is included as the first argument, and the previous node object (or null) as second argument: `onNodeHover(node, prevNode)`. |\n| \u003cb\u003eonLinkClick\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function for link clicks. The link object and the event object are included as arguments `onLinkClick(link, event)`. |\n| \u003cb\u003eonLinkHover\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function for link mouse over events. The link object (or `null` if there's no link under the pointer line of sight) is included as the first argument, and the previous link object (or null) as second argument: `onLinkHover(link, prevLink)`. |\n\n### Render control\n\n| Prop | Type | Default | Description |\n| --- | :--: | :--: | --- |\n| \u003cb\u003eonFinishUpdate\u003c/b\u003e | \u003ci\u003efunc\u003c/i\u003e | *-* | Callback function for notification that the component has finished updating, done iterating through the warmup phase (if needed) and the simulation engine has been resumed. |\n\n| Method | Arguments | Description |\n| --- | :--: | --- |\n| \u003cb\u003etickFrame\u003c/b\u003e | *-* | This method should be called on each cycle of the global renderer to iterate the underlying force simulation engine and update the nodes/links objects' positions. |\n| \u003cb\u003erefresh\u003c/b\u003e | *-* | Redraws all the nodes/links. |\n\n###  Utility\n\n| Method | Arguments | Description |\n| --- | :--: | --- |\n| \u003cb\u003egetGraphBbox\u003c/b\u003e | ([\u003ci\u003enodeFilterFn\u003c/i\u003e]) | Returns the current bounding box of the nodes in the graph, formatted as `{ x: [\u003cnum\u003e, \u003cnum\u003e], y: [\u003cnum\u003e, \u003cnum\u003e], z: [\u003cnum\u003e, \u003cnum\u003e] }`. If no nodes are found, returns `null`. Accepts an optional argument to define a custom node filter: `node =\u003e \u003cboolean\u003e`, which should return a truthy value if the node is to be included. This can be useful to calculate the bounding box of a portion of the graph. |\n\n\n### Input JSON syntax\n\n```json\n{\n    \"nodes\": [ \n        { \n          \"id\": \"id1\",\n          \"name\": \"name1\",\n          \"val\": 1 \n        },\n        { \n          \"id\": \"id2\",\n          \"name\": \"name2\",\n          \"val\": 10 \n        },\n        ...\n    ],\n    \"links\": [\n        {\n            \"source\": \"id1\",\n            \"target\": \"id2\"\n        },\n        ...\n    ]\n}\n```\n\n## Giving Back\n\n[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=L398E7PKP47E8\u0026currency_code=USD\u0026source=url) If this project has helped you and you'd like to contribute back, you can always [buy me a ☕](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=L398E7PKP47E8\u0026currency_code=USD\u0026source=url)!\n\n[npm-img]: https://img.shields.io/npm/v/r3f-forcegraph\n[npm-url]: https://npmjs.org/package/r3f-forcegraph\n[build-size-img]: https://img.shields.io/bundlephobia/minzip/r3f-forcegraph\n[build-size-url]: https://bundlephobia.com/result?p=r3f-forcegraph\n[npm-downloads-img]: https://img.shields.io/npm/dt/r3f-forcegraph\n[npm-downloads-url]: https://www.npmtrends.com/r3f-forcegraph\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasturiano%2Fr3f-forcegraph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvasturiano%2Fr3f-forcegraph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasturiano%2Fr3f-forcegraph/lists"}