bec-widgets 0.94.7__py3-none-any.whl → 0.95.1__py3-none-any.whl

docs/user/widgets/bec_figure/bec_figure.md

@@ -0,0 +1,105 @@
+(user.widgets.bec_figure)=
+# BECFigure
+
+````{tab} Overview
+
+[`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) is a robust framework that provides a fast, flexible plotting environment, similar to the Matplotlib figure. With BECFigure, users can dynamically change layouts, add or remove subplots, and customize their plotting environment in real-time. This flexibility makes BECFigure an ideal tool for both rapid prototyping and detailed data visualization.
+
+- **Dynamic Layout Management**: Easily add, remove, and rearrange subplots within `BECFigure`, enabling tailored visualization setups.
+- **Widget Integration**: Incorporate various specialized widgets like [`WaveformWidget`](user.widgets.waveform_widget), [`ImageWidget`](user.widgets.image_widget) , and [`MotorMapWidget`](user.widgets.motor_map) into `BECFigure`. Note that these widgets can also be used individually. For more details, please refer to the documentation for each individual widget.
+- **Interactive Controls**: Provides interactive tools for zooming, panning, and adjusting plots on the fly, streamlining the data exploration process.
+
+**Schema of the BECFigure components**
+
+![BECFigure.png](BECFigure.png)
+
+````
+
+````{tab} Examples - CLI
+In the following examples, we will use `BECIPythonClient` with a predefined `BECDockArea` as the `gui` object. These tutorials focus on how to work with the `BECFigure` framework, such as changing layouts, adding new elements, and accessing them. For more detailed examples of each individual component, please refer to the example sections of each individual widget: [`WaveformWidget`](user.widgets.waveform_widget), [`MotorMapWidget`](user.widgets.motor_map), [`ImageWidget`](user.widgets.image_widget).
+
+## Example 1 - Adding subplots to BECFigure
+
+In this example, we will demonstrate how to add different subplots to a single `BECFigure` widget.
+
+```python
+# Add a new dock with BECFigure widget
+fig = gui.add_dock().add_widget('BECFigure')
+
+# Add a WaveformWidget to the BECFigure
+plt1 = fig.plot(x_name='samx', y_name='bpm4i')
+
+# Add a second WaveformWidget to the BECFigure, specifying new=True to add it as a new subplot
+plt2 = fig.plot(x_name='samx', y_name='bpm3i', new=True)
+
+# Add a MotorMapWidget to the BECFigure
+mm = fig.motor_map(motor_x='samx', motor_y='samy')
+
+# Add an ImageWidget to the BECFigure
+img = fig.image('eiger')
+```
+```{note}
+By default, the [`.plot`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.plot), [`.image`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.image), and [`.motor_map`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.motor_map) methods always find the first widget of that type in the layout and interact with it. If you want to add a new subplot of the same type, you must either specify the coordinates of the new subplot or use the `new=True` keyword argument, as shown above when adding the second WaveformWidget. Additionally, you can directly add a subplot to a specific, unoccupied position in the layout by specifying the `row` and `col` arguments, such as `fig.plot(x_name='samx', y_name='bpm4i', row=1, col=1)`.
+```
+
+## Example 2 - Changing the layout of BECFigure
+
+The previous example added four subplots into a single `BECFigure` widget. By default, new widgets are always added to the bottom of the BECFigure. However, you can change the layout of the BECFigure by using the [`change_layout`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.change_layout) method, specifying the number of rows and/or columns.
+
+```python
+# Change the layout of the BECFigure to have 4 columns -> 4x1 matrix layout
+fig.change_layout(max_columns=4) 
+
+# Change the layout of the BECFigure to have 2 rows -> 2x2 matrix layout
+fig.change_layout(max_rows=2) 
+```
+
+## Example 3 - Accessing Subplots in BECFigure
+
+The subplots in BECFigure can be accessed in a similar way to Matplotlib figures using the [`axes`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.axes) property. Each subplot can be accessed by its index coordinates within the layout, specified by the row and column index (starting at 0). In following example, we will access the subplots and modify their titles. The layout is a 2x2 matrix, so the subplots are indexed as follows:
+
+```python
+# Access the first subplot in the first row and first column (0, 0)
+subplot1 = fig.axes(0, 0)
+
+# Access the second subplot in the first row and second column (0, 1)
+subplot2 = fig.axes(0, 1)
+
+# Access the first subplot in the second row and first column (1, 0)
+subplot3 = fig.axes(1, 0)
+
+# Example: Set title for the first subplot
+subplot1.set_title("Waveform 1")
+
+# Example: Set title for the second subplot
+subplot2.set_title("Waveform 2")
+
+# Example: Set title for the third subplot
+subplot3.set_title("Motor Map")
+```
+
+In this example, we accessed three different subplots based on their row and column positions and modified their titles.
+
+## Example 4 - Removing Subplots from BECFigure
+
+You may want to remove certain subplots from the `BECFigure`. This can be done using the [`remove`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.remove) method, which takes the row and column index of the subplot you want to remove. The [`remove`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst#bec_widgets.cli.client.BECFigure.remove) method could be also called on the subplot itself.
+
+```python
+
+# Remove the subplot in the second row and second column (1, 1)
+fig.remove(1, 1)
+
+# Remove the subplot in the first row and first column (0, 0)
+fig.remove(0, 0)
+
+# Remove previously accessed subplot plt2 from Example 1
+plt2.remove()
+```
+
+````
+
+````{tab} API
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECFigure.rst
+```
+````

docs/user/widgets/bec_status_box/bec_status_box.md

@@ -0,0 +1,38 @@
+(user.widgets.bec_status_box)=
+# BEC Status Box
+
+````{tab} Overview
+
+The [`BEC Status Box`](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) widget is designed to monitor the status and health of all running BEC processes. This widget provides a real-time overview of the BEC core services, including DeviceServer, ScanServer, SciHub, ScanBundler, and FileWriter. The top-level display indicates the overall state of the BEC services, while the collapsed view allows users to delve into the status of each individual process. By double-clicking on a specific process, users can access a detailed popup window with live updates of the metrics for that process.
+
+## Key Features:
+- **Comprehensive Service Monitoring**: Track the state of individual BEC services, including real-time updates on their health and status.
+- **Automatic Service Tracking**: Automatically detects and monitors additional clients connecting to the BEC services.
+- **Detailed Metrics**: Provides live updates of the metrics for each process, accessible through an interactive popup window.
+
+![BECStatus](./bec_status_box.gif)
+````
+
+````{tab} Examples
+
+The `BECStatusBox` widget can be integrated within a [`BECDockArea`](user.widgets.bec_dock_area) or used as an individual component in your application through `QtDesigner`. Below are examples demonstrating how to create and use the `BECStatusBox` widget.
+
+## Example 1 - Adding BEC Status Box to BECDockArea
+
+In this example, we demonstrate how to add a `BECStatusBox` widget to a `BECDockArea`, allowing users to monitor the status of BEC processes directly from the GUI.
+
+```python
+# Add a new dock with a BECStatusBox widget
+bec_status_box = gui.add_dock().add_widget("BECStatusBox")
+```
+
+```{hint}
+Once the `BECStatusBox` is added, users can interact with it to view the status of individual processes. By expanding the view, you can see the status of each BEC service in detail.
+```
+````
+
+````{tab} API
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox.rst
+```
+````

docs/user/widgets/buttons/buttons.md

@@ -0,0 +1,50 @@
+(user.widgets.buttons)=
+
+# Service Buttons
+
+````{tab} Overview
+
+This section consolidates various custom buttons used within the BEC GUIs, providing essential controls for managing operations and processes. These buttons are designed for easy integration into different layouts within the BEC environment, allowing users to embed functional controls into their applications seamlessly.
+
+## Stop Button
+
+The `Stop Button` is a specialized control that provides an immediate interface to halt ongoing operations in the BEC Client. It is essential for scenarios where operations need to be terminated quickly, such as in the case of an error or when an operation needs to be interrupted by the user.
+
+**Key Features:**
+- **Immediate Termination**: Instantly halts the execution of the current script or process.
+- **Queue Management**: Clears any pending operations in the scan queue, ensuring the system is reset and ready for new tasks.
+
+````
+
+````{tab} Examples
+
+Integrating the `StopButton` into a BEC GUI layout is straightforward. The following example demonstrates how to embed a `StopButton` within a custom GUI layout using `QtWidgets`.
+
+## Example 1 - Embedding a Stop Button in a Custom GUI Layout
+
+This example shows how to create a simple GUI layout with a `StopButton` integrated, allowing the user to halt processes directly from the interface.
+
+```python
+from qtpy.QtWidgets import QWidget, QVBoxLayout
+from bec_widgets.widgets.buttons import StopButton
+
+class MyGui(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
+
+        # Create and add the StopButton to the layout
+        self.stop_button = StopButton()
+        self.layout().addWidget(self.stop_button)
+
+# Example of how this custom GUI might be used:
+my_gui = MyGui()
+my_gui.show()
+```
+````
+
+````{tab} API
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.StopButton.rst
+```
+````

docs/user/widgets/device_browser/device_browser.md

@@ -0,0 +1,36 @@
+(user.widgets.device_browser)=
+
+# Device Browser
+
+````{tab} Overview
+
+The `Device Browser` widget provides a user-friendly interface for browsing through all available devices in the current BEC session. As it supports drag functionality, users can easily drag and drop device into other widgets or applications. 
+
+```{note}
+The `Device Browser` widget is currently under development. Other widgets may not support drag and drop functionality yet.
+```
+
+## Key Features:
+- **Device Search**: Allows users to search for devices using regular expressions.
+- **Drag and Drop**: Supports drag and drop functionality for easy transfer of devices to other widgets or applications.
+
+```{figure} ./device_browser.png
+```
+````
+
+````{tab} Examples
+
+In this example, we demonstrate how to add a `DeviceBrowser` widget to a `BECDockArea` to visualize the progress of a task.
+
+```python
+# Add a new dock with a DeviceBrowser widget
+browser = gui.add_dock().add_widget("DeviceBrowser")
+```
+
+````
+
+````{tab} API
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DeviceBrowser.rst
+```
+````

docs/user/widgets/device_input/device_input.md

@@ -0,0 +1,100 @@
+(user.widgets.device_input)=
+
+# Device Input Widgets
+
+````{tab} Overview
+
+The `Device Input Widgets` consist of two primary widgets: `DeviceLineEdit` and `DeviceComboBox`. Both widgets are designed to facilitate the selection of devices within the BEC environment, allowing users to filter, search, and select devices dynamically. These widgets are highly customizable and can be integrated into a GUI either through direct code instantiation or by using `QtDesigner`.
+
+## DeviceLineEdit
+The `DeviceLineEdit` widget provides a line edit interface with autocomplete functionality for device names, making it easier for users to quickly search and select devices.
+
+## DeviceComboBox
+The `DeviceComboBox` widget offers a dropdown interface for device selection, providing a more visual way to browse through available devices.
+
+## Key Features:
+- **Device Filtering**: Both widgets allow users to filter devices by their class names, ensuring that only relevant devices are shown.
+- **Default Device Setting**: Users can set a default device to be pre-selected when the widget is initialized.
+- **Real-Time Autocomplete (LineEdit)**: The `DeviceLineEdit` widget supports real-time autocomplete, helping users find devices faster.
+- **Dropdown Selection (ComboBox)**: The `DeviceComboBox` widget displays devices in a dropdown list, making selection straightforward.
+- **QtDesigner Integration**: Both widgets can be added as custom widgets in `QtDesigner` or instantiated directly in code.
+
+````
+
+````{tab} Examples
+
+Both `DeviceLineEdit` and `DeviceComboBox` can be integrated within a GUI application through direct code instantiation or by using `QtDesigner`. Below are examples demonstrating how to create and use these widgets.
+
+
+## Example 1 - Creating a DeviceLineEdit in Code
+
+In this example, we demonstrate how to create a `DeviceLineEdit` widget in code and customize its behavior.
+
+```python
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+from bec_widgets.widgets.device_line_edit import DeviceLineEdit
+
+class MyGui(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
+
+        # Create and add the DeviceLineEdit to the layout
+        self.device_line_edit = DeviceLineEdit(device_filter="Motor")
+        self.layout().addWidget(self.device_line_edit)
+
+# Example of how this custom GUI might be used:
+app = QApplication([])
+my_gui = MyGui()
+my_gui.show()
+app.exec_()
+```
+
+## Example 2 - Creating a DeviceComboBox in Code
+
+Similarly, here is an example of creating a `DeviceComboBox` widget in code and customizing its behavior.
+
+```python
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+from bec_widgets.widgets.device_combo_box import DeviceComboBox
+
+class MyGui(QWidget):
+    def __init__(self):
+        super().__init__()
+        self.setLayout(QVBoxLayout(self))  # Initialize the layout for the widget
+
+        # Create and add the DeviceComboBox to the layout
+        self.device_combo_box = DeviceComboBox(device_filter="Motor")
+        self.layout().addWidget(self.device_combo_box)
+
+# Example of how this custom GUI might be used:
+app = QApplication([])
+my_gui = MyGui()
+my_gui.show()
+app.exec_()
+```
+
+## Example 3 - Setting Default Device
+
+Both `DeviceLineEdit` and `DeviceComboBox` allow you to set a default device that will be selected when the widget is initialized.
+
+```python
+# Set default device for DeviceLineEdit
+self.device_line_edit.set_default_device("motor1")
+
+# Set default device for DeviceComboBox
+self.device_combo_box.set_default_device("motor2")
+```
+````
+
+````{tab} API - ComboBox
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DeviceComboBox.rst
+```
+````
+
+````{tab} API - LineEdit
+```{eval-rst}
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.DeviceLineEdit.rst
+```
+````

docs/user/widgets/dock_area/bec_dock_area.md

@@ -0,0 +1,107 @@
+(user.widgets.bec_dock_area)=
+
+# BECDockArea
+
+```{tab} Overview
+
+[`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) is a powerful and flexible container designed to host various widgets and docks within a grid layout. It provides an environment for organizing and managing complex user interfaces, making it ideal for applications that require multiple tools and data visualizations to be displayed simultaneously. BECDockArea is particularly useful for embedding not only visualization tools but also other interactive components, allowing users to tailor their workspace to their specific needs.
+
+- **Flexible Dock Management**: Easily add, remove, and rearrange docks within `BECDockArea`, providing a customized layout for different tasks.
+- **State Persistence**: Save and restore the state of the dock area, enabling consistent user experiences across sessions.
+- **Dock Customization**: Add docks with customizable positions, names, and behaviors, such as floating or closable docks.
+- **Integration with Widgets**: Integrate various widgets like [`WaveformWidget`](user.widgets.waveform_widget), [`ImageWidget`](user.widgets.image_widget), and [`MotorMapWidget`](user.widgets.motor_map) into `BECDockArea`, either as standalone tools or as part of a more complex interface.
+```
+
+![BECDockArea.png](BECDockArea.png)
+
+````{tab} Examples - CLI
+In the following examples, we will use `BECIPythonClient` as the main object to interact with the `BECDockArea`. These tutorials focus on how to work with the `BECDockArea` framework, such as adding and removing docks, saving and restoring layouts, and managing the docked widgets. By default the `BECDockArea` is refered as `gui` in `BECIPythonClient`. For more detailed examples of each individual component, please refer to the example sections of each individual [`widget`](user.widgets).
+
+## Example 1 - Adding Docks to BECDockArea
+
+In this example, we will demonstrate how to add different docks to a single `BECDockArea` widget. New docks are always added to the bottom of the dock area by default; however, you can specify the position of the dock by using the `position` and `relative_to` arguments.
+
+```python
+# Add a new dock with a WaveformWidget to the BECDockArea
+dock1 = gui.add_dock(name="Waveform Dock", widget="BECWaveformWidget")
+
+# Add a second dock with a MotorMapWidget to the BECDockArea to the right of the first dock
+dock2 = gui.add_dock(name="Motor Map Dock", widget="BECMotorMapWidget",relative_to="Waveform Dock", position="right")
+
+# Add a third dock with an ImageWidget to the BECDockArea, placing it on bottom of the dock area
+dock3 = gui.add_dock(name="Image Dock", widget="BECImageWidget")
+```
+
+```{hint}
+You can move docks around by dragging them with the mouse using the dock's title bar. The dock will snap to the grid layout of the dock area.
+```
+
+## Example 2 - Access of Docks in BECDockArea
+
+Docks can be accessed by their name or by the dock object. The dock object can be used to modify the dock properties or to add widgets to the dock.
+
+```python
+# All docks can be accessed by their name from the panels dictionary
+gui.panels
+
+# Output
+{'Waveform Dock': <BECDock object at 0x168b983d0>,
+ 'Motor Map Dock': <BECDock object at 0x13a969250>,
+ 'Image Dock': <BECDock object at 0x13f267950>}
+ 
+# Access the dock by its name
+dock1 = gui.panels["Waveform Dock"]
+
+# Access the widget object of the dock
+waveform_widget = dock1.widget_list[0]
+```
+
+## Example 3 - Detaching and Attaching Docks in BECDockArea
+
+Docks in `BECDockArea` can be detached (floated) or reattached to the main dock area. This is useful when you want to temporarily undock a widget for better visibility or organization. 
+
+```python
+# Detach the dock named "Waveform Dock"
+gui.detach_dock(dock_name="Waveform Dock")
+
+# Docks can be also detached by the dock object
+dock2.detach()
+dock3.detach()
+
+# Docks can be individually reattached to the main dock area
+dock2.attach()
+
+# Reattach all floating docks to the main dock area
+gui.attach_all()
+```
+
+```{note}
+Floating docks are always returned to the original dock area if they are closed manually. Docks can also be detached by double-clicking on the dock title.
+```
+
+## Example 4 - Removing Docks from BECDockArea
+
+Docks can be removed from the dock area by their name or by the dock object. The dock object can be used to remove the dock from the dock area.
+
+```python
+# Removing docks by their name
+gui.remove_dock(dock_name="Waveform Dock")
+
+# Removing docks by the dock object
+dock2.remove()
+
+# Removing all docks from the dock area
+gui.clear_all()
+```
+
+```{warning}
+When removing a dock, all widgets within the dock will be removed as well. This action cannot be undone, and all references to the dock and its widgets will be lost.
+```
+````
+
+````{tab} API
+```{eval-rst} 
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECDockArea.rst
+```
+````
+

docs/user/widgets/image/image_widget.md

@@ -0,0 +1,84 @@
+(user.widgets.image_widget)=
+
+# Image Widget
+
+````{tab} Overview
+
+The Image Widget is a versatile tool designed for visualizing 2D image data, such as camera images, in real-time. Directly integrated with the `BEC` framework, it can display live data streams from connected cameras or other image sources within the current `BEC` session. The widget provides advanced customization options for color maps and scale bars, allowing users to tailor the visualization to their specific needs.
+
+## Key Features:
+- **Flexible Integration**: The widget can be integrated into both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`.
+- **Live Data Visualization**: Real-time plotting of 2D image data from cameras or other image sources, provided that a data stream is available in the BEC session.
+- **Customizable Color Maps and Scale Bars**: Users can customize the appearance of images with various color maps and adjust scale bars to better interpret the visualized data.
+- **Real-time Image Processing**: Apply real-time image processing techniques directly within the widget to enhance the quality or analyze specific aspects of the images such as rotation, log scaling, and FFT.
+- **Data Export**: Export visualized image data to various formats such as PNG, TIFF, or H5 for further analysis or reporting.
+- **Interactive Controls**: Offers interactive controls for zooming, panning, and adjusting the visual properties of the images on the fly.
+
+![Image 2D](./image_plot.gif)
+````
+
+````{tab} Examples - CLI
+
+`ImageWidget` can be embedded in both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases.
+
+## Example 1 - Adding Image Widget to BECFigure
+
+In this example, we demonstrate how to add an `ImageWidget` to a [`BECFigure`](user.widgets.bec_figure) to visualize live data from a connected camera.
+
+```python
+# Add a new dock with BECFigure widget
+fig = gui.add_dock().add_widget('BECFigure')
+
+# Add an ImageWidget to the BECFigure
+img_widget = fig.image(source='eiger')
+img_widget.set_title("Camera Image Eiger")
+```
+
+## Example 2 - Adding Image Widget as a Dock in BECDockArea
+
+Adding `ImageWidget` into a [`BECDockArea`](user.widgets.bec_dock_area) is similar to adding any other widget. The widget has the same API as the one in [`BECFigure`](user.widgets.bec_figure); however, as an independent widget outside [`BECFigure`](user.widgets.bec_figure), it has its own toolbar, allowing users to configure the widget without needing CLI commands.
+
+```python
+# Add an ImageWidget to the BECDockArea
+img_widget = gui.add_dock().add_widget('BECImageWidget')
+
+# Visualize live data from a camera with range from 0 to 100
+img_widget.image(source='eiger')
+img_widget.set_vrange(vmin=0, vmax=100)
+```
+
+## Example 3 - Customizing Image Display
+
+This example demonstrates how to customize the color map and scale bar for an image being visualized in an `ImageWidget`.
+
+```python
+# Set the color map and adjust the scale bar range
+img_widget.set_colormap("viridis")
+img_widget.set_vrange(vmin=10, vmax=200)
+```
+
+## Example 4 - Real-time Image Processing
+
+The `ImageWidget` provides real-time image processing capabilities, such as rotating, scaling, and applying FFT to the displayed images. The following example demonstrates how to rotate an image by 90 degrees, transpose it, and apply FFT.
+
+```python
+# Rotate the image by 90 degrees
+img_widget.set_rotation(deg_90=1)
+
+# Transpose the image
+img_widget.set_transpose(enable=True)
+
+# Apply FFT to the image
+img_widget.set_fft(enable=True)
+
+# Set the logarithmic scale for the image display
+img_widget.set_log(enable=True)
+```
+
+````
+
+````{tab} API
+```{eval-rst}  
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECImageWidget.rst
+```
+````

docs/user/widgets/motor_map/motor_map.md

@@ -0,0 +1,80 @@
+(user.widgets.motor_map)=
+
+# Motor Map Widget
+
+````{tab} Overview
+
+The Motor Map Widget is a specialized tool for tracking and visualizing the positions of motors in real-time. This widget is crucial for applications requiring precise alignment and movement tracking during scans. It provides an intuitive way to monitor motor trajectories, ensuring accurate positioning throughout the scanning process.
+
+## Key Features:
+- **Flexible Integration**: The widget can be integrated into both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`.
+- **Real-time Motor Position Visualization**: Tracks motor positions in real-time and visually represents motor trajectories.
+- **Customizable Visual Elements**: The appearance of all widget components is fully customizable, including scatter size and background values.
+- **Interactive Controls**: Interactive controls for zooming, panning, and adjusting the visual properties of motor trajectories on the fly.
+
+![MotorMap](./motor.gif)
+````
+
+````{tab} Examples CLI
+`MotorMapWidget` can be embedded in both [`BECFigure`](user.widgets.bec_figure) and [`BECDockArea`](user.widgets.bec_dock_area), or used as an individual component in your application through `BECDesigner`. However, the command-line API is the same for all cases.
+
+## Example 1 - Adding Motor Map Widget to BECFigure
+
+In this example, we will demonstrate how to add two different `MotorMapWidgets` into a single [`BECFigure`](user.widgets.bec_figure) widget.
+
+```python
+# Add new dock with BECFigure widget
+fig = gui.add_dock().add_widget('BECFigure')
+
+# Add two WaveformWidgets to the BECFigure
+mm1 = fig.motor_map(motor_x='samx', motor_y='samy')
+mm2 = fig.motor_map(motor_x='aptrx', motor_y='aptry',new=True)
+```
+
+## Example 2 - Adding Motor Map Widget as a Dock in BECDockArea
+
+Adding `MotorMapWidget` into a [`BECDockArea`](user.widgets.bec_dock_area) is similar to adding any other widget. The widget has the same API as the one in BECFigure; however, as an independent widget outside BECFigure, it has its own toolbar, allowing users to configure the widget without needing CLI commands.
+
+```python
+# Add new MotorMaps to the BECDockArea
+mm1 = gui.add_dock().add_widget('BECMotorMapWidget')
+mm2 = gui.add_dock().add_widget('BECMotorMapWidget')
+
+# Add signals to the MotorMaps
+mm1.change_motors(motor_x='samx', motor_y='samy')
+mm2.change_motors(motor_x='aptrx', motor_y='aptry')
+```
+
+## Example 3 - Customizing Motor Map Display
+
+The `MotorMapWidget` allows customization of its visual elements to better suit the needs of your application. Below is an example of how to adjust the scatter size, set background values, and limit the number of points displayed from the position buffer.
+
+```python
+# Set scatter size
+mm1.set_scatter_size(scatter_size=5)
+
+# Set background value
+mm1.set_background_value(background_value=0)
+
+# Limit the number of points displayed and saved in the position buffer
+mm1.set_max_points(max_points=500)
+```
+
+## Example 4 - Changing Motors and Resetting History
+
+You can dynamically change the motors being tracked and reset the history of the motor trajectories during the session.
+
+```python
+# Reset the history of motor movements
+mm1.reset_history()
+
+# Change the motors being tracked
+mm1.change_motors(motor_x='aptrx', motor_y='aptry')
+```
+````
+
+````{tab} API
+```{eval-rst}  
+.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECMotorMap.rst
+```
+````