bec-widgets 0.83.1__py3-none-any.whl → 0.85.0__py3-none-any.whl

CHANGELOG.md

@@ -1,5 +1,45 @@
 # CHANGELOG
 
+## v0.85.0 (2024-07-16)
+
+### Feature
+
+* feat(color_map_selector): added colormap selector with plugin ([`b98fd00`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b98fd00adef97adf57f49b60ade99972b9f5a6bc))
+
+## v0.84.0 (2024-07-15)
+
+### Feature
+
+* feat(waveform): async readback update implemented for async devices ([`0c6a9f2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0c6a9f2310df31ddcd68050a17cfbf52c3e2e226))
+
+* feat(waveform): data are taken directly from ScanItem which is defined from scan_status endpoint; scan update is triggered from scan_segment; plots can be added just specifying y_name -> best effort for setting x reported device ([`b8717f1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b8717f13276734dd655ab03cd6005985ad5af9fb))
+
+### Fix
+
+* fix(waveform): timestamp are not converted to human readable format ([`e495fd3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e495fd30c4c16474689943c7263e3060cb09ffb4))
+
+* fix(waveform): set_x method various bugs fixed ([`8516a1d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8516a1d639925a877f174fa13f427a71131cc918))
+
+* fix(waveform): x axis switching logic fixed when axis are not compatible ([`e4e1a90`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e4e1a905d19def22f970b364c18c953f00e10389))
+
+* fix(waveform): dap leaked RID for all daps in current process; dap RID is now f"{scan_id}-{gui_id}" to distinguish for each plot instance ([`d23fd8b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d23fd8bd074ede6e14eb8e85e025cbced4bd45ef))
+
+* fix(waveform): only one type of x axis allowed; x mode validated ([`9d6ae87`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9d6ae87d0f03ca227570fcca8af2d8190828d271))
+
+* fix(waveform): data for axis are taken by separate method; validation consolidated ([`fc5a8bd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fc5a8bdd8b260f5e9b59ec71a4610c57442e43fe))
+
+* fix(bec_dispatcher): connect_slot can accept kwargs ([`0aa317a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0aa317aae58d3612d46f05b85f8b0db3d12bbe14))
+
+### Refactor
+
+* refactor(waveform): plot can be prompted without specifying kwargs ([`48911e9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/48911e934815923c94edb5ced6042058a11a97f5))
+
+* refactor(jupyter_console_window): added more examples of waveforms ([`fc935d9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fc935d9fc81067c3a67389ff88ea97da2e0c903e))
+
+### Test
+
+* test(waveform): tests extended ([`006992e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/006992e43cc56d56261bc4fd3e9cae9abcab2153))
+
 ## v0.83.1 (2024-07-14)
 
 ### Fix
