string
Your Bold BI application URL needs to be assigned to this member.
Default value
Example
var dashboard = BoldBI.create({
serverUrl: "https://mydashboard.com/bi/site/site1",
});
dashboard.loadDashboard();
string
The Id of the dashboard, which needs to be embedded in a page from your Bold BI application.
Default value
Example
var dashboard = BoldBI.create({
dashboardId: "5cb065f7-dabb-4b0c-9b45-c60a5730e963"
});
dashboard.loadDashboard();
string
This will hold the dashboard path as category name followed by dashboard name.
Syntax
Default value
Example
var dashboard = BoldBI.create({
dashboardPath: "/Samples/Sample Dashboard"
});
dashboard.loadDashboard();
string
The Id of a div element in which the dashboard will be initialized and rendered.
Default value
Example
<div id="container"></div>
<script>
// Embed Dashboard
var dashboard = BoldBI.create({
embedContainerId: "container",
});
dashboard.loadDashboard();
</script>
object
Providing the two types of embedding. One is component
and the other is iframe
. In component type, you will use the embedding SDK for rendering the dashboard. In iframe type, you will load the dashboard URL in the iframe and the dashboard will be rendered.
Possible values
Default value
Example
var dashboard = BoldBI.create({
embedType: BoldBI.EmbedType.Component,
});
dashboard.loadDashboard();
object
Environment refers to the Bold BI application type. Bold BI offers Cloud and Enterprise editions of the dashboard application. You need to assign your application type in this member.
Possible values
Default value
Example
var dashboard = BoldBI.create({
environment: BoldBI.Environment.Enterprise,
});
dashboard.loadDashboard();
object
Mode refers to the dashboard rendering mode such as view
, design
, connection
, and datasource
. The default value was view, which is used to render the dashboard for viewing.
Possible values
Default value
Example
var dashboard = BoldBI.create({
mode: BoldBI.Mode.View,
});
dashboard.loadDashboard();
You can set a culture for the current user using the API in embedding.
For example, if you configure the widget to showcase the currency value, it will be displayed with Auto (English(en-US))
format by default as shown in the following image.
And the values in the widget will be rendered as follows,
You can embed the Bold BI dashboards in your web page by following the steps in this link.
After embedding the dashboard, you can change the culture settings on the embedding dashboard instance to get the desired currency format by passing it using the following highlighted API.
After this, the values in the widget will be displayed as follows within your application.
boolean
Enable or disable the header panel in the Dashboard Viewer.
Default value
Example
var dashboard = BoldBI.create({
dashboardSettings: {
showHeader: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Export
icon in dashboard banner.
Default value
Example
var dashboard = BoldBI.create({
dashboardSettings: {
showExport: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Refresh
icon in dashboard banner.
Default value
Example
var dashboard = BoldBI.create({
dashboardSettings: {
showRefresh: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Option
icon in dashboard banner.
Default value
Example
var dashboard = BoldBI.create({
dashboardSettings: {
showMoreOption: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Export
icon in widget banner.
Default value
Example
var dashboard = BoldBI.create({
widgetSettings: {
showExport: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Option
icon in widget banner.
Default value
Example
var dashboard = BoldBI.create({
widgetSettings: {
showMoreOption: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Clear Filter
icon in widget banner.
Default value
Example
var dashboard = BoldBI.create({
widgetSettings: {
showFilter: true,
}
});
dashboard.loadDashboard();
string
Specifies the filter that has to be applied to the dashboard.
Default value
Example
var dashboard = BoldBI.create({
filterParameters: "Continent=Asia,Africa,Europe"
});
dashboard.loadDashboard();
Dashboard server provides dynamic connection string feature to fetch the data for rendering the dashboard.
boolean
Specifies whether to enable or disable the dynamic connection string feature.
Default value
Example
var dashboard = BoldBI.create({
dynamicConnection: {
isEnabled: false,
}
});
dashboard.loadDashboard();
boolean
This property, holds the values that will be passed to the API in dynamic connection string feature so that the user can use this identity in their API for validating and providing the required connection string.
Default value
Example
var dashboard = BoldBI.create({
dynamicConnection: {
isEnabled: true,
identity: "",
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Excel
export option.
Default value
Example
var dashboard = BoldBI.create({
exportSettings: {
showExcel: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the PDF
export option.
Default value
Example
var dashboard = BoldBI.create({
exportSettings: {
showPDF: true,
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the Image
export option.
Default value
Example
var dashboard = BoldBI.create({
exportSettings: {
showImage: true,
}
});
dashboard.loadDashboard();
string
Set the height of the Dashboard Viewer in % or in pixels.
Default value
Example
var dashboard = BoldBI.create({
height:"768px",
});
dashboard.loadDashboard();
string
Set the width of the Dashboard Viewer in % or in pixels.
Default value
Example
var dashboard = BoldBI.create({
width:"1024px",
});
dashboard.loadDashboard();
object
Bold BI provides dark theming support for Dashboard Viewer. So, user can choose the desired theming for their choice.
Default value
Possible values
Example
var dashboard = BoldBI.create({
theme:BoldBI.Theme.Dark,
});
dashboard.loadDashboard();
string
Any application that embeds Bold BI dashboard and widget needs to be authenticated with Bold BI server and this authentication flow requires sending the confidential information like user email, group details, and embed signature to the Bold BI server. So, you need to implement this authentication flow in your server application and provide the URL for connecting to your server in Bold BI embed instance.
So this property holds the URL of the embedding application that will implement authorization. Learn more about the authorization server here.
Default value
Example
var dashboard = BoldBI.create({
authorizationServer: {
url:"https://serversample.com/embed-details/get",
}
});
dashboard.loadDashboard();
object
This property, holds the headers needs to be sent in your application while connecting to the authorization server.
Default value
Example
var dashboard = BoldBI.create({
authorizationServer:{
headers: {
"Authorization": "Bearer eDIHDIJAdjakdnajdbaidhoasjasajnsJNININfsbfskdnskdnskdn"
}
}
});
dashboard.loadDashboard();
number
Specifies the access token expiration time of the dashboard in seconds.
Default value
Example
var dashboard = BoldBI.create({
expirationTime:100000,
});
dashboard.loadDashboard();
The auto refresh allows you to configure the scheduled refreshing process of the dashboard. It is used to refresh the data based on the specified time.
boolean
Specifies whether to enable or disable the autoRefreshSettings
option.
Default value
Example
var dashboard = BoldBI.create({
autoRefreshSettings:{
enabled: false,
}
});
dashboard.loadDashboard();
number
Specifies the hourly time interval for auto refreshing of data.
Default value
Example
var dashboard = BoldBI.create({
autoRefreshSettings:{
enabled: true,
hourlySchedule: {
hours: 1,
}
}
});
dashboard.loadDashboard();
number
Specifies the minute by minute time interval for auto refreshing of data.
Default value
Example
var dashboard = BoldBI.create({
autoRefreshSettings:{
enabled: true,
hourlySchedule: {
minutes: 10,
}
}
});
dashboard.loadDashboard();
number
Specifies the second by second time interval for auto refreshing of data.
Default value
Example
var dashboard = BoldBI.create({
autoRefreshSettings:{
enabled: true,
hourlySchedule: {
seconds: 30,
}
}
});
dashboard.loadDashboard();