a96e52de20
* Improve widgets library structure * add styling to widgets library images * black linting * update widgets library index generator * update border of docs image * shift grouping Minh suggestion * no ruff in this file * Update chart-from-raw-data.md * lint * add pro to index docs * add workflows to docs * dunno how to spell existent lol * navbar logo to go to root docs * push missing bg * backend for terminal pro repo - Andrew suggestion * update content slightly * no widgets-library content should be pushed, this is generated at runtime * add Rita's vidos + review everything
2.5 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Grouping Mechanism | 1 | Learn about the powerful grouping mechanism in OpenBB Terminal Pro. Understand how widgets can be grouped based on equity categories and tickers, and also how the watchlist widget's unique grouping property works. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
The grouping mechanism is extremely powerful as it allows widgets to be grouped together through one of their parameters based on the category they belong to.
For instance, for the equity category, widgets can be connected through their ticker / symbol. Examples are: AAPL to simbolize Apple, TSLA for Tesla and so on.
This is an example of 3 widgets that belong to the same group, note the dark yellow 1 on the top right.
In addition, when clicking on the grouping icon you can see that they are grouped around the MSFT ticker.
This means that if a user changes the ticker on any of these widgets, the remaining ones will get updated accordingly.
Also note that the grouping is visible on the sidebar, immediately under the dashboard naming.
A trick that you can use to group up widgets together faster is using the SHIFT while clicking on each widget, once creating a group in one of them - the grouping will replicate throughout selected widgets.
Watchlist and grouping
The watchlist widget has a special property in relation to grouping. Since this widget doesn't have a single symbol but many, users can select the row of their ticker of interest, and widgets that are grouped with the watchlist will get updated accordingly.
If a user selects a new ticker in another widget that is grouped with the watchlist, that ticker will be added to the watchlist and will become the one selected by default.