bec-widgets 0.76.0__py3-none-any.whl → 0.77.0__py3-none-any.whl

bec_widgets/cli/client.py

@@ -41,14 +41,14 @@ class BECCurve(RPCBase):
 
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -162,7 +162,7 @@ class BECCurve(RPCBase):
 class BECDock(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -172,7 +172,7 @@ class BECDock(RPCBase):
 
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
@@ -290,7 +290,7 @@ class BECDock(RPCBase):
 class BECDockArea(RPCBase, BECGuiClientMixin):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -398,7 +398,7 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -417,14 +417,14 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
 class BECFigure(RPCBase):
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -432,6 +432,12 @@ class BECFigure(RPCBase):
             dict: The configuration of the widget.
         """
 
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
     @rpc_call
     def axes(self, row: "int", col: "int") -> "BECPlotBase":
         """
@@ -454,103 +460,6 @@ class BECFigure(RPCBase):
             dict: All widgets within the figure.
         """
 
-    @rpc_call
-    def add_plot(
-        self,
-        x: "list | np.ndarray" = None,
-        y: "list | np.ndarray" = None,
-        x_name: "str" = None,
-        y_name: "str" = None,
-        z_name: "str" = None,
-        x_entry: "str" = None,
-        y_entry: "str" = None,
-        z_entry: "str" = None,
-        color: "Optional[str]" = None,
-        color_map_z: "Optional[str]" = "plasma",
-        label: "Optional[str]" = None,
-        validate: "bool" = True,
-        row: "int" = None,
-        col: "int" = None,
-        config=None,
-        dap: "str | None" = None,
-        **axis_kwargs,
-    ) -> "BECWaveform":
-        """
-        Add a Waveform1D plot to the figure at the specified position.
-
-        Args:
-            x(list | np.ndarray): Custom x data to plot.
-            y(list | np.ndarray): Custom y data to plot.
-            x_name(str): The name of the device for the x-axis.
-            y_name(str): The name of the device for the y-axis.
-            z_name(str): The name of the device for the z-axis.
-            x_entry(str): The name of the entry for the x-axis.
-            y_entry(str): The name of the entry for the y-axis.
-            z_entry(str): The name of the entry for the z-axis.
-            color(str): The color of the curve.
-            color_map_z(str): The color map to use for the z-axis.
-            label(str): The label of the curve.
-            validate(bool): If True, validate the device names and entries.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Additional configuration for the widget.
-            **axis_kwargs(dict): Additional axis properties to set on the widget after creation.
-        """
-
-    @rpc_call
-    def add_image(
-        self,
-        monitor: "str" = None,
-        color_bar: "Literal['simple', 'full']" = "full",
-        color_map: "str" = "magma",
-        data: "np.ndarray" = None,
-        vrange: "tuple[float, float]" = None,
-        row: "int" = None,
-        col: "int" = None,
-        config=None,
-        **axis_kwargs,
-    ) -> "BECImageShow":
-        """
-        Add an image to the figure at the specified position.
-
-        Args:
-            monitor(str): The name of the monitor to display.
-            color_bar(Literal["simple","full"]): The type of color bar to display.
-            color_map(str): The color map to use for the image.
-            data(np.ndarray): Custom data to display.
-            vrange(tuple[float, float]): The range of values to display.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Additional configuration for the widget.
-            **axis_kwargs: Additional axis properties to set on the widget after creation.
-
-        Returns:
-            BECImageShow: The image widget.
-        """
-
-    @rpc_call
-    def add_motor_map(
-        self,
-        motor_x: "str" = None,
-        motor_y: "str" = None,
-        row: "int" = None,
-        col: "int" = None,
-        config=None,
-        **axis_kwargs,
-    ) -> "BECMotorMap":
-        """
-        Args:
-            motor_x(str): The name of the motor for the X axis.
-            motor_y(str): The name of the motor for the Y axis.
-            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
-            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
-            config(dict): Additional configuration for the widget.
-            **axis_kwargs:
-
-        Returns:
-            BECMotorMap: The motor map widget.
-        """
-
     @rpc_call
     def plot(
         self,
@@ -566,7 +475,11 @@ class BECFigure(RPCBase):
         color_map_z: "str | None" = "plasma",
         label: "str | None" = None,
         validate: "bool" = True,
+        new: "bool" = False,
+        row: "int | None" = None,
+        col: "int | None" = None,
         dap: "str | None" = None,
+        config: "dict | None" = None,
         **axis_kwargs,
     ) -> "BECWaveform":
         """
@@ -585,7 +498,11 @@ class BECFigure(RPCBase):
             color_map_z(str): The color map to use for the z-axis.
             label(str): The label of the curve.
             validate(bool): If True, validate the device names and entries.
+            new(bool): If True, create a new plot instead of using the first plot.
+            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
+            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
             dap(str): The DAP model to use for the curve.
+            config(dict): Recreates the whole BECWaveform widget from provided configuration.
             **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
@@ -600,6 +517,10 @@ class BECFigure(RPCBase):
         color_map: "str" = "magma",
         data: "np.ndarray" = None,
         vrange: "tuple[float, float]" = None,
+        new: "bool" = False,
+        row: "int | None" = None,
+        col: "int | None" = None,
+        config: "dict | None" = None,
         **axis_kwargs,
     ) -> "BECImageShow":
         """
@@ -611,6 +532,10 @@ class BECFigure(RPCBase):
             color_map(str): The color map to use for the image.
             data(np.ndarray): Custom data to display.
             vrange(tuple[float, float]): The range of values to display.
+            new(bool): If True, create a new plot instead of using the first plot.
+            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
+            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
+            config(dict): Recreates the whole BECImageShow widget from provided configuration.
             **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
@@ -619,7 +544,14 @@ class BECFigure(RPCBase):
 
     @rpc_call
     def motor_map(
-        self, motor_x: "str" = None, motor_y: "str" = None, **axis_kwargs
+        self,
+        motor_x: "str" = None,
+        motor_y: "str" = None,
+        new: "bool" = False,
+        row: "int | None" = None,
+        col: "int | None" = None,
+        config: "dict | None" = None,
+        **axis_kwargs,
     ) -> "BECMotorMap":
         """
         Add a motor map to the figure. Always access the first motor map widget in the figure.
