🔍 adding init kwargs to show dash - fix for #265 (#269)

* 🔍 adding init kwargs to show dash - fix for #265

* 🙈 retain show_dash kwargs in constructor

These can be of special interest for the register_plotly_resampler method

* 🔍 adding init kwargs to show dash - fix for #265

* 🙈 retain show_dash kwargs in constructor

These can be of special interest for the register_plotly_resampler method

* 🧹 fix linting issue

* 🖊️ write docs

* 🧹

* 🙈 linting

---------

Co-authored-by: Jeroen Van Der Donckt <[email protected]>
Co-authored-by: Jeroen Van Der Donckt <[email protected]>

Author: jonasvdd

plotly_resampler/figure_resampler/figure_resampler.py

@@ -146,7 +146,8 @@ def __init__(
             Whether some verbose messages will be printed or not, by default False.
         show_dash_kwargs: dict, optional
             A dict that will be used as default kwargs for the [`show_dash`][figure_resampler.figure_resampler.FigureResampler.show_dash] method.
-            Note that the passed kwargs will be take precedence over these defaults.
+            !!! note
+                The passed kwargs to the [`show_dash`][figure_resampler.figure_resampler.FigureResampler.show_dash] method will take precedence over these defaults.
 
         """
         # Parse the figure input before calling `super`
@@ -467,6 +468,7 @@ def show_dash(
         self,
         mode=None,
         config: dict | None = None,
+        init_dash_kwargs: dict | None = None,
         graph_properties: dict | None = None,
         **kwargs,
     ):
@@ -502,6 +504,17 @@ def show_dash(
             This ``config`` parameter is the same as the dict that you would pass as
             ``config`` argument to the `show` method.
             See more [https://plotly.com/python/configuration-options/](https://plotly.com/python/configuration-options/)
+        init_dash_kwargs: dict, optional
+            Keyword arguments for the Dash app constructor.
+            !!! note
+                This variable is of special interest when working in a jupyterhub +
+                kubernetes environment. In this case, user notebook servers are spawned
+                as separate pods and user access to those servers are proxied via
+                jupyterhub. Dash requires the `requests_pathname_prefix` to be set on
+                __init__ - which can be done via this `init_dash_kwargs` argument.
+                Note that you should also pass the `jupyter_server_url` to the
+                `show_dash` method.
+                More details: https://github.com/predict-idlab/plotly-resampler/issues/265
         graph_properties: dict, optional
             Dictionary of (keyword, value) for the properties that should be passed to
             the dcc.Graph, by default None.
@@ -510,9 +523,10 @@ def show_dash(
             ``config`` parameter for this property in this method.
             See more [https://dash.plotly.com/dash-core-components/graph](https://dash.plotly.com/dash-core-components/graph)
         **kwargs: dict
-            Additional app.run_server() kwargs. e.g.: port, ...
-            Also note that these kwargs take precedence over the ones passed to the
-            constructor via the ``show_dash_kwargs`` argument.
+            kwargs for the ``app.run_server()`` method, e.g., port=8037.
+            !!! note
+                These kwargs take precedence over the ones that are passed to the
+                constructor via the ``show_dash_kwargs`` argument.
 
         """
         available_modes = ["external", "inline", "inline_persistent", "jupyterlab"]
@@ -547,9 +561,9 @@ def show_dash(
                         self.data[trace_idx].update(updated_trace)
 
         # 1. Construct the Dash app layout
-        app_init_kwargs = {}
+        init_dash_kwargs = {} if init_dash_kwargs is None else init_dash_kwargs
         if self._create_overview:
-            app_init_kwargs["assets_folder"] = os.path.relpath(
+            init_dash_kwargs["assets_folder"] = os.path.relpath(
                 ASSETS_FOLDER, os.getcwd()
             )
 
@@ -559,18 +573,19 @@ def show_dash(
                 # Inline persistent mode: we display a static image of the figure when the
                 # app is not reachable
                 # Note: this is the "inline" behavior of JupyterDashInlinePersistentOutput
-                app = JupyterDashPersistentInlineOutput("local_app", **app_init_kwargs)
+                app = JupyterDashPersistentInlineOutput("local_app", **init_dash_kwargs)
                 self._is_persistent_inline = True
             else:
                 # If Jupyter Dash is not installed, inline persistent won't work and hence
                 # we default to normal inline mode with a normal Dash app
-                app = dash.Dash("local_app", **app_init_kwargs)
+                app = dash.Dash("local_app", **init_dash_kwargs)
                 warnings.warn(
                     "'jupyter_dash' is not installed. The persistent inline mode will not work. Defaulting to standard inline mode."
                 )
         else:
             # jupyter dash uses a normal Dash app as figure
-            app = dash.Dash("local_app", **app_init_kwargs)
+            app = dash.Dash("local_app", **init_dash_kwargs)
+
         # fmt: off
         div = dash.html.Div(
             style={
@@ -582,7 +597,7 @@ def show_dash(
                 TraceUpdater(id="trace-updater", gdID="resample-figure", sequentialUpdate=False),
             ],
         )
-        # # fmt: on
+        # fmt: on
         if self._create_overview:
             overview_config = config.copy() if config is not None else {}
             overview_config["displayModeBar"] = False