📖

Author: jonasvdd

plotly_resampler/figure_resampler/__init__.py

@@ -1,7 +1,8 @@
 # -*- coding: utf-8 -*-
 """
-Module withholdingg wrappers for the plotly ``go.Figure`` and ``go.FigureWidget`` class 
-which allows bookkeeping and back-end based resampling of high-frequency sequential data.
+Module withholding wrappers for the plotly ``go.Figure`` and ``go.FigureWidget`` class 
+which allows bookkeeping and back-end based resampling of high-frequency sequential
+data.
 
 Tip
 ---

plotly_resampler/figure_resampler/figure_resampler.py

@@ -2,6 +2,8 @@
 """
 ``FigureResampler`` wrapper around the plotly ``go.Figure`` class.
 
+Creates a web-application and uses ``dash`` callbacks to enable dynamic resampling.
+
 """
 
 from __future__ import annotations
@@ -88,8 +90,7 @@ def show_dash(
             ``config`` parameter for this property in this method.
             See more https://dash.plotly.com/dash-core-components/graph
         **kwargs: dict
-            Additional app.run_server() kwargs.
-            e.g.: port
+            Additional app.run_server() kwargs. e.g.: port
 
         """
         graph_properties = {} if graph_properties is None else graph_properties

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -1,6 +1,10 @@
 # -*- coding: utf-8 -*-
 """
-Abstract interface of which the concrete *Resampler* classes write towards.
+Abstract ``AbstractFigureAggregator`` interface for the concrete *Resampler* classes.
+
+.. |br| raw:: html
+
+   <br>
 
 """
 

plotly_resampler/figure_resampler/figurewidget_resampler.py

@@ -2,6 +2,8 @@
 """
 ``FigureWidgetResampler`` wrapper around the plotly ``go.FigureWidget`` class.
 
+Utilizes the ``fig.layout.on_change`` method to enable dynamic resampling.
+
 """
 
 from __future__ import annotations
@@ -25,7 +27,10 @@ class _FigureWidgetResamplerM(type(AbstractFigureAggregator), type(go.FigureWidg
 class FigureWidgetResampler(
     AbstractFigureAggregator, go.FigureWidget, metaclass=_FigureWidgetResamplerM
 ):
-    """Data aggregation functionality wrapper for ``go.FigureWidgets``."""
+    """Data aggregation functionality wrapper for ``go.FigureWidgets``.
+
+    .. attention:: This wrapper only works within ``jupyter``-based environments.
+    """
 
     def __init__(
         self,
@@ -105,7 +110,7 @@ def _update_x_ranges(self, layout, *x_ranges):
                 relayout_dict[f"{xaxis_str}.range[0]"] = x_range[0]
                 relayout_dict[f"{xaxis_str}.range[1]"] = x_range[1]
 
-                # An update will take place for that trace 
+                # An update will take place for that trace
                 # -> save current xaxis range to _prev_layout
                 self._prev_layout[xaxis_str]['range'] = x_range