Category / Section
How to hide the header section in the embedded dashboard?
Published:
In some cases, you may want to hide the header of an embedded dashboard for a cleaner look or to save space. This can be achieved using the API member dashboardSettings.showHeader
. This is a boolean property that can be set to false
to hide the header of the embedded dashboard.
Steps to Hide the Header of an Embedded Dashboard
- In the
BoldBI.create()
method of the embedded application, add the API memberdashboardSettings.showHeader
and set it tofalse
. This will hide the header of the dashboard. Here is a code snippet for reference:
var dashboard = BoldBI.create({
dashboardSettings: {
showHeader: false,
}
});
dashboard.loadDashboard();
The image below demonstrates the dashboard with the header hidden when setting the API dashboardSettings.showHeader
to false
.
- If you want to enable the header of the embedded dashboard back, simply set this API to
true
. Here is a code snippet for reference:
var dashboard = BoldBI.create({
dashboardSettings: {
showHeader: true,
}
});
dashboard.loadDashboard();