Merge branch 'figresampler_display_improvements' into os_matrix

Author: jvdd

plotly_resampler/figure_resampler/figure_resampler.py

@@ -43,10 +43,6 @@ def __init__(
         verbose: bool = False,
         show_dash_kwargs: dict | None = None,
     ):
-        # `pr_props`` is a variable to store properties of a plotly-resampler figure
-        # This variable will only be set when loading a pickled plotly-resampler figure
-        pr_props = None
-
         # Parse the figure input before calling `super`
         if is_figure(figure) and not is_fr(figure):  
             # A go.Figure
@@ -78,8 +74,12 @@ def __init__(
                 f._grid_str = figure.get("_grid_str")
                 f._grid_ref = figure.get("_grid_ref")
                 f.add_traces(figure.get("data"))
-                # `pr_props`will be not None when loading a pickled plotly-resampler figure
-                pr_props = figure.get("pr_props") 
+                # `pr_props` is not None when loading a pickled plotly-resampler figure
+                f._pr_props = figure.get("pr_props") 
+                # `f._pr_props`` is an attribute to store properties of a
+                # plotly-resampler figure. This attribute is only used to pass
+                # information to the super() constructor. Once the super constructor is
+                # called, the attribute is removed.
 
                 # f.add_frames(figure.get("frames")) TODO
             elif isinstance(figure, (dict, list)):
@@ -97,7 +97,6 @@ def __init__(
             show_mean_aggregation_size,
             convert_traces_kwargs,
             verbose,
-            pr_props=pr_props,
         )
 
         if isinstance(figure, AbstractFigureAggregator):

plotly_resampler/figure_resampler/figure_resampler_interface.py

@@ -92,13 +92,6 @@ def __init__(
                 ``convert_existing_traces`` is set to True.
         verbose: bool, optional
             Whether some verbose messages will be printed or not, by default False.
-        pr_props: dict, optional
-            A dict of properties that will be overwrite the above arguments.
-            This is useful when the figure is created from a pickled object, allowing
-            the PR figure to be created with the same properties as the pickled object.
-            .. note::
-                Users should not use this argument, as it is used internally by the
-                subclasses of this abstract class.
 
         """
         self._hf_data: Dict[str, dict] = {}
@@ -111,18 +104,22 @@ def __init__(
 
         self._global_downsampler = default_downsampler
 
-        # Overwrite the passed properties with the property dict values
-        # (this is the case when the PR figure is created from a pickled object)
-        if pr_props is not None:
-            for k, v in pr_props.items():
-                setattr(self, k, v)
-
         # Given figure should always be a BaseFigure that is not wrapped by
         # a plotly-resampler class
         assert isinstance(figure, BaseFigure)
         assert not issubclass(type(figure), AbstractFigureAggregator)
         self._figure_class = figure.__class__
 
+        # Overwrite the passed arguments with the property dict values
+        # (this is the case when the PR figure is created from a pickled object)
+        if hasattr(figure, "_pr_props"):
+            pr_props = figure._pr_props  # a dict of PR properties
+            if pr_props is not None:
+                # Overwrite the default arguments with the serialized properties
+                for k, v in pr_props.items():
+                    setattr(self, k, v)
+            delattr(figure, "_pr_props")  # should not be stored anymore
+
         if convert_existing_traces:
             # call __init__ with the correct layout and set the `_grid_ref` of the
             # to-be-converted figure

plotly_resampler/figure_resampler/figurewidget_resampler.py

@@ -56,10 +56,6 @@ def __init__(
         f = self._get_figure_class(go.FigureWidget)()
         f._data_validator.set_uid = False
 
-        # `pr_props`` is a variable to store properties of a plotly-resampler figure
-        # This variable will only be set when loading a pickled plotly-resampler figure
-        pr_props = None
-
         if isinstance(figure, BaseFigure):  
             # A base figure object, can be; 
             # - a base plotly figure: go.Figure or go.FigureWidget
@@ -79,8 +75,12 @@ def __init__(
             f._grid_str = figure.get("_grid_str")
             f._grid_ref = figure.get("_grid_ref")
             f.add_traces(figure.get("data"))
-            # `pr_props`will be not None when loading a pickled plotly-resampler figure
-            pr_props = figure.get("pr_props") 
+            # `pr_props` is not None when loading a pickled plotly-resampler figure
+            f._pr_props = figure.get("pr_props") 
+            # `f._pr_props`` is an attribute to store properties of a plotly-resampler
+            # figure. This attribute is only used to pass information to the super()
+            # constructor. Once the super constructor is called, the attribute is
+            # removed.
 
             # f.add_frames(figure.get("frames")) TODO
         elif isinstance(figure, (dict, list)):
@@ -96,7 +96,6 @@ def __init__(
             show_mean_aggregation_size,
             convert_traces_kwargs,
             verbose,
-            pr_props=pr_props,
         )
 
         if isinstance(figure, AbstractFigureAggregator):