jayceslesar/plotly-resampler

plotly_resampler: visualize large sequential data by adding resampling functionality to Plotly figures

Plotly is an awesome interactive visualization library, however it can get pretty slow when a lot of data points are visualized (100 000+ datapoints). This library solves this by downsampling (aggregating) the data respective to the view and then plotting the aggregated points. When you interact with the plot (panning, zooming, ...), callbacks are used to aggregate data and update the figure.

In this Plotly-Resampler demo over 110,000,000 data points are visualized!

Installation

pip	`pip install plotly-resampler`

Features 🎉

Convenient to use:
- just add either
  - register_plotly_resampler function to your notebook with the best suited mode argument.
  - FigureResampler decorator around a plotly Figure and call .show_dash()
  - FigureWidgetResampler decorator around a plotly Figure and output the instance in a cell
- allows all other plotly figure construction flexibility to be used!
Environment-independent
- can be used in Jupyter, vscode-notebooks, Pycharm-notebooks, Google Colab, DataSpell, and even as application (on a server)
Interface for various aggregation algorithms:
- ability to develop or select your preferred sequence aggregation method

Usage

Add dynamic aggregation to your plotly Figure (unfold your fitting use case)

🤖 Automatically (minimal code overhead):

Use the register_plotly_resampler function

Import and call the register_plotly_resampler method
Just use your regular graph construction code

code example:

import plotly.graph_objects as go; import numpy as np
from plotly_resampler import register_plotly_resampler

# Call the register function once and all Figures/FigureWidgets will be wrapped
# according to the register_plotly_resampler its `mode` argument
register_plotly_resampler(mode='auto')

x = np.arange(1_000_000)
noisy_sin = (3 + np.sin(x / 200) + np.random.randn(len(x)) / 10) * x / 1_000


# auto mode: when working in an IPython environment, this will automatically be a 
# FigureWidgetResampler else, this will be an FigureResampler
f = go.Figure()
f.add_trace({"y": noisy_sin + 2, "name": "yp2"})
f

Note: This wraps all plotly graph object figures with a FigureResampler | FigureWidgetResampler. This can thus also be used for the plotly.express interface. 🎉

👷 Manually (higher data aggregation configurability, more speedup possibilities):

Within a jupyter environment without creating a web application

wrap the plotly Figure with FigureWidgetResampler
output the FigureWidgetResampler instance in a cell

import plotly.graph_objects as go; import numpy as np
from plotly_resampler import FigureResampler, FigureWidgetResampler

x = np.arange(1_000_000)
noisy_sin = (3 + np.sin(x / 200) + np.random.randn(len(x)) / 10) * x / 1_000

# OPTION 1 - FigureWidgetResampler: dynamic aggregation via `FigureWidget.layout.on_change`
fig = FigureWidgetResampler(go.Figure())
fig.add_trace(go.Scattergl(name='noisy sine', showlegend=True), hf_x=x, hf_y=noisy_sin)

fig

Using a web-application with dash callbacks

wrap the plotly Figure with FigureResampler
call .show_dash() on the Figure

import plotly.graph_objects as go; import numpy as np
from plotly_resampler import FigureResampler, FigureWidgetResampler

x = np.arange(1_000_000)
noisy_sin = (3 + np.sin(x / 200) + np.random.randn(len(x)) / 10) * x / 1_000

# OPTION 2 - FigureResampler: dynamic aggregation via a Dash web-app
fig = FigureResampler(go.Figure())
fig.add_trace(go.Scattergl(name='noisy sine', showlegend=True), hf_x=x, hf_y=noisy_sin)

fig.show_dash(mode='inline')

Tip 💡: For significant faster initial loading of the Figure, we advise to wrap the constructor of the plotly Figure and add the trace data as hf_x and hf_y

Note: Any plotly Figure can be wrapped with FigureResampler and FigureWidgetResampler! 🎉 But, (obviously) only the scatter traces will be resampled.

Important considerations & tips

When running the code on a server, you should forward the port of the FigureResampler.show_dash() method to your local machine.
Note that you can add dynamic aggregation to plotly figures with the FigureWidgetResampler wrapper without needing to forward a port!
The FigureWidgetResampler uses the IPython main thread for its data aggregation functionality, so when this main thread is occupied, no resampling logic can be executed. For example; if you perform long computations within your notebook, the kernel will be occupied during these computations, and will only execute the resampling operations that take place during these computations after finishing that computation.
In general, when using downsampling one should be aware of (possible) aliasing effects. The [R] in the legend indicates when the corresponding trace is being resampled (and thus possibly distorted) or not. Additionally, the ~<range> suffix represent the mean aggregation bin size in terms of the sequence index.
The plotly autoscale event (triggered by the autoscale button or a double-click within the graph), does not reset the axes but autoscales the current graph-view of plotly-resampler figures. This design choice was made as it seemed more intuitive for the developers to support this behavior with double-click than the default axes-reset behavior. The graph axes can ofcourse be resetted by using the reset_axis button. If you want to give feedback and discuss this further with the developers, see issue #49.

Cite

Paper (preprint): https://arxiv.org/abs/2206.08703

@inproceedings{van2022plotly,
  title={Plotly-resampler: Effective visual analytics for large time series},
  author={Van Der Donckt, Jonas and Van Der Donckt, Jeroen and Deprost, Emiel and Van Hoecke, Sofie},
  booktitle={2022 IEEE Visualization and Visual Analytics (VIS)},
  pages={21--25},
  year={2022},
  organization={IEEE}
}

Future work 🔨

Support .add_traces() (currently only .add_trace is supported)
Support hf_color and hf_markersize, see #148
Create C bindings for our EfficientLTTB algorithm.
Integrate with tsdownsample 🐎

👤 Jonas Van Der Donckt, Jeroen Van Der Donckt, Emiel Deprost

jayceslesar / plotly-resampler