{"id":23065554,"url":"https://github.com/vasturiano/three-forcegraph","last_synced_at":"2025-05-15T01:09:35.343Z","repository":{"id":27982385,"uuid":"115782108","full_name":"vasturiano/three-forcegraph","owner":"vasturiano","description":"Force-directed graph as a ThreeJS 3d object","archived":false,"fork":false,"pushed_at":"2025-03-21T03:35:47.000Z","size":1032,"stargazers_count":267,"open_issues_count":4,"forks_count":47,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-15T03:39:50.828Z","etag":null,"topics":["3d","3d-force-graph","d3js","data-visualization","force-directed-graphs","threejs","webgl"],"latest_commit_sha":null,"homepage":"https://vasturiano.github.io/three-forcegraph/example/basic/","language":"JavaScript","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,"zenodo":null}},"created_at":"2017-12-30T07:45:50.000Z","updated_at":"2025-04-07T16:57:04.000Z","dependencies_parsed_at":"2024-02-08T02:36:02.318Z","dependency_job_id":"832ea402-2cb0-450b-ae57-72269a81b6a3","html_url":"https://github.com/vasturiano/three-forcegraph","commit_stats":{"total_commits":331,"total_committers":10,"mean_commits":33.1,"dds":0.06042296072507558,"last_synced_commit":"541892562d5d823031ef4043f4e25e808b8074c7"},"previous_names":[],"tags_count":147,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fthree-forcegraph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fthree-forcegraph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fthree-forcegraph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vasturiano%2Fthree-forcegraph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vasturiano","download_url":"https://codeload.github.com/vasturiano/three-forcegraph/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254254043,"owners_count":22039792,"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","3d-force-graph","d3js","data-visualization","force-directed-graphs","threejs","webgl"],"created_at":"2024-12-16T05:08:57.229Z","updated_at":"2025-05-15T01:09:30.336Z","avatar_url":"https://github.com/vasturiano.png","language":"JavaScript","readme":"ThreeJS 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=\"https://observablehq.com/@vasturiano/3d-force-directed-graph\"\u003e\u003cimg width=\"80%\" src=\"https://vasturiano.github.io/three-forcegraph/example/preview.png\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nA [ThreeJS](https://threejs.org/) WebGL class to represent a graph data structure in a 3-dimensional space using a force-directed iterative layout.\nUses either [d3-force-3d](https://github.com/vasturiano/d3-force-3d) or [ngraph](https://github.com/anvaka/ngraph.forcelayout3d) for the underlying physics engine.\n\nSee also the [standalone version](https://github.com/vasturiano/3d-force-graph), and the [react-three-fiber bindings](https://github.com/vasturiano/r3f-forcegraph).\n\n\n## Quick start\n\n```js\nimport ThreeForceGraph from 'three-forcegraph';\n```\nor using a *script* tag\n```html\n\u003cscript src=\"//cdn.jsdelivr.net/npm/three-forcegraph\"\u003e\u003c/script\u003e\n```\nthen\n```js\nconst myGraph = new ThreeForceGraph()\n  .graphData(myData);\n\nconst myScene = new THREE.Scene();\nmyScene.add(myGraph);\n\n...\n\n// on animation frame\nmyGraph.tickFrame();\n```\n\n## API reference\n\n| Method | Description | Default |\n| --- | --- | :--: |\n| \u003cb\u003egraphData\u003c/b\u003e([\u003ci\u003edata\u003c/i\u003e]) | Getter/setter for graph data structure (see below for syntax details). Can also be used to apply [incremental updates](https://observablehq.com/@vasturiano/dynamic-3d-graph). | `{ nodes: [], links: [] }` |\n| \u003cb\u003ejsonUrl\u003c/b\u003e([\u003ci\u003eurl\u003c/i\u003e]) | URL of JSON file to load graph data directly from, as an alternative to specifying \u003ci\u003egraphData\u003c/i\u003e directly. | |\n| \u003cb\u003enumDimensions\u003c/b\u003e([\u003ci\u003eint\u003c/i\u003e]) | Getter/setter for number of dimensions to run the force simulation on (1, 2 or 3). | 3 |\n| \u003cb\u003edagMode\u003c/b\u003e([\u003ci\u003estr\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\u003enum\u003c/i\u003e]) | If `dagMode` is engaged, this specifies the distance between the different graph depths. | *auto-derived from the number of nodes* |\n| \u003cb\u003edagNodeFilter\u003c/b\u003e([\u003ci\u003efn\u003c/i\u003e]) | 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. | `node =\u003e true` |\n| \u003cb\u003eonDagError\u003c/b\u003e([\u003ci\u003efn\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. | *throws exception* |\n| \u003cb\u003enodeRelSize\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the ratio of node sphere volume (cubic px) per value unit. | 4 |\n| \u003cb\u003enodeId\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e]) | Node object accessor attribute for unique node id (used in link objects source/target). | `id` |\n| \u003cb\u003enodeVal\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Node object accessor function, attribute or a numeric constant for the node numeric value (affects sphere volume). | `val` |\n| \u003cb\u003enodeResolution\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the geometric resolution of each node, expressed in how many slice segments to divide the circumference. Higher values yield smoother spheres. | 8 |\n| \u003cb\u003enodeVisibility\u003c/b\u003e([\u003ci\u003eboolean\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Node object accessor function, attribute or a boolean constant for whether to display the node. | `true` |\n| \u003cb\u003enodeColor\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Node object accessor function or attribute for node color (affects sphere color). | `color` |\n| \u003cb\u003enodeAutoColorBy\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Node object accessor function (`fn(node)`) or attribute (e.g. `'type'`) to automatically group colors by. Only affects nodes without a color attribute. | |\n| \u003cb\u003enodeOpacity\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for all the nodes sphere opacity, between [0,1]. | 0.75   |\n| \u003cb\u003enodeThreeObject\u003c/b\u003e([\u003ci\u003eObject3d\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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.  | *default node object is a sphere, sized according to `val` and styled according to `color`.* |\n| \u003cb\u003enodeThreeObjectExtend\u003c/b\u003e([\u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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`).  | `false` |\n| \u003cb\u003enodePositionUpdate\u003c/b\u003e([\u003ci\u003efn(nodeObject, coords, node)\u003c/i\u003e]) | Getter/setter for the 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| \u003cb\u003elinkSource\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e]) | Link object accessor attribute referring to id of source node. | `source` |\n| \u003cb\u003elinkTarget\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e]) | Link object accessor attribute referring to id of target node. | `target` |\n| \u003cb\u003elinkVisibility\u003c/b\u003e([\u003ci\u003eboolean\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function, attribute or a boolean constant for whether to display the link line. A value of `false` maintains the link force without rendering it. | `true` |\n| \u003cb\u003elinkColor\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function or attribute for line color. | `color` |\n| \u003cb\u003elinkAutoColorBy\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function (`fn(link)`) or attribute (e.g. `'type'`) to automatically group colors by. Only affects links without a color attribute. | |\n| \u003cb\u003elinkOpacity\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for line opacity of all the links, between [0,1]. | 0.2 |\n| \u003cb\u003elinkWidth\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function, attribute or a numeric constant for the link line width. A value of zero will render a [ThreeJS Line](https://threejs.org/docs/#api/objects/Line) whose width is constant (`1px`) regardless of distance. Values are rounded to the nearest decimal for indexing purposes. | 0 |\n| \u003cb\u003elinkResolution\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the geometric resolution of each link, expressed in how many radial segments to divide the cylinder. Higher values yield smoother cylinders. Applicable only to links with positive width. | 6 |\n| \u003cb\u003elinkCurvature\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function, attribute or a numeric constant for the curvature radius of the link line. Curved lines are represented as 3D bezier curves, and any numeric value is accepted. 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. Lines are curved clockwise for positive values, and counter-clockwise for negative values. Note that rendering curved lines is purely a visual effect and does not affect the behavior of the underlying forces. | 0 |\n| \u003cb\u003elinkCurveRotation\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | 0 |\n| \u003cb\u003elinkMaterial\u003c/b\u003e([\u003ci\u003eMaterial\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | *default link material is [MeshLambertMaterial](https://threejs.org/docs/#api/materials/MeshLambertMaterial) styled according to `color` and `opacity`.* |\n| \u003cb\u003elinkThreeObject\u003c/b\u003e([\u003ci\u003eObject3d\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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.  | *default link object is a line or cylinder, sized according to `width` and styled according to `material`.* |\n| \u003cb\u003elinkThreeObjectExtend\u003c/b\u003e([\u003ci\u003ebool\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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`).  | `false` |\n| \u003cb\u003elinkPositionUpdate\u003c/b\u003e([\u003ci\u003efn(linkObject, { start, end }, link)\u003c/i\u003e]) | Getter/setter for the 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\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | 0 |\n| \u003cb\u003elinkDirectionalArrowColor\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function or attribute for the color of the arrow head. | `color` |\n| \u003cb\u003elinkDirectionalArrowRelPos\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | 0.5 |\n| \u003cb\u003elinkDirectionalArrowResolution\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the geometric resolution of the arrow head, expressed in how many slice segments to divide the cone base circumference. Higher values yield smoother arrows. | 8 |\n| \u003cb\u003elinkDirectionalParticles\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | 0 |\n| \u003cb\u003elinkDirectionalParticleSpeed\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | 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. | 0.01 |\n| \u003cb\u003elinkDirectionalParticleWidth\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e, \u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function, attribute or a numeric constant for the directional particles width. Values are rounded to the nearest decimal for indexing purposes. | 0.5 |\n| \u003cb\u003elinkDirectionalParticleColor\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e or \u003ci\u003efn\u003c/i\u003e]) | Link object accessor function or attribute for the directional particles color. | `color` |\n| \u003cb\u003elinkDirectionalParticleResolution\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the geometric resolution of each directional particle, expressed in how many slice segments to divide the circumference. Higher values yield smoother particles. | 4 |\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| \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| \u003cb\u003eforceEngine\u003c/b\u003e([\u003ci\u003estr\u003c/i\u003e]) | Getter/setter for which force-simulation engine to use ([*d3*](https://github.com/vasturiano/d3-force-3d) or [*ngraph*](https://github.com/anvaka/ngraph.forcelayout)). | `d3` |\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\u003ed3AlphaMin\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the [simulation alpha min](https://github.com/vasturiano/d3-force-3d#simulation_alphaMin) parameter, only applicable if using the d3 simulation engine. | `0` |\n| \u003cb\u003ed3AlphaDecay\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the [simulation intensity decay](https://github.com/vasturiano/d3-force-3d#simulation_alphaDecay) parameter, only applicable if using the d3 simulation engine. | `0.0228` |\n| \u003cb\u003ed3AlphaTarget\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the [simulation alpha target](https://github.com/vasturiano/d3-force-3d#simulation_alphaTarget) parameter, only applicable if using the d3 simulation engine. | `0` |\n| \u003cb\u003ed3VelocityDecay\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for the 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. | `0.4` |\n| \u003cb\u003ed3Force\u003c/b\u003e(\u003ci\u003estr\u003c/i\u003e, [\u003ci\u003efn\u003c/i\u003e]) | Getter/setter for 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. This method is 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#physics-simulator) syntax. This method is only applicable if using the ngraph simulation engine. | *ngraph default* |\n| \u003cb\u003ewarmupTicks\u003c/b\u003e([\u003ci\u003eint\u003c/i\u003e]) | Getter/setter for number of layout engine cycles to dry-run at ignition before starting to render. | 0 |\n| \u003cb\u003ecooldownTicks\u003c/b\u003e([\u003ci\u003eint\u003c/i\u003e]) | Getter/setter for how many build-in frames to render before stopping and freezing the layout engine. | Infinity |\n| \u003cb\u003ecooldownTime\u003c/b\u003e([\u003ci\u003enum\u003c/i\u003e]) | Getter/setter for how long (ms) to render for before stopping and freezing the layout engine. | 15000 |\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| \u003cb\u003eonEngineTick\u003c/b\u003e(\u003ci\u003efn\u003c/i\u003e) | Callback function invoked at every tick of the simulation engine. | - |\n| \u003cb\u003eonEngineStop\u003c/b\u003e(\u003ci\u003efn\u003c/i\u003e) | Callback function invoked when the simulation engine stops and the layout is frozen. | - |\n| \u003cb\u003eonLoading\u003c/b\u003e(\u003ci\u003efn\u003c/i\u003e) | Callback function for notification that data is being loaded asynchronously based on `jsonUrl`. | - |\n| \u003cb\u003eonFinishLoading\u003c/b\u003e(\u003ci\u003efn\u003c/i\u003e) | Callback function for notification that the component has finished loading data asynchronously. | - |\n| \u003cb\u003eonUpdate\u003c/b\u003e(\u003ci\u003efn\u003c/i\u003e) | Callback function for notification that the component has started updating and the simulation engine is temporarily paused. | - |\n| \u003cb\u003eonFinishUpdate\u003c/b\u003e(\u003ci\u003efn\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| \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\u003eresetProps\u003c/b\u003e() | Reset all object properties to their default value. ||\n| \u003cb\u003erefresh\u003c/b\u003e() | Redraws all the nodes/links. ||\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/three-forcegraph\n[npm-url]: https://npmjs.org/package/three-forcegraph\n[build-size-img]: https://img.shields.io/bundlephobia/minzip/three-forcegraph\n[build-size-url]: https://bundlephobia.com/result?p=three-forcegraph\n[npm-downloads-img]: https://img.shields.io/npm/dt/three-forcegraph\n[npm-downloads-url]: https://www.npmtrends.com/three-forcegraph\n","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":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasturiano%2Fthree-forcegraph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvasturiano%2Fthree-forcegraph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvasturiano%2Fthree-forcegraph/lists"}