Package Exports
- force-graph
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (force-graph) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
force-graph
Force-directed graph rendered on HTML5 canvas.
A web component to represent a graph data structure in a 2-dimensional canvas using a force-directed iterative layout. Uses HTML5 canvas for rendering and d3-force for the underlying physics engine. Supports zooming/panning and hover/click interaction.
Check out the examples:
- Basic (source)
- Load JSON (source)
- Larger graph (source)
- Dynamic data changes (source)
- Auto-colored nodes/links (source)
- Node collision detection (source)
- Directional links (source)
See also the 3D version.
Quick start
import ForceGraph from 'force-graph';or
var ForceGraph = require('force-graph');or even
<script src="//unpkg.com/force-graph"></script>then
var myGraph = ForceGraph();
myGraph(<myDOMElement>)
.graphData(<myData>);API reference
| Method | Description | Default |
|---|---|---|
| width([px]) | Getter/setter for the canvas width. | <window width> |
| height([px]) | Getter/setter for the canvas height. | <window height> |
| graphData([data]) | Getter/setter for graph data structure (see below for syntax details). Can also be used to apply incremental updates. | { nodes: [], links: [] } |
| backgroundColor([str]) | Getter/setter for the chart background color. | <transparent> |
| nodeRelSize([num]) | Getter/setter for the ratio of node circle area (square px) per value unit. | 4 |
| nodeId([str]) | Node object accessor attribute for unique node id (used in link objects source/target). | id |
| nodeLabel([str or fn]) | Node object accessor function or attribute for name (shown in label). Supports plain text or HTML content. | name |
| nodeVal([num, str or fn]) | Node object accessor function, attribute or a numeric constant for the node numeric value (affects circle area). | val |
| nodeColor([str or fn]) | Node object accessor function or attribute for node color (affects circle 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. |
|
| nodeCanvasObject([fn]) | Callback function for painting a custom 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>). |
default node object is a circle, 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 |
| linkLabel([str or fn]) | Link object accessor function or attribute for name (shown in label). Supports plain text or HTML content. | name |
| linkHoverPrecision([int]) | Whether to display the link label when hovering the link closely (low value) or from far away (high value). | 4 |
| 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. |
|
| linkWidth([num, str or fn]) | Link object accessor function, attribute or a numeric constant for the link line width. Keep in mind that link widths remain visually contant through various zoom levels, where as node sizes scale relatively. | 1 |
| linkDirectionalParticles([num, str or fn]) | Link object accessor function, attribute or a numeric constant for the number of particles (small circles) 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 (diameter). | 4 |
| linkDirectionalParticleColor([str or fn]) | Link object accessor function or attribute for the directional particles color. | color |
| d3AlphaDecay([num]) | Getter/setter for the simulation intensity decay parameter. | 0.0228 |
| d3VelocityDecay([num]) | Getter/setter for the nodes' velocity decay that simulates the medium resistance. | 0.4 |
| d3Force(str, [fn]) | Getter/setter for the internal forces that control the d3 simulation engine. Follows the same interface as d3-force'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. |
|
| 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 |
| onNodeClick(fn) | Callback function for node clicks. The node object is included as single argument onNodeClick(node). |
- |
| onLinkClick(fn) | Callback function for link clicks. The link object is included as single argument onLinkClick(node). |
- |
| onNodeHover(fn) | 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(fn) | 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). |
- |
| 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. | |
| resetProps() | Reset all component 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"
},
(...)
]
}
