react-force-graph
React bindings for the force-graph suite of components: 3d-force-graph (ThreeJS/WebGL), 3d-force-graph-vr (A-Frame) and force-graph (2D HTML Canvas).
This module exports 3 React components with identical interfaces: ForceGraph2D, ForceGraph3D and ForceGraphVR. Each can be used to represent a graph data structure in a 2 or 3-dimensional space using a force-directed iterative layout.
For dependency convenience, all of the components are also available as stand-alone packages: react-force-graph-2d, react-force-graph-3d and react-force-graph-vr.
Uses canvas/WebGL for rendering and d3-force-3d for the underlying physics engine. Supports zooming/panning, node dragging and node/link hover/click interactions.
Check out the examples:
- Basic (source)
- Directional arrows (source)
- Directional moving particles (source)
- Auto-colored nodes/links (source)
- 2D Text nodes (source)
- 3D Text nodes (source)
- Image nodes (source)
- Custom 2D node shapes (source)
- Custom 3D/VR node geometries (source)
- Curved lines and self links (source)
- Text in links (source)
- Highlight nodes/links (source)
- Larger graph (source)
- Dynamic data changes (source)
- Click to focus on node (source)
- Camera automatic orbitting (source)
- Node collision detection (source)
- Force-directed tree (DAG mode) (source)
Quick start
import { ForceGraph2D, ForceGraph3D, ForceGraphVR } from 'react-force-graph'; or
import ForceGraph2D from 'react-force-graph-2d'; import ForceGraph3D from 'react-force-graph-3d'; import ForceGraphVR from 'react-force-graph-vr'; or using a script tag
<script src="//unpkg.com/react-force-graph-2d"></script> <script src="//unpkg.com/react-force-graph-3d"></script> <script src="//unpkg.com/react-force-graph-vr"></script> then
ReactDOM.render( <ForceGraph3D graphData={myData} />, myDOMElement ); API reference
Note that not all props listed below apply to all 3 components. The last 3 columns in these tables indicate the specific component availability of each prop/method.
Data input
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| graphData | object | { nodes: [], links: [] } | Graph data structure (see below for syntax details). Can also be used to apply incremental updates. | |||
| nodeId | string | id | Node object accessor attribute for unique node id (used in link objects source/target). | |||
| linkSource | string | source | Link object accessor attribute referring to id of source node. | |||
| linkTarget | string | target | Link object accessor attribute referring to id of target node. |
Container layout
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| width | number | <window width> | Canvas width, in px. | |||
| height | number | <window height> | Canvas height, in px. | |||
| backgroundColor | string | (2D - light / 3D - dark) | Chart background color. | |||
| showNavInfo | bool | true | Whether to show the navigation controls footer info. |
Node styling
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| nodeRelSize | number | 4 | Ratio of node circle area (square px) [2D] or sphere volume (cubic px) [3D] per value unit. | |||
| nodeVal | number, string or func | val | Node object accessor function, attribute or a numeric constant for the node numeric value (affects node size). | |||
| nodeLabel | string or func | name | Node object accessor function or attribute for name (shown in label). Supports plain text or HTML content (except in VR). | |||
| nodeDesc | string or func | desc | For VR only. Node object accessor function or attribute for description (shown under label). | |||
| nodeVisibility | bool, string or func | true | Node object accessor function, attribute or a boolean constant for whether to display the node. | |||
| nodeColor | string or func | color | Node object accessor function or attribute for node color. | |||
| nodeAutoColorBy | string or func | Node object accessor function or attribute to automatically group colors by. Only affects nodes without a color attribute. | ||||
| nodeOpacity | number | 0.75 | Nodes sphere opacity, between [0,1]. | |||
| nodeResolution | number | 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. | |||
| nodeCanvasObject | func | default 2D node object is a circle, sized according to val and styled according to color. | Callback function for painting a custom 2D canvas object to represent graph nodes. Should use the provided canvas context attribute to perform drawing operations for each node. The callback function will be called for each node at every frame, and has the signature: nodeCanvasObject(<node>, <canvas context>, <current global scale>, <isShadowContext>). | |||
| nodeCanvasObjectMode | string or func | () => 'replace' | Node object accessor function or attribute for the custom drawing mode. Use in combination with nodeCanvasObject to specify how to customize nodes painting. Possible values are:
| |||
| nodeThreeObject | Object3d, string or func | 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. If a falsy value is returned, the default 3d object type will be used instead for that node. | |||
| nodeThreeObjectExtend | bool, string or func | 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). |
Link styling
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| linkLabel | string or func | name | Link object accessor function or attribute for name (shown in label). Supports plain text or HTML content (except in VR). | |||
| linkDesc | string or func | desc | For VR only. Link object accessor function or attribute for description (shown under label). | |||
| linkVisibility | bool, string or func | true | Link object accessor function, attribute or a boolean constant for whether to display the link line. | |||
| linkColor | string or func | color | Link object accessor function or attribute for line color. | |||
| linkAutoColorBy | string or func | Link object accessor function or attribute to automatically group colors by. Only affects links without a color attribute. | ||||
| linkOpacity | number | 0.2 | Line opacity of links, between [0,1]. | |||
| linkWidth | number, string or func | 1 | Link object accessor function, attribute or a numeric constant for the link line width. | |||
| linkResolution | number | 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. | |||
| linkCurvature | number, string or func | 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. | |||
| linkCurveRotation | number, string or func | 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. | |||
| linkMaterial | Material, string or func | default link material is 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. If a falsy value is returned, the default material will be used instead for that link. | |||
| linkCanvasObject | func | default 2D link object is a line, styled according to width and color. | Callback function for painting a custom canvas object to represent graph links. Should use the provided canvas context attribute to perform drawing operations for each link. The callback function will be called for each link at every frame, and has the signature: .linkCanvasObject(<link>, <canvas context>, <current global scale>). | |||
| linkCanvasObjectMode | string or func | () => 'replace' | Link object accessor function or attribute for the custom drawing mode. Use in combination with linkCanvasObject to specify how to customize links painting. Possible values are:
| |||
| linkThreeObject | Object3d, string or func | 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. If a falsy value is returned, the default 3d object type will be used instead for that link. | |||
| linkThreeObjectExtend | bool, string or func | 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). | |||
| linkPositionUpdate | func(linkObject, { start, end }, link) | 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. | ||||
| linkDirectionalArrowLength | number, string or func | 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 > target. A value of 0 hides the arrow. | |||
| linkDirectionalArrowColor | string or func | color | Link object accessor function or attribute for the color of the arrow head. | |||
| linkDirectionalArrowRelPos | number, string or func | 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. | |||
| linkDirectionalArrowResolution | number | 8 | 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. | |||
| linkDirectionalParticles | number, string or func | 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 > target, and can be used to indicate link directionality. | |||
| linkDirectionalParticleSpeed | number, string or func | 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. | |||
| linkDirectionalParticleWidth | number, string or func | 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. | |||
| linkDirectionalParticleColor | string or func | color | Link object accessor function or attribute for the directional particles color. | |||
| linkDirectionalParticleResolution | number | 4 | Geometric resolution of each 3D directional particle, expressed in how many slice segments to divide the circumference. Higher values yield smoother particles. |
Render control
| Prop | Type | Default | Description |
|---|---|---|---|
| rendererConfig | object | { antialias: true, alpha: true } | Configuration parameters to pass to the ThreeJS WebGLRenderer constructor. This prop only has an effect on component mount. |
| Method | Arguments | Description | 2D | 3D | VR |
|---|---|---|---|---|---|
| pauseAnimation | - | Pauses the rendering cycle of the component, effectively freezing the current view and cancelling all user interaction. This method can be used to save performance in circumstances when a static image is sufficient. | |||
| resumeAnimation | - | Resumes the rendering cycle of the component, and re-enables the user interaction. This method can be used together with pauseAnimation for performance optimization purposes. | |||
| centerAt | ([x], [y], [ms]) | Set the coordinates of the center of the viewport. This method can be used to perform panning on the 2D canvas programmatically. Each of the x, y coordinates is optional, allowing for motion in just one dimension. An optional 3rd argument defines the duration of the transition (in ms) to animate the canvas motion. | |||
| zoom | ([number], [ms]) | Set the 2D canvas zoom amount. The zoom is defined in terms of the scale transform of each px. A value of 1 indicates unity, larger values zoom in and smaller values zoom out. An optional 2nd argument defines the duration of the transition (in ms) to animate the canvas motion. By default the zoom is set to a value inversely proportional to the amount of nodes in the system. | |||
| cameraPosition | ([{x,y,z}],[lookAt], [ms]) | Re-position the camera, in terms of x, y, z coordinates. Each of the coordinates is optional, allowing for motion in just some dimensions. The optional optional second argument can be used to define the direction that the camera should aim at, in terms of an {x,y,z} point in the 3D space. The 3rd optional argument defines the duration of the transition (in ms) to animate the camera motion. A value of 0 (default) moves the camera immediately to the final position. By default the camera will face the center of the graph at a z distance proportional to the amount of nodes in the system. | |||
| scene | - | Access the internal ThreeJS Scene. | |||
| camera | - | Access the internal ThreeJS Camera. | |||
| renderer | - | Access the internal ThreeJS WebGL renderer. | |||
| controls | - | Access the internal ThreeJS controls object. | |||
| refresh | - | Redraws all the nodes/links and reheats the force simulation engine. |
Force engine (d3-force) configuration
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| numDimensions | 1, 2 or 3 | 3 | Not applicable to 2D mode. Number of dimensions to run the force simulation on. | |||
| dagMode | string | - | Apply layout constraints based on the graph directionality. Only works for DAG 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). | |||
| dagLevelDistance | number | auto-derived from the number of nodes | If dagMode is engaged, this specifies the distance between the different graph depths. | |||
| d3AlphaDecay | number | 0.0228 | Sets the simulation intensity decay parameter. | |||
| d3VelocityDecay | number | 0.4 | Nodes' velocity decay that simulates the medium resistance. | |||
| warmupTicks | number | 0 | Number of layout engine cycles to dry-run at ignition before starting to render. | |||
| cooldownTicks | number | Infinity | How many build-in frames to render before stopping and freezing the layout engine. | |||
| cooldownTime | number | 15000 | How long (ms) to render for before stopping and freezing the layout engine. | |||
| onEngineTick | func | - | Callback function invoked at every tick of the simulation engine. | |||
| onEngineStop | func | - | Callback function invoked when the simulation engine stops and the layout is frozen. |
| Method | Arguments | Description | 2D | 3D | VR |
|---|---|---|---|---|---|
| d3Force | (string, [func]) | Access to 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. |
Interaction
| Prop | Type | Default | Description | 2D | 3D | VR |
|---|---|---|---|---|---|---|
| onNodeClick | func | - | Callback function for node (left-button) clicks. The node object is included as single argument onNodeClick(node). | |||
| onNodeRightClick | func | - | Callback function for node right-clicks. The node object is included as single argument onNodeRightClick(node). | |||
| onNodeHover | func | - | Callback function for node mouse over events. The node object (or null if there's no node under the mouse line of sight) is included as the first argument, and the previous node object (or null) as second argument: onNodeHover(node, prevNode). | |||
| onNodeDrag | func | - | Callback function for node drag interactions. This function is invoked repeatedly while dragging a node, every time its position is updated. The node object is included as single argument onNodeDrag(node). | |||
| onNodeDragEnd | func | - | Callback function for the end of node drag interactions. This function is invoked when the node is released. The node object is included as single argument onNodeDragEnd(node). | |||
| onLinkClick | func | - | Callback function for link (left-button) clicks. The link object is included as single argument onLinkClick(link). | |||
| onLinkRightClick | func | - | Callback function for link right-clicks. The link object is included as single argument onLinkRightClick(link). | |||
| onLinkHover | func | - | Callback function for link mouse over events. The link object (or null if there's no link under the mouse line of sight) is included as the first argument, and the previous link object (or null) as second argument: onLinkHover(link, prevLink). | |||
| linkHoverPrecision | number | 4 | Whether to display the link label when gazing the link closely (low value) or from far away (high value). | |||
| onZoom | func | - | Callback function for zoom/pan events. The current zoom transform is included as single argument onZoom({ k, x, y }). Note that onZoom is triggered by user interaction as well as programmatic zooming/panning with zoom() and centerAt(). | - | ||
| controlType | string | trackball | Which type of control to use to control the camera on 3D mode. Choice between trackball, orbit or fly. | |||
| enableZoomPanInteraction | bool | true | Whether to enable zooming and panning user interactions on a 2D canvas. | |||
| enableNavigationControls | bool | true | Whether to enable the trackball navigation controls used to move the camera using mouse interactions (rotate/zoom/pan). | |||
| enablePointerInteraction | bool | true | Whether to enable the mouse tracking events. This activates an internal tracker of the canvas mouse position and enables the functionality of object hover/click and tooltip labels, at the cost of performance. If you're looking for maximum gain in your graph performance it's recommended to switch off this property. | |||
| enableNodeDrag | bool | true | Whether to enable the user interaction to drag nodes by click-dragging. If enabled, every time a node is dragged the simulation is re-heated so the other nodes react to the changes. Only applicable if enablePointerInteraction is true. |
Input JSON syntax
{ "nodes": [ { "id": "id1", "name": "name1", "val": 1 }, { "id": "id2", "name": "name2", "val": 10 }, (...) ], "links": [ { "source": "id1", "target": "id2" }, (...) ] } Giving Back
