Package Health Score

62 / 100

security
Security review needed
popularity
Small
maintenance
Sustainable
community
Sustainable

Explore Similar Packages

Security

Security review needed

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.3.1	\|	11/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.5	\|	02/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.35.6	\|	04/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.3	\|	04/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.2	\|	04/2017		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 (8,309)

GitHub Stars: 226
Forks: 52
Contributors: 2

Direct Usage Popularity

The npm package 3d-force-graph-vr receives a total of 8,309 downloads a week. As such, we scored 3d-force-graph-vr popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package 3d-force-graph-vr, we found that it has been starred 226 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: 2
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like 3d-force-graph-vr is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 15
Open PR: 0
Last Release: 16 days ago
Last Commit: 16 days ago

Further analysis of the maintenance status of 3d-force-graph-vr based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that 3d-force-graph-vr demonstrates a positive version release cadence with at least one new version released in the past 3 months.

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: >=12

Age: 8 years
Dependencies: 6 Direct
Versions: 150
Install Size: 14.9 MB
Dist-tags: 2
# of Files: 8
Maintainers: 1
TS Typings: Yes

3d-force-graph-vr 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

3D Force-Directed Graph in VR

A web component to represent a graph data structure in virtual reality using a force-directed iterative layout. Uses A-Frame for VR rendering and d3-force-3d for the layout physics engine.

And check out the React bindings.

Examples

Quick start

import ForceGraphVR from '3d-force-graph-vr';

or using a script tag

then

const myGraph = ForceGraphVR();
myGraph(myDOMElement)
  .graphData(myData);

API reference

Data input

Method	Description	Default
graphData([data])	Getter/setter for graph data structure (see below for syntax details).	`{ nodes: [], links: [] }`
jsonUrl([url])	URL of JSON file to load graph data directly from, as an alternative to specifying graphData directly.
nodeId([str])	Node object accessor attribute for unique node id (used in link objects source/target).	`id`
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`

Container layout

Method	Description	Default
width([px])	Getter/setter for the canvas width.	<window width>
height([px])	Getter/setter for the canvas height.	<window height>
backgroundColor([str])	Getter/setter for the chart background color.	`#000011`
showNavInfo([boolean])	Getter/setter for whether to show the navigation controls footer info.	`true`

Node styling

Method	Description	Default
nodeRelSize([num])	Getter/setter for the ratio of node sphere volume (cubic px) per value unit.	4
nodeVal([num, str or fn])	Node object accessor function, attribute or a numeric constant for the node numeric value (affects sphere volume).	`val`
nodeLabel([str or fn])	Node object accessor function or attribute for name (shown in label).	`name`
nodeDesc([str or fn])	Node object accessor function or attribute for description (shown under label).	`desc`
nodeVisibility([boolean, str or fn])	Node object accessor function, attribute or a boolean constant for whether to display the node.	`true`
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
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
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`.
nodeThreeObjectExtend([bool, str or fn])	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`

Link styling

Method	Description	Default
linkLabel([str or fn])	Link object accessor function or attribute for name (shown in label).	`name`
linkDesc([str or fn])	Link object accessor function or attribute for description (shown under label).	`desc`
linkVisibility([boolean, str or fn])	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`
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
linkCurvature([num, str or fn])	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
linkCurveRotation([num, str or fn])	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
linkMaterial([Material, str or fn])	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.	default link material is MeshLambertMaterial styled according to `color` and `opacity`.
linkThreeObject([Object3d, str or fn])	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.	default link object is a line or cylinder, sized according to `width` and styled according to `material`.
linkThreeObjectExtend([bool, str or fn])	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`
linkPositionUpdate([fn(linkObject, { start, end }, link)])	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.
linkDirectionalArrowLength([num, str or fn])	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.	0
linkDirectionalArrowColor([str or fn])	Link object accessor function or attribute for the color of the arrow head.	`color`
linkDirectionalArrowRelPos([num, str or fn])	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
linkDirectionalArrowResolution([num])	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
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
emitParticle(link)	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.

Interaction

Method	Description	Default
onNodeHover([fn])	Callback function for node hover events. The node object (or `null` if there's no node directly under the pointer line of sight) is included as the first argument, and the previous node object (or `null`) as second argument.	-
onLinkHover([fn])	Callback function for link hover events. The link object (or `null` if there's no link directly under the pointer line of sight) is included as the first argument, and the previous link object (or `null`) as second argument.	-
onNodeClick([fn])	Callback function for node click events. The node object is included as sole argument.	-
onLinkClick([fn])	Callback function for link click events. The link object is included as sole argument.	-

Force engine configuration

Method	Description	Default
forceEngine([str])	Getter/setter for which force-simulation engine to use (d3 or ngraph).	`d3`
numDimensions([int])	Getter/setter for number of dimensions to run the force simulation on (1, 2 or 3).	3
dagMode([str])	Apply layout constraints based on the graph directionality. Only works correctly 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([num])	If `dagMode` is engaged, this specifies the distance between the different graph depths.	auto-derived from the number of nodes
dagNodeFilter([fn])	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 => true`
onDagError([fn])	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
d3AlphaMin([num])	Getter/setter for the simulation alpha min parameter, only applicable if using the d3 simulation engine.	`0`
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.
d3ReheatSimulation()	Reheats the force simulation engine, by setting the `alpha` value to `1`. Only applicable if using the d3 simulation engine.
ngraphPhysics([object])	Specify custom physics configuration for ngraph, according to its configuration object syntax. This method is only applicable if using the ngraph simulation engine.	ngraph default
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
onEngineTick(fn)	Callback function invoked at every tick of the simulation engine.	-
onEngineStop(fn)	Callback function invoked when the simulation engine stops and the layout is frozen.	-
refresh()	Redraws all the nodes/links.

Utility

Method	Description
getGraphBbox([nodeFilterFn])	Returns the current bounding box of the nodes in the graph, formatted as `{ x: [, ], y: [, ], z: [, ] }`. If no nodes are found, returns `null`. Accepts an optional argument to define a custom node filter: `node =>` , 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.

Input JSON syntax

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

Giving Back

If this project has helped you and you'd like to contribute back, you can always buy me a ☕!

3d-force-graph-vr dependencies

accessor-fn aframe aframe-extras aframe-forcegraph-component kapsule polished

3d-force-graph-vr development dependencies

@babel/core @babel/preset-env @rollup/plugin-babel @rollup/plugin-commonjs @rollup/plugin-node-resolve @rollup/plugin-terser postcss rimraf rollup rollup-plugin-dts rollup-plugin-postcss typescript

FAQs

What is 3d-force-graph-vr?

UI component for a 3D force-directed graph in VR. Visit Snyk Advisor to see a full health score report for 3d-force-graph-vr, including popularity, security, maintenance & community analysis.

Is 3d-force-graph-vr popular?

The npm package 3d-force-graph-vr receives a total of 8,309 weekly downloads. As such, 3d-force-graph-vr popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is 3d-force-graph-vr well maintained?

We found indications that 3d-force-graph-vr maintenance is sustainable demonstrating some project activity. We saw a total of 2 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is 3d-force-graph-vr safe to use?

While scanning the latest version of 3d-force-graph-vr, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 18 November-2024, at 03:05 (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