bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-13 19:21:50 +02:00
Code Activity

docs(bar): docs updated

Browse Source
This commit is contained in:
wyzula_j
2024-06-06 11:45:25 +02:00
parent e883dbad81
commit 4be0d14b74
1 changed files with 37 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
docs/user/widgets/spiral_progress_bar.md
View File

@ -1,6 +1,12 @@
(user.widgets.spiral_progress_bar)=
# [Spiral Progress Bar](/api_reference/_autosummary/bec_widgets.cli.client.SpiralProgressBar)
**Purpose** The Spiral Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to the progress of a device readback or scan.
**Purpose:**
The Spiral Progress Bar widget is a circular progress bar that can be used to visualize the progress of a task. The
widget is designed to be used in applications where the progress of a task is represented as a percentage. The Spiral
Progress Bar widget is a part of the BEC Widgets library and can be controlled directly using its API, or hooked up to
the progress of a device readback or scan.
**Key Features:**
@ -11,11 +17,38 @@
**Example of Use:**
![SpiralProgressBar](./progress_bar.gif)
**Code example**
The following code snipped demonstrates how to create a 2D scatter plot using BEC Widgets within BEC.
**Code example:**
The following code snipped demonstrates how to create a `SpiralProgressBar` using BEC Widgets within BEC.
```python
# adds a new dock with a spiral progress bar
progress = gui.add_dock().add_widget("SpiralProgressBar")
# customize the size of the ring
progress.set_line_width(20)
```
```
By default, the Spiral Progress Bar widget will display a single ring. To add more rings, use the add_ring method:
```python
# adds a new dock with a spiral progress bar
progress.add_ring()
```
To access rings and specify their properties, you can use `progress.rings` with an index specifying the ring index (
starting from 0):
```python
progress.rings[0].set_line_width(20) # set the width of the first ring
progress.rings[1].set_line_width(10) # set the width of the second ring
```
By default, the `SpiralProgressBar` widget is set with `progress.enable_auto_update(True)`, which will automatically
update the bars in the widget. To manually set updates for each progress bar, use the set_update method. Note that
manually updating a ring will disable the automatic update for the whole widget:
```python
progress.rings[0].set_update("scan") # set the update of the first ring to be an overall scan progress
progress.rings[1].set_update("device",
"samx") # set the update of the second ring to be a device readback (in this case, samx)
```