dash-react-force-graph

dash-react-force-graph is a Dash wrapper around the react-force-graph library.

Only the ForceGraph2D component has been ported so far.

Some additional React dependencies have been incorporated to add features such as node right-click context menu, and a menu for modifying graph forces.

This repo is used for building an internal app. Therefore, it has absolutely no guarantees, and not much documentation. Also, it can break or be removed at any point. You are encouraged to clone or fork it and develop it further to suit your needs. (PRs are, of course, welcome).

It has many features in common with Dash cytoscape which is a much more polished project.

See usage.py for a simple example and check out the original react component repo above for many others.

Quick start

Install the library:

pip: python -m pip install git+https://github.com/nodelab-org/dash-react-force-graph

pipenv: python -m pip install git+https://github.com/nodelab-org/dash-react-force-graph#egg=dash-react-force-graph

poetry: poetry add git+https://github.com/nodelab-org/dash-react-force-graph#master

Install Dash and its dependencies: https://dash.plotly.com/installation
For a simple example, download and run usage.py
1. wget https://github.com/nodelab-org/dash-react-force-graph/blob/master/usage.py
2. python usage.py
3. Visit http://localhost:8050 in your web browser. Enjoy!

Features

Please see the react-force-graph docs.

The Dash components expose many of the original React component props directly. Exceptions are:

Props taking javascript functions, if available in the Dash component, are implemented differently (since Dash cannot serialize a javascript function).
Methods (such as d3ReheatSimulation) are, where possible, exposed as Dash props, either boolean or arrays of method arguments. Some methods, such as .scene() are currently not exposed in the Dash version.

Many function props (such as event handlers e.g. onNodeClick) which are available in the react component have been provided built-in functions that perform some sensible default behavior (such as clicking a node to select it). In this case, the Dash component exposes the clicked node and its coordinates as additional props.

See comments in the prop validation parts of the components in./lib/components/ for detail.

technical notes

graphData

A useEffect hook listens for changes to props.graphData.nodes, props.graphData.links. We check whether the sets of node or link ids have changed. If they have not, the graphData state is not updated.
The props.forceRefresh, an integer, can be used to force and update of graphDataNodes for cases where a change has been made but node and link ids are unchanged (e.g. if node props have been changed.)

Standard README text from the Dash component boilerplate

Contributing

See CONTRIBUTING.md

Install dependencies

If you have selected install_dependencies during the prompt, you can skip this part.

Install npm packages
```
$ npm install
```
Create a virtual env and activate.
```
$ virtualenv venv
$ . venv/bin/activate
```
Note: venv\Scripts\activate for windows
Install python packages required to build components.
```
$ pip install -r requirements.txt
```
Install the python packages for testing (optional)
```
$ pip install -r tests/requirements.txt
```

Write your component code in `src/lib/components/DashReactForceGraph.react.js`.

The demo app is in src/demo and you will import your example component code into your demo app.
Test your code in a Python environment:
1. Build your code
```
$ npm run build
```
2. Run and modify the usage.py sample dash app:
```
$ python usage.py
```
Write tests for your component.
- A sample test is available in tests/test_usage.py, it will load usage.py and you can then automate interactions with selenium.
- Run the tests with $ pytest tests.
- The Dash team uses these types of integration tests extensively. Browse the Dash component code on GitHub for more examples of testing (e.g. https://github.com/plotly/dash-core-components)
Add custom styles to your component by putting your custom CSS files into your distribution folder (dash_react_force_graph).
- Make sure that they are referenced in MANIFEST.in so that they get properly included when you're ready to publish your component.
- Make sure the stylesheets are added to the _css_dist dict in dash_react_force_graph/__init__.py so dash will serve them automatically when the component suite is requested.
Review your code

Create a production build and publish:

Build your code:
```
$ npm run build
```
Create a Python distribution
```
$ python setup.py sdist bdist_wheel
```
This will create source and wheel distribution in the generated the dist/ folder. See PyPA for more information.
Test your tarball by copying it into a new environment and installing it locally:
```
$ pip install dash_react_force_graph-0.0.1.tar.gz
```
If it works, then you can publish the component to NPM and PyPI:
1. Publish on PyPI
```
$ twine upload dist/*
```
2. Cleanup the dist folder (optional)
```
$ rm -rf dist
```
3. Publish on NPM (Optional if chosen False in publish_on_npm)
```
$ npm publish
```
  Publishing your component to NPM will make the JavaScript bundles available on the unpkg CDN. By default, Dash serves the component library's CSS and JS locally, but if you choose to publish the package to NPM you can set serve_locally to False and you may see faster load times.
Share your component with the community! https://community.plotly.com/c/dash
1. Publish this repository to GitHub
2. Tag your GitHub repository with the plotly-dash tag so that it appears here: https://github.com/topics/plotly-dash
3. Create a post in the Dash community forum: https://community.plotly.com/c/dash

nodelab-org/dash-react-force-graph