How to Enable Filters Overview Options like "Save", "Save As" and "View Saved Filters" in Embedded Bold BI Dashboards?
When embedding Bold BI dashboards into your application, you may want to provide users with the ability to modify/save their filters in the filters overview and access saved filters directly from the embedded dashboard. This functionality is available in the Bold BI server and can also be enabled in embedded dashboards with the correct JavaScript API configurations.
Enabling Save Options in Embedded Dashboards
To enable the “Save As,” “Save,” and “View Saved Filters” options in the filters overview of your embedded dashboard, you need to adjust the JavaScript API settings. This is done within the BoldBI.create()
function of your embedded application. The following settings should be configured:
dashboardSettings.filterOverviewSettings.showSaveAsIcon
: Set this totrue
to show the “Save As” icon.dashboardSettings.filterOverviewSettings.showSaveIcon
: Set this totrue
to show the “Save” icon.dashboardSettings.filterOverviewSettings.showViewSavedFilterIcon
: Set this totrue
to show the “View Saved Filters” icon.
Here is an example of how to set these options in the BoldBI.create()
function:
BoldBI.create({
// ... other settings ...
dashboardSettings: {
filterOverviewSettings: {
showSaveAsIcon: true,
showSaveIcon: true,
showViewSavedFilterIcon: true
}
}
// ... other settings ...
});
Enabling Default Views
To save a default view, you must enable the default views settings within the Bold BI application. Once this feature is turned on, a toggle button will appear while saving the view, allowing users to save particular views as the default.
To enable default views:
- Navigate to the Default Views settings in the Bold BI application.
- Turn on the feature to allow users to set default views.
By following these steps, you will enhance the user experience by providing the flexibility to save and manage their filters directly within the embedded dashboard.
Additional References
For more detailed information and guidance, please refer to the following resources:
- Show Save As Icon Documentation
- Show Save Icon Documentation
- Show View Saved Filter Icon Documentation
- Default Views in embedded dashboard
By configuring these settings, you ensure that users have a consistent and powerful experience with your embedded Bold BI dashboards, mirroring the functionality they would expect from the Bold BI server.