diff --git a/docs/user/getting_started/BECDockArea.png b/docs/user/getting_started/BECDockArea.png new file mode 100644 index 00000000..245220ea Binary files /dev/null and b/docs/user/getting_started/BECDockArea.png differ diff --git a/docs/user/getting_started/quick_start.md b/docs/user/getting_started/quick_start.md index c48a1b75..1ed5fcb6 100644 --- a/docs/user/getting_started/quick_start.md +++ b/docs/user/getting_started/quick_start.md @@ -5,6 +5,10 @@ In order to use BEC Widgets as a plotting tool for BEC, it needs to be [installe ## BECDockArea The `bec.gui` object is your entry point to BEC Widgets. It is a [`BECDockArea`](/api_reference/_autosummary/bec_widgets.cli.client.BECDockArea) instance that can be composed of multiple [`BECDock`](/api_reference/_autosummary/bec_widgets.cli.client.BECDock)s that can be attached / detached to the main area. These docks allow users to freely arrange and customize the widgets they add to the gui, providing a flexible and customizable interface to visualize data. +**Schema of the BECDockArea** + +![BECDockArea.png](BECDockArea.png) + ## Widgets Widgets are the building blocks of the BEC Widgets framework. They are the visual components that allow users to interact with the data and control the behavior of the application. Each dock can contain multiple widgets, albeit we recommend for most use cases a single widget per dock. BEC Widgets provides a set of core widgets (cf. [widgets](#user.widgets)). More widgets can be added by the users, and we invite you to explore the [developer documentation](developer.widgets) to learn how to create custom widgets. For the introduction given here, we will focus on the `BECFigure` widget, as it is the most commonly used widget for visualizing data from BEC. The same access pattern can be used for all other widgets. diff --git a/docs/user/widgets/BECFigure.png b/docs/user/widgets/BECFigure.png new file mode 100644 index 00000000..ec6d7754 Binary files /dev/null and b/docs/user/widgets/BECFigure.png differ diff --git a/docs/user/widgets/bec_figure.md b/docs/user/widgets/bec_figure.md index 9c903dfa..3bf9a5c6 100644 --- a/docs/user/widgets/bec_figure.md +++ b/docs/user/widgets/bec_figure.md @@ -3,6 +3,10 @@ [`BECFigure`](/api_reference/_autosummary/bec_widgets.cli.client.BECFigure) is a widget that provides a graphical user interface for creating and managing plots. It is a versatile tool that allows users to create a wide range of plots, from simple 1D waveforms to complex 2D scatter plots. BECFigure is designed to be user-friendly and interactive, enabling users to customize plots and visualize data in real-time. In the following, we describe 4 different type of widgets thaat are available in BECFigure. +**Schema of the BECFigure** + +![BECFigure.png](BECFigure.png) + (user.widgets.waveform_1d)= ## [1D Waveform Widget](/api_reference/_autosummary/bec_widgets.cli.client.BECWaveform)