Create a widget
- Juan Tomás Alonso Nieto (Deactivated)
- Borja Moro Moreno
Adding widgets to an Activeboard
To create a widget from scratch:
Widget properties
When you click the title bar (or the ellipsis menu and select Properties), a panel opens on the right side with the following tabs:
Data
ID | This is a unique name for the widget used for internal calls, such as referring to data in the widget from another widget's script. It is auto-generated and cannot be modified. | |
Name | The name of the widget. This is the friendly name that appears in the widget title bar in the Activeboard. | |
|---|---|---|
Description | Enter a meaningful description of the widget. | |
Data source | This is the query that feeds data to the widget. Click the Edit button to open the Query editor, where you can edit and update the widget's query script. Learn how to build your widget's source queries in this article. | |
Custom date range | (Optional) Toggle on this option to set a date range to apply to the widget and its dependencies, overriding the date range set for the Activeboard. Widgets with a custom date range show the calendar icon in the top right corner. Learn more about setting time ranges here. | |
Data loading | You can select the data fetching method for your widget. When you select an option other than Inherited, the widget option will always take priority over the global Activeboard option.  | |
| Inherited (default) | This option aligns the data fetching method with that of the Activeboard. |
On demand | PERFORMANCE: OPTIMAL Having several widgets with this option has a positive impact on performance, as it ensures that resources are utilized exactly where and when you need them. When this option is enabled, the widget will retrieve data only when manually prompted. This means that the widget is empty after accessing the Activeboard and displays a message explaining why, along with a button to manually fetch data. Widgets with this option enabled will remain unaffected by the Active refresh and will work fine when scheduling Activeboard reports. However, it has implications when exporting the Activeboard to PDF.  | |
Lazy | PERFORMANCE: BALANCED Having several widgets with this option has minimal impact on performance, as resources are utilized only when needed and for limited data segments. When this option is enabled, the widget will retrieve data only when it enters the screen after scrolling. This means that the widget will not be loaded unless it is within the visible part of the landing screen or enters the screen after scrolling. | |
Eager | PERFORMANCE: POTENTIALLY REDUCED Having several widgets with this option might affect performance considerably, as it needs to allocate as many resources as needed to retrieve data instantly. When this option is enabled, the widget will retrieve data as soon as the Activeboard is accessed. | |
Visual
The settings available in the Visual tab will depend upon the type of graphic chosen for the widget. Learn more about the settings of the different types of widgets in this article.
Raw
Here you can access the raw configuration of each widget. You can edit this, and copy and paste it in the Raw field of another widget to clone the widget settings. This is especially useful when you wish to copy widgets across different Activeboards. If you perform any changes, click the Save changes button to apply them.