string
The ID of a div element in which the dashboard will be initialized and rendered.
""
(empty)Example
<div id="container"></div>
<script>
// Embed Dashboard
var dashboard = BoldBI.create({
embedContainerId: "container",
});
dashboard.loadPinboard();
</script>
object
Specifies the type of Bold BI application, either Cloud or Enterprise edition.
BoldBI.Environment.Cloud
BoldBI.Environment.Enterprise
BoldBI.Environment.Enterprise
Example
var dashboard = BoldBI.create({
environment: BoldBI.Environment.Enterprise,
});
dashboard.loadPinboard();
number
This property allows you to set the expiration time for the access token, in seconds. You can customize the duration based on your application’s needs. The maximum allowed value is 604800 seconds (7 days). The minimum recommended value depends on your security and session requirements.
86400
(24 hours)Example
var dashboard = BoldBI.create({
expirationTime:100000,
});
dashboard.loadPinboard();
string
Defines the height of the embedding module in percentages or pixels.
Example
var dashboard = BoldBI.create({
height:"800px", //The dashboard is now rendered with a height of 800px
});
dashboard.loadPinboard();
object
Defines the dashboard rendering mode.
BoldBI.Mode.View
BoldBI.Mode.Design
BoldBI.Mode.Connection
BoldBI.Mode.DataSource
BoldBI.Mode.View
Example
var dashboard = BoldBI.create({
mode: BoldBI.Mode.View,
});
dashboard.loadPinboard();
string
The pinboard that needs to be embedded in a page from your Bold BI application needs to be named.
""
(empty)Example
var pinboard = BoldBI.create({
pinboardName: "Pinboard Name"
});
pinboard.loadPinboard();
string
The URL of the Bold BI application.
""
(empty)Example
var dashboard = BoldBI.create({
serverUrl: "https://mydashboard.com/bi/site/site1",
});
dashboard.loadPinboard();
string
Defines the width of the embedding module in percentages or pixels.
Example
var dashboard = BoldBI.create({
width:"1200px", //The dashboard is now rendered with a width of 1200px.
});
dashboard.loadPinboard();
string
Any application that embeds a Bold BI dashboard and widget needs to authenticate with the Bold BI server. This authentication flow requires sending confidential information such as user email, group details, and embed signature to the Bold BI server. Therefore, you must implement this authentication flow in your server application and provide the URL for connecting to your server in the Bold BI embed instance. Refer to the authorization server documentation for details.
""
(empty)Example
var dashboard = BoldBI.create({
authorizationServer: {
url:"https://serversample.com/embed-details/get",
}
});
dashboard.loadDashboard();
object
Transmits custom data or header values to the embedding application’s Authorization Server. As a result, you may find this value in the headers of the Authorization Server API.
{}
(empty object)Example
var dashboard = BoldBI.create({
authorizationServer:{
headers: {
"Cookie": "Set-Cookie: sessionId=38afes7a8",
}
}
});
dashboard.loadDashboard();
boolean
Specifies whether to show or hide the error messages inside the dashboard container. The onError
event is a callback function used to catch and handle errors that occur during the dashboard embedding process.
false
true
to suppress embedded error UI and handle errors via a custom callback.Example
var dashboard = BoldBI.create({
settings:{
hideErrorMessage:true
},
events:{
onError: function (args) {
var dashboardContainer = document.getElementById("dashboard");
dashboardContainer.innerHTML = "Provide valid Pinboard Name.";
},
}
});
dashboard.loadPinboard();
boolean
Specifies whether Bing Map-related files need to be downloaded.
false
true
if the dashboard contains a Bing Map widget.Example
var dashboard = BoldBI.create({
bingMapRequired: false,
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the CSV
export option.
true
Example
var dashboard = BoldBI.create({
settings:{
export: {
csv: true,
}
}
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the Excel
export option.
true
Example
var dashboard = BoldBI.create({
settings:{
export: {
excel: true,
}
}
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the Image
export option.
true
Example
var dashboard = BoldBI.create({
settings: {
export: {
image: true
}
}
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the PDF
export option.
true
Example
var dashboard = BoldBI.create({
settings:{
export: {
pdf: true,
}
}
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the header panel on the pinboard.
true
Example
var dashboard = BoldBI.create({
settings: {
pinboard: {
header: true
}
}
});
dashboard.loadPinboard();
boolean
Specifies whether to show or hide the Unpin option on the Pinboard.
true
Example
var dashboard = BoldBI.create({
settings: {
pinboard: {
unpinWidget: true
}
}
});
dashboard.loadPinboard();