react-force-graph-two-dim-only

v1.8.2

React component for 2D, 3D and VR force directed graphs For more information about how to use this package see README

Latest version published 6 years ago

License: MIT

NPM

GitHub

Package Health Score

51 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.8.2	\|	07/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (96)

GitHub Stars: 2.21K
Forks: 284
Contributors: 6

Direct Usage Popularity

The npm package react-force-graph-two-dim-only receives a total of 96 downloads a week. As such, we scored react-force-graph-two-dim-only popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package react-force-graph-two-dim-only, we found that it has been starred 2,209 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 6
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like react-force-graph-two-dim-only is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 202
Open PR: 0
Last Release: 6 years ago
Last Commit: 28 days ago

Further analysis of the maintenance status of react-force-graph-two-dim-only based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for react-force-graph-two-dim-only is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 4 Direct
Versions: 2
Install Size: 2.84 MB
Dist-tags: 1
# of Files: 35
Maintainers: 1
TS Typings: No

react-force-graph-two-dim-only has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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.

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:

Quick start

import { ForceGraph2D, ForceGraph3D, ForceGraphVR } from 'react-force-graph';

var { ForceGraph2D, ForceGraph3D, ForceGraphVR } = require('react-force-graph');

or even

then

ReactDOM.render(
  , 
  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).			✔️
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(, <canvas>, )`.	✔️
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.		✔️	✔️

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).			✔️
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.		✔️	✔️
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

Method	Arguments	Description	2D	3D
stopAnimation	-	Stops the rendering cycle of the component, effectively freezing the current view and canceling all future user interaction. This method can be used to save performance in circumstances when a static image is sufficient.	✔️	✔️
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	([num], [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.		✔️

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.		✔️	✔️
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	num	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 clicks. The node object is included as single argument `onNodeClick(node)`.	✔️	✔️
onLinkClick	func	-	Callback function for link clicks. The link object is included as single argument `onLinkClick(link)`.	✔️	✔️
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)`.	✔️	✔️
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).	✔️	✔️	✔️
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"
        },
        (...)
    ]
}
```</canvas>

react-force-graph-two-dim-only dependencies

force-graph kapsule prop-types react-kapsule

react-force-graph-two-dim-only development dependencies

babel-core babel-plugin-external-helpers babel-plugin-transform-class-properties babel-plugin-transform-object-rest-spread babel-preset-env babel-preset-react rimraf rollup rollup-plugin-babel rollup-plugin-commonjs rollup-plugin-node-resolve rollup-plugin-replace rollup-watch uglify-es

FAQs

What is react-force-graph-two-dim-only?

React component for 2D, 3D and VR force directed graphs. Visit Snyk Advisor to see a full health score report for react-force-graph-two-dim-only, including popularity, security, maintenance & community analysis.

Is react-force-graph-two-dim-only popular?

The npm package react-force-graph-two-dim-only receives a total of 96 weekly downloads. As such, react-force-graph-two-dim-only popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is react-force-graph-two-dim-only well maintained?

We found indications that react-force-graph-two-dim-only is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is react-force-graph-two-dim-only safe to use?

The npm package react-force-graph-two-dim-only was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 11 November-2024, at 03:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP