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
3.9 KiB
Vendored
title, sidebar_position, description, keywords
| title | sidebar_position | description | keywords | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Widgets | 0 | The page contains detailed information about the interactive elements and functionalities of OpenBB Terminal Pro widgets. From grouping mechanisms to settings, these widgets offer an interactive dashboard experience for users to track and analyze their investments and data. The widgets support both raw data and chart interpretations for data visualization. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
Upper Tab
The upper tab houses all the interactive elements and additional information related to the widget's content.
Left Side
Title
The title identifies the widget and is used when adding the same widget to another dashboard via advanced search.
Symbol
Some widgets are associated with a symbol. Changing this symbol updates the table content to reflect the new symbol.
Group
The group (if any) that the widget belongs to. If multiple widgets belong to the same group, updating the symbol in one will automatically update the symbol in the others.
Right Side
Staleness Indicator
This indicator shows the freshness of the data:
-
Green - updated within the last 30 seconds
-
Yellow - updated between 30 seconds and 5 minutes ago
-
Red - updated over 5 minutes ago
Chat with Widget
Our proprietary generative AI feature allows you to interact with the widget. Ask it to summarize its contents or explain how its data could impact your investment positions.
Grouping Mechanism
This feature allows you to group widgets together. When widgets are grouped, they share a color and number. You can see which dashboards have which groupings by looking at the text below the dashboard title in the sidebar.
Settings
- Settings - View the data source and select or hide columns.
- Share - Share this widget with your team.
- Duplicate - Create a copy of this widget on the same dashboard.
- Export - Export data in various formats, such as csv, xlsx, png, or jpeg.
- Maximize - View the widget in full-screen mode.
- Copy to - Copy the widget to a different dashboard.
Close
This option removes the widget from the dashboard.
Content
OpenBB widgets support two main types of content:
Raw Data
Displayed in a table format. This is powerful as it allows to leverage the charting from raw data capabilities of the application.
Charts
Visual representations of data, including line charts, bar charts, pie charts, and other custom charts. Some examples below,