three-forcegraph

ThreeJS Force-Directed Graph

A ThreeJS WebGL class to represent a graph data structure in a 3-dimensional space using a force-directed iterative layout. Uses either d3-force-3d or ngraph for the underlying physics engine.

Quick start

import ThreeForceGraph from 'three-forcegraph';

or

var ThreeForceGraph = require('three-forcegraph');

or even

<script src="//unpkg.com/three-forcegraph"></script>

then

var myGraph = new ThreeForceGraph()
    .graphData(<myData>);

var myScene = new THREE.Scene();
myScene.add(myGraph);

...

// on animation frame
myGraph.tickFrame();

API reference

Method	Description	Default
graphData([data])	Getter/setter for graph data structure (see below for syntax details). Can also be used to apply incremental updates.	{ nodes: [], links: [] }
jsonUrl([url])	URL of JSON file to load graph data directly from, as an alternative to specifying graphData directly.
numDimensions([int])	Getter/setter for number of dimensions to run the force simulation on (1, 2 or 3).	3
nodeRelSize([num])	Getter/setter for the ratio of node sphere volume (cubic px) per value unit.	4
nodeId([str])	Node object accessor attribute for unique node id (used in link objects source/target).	id
nodeVal([num, str or fn])	Node object accessor function, attribute or a numeric constant for the node numeric value (affects sphere volume).	val
nodeResolution([num])	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
nodeColor([str or fn])	Node object accessor function or attribute for node color (affects sphere color).	color
nodeAutoColorBy([str or fn])	Node object accessor function (fn(node)) or attribute (e.g. 'type') to automatically group colors by. Only affects nodes without a color attribute.
nodeOpacity([num])	Getter/setter for the nodes sphere opacity, between [0,1].	0.75
nodeThreeObject([Object3d, str or fn])	Node object accessor function or attribute for generating a custom 3d object to render as graph nodes. Should return an instance of ThreeJS Object3d. If a falsy 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.
linkSource([str])	Link object accessor attribute referring to id of source node.	source
linkTarget([str])	Link object accessor attribute referring to id of target node.	target
linkColor([str or fn])	Link object accessor function or attribute for line color.	color
linkAutoColorBy([str or fn])	Link object accessor function (fn(link)) or attribute (e.g. 'type') to automatically group colors by. Only affects links without a color attribute.
linkOpacity([num])	Getter/setter for line opacity of links, between [0,1].	0.2
linkWidth([num, str or fn])	Link object accessor function, attribute or a numeric constant for the link line width. A value of zero will render a ThreeJS Line whose width is constant (1px) regardless of distance. Values are rounded to the nearest decimal for indexing purposes.	0
linkResolution([num])	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
linkDirectionalParticles([num, str or fn])	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 > target, and can be used to indicate link directionality.	0
linkDirectionalParticleSpeed([num, str or fn])	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
linkDirectionalParticleWidth([num, str or fn])	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
linkDirectionalParticleColor([str or fn])	Link object accessor function or attribute for the directional particles color.	color
linkDirectionalParticleResolution([num])	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
forceEngine([str])	Getter/setter for which force-simulation engine to use (d3 or ngraph).	d3
d3AlphaDecay([num])	Getter/setter for the simulation intensity decay parameter, only applicable if using the d3 simulation engine.	0.0228
d3VelocityDecay([num])	Getter/setter for the nodes' velocity decay that simulates the medium resistance, only applicable if using the d3 simulation engine.	0.4
d3Force(str, [fn])	Getter/setter for the internal forces that control the d3 simulation engine. Follows the same interface as d3-force-3d's simulation.force. Three forces are included by default: 'link' (based on forceLink), 'charge' (based on forceManyBody) and 'center' (based on 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.
warmupTicks([int])	Getter/setter for number of layout engine cycles to dry-run at ignition before starting to render.	0
cooldownTicks([int])	Getter/setter for how many build-in frames to render before stopping and freezing the layout engine.	Infinity
cooldownTime([num])	Getter/setter for how long (ms) to render for before stopping and freezing the layout engine.	15000
onLoading(fn)	Callback function for notification that data is being loaded, and the rendering engine is temporarily paused.	-
onFinishLoading(fn)	Callback function for notification that the component has finished loading data and iterating through the warmup phase, and the rendering engine has been resumed.	-
tickFrame()	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.
resetProps()	Reset all object properties to their default value.

Input JSON syntax

{
    "nodes": [
        {
            "id": "id1",
            "name": "name1",
            "val": 1
        },
        {
            "id": "id2",
            "name": "name2",
            "val": 10
        },
        (...)
    ],
    "links": [
        {
            "source": "id1",
            "target": "id2"
        },
        (...)
    ]
}