@@ -99,45 +139,3 @@
 * fix(motor_control): temporary remove of motor control widgets ([`99114f1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/99114f14f62202e1fd8bf145616fa8c69937ada4))
 
 ## v0.81.0 (2024-07-06)
-
-### Feature
-
-* feat(color_button): can get colors in RGBA or HEX ([`9594be2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9594be260680d11c8550ff74ffb8d679e5a5b8f6))
-
-## v0.80.1 (2024-07-06)
-
-### Fix
-
-* fix(entry_validator): check for entry == "" ([`61de7e9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/61de7e9e221c766b9fb3ec23246da6a11c96a986))
-
-## v0.80.0 (2024-07-06)
-
-### Feature
-
-* feat(qt5): dropped support for qt5; pyside2 and pyqt5 ([`fadbf77`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fadbf77866903beff6580802bc203d53367fc7e7))
-
-* feat(plugins): moved plugin dict to dataclass and container ([`03819a3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/03819a3d902b4a51f3e882d52aedd971b2a8e127))
-
-* feat(plugins): added support for pyqt6 ui files ([`d6d0777`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d6d07771135335cb78dc648508ce573b8970261a))
-
-* feat(plugins): added bec widgets base class ([`1aa83e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1aa83e0ef1ffe45b01677b0b4590535cb0ca1cff))
-
-## v0.79.3 (2024-07-05)
-
-### Fix
-
-* fix: changed inheritance to adress qt designer bug in rendering ([`e403870`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e403870874bd5e45840a034d6f1b3dd576d9c846))
-
-* fix: add designer plugin classes ([`1586ce2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1586ce2d6cba2bb086b2ef596e724bb9e40ab4f2))
-
-### Refactor
-
-* refactor: simplify logic in bec_status_box ([`576353c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/576353cfe8c6fd64db561f0b6e2bc951300643d3))
-
-## v0.79.2 (2024-07-04)
-
-### Fix
-
-* fix: overwrite closeEvent and call super class ([`bc0ef78`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bc0ef7893ef100b71b62101c459655509b534a56))
-
-## v0.79.1 (2024-07-03)

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.83.1
+Version: 0.85.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -19,6 +19,9 @@ class Widgets(str, enum.Enum):
     BECMotorMapWidget = "BECMotorMapWidget"
     BECQueue = "BECQueue"
     BECStatusBox = "BECStatusBox"
+    DeviceBox = "DeviceBox"
+    DeviceComboBox = "DeviceComboBox"
+    DeviceLineEdit = "DeviceLineEdit"
     RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
     StopButton = "StopButton"
@@ -465,8 +468,9 @@ class BECFigure(RPCBase):
     @rpc_call
     def plot(
         self,
-        x: "list | np.ndarray | None" = None,
+        arg1: "list | np.ndarray | str | None" = None,
         y: "list | np.ndarray | None" = None,
+        x: "list | np.ndarray | None" = None,
         x_name: "str | None" = None,
         y_name: "str | None" = None,
         z_name: "str | None" = None,
@@ -488,8 +492,9 @@ class BECFigure(RPCBase):
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
 
         Args:
-            x(list | np.ndarray): Custom x data to plot.
+            arg1(list | np.ndarray | str | None): First argument which can be x data, y data, or y_name.
             y(list | np.ndarray): Custom y data to plot.
+            x(list | np.ndarray): Custom x 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.
@@ -1494,8 +1499,9 @@ class BECWaveform(RPCBase):
     @rpc_call
     def plot(
         self,
-        x: "list | np.ndarray | None" = None,
+        arg1: "list | np.ndarray | str | None" = None,
         y: "list | np.ndarray | None" = None,
+        x: "list | np.ndarray | None" = None,
         x_name: "str | None" = None,
         y_name: "str | None" = None,
         z_name: "str | None" = None,
@@ -1507,13 +1513,20 @@ class BECWaveform(RPCBase):
         label: "str | None" = None,
         validate: "bool" = True,
         dap: "str | None" = None,
+        **kwargs,
     ) -> "BECCurve":
         """
         Plot a curve to the plot widget.
+
         Args:
-            x(list | np.ndarray): Custom x data to plot.
+            arg1(list | np.ndarray | str | None): First argument which can be x data, y data, or y_name.
             y(list | np.ndarray): Custom y data to plot.
-            x_name(str): The name of the device for the x-axis.
+            x(list | np.ndarray): Custom y data to plot.
+            x_name(str): Name of the x signal.
+                - "best_effort": Use the best effort signal.
+                - "timestamp": Use the timestamp signal.
+                - "index": Use the index signal.
+                - Custom signal name of device from BEC.
             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.
@@ -1523,7 +1536,7 @@ class BECWaveform(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.
-            dap(str): The dap model to use for the curve. If not specified, none will be added.
+            dap(str): The dap model to use for the curve, only available for sync devices. If not specified, none will be added.
 
         Returns:
             BECCurve: The curve object.
@@ -1532,12 +1545,13 @@ class BECWaveform(RPCBase):
     @rpc_call
     def add_dap(
         self,
-        x_name: "str",
-        y_name: "str",
+        x_name: "str | None" = None,
+        y_name: "str | None" = None,
         x_entry: "Optional[str]" = None,
         y_entry: "Optional[str]" = None,
         color: "Optional[str]" = None,
         dap: "str" = "GaussianModel",
+        validate_bec: "bool" = True,
         **kwargs,
     ) -> "BECCurve":
         """
@@ -1552,12 +1566,27 @@ class BECWaveform(RPCBase):
             color_map_z(str): The color map to use for the z-axis.
             label(str, optional): Label of the curve. Defaults to None.
             dap(str): The dap model to use for the curve.
+            validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
             **kwargs: Additional keyword arguments for the curve configuration.
 
         Returns:
             BECCurve: The curve object.
         """
 
+    @rpc_call
+    def set_x(self, x_name: "str", x_entry: "str | None" = None):
+        """
+        Change the x axis of the plot widget.
+
+        Args:
+            x_name(str): Name of the x signal.
+                - "best_effort": Use the best effort signal.
+                - "timestamp": Use the timestamp signal.
+                - "index": Use the index signal.
+                - Custom signal name of device from BEC.
+            x_entry(str): Entry of the x signal.
+        """
+
     @rpc_call
     def get_dap_params(self) -> "dict":
         """
@@ -1742,6 +1771,12 @@ class BECWaveform(RPCBase):
         Remove the plot widget from the figure.
         """
 
+    @rpc_call
+    def clear_all(self):
+        """
+        None
+        """
+
     @rpc_call
     def set_legend_label_size(self, size: "int" = None):
         """
@@ -1752,6 +1787,24 @@ class BECWaveform(RPCBase):
         """
 
 
+class DeviceBox(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+
 class DeviceComboBox(RPCBase):
     @property
     @rpc_call

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -2,13 +2,19 @@ import os
 
 import numpy as np
 import pyqtgraph as pg
-from qtconsole.inprocess import QtInProcessKernelManager
-from qtconsole.rich_jupyter_widget import RichJupyterWidget
 from qtpy.QtCore import QSize
 from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
-
-from bec_widgets.utils import BECDispatcher, UILoader
+from qtpy.QtWidgets import (
+    QApplication,
+    QGroupBox,
+    QHBoxLayout,
+    QSplitter,
+    QTabWidget,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils import BECDispatcher
 from bec_widgets.utils.colors import apply_theme
 from bec_widgets.widgets.dock.dock_area import BECDockArea
 from bec_widgets.widgets.figure import BECFigure
@@ -21,14 +27,8 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
     def __init__(self, parent=None):
         super().__init__(parent)
 
-        current_path = os.path.dirname(__file__)
-        self.ui = UILoader().load_ui(os.path.join(current_path, "jupyter_console_window.ui"), self)
-
         self._init_ui()
 
-        self.ui.splitter.setSizes([200, 100])
-        self.safe_close = False
-
         # console push
         if self.console.inprocess is True:
             self.console.kernel_manager.kernel.shell.push(
@@ -40,10 +40,12 @@ 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,
+                    "w5": self.w5,
+                    "w6": self.w6,
+                    "w7": self.w7,
+                    "w8": self.w8,
+                    "w9": self.w9,
                     "d0": self.d0,
                     "d1": self.d1,
                     "d2": self.d2,
@@ -53,14 +55,30 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
             )
 
     def _init_ui(self):
-        # Plotting window
-        self.glw_1_layout = QVBoxLayout(self.ui.glw)  # Create a new QVBoxLayout
-        self.figure = BECFigure(parent=self, gui_id="remote")  # Create a new BECDeviceMonitor
-        self.glw_1_layout.addWidget(self.figure)  # Add BECDeviceMonitor to the layout
+        self.layout = QHBoxLayout(self)
+
+        # Horizontal splitter
+        splitter = QSplitter(self)
+        self.layout.addWidget(splitter)
 
-        self.dock_layout = QVBoxLayout(self.ui.dock_placeholder)
-        self.dock = BECDockArea(gui_id="remote")
-        self.dock_layout.addWidget(self.dock)
+        tab_widget = QTabWidget(splitter)
+
+        first_tab = QWidget()
+        first_tab_layout = QVBoxLayout(first_tab)
+        self.dock = BECDockArea(gui_id="dock")
+        first_tab_layout.addWidget(self.dock)
+        tab_widget.addTab(first_tab, "Dock Area")
+
+        second_tab = QWidget()
+        second_tab_layout = QVBoxLayout(second_tab)
+        self.figure = BECFigure(parent=self, gui_id="figure")
+        second_tab_layout.addWidget(self.figure)
+        tab_widget.addTab(second_tab, "BEC Figure")
+
+        group_box = QGroupBox("Jupyter Console", splitter)
+        group_box_layout = QVBoxLayout(group_box)
+        self.console = BECJupyterConsole(inprocess=True)
+        group_box_layout.addWidget(self.console)
 
         # add stuff to figure
         self._init_figure()
@@ -68,44 +86,70 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         # init dock for testing
         self._init_dock()
 
-        self.console_layout = QVBoxLayout(self.ui.widget_console)
-        self.console = BECJupyterConsole(inprocess=True)
-        self.console_layout.addWidget(self.console)
+        self.setWindowTitle("Jupyter Console Window")
 
     def _init_figure(self):
-        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.plot(
-            x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="magma", new=True
+        self.w1 = self.figure.plot(
+            x_name="samx",
+            y_name="bpm4i",
+            # title="Standard Plot with sync device, custom labels - w1",
+            # x_label="Motor Position",
+            # y_label="Intensity (A.U.)",
+            row=0,
+            col=0,
+        )
+        self.w1.set(
+            title="Standard Plot with sync device, custom labels - w1",
+            x_label="Motor Position",
+            y_label="Intensity (A.U.)",
+        )
+        self.w2 = self.figure.motor_map("samx", "samy", row=0, col=1)
+        self.w3 = self.figure.image(
+            "eiger", color_map="viridis", vrange=(0, 100), title="Eiger Image - w3", row=0, col=2
+        )
+        self.w4 = self.figure.plot(
+            x_name="samx",
+            y_name="samy",
+            z_name="bpm4i",
+            color_map_z="magma",
+            new=True,
+            title="2D scatter plot - w4",
+            row=0,
+            col=3,
+        )
+        self.w5 = self.figure.plot(
+            y_name="bpm4i",
+            new=True,
+            title="Best Effort Plot - w5",
+            dap="GaussianModel",
+            row=1,
+            col=0,
+        )
+        self.w6 = self.figure.plot(
+            x_name="timestamp", y_name="bpm4i", new=True, title="Timestamp Plot - w6", row=1, col=1
+        )
+        self.w7 = self.figure.plot(
+            x_name="index", y_name="bpm4i", new=True, title="Index Plot - w7", row=1, col=2
+        )
+        self.w8 = self.figure.plot(
+            y_name="monitor_async", new=True, title="Async Plot - Best Effort - w8", row=2, col=0
+        )
+        self.w9 = self.figure.plot(
+            x_name="timestamp",
+            y_name="monitor_async",
+            new=True,
+            title="Async Plot - timestamp - w9",
+            row=2,
+            col=1,
+        )
+        self.w10 = self.figure.plot(
+            x_name="index",
+            y_name="monitor_async",
+            new=True,
+            title="Async Plot - index - w10",
+            row=2,
+            col=2,
         )
-
-        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):
 
@@ -131,9 +175,13 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
 
     def closeEvent(self, event):
         """Override to handle things when main window is closed."""
+        self.dock.clear_all()
         self.dock.cleanup()
+        self.dock.close()
         self.figure.clear_all()
-        self.figure.client.shutdown()
+        self.figure.cleanup()
+        self.figure.close()
+
         super().closeEvent(event)
 
 

bec_widgets/utils/bec_dispatcher.py

@@ -134,7 +134,10 @@ class BECDispatcher:
         cls.qapp = None
 
     def connect_slot(
-        self, slot: Callable, topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]]
+        self,
+        slot: Callable,
+        topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
+        **kwargs,
     ) -> None:
         """Connect widget's pyqt slot, so that it is called on new pub/sub topic message.
 
@@ -144,7 +147,7 @@ class BECDispatcher:
             topics (EndpointInfo | str | list): A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
         """
         slot = QtThreadSafeCallback(slot)
-        self.client.connector.register(topics, cb=slot)
+        self.client.connector.register(topics, cb=slot, **kwargs)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         self._slots[slot].update(set(topics_str))
 

bec_widgets/widgets/color_map_selector/color_map_selector.py

@@ -0,0 +1,111 @@
+import pyqtgraph as pg
+from qtpy.QtCore import Property, Signal, Slot
+from qtpy.QtGui import QColor, QFontMetrics, QImage
+from qtpy.QtWidgets import QApplication, QComboBox, QStyledItemDelegate, QVBoxLayout, QWidget
+
+
+class ColormapDelegate(QStyledItemDelegate):
+    def __init__(self, parent=None):
+        super(ColormapDelegate, self).__init__(parent)
+        self.image_width = 25
+        self.image_height = 10
+        self.gap = 10
+
+    def paint(self, painter, option, index):
+        text = index.data()
+        colormap = pg.colormap.get(text)
+        colors = colormap.getLookupTable(start=0.0, stop=1.0, alpha=False)
+
+        font_metrics = QFontMetrics(painter.font())
+        text_width = font_metrics.width(text)
+        text_height = font_metrics.height()
+
+        total_height = max(text_height, self.image_height)
+
+        image = QImage(self.image_width, self.image_height, QImage.Format_RGB32)
+        for i in range(self.image_width):
+            color = QColor(*colors[int(i * (len(colors) - 1) / (self.image_width - 1))])
+            for j in range(self.image_height):
+                image.setPixel(i, j, color.rgb())
+
+        painter.drawImage(
+            option.rect.x(), option.rect.y() + (total_height - self.image_height) // 2, image
+        )
+        painter.drawText(
+            option.rect.x() + self.image_width + self.gap,
+            option.rect.y() + (total_height - text_height) // 2 + font_metrics.ascent(),
+            text,
+        )
+
+
+class ColormapSelector(QWidget):
+    """
+    Simple colormap combobox widget. By  default it loads all the available colormaps in pyqtgraph.
+    """
+
+    colormap_changed_signal = Signal(str)
+
+    def __init__(self, parent=None, default_colormaps=None):
+        super().__init__(parent)
+        self._colormaps = []
+        self.initUI(default_colormaps)
+
+    def initUI(self, default_colormaps=None):
+        self.layout = QVBoxLayout(self)
+        self.combo = QComboBox()
+        self.combo.setItemDelegate(ColormapDelegate())
+        self.combo.currentTextChanged.connect(self.colormap_changed)
+        self.available_colormaps = pg.colormap.listMaps()
+        if default_colormaps is None:
+            default_colormaps = self.available_colormaps
+        self.add_color_maps(default_colormaps)
+        self.layout.addWidget(self.combo)
+
+    @Slot()
+    def colormap_changed(self):
+        """
+        Emit the colormap changed signal with the current colormap selected in the combobox.
+        """
+        self.colormap_changed_signal.emit(self.combo.currentText())
+
+    def add_color_maps(self, colormaps=None):
+        """
+        Add colormaps to the combobox.
+
+        Args:
+            colormaps(list): List of colormaps to add to the combobox. If None, all available colormaps are added.
+        """
+        self.combo.clear()
+        if colormaps is not None:
+            for name in colormaps:
+                if name in self.available_colormaps:
+                    self.combo.addItem(name)
+        else:
+            for name in self.available_colormaps:
+                self.combo.addItem(name)
+        self._colormaps = colormaps if colormaps is not None else self.available_colormaps
+
+    @Property("QStringList")
+    def colormaps(self):
+        """
+        Property to get and set the colormaps in the combobox.
+        """
+        return self._colormaps
+
+    @colormaps.setter
+    def colormaps(self, value):
+        """
+        Set the colormaps in the combobox.
+        """
+        if self._colormaps != value:
+            self._colormaps = value
+            self.add_color_maps(value)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    ex = ColormapSelector()
+    ex.show()
+    sys.exit(app.exec_())

bec_widgets/widgets/color_map_selector/color_map_selector.pyproject

@@ -0,0 +1 @@
+{'files': ['color_map_selector.py']}

bec_widgets/widgets/color_map_selector/color_map_selector_plugin.py

@@ -0,0 +1,57 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+from bec_widgets.widgets.color_map_selector.color_map_selector import ColormapSelector
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ColormapSelector' name='color_map_selector'>
+    </widget>
+</ui>
+"""
+
+
+class ColormapSelectorPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ColormapSelector(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        current_path = os.path.dirname(__file__)
+        icon_path = os.path.join(current_path, "assets", "color_map_selector_icon.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "color_map_selector"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ColormapSelector"
+
+    def toolTip(self):
+        return "A custom QComboBox widget for selecting colormaps."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/color_map_selector/register_color_map_selector.py

@@ -0,0 +1,17 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.color_map_selector.color_map_selector_plugin import (
+        ColormapSelectorPlugin,
+    )
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(ColormapSelectorPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()