A Dash Graph component modified to support use of figure.data-structured input to extend and/or add traces.
Project description
dash-extendable-graph
dash-extendable-graph
is a Dash component library containing a single component: ExtendableGraph
. The component was forked from Plotly's core Graph
component (dash-core-components). dash-extendable-graph
has modified extendData
and prependData
properties that accept trace data matching the format for figure["data"]
. These properties support (1) adding new traces and (2) allow multiple trace types to be extended/prepended within a single callback (not supported by the core component)
Note: As of version 1.1.0, dash-extendable-graph
includes a minimized plotly.js as an internal dependency. Previously, the component assumed it would be used in conjunction with dash-core-components
.
Installation
Get started with:
- Install Dash and dependencies: https://dash.plot.ly/installation
$ pip install -r requirements.txt
- Install dash-extendable-graph
$ pip install dash-extendable-graph
- Run
python usage.py
- Visit http://localhost:8050 in your web browser
Usage
General examples may be found in usage.py
extendData
updateData
[list]: a list of dictionaries, each dictionary representing trace data in a format matchingfigure['data']
(e.gdict(x=[1], y=[1])
)traceIndices
[list, optional]: identify the traces that should be extended. If the specified trace index does not exist, a (new) corresponding trace shall be appended to the figure.maxPoints
[number, optional]: define the maximum number of points to plot in the figure (per trace).
Based on the Plotly.extendTraces()
api. However, the updateData
key has been modified to better match the contents of Plotly.plot()
(e.g. Graph.figure
). Aside from following dash-familiar styling, this component allows the user to extend traces of different types in a single call (Plotly.extendTraces()
takes a map of key:val and assumes all traces will share the same data keys).
prependData
updateData
[list]: a list of dictionaries, each dictionary representing trace data in a format matchingfigure['data']
(e.gdict(x=[1], y=[1])
)traceIndices
[list, optional]: identify the traces that should be extended. If the specified trace index does not exist, a (new) corresponding trace shall be appended to the figure.maxPoints
[number, optional]: define the maximum number of points to plot in the figure (per trace).
Based on the Plotly.prependTraces()
api. However, the updateData
key has been modified to better match the contents of Plotly.plot()
(e.g. Graph.figure
). Aside from following dash-familiar styling, this component allows the user to prepend traces of different types in a single call (Plotly.prependTraces()
takes a map of key:val and assumes all traces will share the same data keys).
Code
Extend a trace once per second, limited to 100 maximum points.
import dash_extendable_graph as deg
import dash
from dash.dependencies import Input, Output, State
import dash_html_components as html
import dash_core_components as dcc
import random
app = dash.Dash(__name__)
app.scripts.config.serve_locally = True
app.css.config.serve_locally = True
app.layout = html.Div([
deg.ExtendableGraph(
id='extendablegraph_example',
figure=dict(
data=[{'x': [0],
'y': [0],
'mode':'lines+markers'
}],
)
),
dcc.Interval(
id='interval_extendablegraph_update',
interval=1000,
n_intervals=0,
max_intervals=-1),
html.Div(id='output')
])
@app.callback(Output('extendablegraph_example', 'extendData'),
[Input('interval_extendablegraph_update', 'n_intervals')],
[State('extendablegraph_example', 'figure')])
def update_extendData(n_intervals, existing):
x_new = existing['data'][0]['x'][-1] + 1
y_new = random.random()
return [dict(x=[x_new], y=[y_new])], [0], 100
if __name__ == '__main__':
app.run_server(debug=True)
Contributing
See CONTRIBUTING.md
Local Installation
- Dependencies
$ npm install
$ virtualenv venv
$ . venv/bin/activate
$ pip install -r requirements.txt
For developers:
$ pip install -r tests/requirements.txt
- Build
$ npm run build
- Check out the component via component-playground
$ npm run start
The demo app is in `src/demo`
- Check out the sample Dash application using the component
$ python setup.py install
$ python usage.py
Tests
Run locally
Run linting + integration tests in one command:
$ npm run test
Or run tests individually:
Code style
Uses flake8
, eslint
, and prettier
. Check package.json
, .eslintrc
, .eslintignore
for configuration settings.
$ npm run lint
Also you can apply formatting settings.
$ npm run format
Integration Tests
Integration tests for the component can be found in tests/
$ pytest
Selenium test runner configuration options are located in pytest.ini
(e.g. --webdriver
, --headless
). See dash[testing]
documentation for more information on built-ins provided by the dash test fixture.
Run individual integration tests based on the filename.
$ pytest tests/test_extend_maxpoints.py
Continuous Integration
This repository uses a github action to automate integration testing. Linting and Tests are triggered for each pull request created in the master
branch.
Package Publishing
This repository uses a github action to automate package deployment (in this case, compiling a source archive and binary wheel using setuptools
). Publishing is triggered on each published release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dash_extendable_graph-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9d39a628ae71984e539fe58c36dcb2b54aa4ea350d797e0efb636eabaed3db7a |
|
MD5 | 0e63a0894c4985fbd2dc843c297472ce |
|
BLAKE2b-256 | 65ab87a107c41cdb1d57ec8ac19d902eb837bb6c8bcbb60010f0b5b9fc43cf18 |
Hashes for dash_extendable_graph-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | add7f59e2a0016ef78bffbf64d1f5e036ce7907c54238a5b5bb350883e540d3c |
|
MD5 | fad64142e0946ce3f390eab82d75bd51 |
|
BLAKE2b-256 | 9b9cc0444857ba478e24523d166ff332924ddeafcb06c75d70766369921711c3 |