bec-widgets 0.51.0__py3-none-any.whl → 0.52.1__py3-none-any.whl

bec_widgets/cli/client.py

@@ -2,7 +2,7 @@
 
 from typing import Literal, Optional, overload
 
-from bec_widgets.cli.client_utils import BECFigureClientMixin, RPCBase, rpc_call
+from bec_widgets.cli.client_utils import BECGuiClientMixin, RPCBase, rpc_call
 
 
 class BECPlotBase(RPCBase):
@@ -11,6 +11,7 @@ class BECPlotBase(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -19,8 +20,10 @@ class BECPlotBase(RPCBase):
     def set(self, **kwargs) -> "None":
         """
         Set the properties of the plot widget.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - title: str
             - x_label: str
@@ -35,6 +38,7 @@ class BECPlotBase(RPCBase):
     def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
+
         Args:
             title(str): Title of the plot widget.
         """
@@ -43,6 +47,7 @@ class BECPlotBase(RPCBase):
     def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
+
         Args:
             label(str): Label of the x-axis.
         """
@@ -51,6 +56,7 @@ class BECPlotBase(RPCBase):
     def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
+
         Args:
             label(str): Label of the y-axis.
         """
@@ -59,6 +65,7 @@ class BECPlotBase(RPCBase):
     def set_x_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the x-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the x-axis.
         """
@@ -67,6 +74,7 @@ class BECPlotBase(RPCBase):
     def set_y_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the y-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the y-axis.
         """
@@ -105,6 +113,7 @@ class BECPlotBase(RPCBase):
     def set_grid(self, x: "bool" = False, y: "bool" = False):
         """
         Set the grid of the plot widget.
+
         Args:
             x(bool): Show grid on the x-axis.
             y(bool): Show grid on the y-axis.
@@ -114,6 +123,7 @@ class BECPlotBase(RPCBase):
     def lock_aspect_ratio(self, lock):
         """
         Lock aspect ratio.
+
         Args:
             lock(bool): True to lock, False to unlock.
         """
@@ -122,6 +132,7 @@ class BECPlotBase(RPCBase):
     def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
         """
         Plot custom data on the plot widget. These data are not saved in config.
+
         Args:
             data_x(list|np.ndarray): x-axis data
             data_y(list|np.ndarray): y-axis data
@@ -148,6 +159,7 @@ class BECWaveform(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -169,6 +181,7 @@ class BECWaveform(RPCBase):
     ) -> "BECCurve":
         """
         Add a curve to the plot widget from the scan segment.
+
         Args:
             x_name(str): Name of the x signal.
             x_entry(str): Entry of the x signal.
@@ -196,6 +209,7 @@ class BECWaveform(RPCBase):
     ) -> "BECCurve":
         """
         Add a custom data curve to the plot widget.
+
         Args:
             x(list|np.ndarray): X data of the curve.
             y(list|np.ndarray): Y data of the curve.
@@ -211,6 +225,7 @@ class BECWaveform(RPCBase):
     def remove_curve(self, *identifiers):
         """
         Remove a curve from the plot widget.
+
         Args:
             *identifiers: Identifier of the curve to be removed. Can be either an integer (index) or a string (curve_id).
         """
@@ -220,6 +235,7 @@ class BECWaveform(RPCBase):
         """
         Update the scan curves with the data from the scan storage.
         Provide only one of scan_id or scan_index.
+
         Args:
             scan_id(str, optional): ScanID of the scan to be updated. Defaults to None.
             scan_index(int, optional): Index of the scan to be updated. Defaults to None.
@@ -238,8 +254,10 @@ class BECWaveform(RPCBase):
     def get_curve(self, identifier) -> "BECCurve":
         """
         Get the curve by its index or ID.
+
         Args:
             identifier(int|str): Identifier of the curve. Can be either an integer (index) or a string (curve_id).
+
         Returns:
             BECCurve: The curve object.
         """
@@ -248,18 +266,21 @@ class BECWaveform(RPCBase):
     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 | WidgetConfig", replot_last_scan: "bool" = False):
+    def apply_config(self, config: "dict | SubplotConfig", replot_last_scan: "bool" = False):
         """
         Apply the configuration to the 1D waveform widget.
+
         Args:
-            config(dict|WidgetConfig): Configuration settings.
+            config(dict|SubplotConfig): Configuration settings.
             replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
         """
 
@@ -267,8 +288,10 @@ class BECWaveform(RPCBase):
     def get_all_data(self, output: "Literal['dict', 'pandas']" = "dict") -> "dict | pd.DataFrame":
         """
         Extract all curve data into a dictionary or a pandas DataFrame.
+
         Args:
             output (Literal["dict", "pandas"]): Format of the output data.
+
         Returns:
             dict | pd.DataFrame: Data of all curves in the specified format.
         """
@@ -277,8 +300,10 @@ class BECWaveform(RPCBase):
     def set(self, **kwargs) -> "None":
         """
         Set the properties of the plot widget.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - title: str
             - x_label: str
@@ -293,6 +318,7 @@ class BECWaveform(RPCBase):
     def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
+
         Args:
             title(str): Title of the plot widget.
         """
@@ -301,6 +327,7 @@ class BECWaveform(RPCBase):
     def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
+
         Args:
             label(str): Label of the x-axis.
         """
@@ -309,6 +336,7 @@ class BECWaveform(RPCBase):
     def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
+
         Args:
             label(str): Label of the y-axis.
         """
@@ -317,6 +345,7 @@ class BECWaveform(RPCBase):
     def set_x_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the x-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the x-axis.
         """
@@ -325,6 +354,7 @@ class BECWaveform(RPCBase):
     def set_y_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the y-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the y-axis.
         """
@@ -363,6 +393,7 @@ class BECWaveform(RPCBase):
     def set_grid(self, x: "bool" = False, y: "bool" = False):
         """
         Set the grid of the plot widget.
+
         Args:
             x(bool): Show grid on the x-axis.
             y(bool): Show grid on the y-axis.
@@ -372,6 +403,7 @@ class BECWaveform(RPCBase):
     def lock_aspect_ratio(self, lock):
         """
         Lock aspect ratio.
+
         Args:
             lock(bool): True to lock, False to unlock.
         """
@@ -380,6 +412,7 @@ class BECWaveform(RPCBase):
     def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
         """
         Plot custom data on the plot widget. These data are not saved in config.
+
         Args:
             data_x(list|np.ndarray): x-axis data
             data_y(list|np.ndarray): y-axis data
@@ -393,7 +426,7 @@ class BECWaveform(RPCBase):
         """
 
 
-class BECFigure(RPCBase, BECFigureClientMixin):
+class BECFigure(RPCBase):
     @property
     @rpc_call
     def rpc_id(self) -> "str":
@@ -406,6 +439,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -414,6 +448,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     def axes(self, row: "int", col: "int") -> "BECPlotBase":
         """
         Get widget by its coordinates in the figure.
+
         Args:
             row(int): the row coordinate
             col(int): the column coordinate
@@ -426,7 +461,9 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     @rpc_call
     def widgets(self) -> "dict":
         """
-        None
+        All widgets within the figure with gui ids as keys.
+        Returns:
+            dict: All widgets within the figure.
         """
 
     @rpc_call
@@ -451,6 +488,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "BECWaveform":
         """
         Add a Waveform1D plot to the figure at the specified position.
+
         Args:
             widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
@@ -474,6 +512,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "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.
@@ -531,6 +570,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "BECWaveform":
         """
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
+
         Args:
             x_name(str): The name of the device for the x-axis.
             y_name(str): The name of the device for the y-axis.
@@ -562,6 +602,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "BECImageShow":
         """
         Add an image to the figure. Always access the first image widget in the figure.
+
         Args:
             monitor(str): The name of the monitor to display.
             color_bar(Literal["simple","full"]): The type of color bar to display.
@@ -580,6 +621,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "BECMotorMap":
         """
         Add a motor map to the figure. Always access the first motor map widget in the figure.
+
         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.
@@ -599,6 +641,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     ) -> "None":
         """
         Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
+
         Args:
             row(int): The row coordinate of the widget to remove.
             col(int): The column coordinate of the widget to remove.
@@ -621,6 +664,7 @@ class BECFigure(RPCBase, BECFigureClientMixin):
     def change_theme(self, theme: "Literal['dark', 'light']") -> "None":
         """
         Change the theme of the figure widget.
+
         Args:
             theme(Literal["dark","light"]): The theme to set for the figure widget.
         """
@@ -666,6 +710,7 @@ class BECCurve(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -674,8 +719,10 @@ class BECCurve(RPCBase):
     def set(self, **kwargs):
         """
         Set the properties of the curve.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - color: str
             - symbol: str
@@ -695,6 +742,7 @@ class BECCurve(RPCBase):
     def set_color(self, color: "str", symbol_color: "Optional[str]" = None):
         """
         Change the color of the curve.
+
         Args:
             color(str): Color of the curve.
             symbol_color(str, optional): Color of the symbol. Defaults to None.
@@ -704,6 +752,7 @@ class BECCurve(RPCBase):
     def set_colormap(self, colormap: "str"):
         """
         Set the colormap for the scatter plot z gradient.
+
         Args:
             colormap(str): Colormap for the scatter plot.
         """
@@ -712,6 +761,7 @@ class BECCurve(RPCBase):
     def set_symbol(self, symbol: "str"):
         """
         Change the symbol of the curve.
+
         Args:
             symbol(str): Symbol of the curve.
         """
@@ -720,6 +770,7 @@ class BECCurve(RPCBase):
     def set_symbol_color(self, symbol_color: "str"):
         """
         Change the symbol color of the curve.
+
         Args:
             symbol_color(str): Color of the symbol.
         """
@@ -728,6 +779,7 @@ class BECCurve(RPCBase):
     def set_symbol_size(self, symbol_size: "int"):
         """
         Change the symbol size of the curve.
+
         Args:
             symbol_size(int): Size of the symbol.
         """
@@ -736,6 +788,7 @@ class BECCurve(RPCBase):
     def set_pen_width(self, pen_width: "int"):
         """
         Change the pen width of the curve.
+
         Args:
             pen_width(int): Width of the pen.
         """
@@ -744,6 +797,7 @@ class BECCurve(RPCBase):
     def set_pen_style(self, pen_style: "Literal['solid', 'dash', 'dot', 'dashdot']"):
         """
         Change the pen style of the curve.
+
         Args:
             pen_style(Literal["solid", "dash", "dot", "dashdot"]): Style of the pen.
         """
@@ -770,6 +824,7 @@ class BECImageShow(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -778,6 +833,7 @@ class BECImageShow(RPCBase):
     def add_image_by_config(self, config: "ImageItemConfig | dict") -> "BECImageItem":
         """
         Add an image to the widget by configuration.
+
         Args:
             config(ImageItemConfig|dict): The configuration of the image.
 
@@ -789,6 +845,7 @@ class BECImageShow(RPCBase):
     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.
@@ -801,6 +858,7 @@ class BECImageShow(RPCBase):
     def get_image_dict(self) -> "dict[str, dict[str, BECImageItem]]":
         """
         Get all images.
+
         Returns:
             dict[str, dict[str, BECImageItem]]: The dictionary of images.
         """
@@ -841,6 +899,7 @@ class BECImageShow(RPCBase):
         """
         Set the range of the color bar.
         If name is not specified, then set vrange for all images.
+
         Args:
             vmin(float): Minimum value of the color bar.
             vmax(float): Maximum value of the color bar.
@@ -852,6 +911,7 @@ class BECImageShow(RPCBase):
         """
         Set the color map of the image.
         If name is not specified, then set color map for all images.
+
         Args:
             cmap(str): The color map of the image.
             name(str): The name of the image. If None, apply to all images.
@@ -861,6 +921,7 @@ class BECImageShow(RPCBase):
     def set_autorange(self, enable: "bool" = False, name: "str" = None):
         """
         Set the autoscale of the image.
+
         Args:
             enable(bool): Whether to autoscale the color bar.
             name(str): The name of the image. If None, apply to all images.
@@ -871,6 +932,7 @@ class BECImageShow(RPCBase):
         """
         Set the monitor of the image.
         If name is not specified, then set monitor for all images.
+
         Args:
             monitor(str): The name of the monitor.
             name(str): The name of the image. If None, apply to all images.
@@ -881,6 +943,7 @@ class BECImageShow(RPCBase):
         """
         Set the post processing of the image.
         If name is not specified, then set post processing for all images.
+
         Args:
             name(str): The name of the image. If None, apply to all images.
             **kwargs: Keyword arguments for the properties to be set.
@@ -895,6 +958,7 @@ class BECImageShow(RPCBase):
     def set_image_properties(self, name: "str" = None, **kwargs):
         """
         Set the properties of the image.
+
         Args:
             name(str): The name of the image. If None, apply to all images.
             **kwargs: Keyword arguments for the properties to be set.
@@ -915,6 +979,7 @@ class BECImageShow(RPCBase):
         """
         Set the FFT of the image.
         If name is not specified, then set FFT for all images.
+
         Args:
             enable(bool): Whether to perform FFT on the monitor data.
             name(str): The name of the image. If None, apply to all images.
@@ -925,6 +990,7 @@ class BECImageShow(RPCBase):
         """
         Set the log of the image.
         If name is not specified, then set log for all images.
+
         Args:
             enable(bool): Whether to perform log on the monitor data.
             name(str): The name of the image. If None, apply to all images.
@@ -935,6 +1001,7 @@ class BECImageShow(RPCBase):
         """
         Set the rotation of the image.
         If name is not specified, then set rotation for all images.
+
         Args:
             deg_90(int): The rotation angle of the monitor data before displaying.
             name(str): The name of the image. If None, apply to all images.
@@ -945,6 +1012,7 @@ class BECImageShow(RPCBase):
         """
         Set the transpose of the image.
         If name is not specified, then set transpose for all images.
+
         Args:
             enable(bool): Whether to transpose the monitor data before displaying.
             name(str): The name of the image. If None, apply to all images.
@@ -954,6 +1022,7 @@ class BECImageShow(RPCBase):
     def toggle_threading(self, use_threading: "bool"):
         """
         Toggle threading for the widgets postprocessing and updating.
+
         Args:
             use_threading(bool): Whether to use threading.
         """
@@ -962,8 +1031,10 @@ class BECImageShow(RPCBase):
     def set(self, **kwargs) -> "None":
         """
         Set the properties of the plot widget.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - title: str
             - x_label: str
@@ -978,6 +1049,7 @@ class BECImageShow(RPCBase):
     def set_title(self, title: "str"):
         """
         Set the title of the plot widget.
+
         Args:
             title(str): Title of the plot widget.
         """
@@ -986,6 +1058,7 @@ class BECImageShow(RPCBase):
     def set_x_label(self, label: "str"):
         """
         Set the label of the x-axis.
+
         Args:
             label(str): Label of the x-axis.
         """
@@ -994,6 +1067,7 @@ class BECImageShow(RPCBase):
     def set_y_label(self, label: "str"):
         """
         Set the label of the y-axis.
+
         Args:
             label(str): Label of the y-axis.
         """
@@ -1002,6 +1076,7 @@ class BECImageShow(RPCBase):
     def set_x_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the x-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the x-axis.
         """
@@ -1010,6 +1085,7 @@ class BECImageShow(RPCBase):
     def set_y_scale(self, scale: "Literal['linear', 'log']" = "linear"):
         """
         Set the scale of the y-axis.
+
         Args:
             scale(Literal["linear", "log"]): Scale of the y-axis.
         """
@@ -1048,6 +1124,7 @@ class BECImageShow(RPCBase):
     def set_grid(self, x: "bool" = False, y: "bool" = False):
         """
         Set the grid of the plot widget.
+
         Args:
             x(bool): Show grid on the x-axis.
             y(bool): Show grid on the y-axis.
@@ -1057,6 +1134,7 @@ class BECImageShow(RPCBase):
     def lock_aspect_ratio(self, lock):
         """
         Lock aspect ratio.
+
         Args:
             lock(bool): True to lock, False to unlock.
         """
@@ -1065,6 +1143,7 @@ class BECImageShow(RPCBase):
     def plot(self, data_x: "list | np.ndarray", data_y: "list | np.ndarray", **kwargs):
         """
         Plot custom data on the plot widget. These data are not saved in config.
+
         Args:
             data_x(list|np.ndarray): x-axis data
             data_y(list|np.ndarray): y-axis data
@@ -1093,6 +1172,7 @@ class BECConnector(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -1117,6 +1197,7 @@ class BECImageItem(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -1125,8 +1206,10 @@ class BECImageItem(RPCBase):
     def set(self, **kwargs):
         """
         Set the properties of the image.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - downsample
             - color_map
@@ -1143,6 +1226,7 @@ class BECImageItem(RPCBase):
     def set_fft(self, enable: "bool" = False):
         """
         Set the FFT of the image.
+
         Args:
             enable(bool): Whether to perform FFT on the monitor data.
         """
@@ -1151,6 +1235,7 @@ class BECImageItem(RPCBase):
     def set_log(self, enable: "bool" = False):
         """
         Set the log of the image.
+
         Args:
             enable(bool): Whether to perform log on the monitor data.
         """
@@ -1159,6 +1244,7 @@ class BECImageItem(RPCBase):
     def set_rotation(self, deg_90: "int" = 0):
         """
         Set the rotation of the image.
+
         Args:
             deg_90(int): The rotation angle of the monitor data before displaying.
         """
@@ -1167,6 +1253,7 @@ class BECImageItem(RPCBase):
     def set_transpose(self, enable: "bool" = False):
         """
         Set the transpose of the image.
+
         Args:
             enable(bool): Whether to transpose the image.
         """
@@ -1175,6 +1262,7 @@ class BECImageItem(RPCBase):
     def set_opacity(self, opacity: "float" = 1.0):
         """
         Set the opacity of the image.
+
         Args:
             opacity(float): The opacity of the image.
         """
@@ -1183,6 +1271,7 @@ class BECImageItem(RPCBase):
     def set_autorange(self, autorange: "bool" = False):
         """
         Set the autorange of the color bar.
+
         Args:
             autorange(bool): Whether to autorange the color bar.
         """
@@ -1191,6 +1280,7 @@ class BECImageItem(RPCBase):
     def set_color_map(self, cmap: "str" = "magma"):
         """
         Set the color map of the image.
+
         Args:
             cmap(str): The color map of the image.
         """
@@ -1199,6 +1289,7 @@ class BECImageItem(RPCBase):
     def set_auto_downsample(self, auto: "bool" = True):
         """
         Set the auto downsample of the image.
+
         Args:
             auto(bool): Whether to downsample the image.
         """
@@ -1207,6 +1298,7 @@ class BECImageItem(RPCBase):
     def set_monitor(self, monitor: "str"):
         """
         Set the monitor of the image.
+
         Args:
             monitor(str): The name of the monitor.
         """
@@ -1217,6 +1309,7 @@ class BECImageItem(RPCBase):
     ):
         """
         Set the range of the color bar.
+
         Args:
             vmin(float): Minimum value of the color bar.
             vmax(float): Maximum value of the color bar.
@@ -1237,6 +1330,7 @@ class BECMotorMap(RPCBase):
     def config_dict(self) -> "dict":
         """
         Get the configuration of the widget.
+
         Returns:
             dict: The configuration of the widget.
         """
@@ -1252,6 +1346,7 @@ class BECMotorMap(RPCBase):
     ) -> "None":
         """
         Change the active motors for the plot.
+
         Args:
             motor_x(str): Motor name for the X axis.
             motor_y(str): Motor name for the Y axis.
@@ -1264,6 +1359,7 @@ class BECMotorMap(RPCBase):
     def set_max_points(self, max_points: "int") -> "None":
         """
         Set the maximum number of points to display.
+
         Args:
             max_points(int): Maximum number of points to display.
         """
@@ -1272,6 +1368,7 @@ class BECMotorMap(RPCBase):
     def set_precision(self, precision: "int") -> "None":
         """
         Set the decimal precision of the motor position.
+
         Args:
             precision(int): Decimal precision of the motor position.
         """
@@ -1280,6 +1377,7 @@ class BECMotorMap(RPCBase):
     def set_num_dim_points(self, num_dim_points: "int") -> "None":
         """
         Set the number of dim points for the motor map.
+
         Args:
             num_dim_points(int): Number of dim points.
         """
@@ -1288,6 +1386,7 @@ class BECMotorMap(RPCBase):
     def set_background_value(self, background_value: "int") -> "None":
         """
         Set the background value of the motor map.
+
         Args:
             background_value(int): Background value of the motor map.
         """
@@ -1296,6 +1395,7 @@ class BECMotorMap(RPCBase):
     def set_scatter_size(self, scatter_size: "int") -> "None":
         """
         Set the scatter size of the motor map plot.
+
         Args:
             scatter_size(int): Size of the scatter points.
         """
@@ -1307,3 +1407,226 @@ class BECMotorMap(RPCBase):
         Returns:
             dict: Data of the motor map.
         """
+
+
+class BECDock(RPCBase):
+    @property
+    @rpc_call
+    def rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+    @property
+    @rpc_call
+    def widget_list(self) -> "list":
+        """
+        Get the widgets in the dock.
+
+        Returns:
+            widgets(list): The widgets in the dock.
+        """
+
+    @rpc_call
+    def show_title_bar(self):
+        """
+        Hide the title bar of the dock.
+        """
+
+    @rpc_call
+    def hide_title_bar(self):
+        """
+        Hide the title bar of the dock.
+        """
+
+    @rpc_call
+    def get_widgets_positions(self) -> "dict":
+        """
+        Get the positions of the widgets in the dock.
+
+        Returns:
+            dict: The positions of the widgets in the dock as dict -> {(row, col, rowspan, colspan):widget}
+        """
+
+    @rpc_call
+    def set_title(self, title: "str"):
+        """
+        Set the title of the dock.
+
+        Args:
+            title(str): The title of the dock.
+        """
+
+    @rpc_call
+    def add_widget_bec(
+        self,
+        widget_type: "str",
+        row=None,
+        col=0,
+        rowspan=1,
+        colspan=1,
+        shift: "Literal['down', 'up', 'left', 'right']" = "down",
+    ):
+        """
+        Add a widget to the dock.
+
+        Args:
+            widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
+            row(int): The row to add the widget to. If None, the widget will be added to the next available row.
+            col(int): The column to add the widget to.
+            rowspan(int): The number of rows the widget should span.
+            colspan(int): The number of columns the widget should span.
+            shift(Literal["down", "up", "left", "right"]): The direction to shift the widgets if the position is occupied.
+        """
+
+    @rpc_call
+    def list_eligible_widgets(self) -> "list":
+        """
+        List all widgets that can be added to the dock.
+
+        Returns:
+            list: The list of eligible widgets.
+        """
+
+    @rpc_call
+    def move_widget(self, widget: "QWidget", new_row: "int", new_col: "int"):
+        """
+        Move a widget to a new position in the layout.
+
+        Args:
+            widget(QWidget): The widget to move.
+            new_row(int): The new row to move the widget to.
+            new_col(int): The new column to move the widget to.
+        """
+
+    @rpc_call
+    def remove_widget(self, widget_rpc_id: "str"):
+        """
+        Remove a widget from the dock.
+
+        Args:
+            widget_rpc_id(str): The ID of the widget to remove.
+        """
+
+    @rpc_call
+    def remove(self):
+        """
+        Remove the dock from the parent dock area.
+        """
+
+    @rpc_call
+    def attach(self):
+        """
+        Attach the dock to the parent dock area.
+        """
+
+    @rpc_call
+    def detach(self):
+        """
+        Detach the dock from the parent dock area.
+        """
+
+
+class BECDockArea(RPCBase, BECGuiClientMixin):
+    @property
+    @rpc_call
+    def panels(self) -> "dict":
+        """
+        Get the docks in the dock area.
+        Returns:
+            dock_dict(dict): The docks in the dock area.
+        """
+
+    @rpc_call
+    def save_state(self) -> "dict":
+        """
+        Save the state of the dock area.
+
+        Returns:
+            dict: The state of the dock area.
+        """
+
+    @rpc_call
+    def remove_dock(self, name: "str"):
+        """
+        Remove a dock by name and ensure it is properly closed and cleaned up.
+
+        Args:
+            name(str): The name of the dock to remove.
+        """
+
+    @rpc_call
+    def restore_state(
+        self, state: "dict" = None, missing: "Literal['ignore', 'error']" = "ignore", extra="bottom"
+    ):
+        """
+        Restore the state of the dock area. If no state is provided, the last state is restored.
+
+        Args:
+            state(dict): The state to restore.
+            missing(Literal['ignore','error']): What to do if a dock is missing.
+            extra(str): Extra docks that are in the dockarea but that are not mentioned in state will be added to the bottom of the dockarea, unless otherwise specified by the extra argument.
+        """
+
+    @rpc_call
+    def add_dock(
+        self,
+        name: "str" = None,
+        position: "Literal['bottom', 'top', 'left', 'right', 'above', 'below']" = None,
+        relative_to: "BECDock | None" = None,
+        closable: "bool" = False,
+        prefix: "str" = "dock",
+        widget: "str | QWidget | None" = None,
+        row: "int" = None,
+        col: "int" = 0,
+        rowspan: "int" = 1,
+        colspan: "int" = 1,
+    ) -> "BECDock":
+        """
+        Add a dock to the dock area. Dock has QGridLayout as layout manager by default.
+
+        Args:
+            name(str): The name of the dock to be displayed and for further references. Has to be unique.
+            position(Literal["bottom", "top", "left", "right", "above", "below"]): The position of the dock.
+            relative_to(BECDock): The dock to which the new dock should be added relative to.
+            closable(bool): Whether the dock is closable.
+            prefix(str): The prefix for the dock name if no name is provided.
+            widget(str|QWidget|None): The widget to be added to the dock. While using RPC, only BEC RPC widgets from RPCWidgetHandler are allowed.
+            row(int): The row of the added widget.
+            col(int): The column of the added widget.
+            rowspan(int): The rowspan of the added widget.
+            colspan(int): The colspan of the added widget.
+
+        Returns:
+            BECDock: The created dock.
+        """
+
+    @rpc_call
+    def clear_all(self):
+        """
+        Close all docks and remove all temp areas.
+        """
+
+    @rpc_call
+    def detach_dock(self, dock_name: "str") -> "BECDock":
+        """
+        Undock a dock from the dock area.
+
+        Args:
+            dock_name(str): The dock to undock.
+
+        Returns:
+            BECDock: The undocked dock.
+        """
+
+    @rpc_call
+    def attach_all(self):
+        """
+        Return all floating docks to the dock area.
+        """
+
+    @rpc_call
+    def get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """