DashVis Component
Full implementation of vis.js network framework for Plotly Dash
Explore the documentation
·
Report a bug
·
Request a feature
A full implementation of vis.js Network component for Dash Plotly. Useful for displaying dynamic, automatically organised, customizable network views.
Table of contents
- Table of contents
- Installation
- Quick start
- See how it is used
- Advanced examples
- Linking a stylesheet
- Contributing
- Future work 🔨
Installation
PyPI
You can install dashvis with pip:
pip install dashvis
Quick start
dashvis exposes a single component, DashNetwork. Simply create one and include it in your Dash layout. Simplest example:
import dash
from dash import html
from dashvis import DashNetwork
app = dash.Dash()
app.layout = html.Div([
DashNetwork()
])
if __name__ == '__main__':
app.run_server(debug=True)
See how it is used
A simple usage example is provided in usage.py.
- Run:
python -m venv dashvis-venv
source dashvis-venv/bin/activate
pip install -r requirements.txt
npm install
npm run build
python usage.py
- Visit http://localhost:8050 in your web browser
Advanced examples
Examples which cover the entire API of vis.js are available in usage_examples folder.
Running them requires PYTHONPATH to be made aware of dashvis.
Simply run:
export PYTHONPATH="${PYTHONPATH}:./dashvis"
and then run any example from repo root directory of the repository:
python usage_examples/<example_name>.py
Linking a stylesheet
dashvis doesn't come with CSS included. If you enable network manipulation or navigation features, you need to include a stylesheet to draw those components of the network.
For convenience, links to vis.js stylesheets are included for you and can be used as follows:
import dash
import dashvis.stylesheets
app = dash.Dash(external_stylesheets=[dashvis.stylesheets.VIS_NETWORK_STYLESHEET])
Contributing
See CONTRIBUTING.md
Future work 🔨
- Update
usage.py - Fix two disabled
vis.jsfunction calls - Write tests
- Add tests and code coverage badges
- Update this README
1 maintainer
Metadata
1 maintainer
Release files for dashvis 0.1.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| dashvis-0.1.14.tar.gz | 779.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dashvis-0.1.14-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / dashvis-0.1.14.tar.gz
| Download URL | dashvis-0.1.14.tar.gz |
|---|---|
| Size | 779.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
36be96cda45d662a2771b67200d079d655f255433cd48cc392434f68e67545c4
|
|
BLAKE2b-256 checksum How to use checksums |
6e62c2615f991bd936a959b120e4a8210e2f5c88d693fbc8cda8a2949813227f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / dashvis-0.1.14-py3-none-any.whl
| Download URL | dashvis-0.1.14-py3-none-any.whl |
|---|---|
| Size | 786.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
279236b51bdbb6efda1d90df692c4ed6182d0d97c64102450b623bb737488e70
|
|
BLAKE2b-256 checksum How to use checksums |
57bef22339bfb4a0b42bfbe983a1687e2932fab32cace996e6005da650c076c9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
