Merge pull request #75 from predict-idlab/add_traces_bug

🐛 return self when calling add_traces

Author: jvdd

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -994,6 +994,11 @@ def add_traces(
             .. seealso::
                 `Figure.add_traces <https://plotly.com/python-api-reference/generated/plotly.graph_objects.Figure.html#plotly.graph_objects.Figure.add_traces>`_ docs.
 
+        Returns
+        -------
+        BaseFigure
+            The Figure on which ``add_traces`` was called on; i.e. self.
+
         """
         # note: Plotly its add_traces also a allows non list-like input e.g. a scatter
         # object; the code below is an exact copy of their internally applied parsing
@@ -1053,7 +1058,7 @@ def add_traces(
             assert trace is not None
             data[i] = trace
 
-        super(self._figure_class, self).add_traces(data, **traces_kwargs)
+        return super(self._figure_class, self).add_traces(data, **traces_kwargs)
 
     def _clear_figure(self):
         """Clear the current figure object it's data and layout."""

tests/test_figure_resampler.py

@@ -841,6 +841,19 @@ def test_fr_list_scatter_add_traces(float_series):
     assert len(fr_fig.data) == 5
 
 
+def test_fr_add_scatter():
+    # Checks whether the add_scatter method works as expected
+    # .add_scatter calls `add_traces` under the hood
+    f_orig = go.Figure().add_scatter(y=np.arange(2_000))
+    f_pr = FigureResampler().add_scatter(y=np.arange(2_000))
+
+    assert len(f_orig.data) == 1
+    assert (len(f_pr.data) == 1) & (len(f_pr.hf_data) == 1)
+    assert len(f_orig.data[0].y) == 2_000
+    assert len(f_pr.data[0]["y"]) == 1_000
+    assert np.all(f_orig.data[0].y == f_pr.hf_data[0]["y"])
+
+
 def test_fr_copy_hf_data(float_series):
     fr_fig = FigureResampler(default_n_shown_samples=2000)
     traces: List[dict] = [

tests/test_figurewidget_resampler.py

@@ -1724,3 +1724,15 @@ def test_fwr_list_scatter_add_traces(float_series):
     fr_fig.add_traces(go.Scatter({'y': float_series[:1000], 'name': "s_agg"}), max_n_samples=999)
     assert len(fr_fig.hf_data) == 4
     assert len(fr_fig.data) == 5
+
+def test_fwr_add_scatter():
+    # Checks whether the add_scatter method works as expected
+    # .add_scatter calls `add_traces` under the hood
+    fw_orig = go.FigureWidget().add_scatter(y=np.arange(2_000))
+    fw_pr = FigureWidgetResampler().add_scatter(y=np.arange(2_000))
+
+    assert len(fw_orig.data) == 1
+    assert (len(fw_pr.data) == 1) & (len(fw_pr.hf_data) == 1)
+    assert len(fw_orig.data[0].y) == 2_000
+    assert len(fw_pr.data[0]["y"]) == 1_000
+    assert np.all(fw_orig.data[0].y == fw_pr.hf_data[0]["y"])