@@ -627,6 +559,10 @@ class BECFigure(RPCBase):
         Args:
             motor_x(str): The name of the motor for the X axis.
             motor_y(str): The name of the motor for the Y axis.
+            new(bool): If True, create a new plot instead of using the first plot.
+            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
+            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
+            config(dict): Recreates the whole BECImageShow widget from provided configuration.
             **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
@@ -677,12 +613,6 @@ class BECFigure(RPCBase):
         Clear all widgets from the figure and reset to default state
         """
 
-    @rpc_call
-    def get_all_rpc(self) -> "dict":
-        """
-        Get all registered RPC objects.
-        """
-
     @property
     @rpc_call
     def widget_list(self) -> "list[BECPlotBase]":
@@ -696,14 +626,14 @@ class BECFigure(RPCBase):
 class BECImageItem(RPCBase):
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -850,14 +780,14 @@ class BECImageItem(RPCBase):
 class BECImageShow(RPCBase):
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -877,34 +807,12 @@ class BECImageShow(RPCBase):
             BECImageItem: The image object.
         """
 
-    @rpc_call
-    def get_image_config(self, image_id, dict_output: "bool" = True) -> "ImageItemConfig | dict":
-        """
-        Get the configuration of the image.
-
-        Args:
-            image_id(str): The ID of the image.
-            dict_output(bool): Whether to return the configuration as a dictionary. Defaults to True.
-
-        Returns:
-            ImageItemConfig|dict: The configuration of the image.
-        """
-
-    @rpc_call
-    def get_image_dict(self) -> "dict[str, dict[str, BECImageItem]]":
-        """
-        Get all images.
-
-        Returns:
-            dict[str, dict[str, BECImageItem]]: The dictionary of images.
-        """
-
     @rpc_call
     def add_monitor_image(
         self,
         monitor: "str",
         color_map: "Optional[str]" = "magma",
-        color_bar: "Optional[Literal['simple', 'full']]" = "simple",
+        color_bar: "Optional[Literal['simple', 'full']]" = "full",
         downsample: "Optional[bool]" = True,
         opacity: "Optional[float]" = 1.0,
         vrange: "Optional[tuple[int, int]]" = None,
@@ -920,7 +828,7 @@ class BECImageShow(RPCBase):
         name: "str",
         data: "Optional[np.ndarray]" = None,
         color_map: "Optional[str]" = "magma",
-        color_bar: "Optional[Literal['simple', 'full']]" = "simple",
+        color_bar: "Optional[Literal['simple', 'full']]" = "full",
         downsample: "Optional[bool]" = True,
         opacity: "Optional[float]" = 1.0,
         vrange: "Optional[tuple[int, int]]" = None,
@@ -1065,15 +973,6 @@ class BECImageShow(RPCBase):
             name(str): The name of the image. If None, apply to all images.
         """
 
-    @rpc_call
-    def toggle_threading(self, use_threading: "bool"):
-        """
-        Toggle threading for the widgets postprocessing and updating.
-
-        Args:
-            use_threading(bool): Whether to use threading.
-        """
-
     @rpc_call
     def set(self, **kwargs) -> "None":
         """
@@ -1209,14 +1108,14 @@ class BECImageShow(RPCBase):
 class BECMotorMap(RPCBase):
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1307,7 +1206,7 @@ class BECMotorMap(RPCBase):
 class BECPlotBase(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1450,7 +1349,7 @@ class BECPlotBase(RPCBase):
 class BECQueue(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1459,7 +1358,7 @@ class BECQueue(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -1468,7 +1367,7 @@ class BECQueue(RPCBase):
 class BECStatusBox(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1477,7 +1376,7 @@ class BECStatusBox(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -1486,14 +1385,14 @@ class BECStatusBox(RPCBase):
 class BECWaveform(RPCBase):
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1618,28 +1517,6 @@ class BECWaveform(RPCBase):
             BECCurve: The curve object.
         """
 
-    @rpc_call
-    def get_curve_config(self, curve_id: "str", dict_output: "bool" = True) -> "CurveConfig | dict":
-        """
-        Get the configuration of a curve by its ID.
-
-        Args:
-            curve_id(str): ID of the curve.
-
-        Returns:
-            CurveConfig|dict: Configuration of the curve.
-        """
-
-    @rpc_call
-    def apply_config(self, config: "dict | SubplotConfig", replot_last_scan: "bool" = False):
-        """
-        Apply the configuration to the 1D waveform widget.
-
-        Args:
-            config(dict|SubplotConfig): Configuration settings.
-            replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
-        """
-
     @rpc_call
     def get_all_data(self, output: "Literal['dict', 'pandas']" = "dict") -> "dict | pd.DataFrame":
         """
@@ -1787,7 +1664,7 @@ class BECWaveform(RPCBase):
 class DeviceComboBox(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1796,7 +1673,7 @@ class DeviceComboBox(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -1805,7 +1682,7 @@ class DeviceComboBox(RPCBase):
 class DeviceInputBase(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1814,7 +1691,7 @@ class DeviceInputBase(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -1823,7 +1700,7 @@ class DeviceInputBase(RPCBase):
 class DeviceLineEdit(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1832,7 +1709,7 @@ class DeviceLineEdit(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -1840,21 +1717,21 @@ class DeviceLineEdit(RPCBase):
 
 class Ring(RPCBase):
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
 
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -1940,21 +1817,21 @@ class Ring(RPCBase):
 
 class RingProgressBar(RPCBase):
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
 
     @property
     @rpc_call
-    def rpc_id(self) -> "str":
+    def _rpc_id(self) -> "str":
         """
         Get the RPC ID of the widget.
         """
 
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -2120,7 +1997,7 @@ class RingProgressBar(RPCBase):
 class ScanControl(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -2129,7 +2006,7 @@ class ScanControl(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """
@@ -2138,7 +2015,7 @@ class ScanControl(RPCBase):
 class StopButton(RPCBase):
     @property
     @rpc_call
-    def config_dict(self) -> "dict":
+    def _config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
 
@@ -2147,7 +2024,7 @@ class StopButton(RPCBase):
         """
 
     @rpc_call
-    def get_all_rpc(self) -> "dict":
+    def _get_all_rpc(self) -> "dict":
         """
         Get all registered RPC objects.
         """

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -40,12 +40,13 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
                     "w1": self.w1,
                     "w2": self.w2,
                     "w3": self.w3,
+                    "w1_c": self.w1_c,
+                    "w2_c": self.w2_c,
+                    "w3_c": self.w3_c,
+                    "w4": self.w4,
                     "d0": self.d0,
                     "d1": self.d1,
                     "d2": self.d2,
-                    "fig0": self.fig0,
-                    "fig1": self.fig1,
-                    "fig2": self.fig2,
                     "plt": self.plt,
                     "bar": self.bar,
                 }
@@ -75,17 +76,37 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.figure.plot(x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="cividis")
         self.figure.motor_map("samx", "samy")
         self.figure.image("eiger", color_map="viridis", vrange=(0, 100))
-        self.figure.add_plot(x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="magma")
+        self.figure.plot(
+            x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="magma", new=True
+        )
 
         self.figure.change_layout(2, 2)
 
         self.w1 = self.figure[0, 0]
         self.w2 = self.figure[0, 1]
         self.w3 = self.figure[1, 0]
+        self.w4 = self.figure[1, 1]
+
+        # Plot Customisation
+        self.w1.set_title("Waveform 1")
+        self.w1.set_x_label("Motor Position (samx)")
+        self.w1.set_y_label("Intensity A.U.")
+
+        # Image Customisation
+        self.w3.set_title("Eiger Image")
+        self.w3.set_x_label("X")
+        self.w3.set_y_label("Y")
+
+        # Configs to try to pass
+        self.w1_c = self.w1._config_dict
+        self.w2_c = self.w2._config_dict
+        self.w3_c = self.w3._config_dict
 
         # curves for w1
         self.c1 = self.w1.get_config()
 
+        self.fig_c = self.figure._config_dict
+
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")