https://github.com/vasturiano/d3-force-constant
A constant acceleration force type for the d3-force simulation engine
https://github.com/vasturiano/d3-force-constant
acceleration-force d3-force d3js force-simulation
Last synced: 3 months ago
JSON representation
A constant acceleration force type for the d3-force simulation engine
- Host: GitHub
- URL: https://github.com/vasturiano/d3-force-constant
- Owner: vasturiano
- License: mit
- Created: 2017-09-22T00:30:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-06-05T23:06:58.000Z (4 months ago)
- Last Synced: 2025-07-12T03:49:27.502Z (3 months ago)
- Topics: acceleration-force, d3-force, d3js, force-simulation
- Language: JavaScript
- Homepage:
- Size: 105 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
d3.forceConstant
==============
[![NPM package][npm-img]][npm-url]
[![Build Size][build-size-img]][build-size-url]
[![NPM Downloads][npm-downloads-img]][npm-downloads-url]
A constant acceleration force type for the [d3-force](https://github.com/d3/d3-force) simulation engine.
This force accelerates nodes in a particular direction by a constant amount at each tick. Both the force strength and the direction can be set custom per node, or global for all the nodes equally.
It can be used, for example to simulate weight caused by earth's gravity (constant acceleration pointing down), as well as wind blowing or a current flowing in an arbitrary direction.
This force plugin is also compatible with [d3-force-3d](https://github.com/vasturiano/d3-force-3d) and can function in a one, two (default) or three dimensional space.
## Quick start
```js
import d3ForceConstant from 'd3-force-constant';
```
or using a *script* tag
```html
```
then
```js
d3.forceSimulation()
.nodes()
.force('gravity', d3.forceConstant()
.strength(0.5)
.direction(90)
);
```
## API reference
| Method | Description | Default |
| ------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------- |
| strength([num or fn]) | Getter/setter for the node object strength accessor function (`fn(node)`) or a constant (`num`) for all nodes. This represents the strength of the force, in terms of velocity deltas per tick, i.e. `px/tick^2`. | 1 |
| direction([num or fn]) | Getter/setter for the node object direction accessor function (`fn(node)`) or a constant (`num`) for all nodes. This defines the orientation of the force in the XY plane in degrees, with `0` representing only X increases (rightwards in SVG convention) and `90` only Y increases (downwards). | 90 |
| zAngle([num or fn]) | Getter/setter for the node object Z axis angle accessor function (`fn(node)`) or a constant (`num`) for all nodes. Mainly applicable in 3D scenarios when using [d3-force-3d](https://github.com/vasturiano/d3-force-3d). This defines the angle of the force in degrees against the XY plane, with `0` indicating parallel (no Z influence) and `-90` (far) / `90` (near) perpendicular (`direction` has no effect in this case). Values below `-90` or above `90` invert direction on the XY plane. | 0 |
## ❤️ Support This Project
If you find this module useful and would like to support its development, you can [buy me a ☕](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=L398E7PKP47E8¤cy_code=USD&source=url). Your contributions help keep open-source sustainable!
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=L398E7PKP47E8¤cy_code=USD&source=url)
[npm-img]: https://img.shields.io/npm/v/d3-force-constant
[npm-url]: https://npmjs.org/package/d3-force-constant
[build-size-img]: https://img.shields.io/bundlephobia/minzip/d3-force-constant
[build-size-url]: https://bundlephobia.com/result?p=d3-force-constant
[npm-downloads-img]: https://img.shields.io/npm/dt/d3-force-constant
[npm-downloads-url]: https://www.npmtrends.com/d3-force-constant