Members

datasourceId

string

Defines the ID of the dashboard to be embedded from your Bold BI application.

• Required: Yes
• Default: "" (empty)

Example

var dashboard = BoldBI.create({
     datasourceId: "5cb065f7-dabb-4b0c-9b45-c60a5730e963"                
});
dashboard.loadDatasource();

datasourceName

string

The name of the datasource, which needs to be embedded in a page from your Bold BI application, is required.

• Default: "" (empty)

Example

var dashboard = BoldBI.create({
     datasourceName: "Sample Datasource"
});
dashboard.loadDatasource();

embedContainerId

string

The ID of a div element in which the dashboard will be initialized and rendered.

• Required: Yes
• Default: "" (empty)

Example

<div id="container"></div> 
<script> 
     var dashboard = BoldBI.create({
          embedContainerId: "container",        
     });
     dashboard.loadDatasource();
</script>

environment

object

Specifies the type of Bold BI application, either Cloud or Enterprise edition.

• Possible Values:
  • BoldBI.Environment.Cloud
  • BoldBI.Environment.Enterprise
• Default: BoldBI.Environment.Enterprise

Example

var dashboard = BoldBI.create({
     environment: BoldBI.Environment.Enterprise,        
});
dashboard.loadDatasource();

expirationTime

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.

• Required: No
• Default: 86400 (24 hours)

Example

var dashboard = BoldBI.create({
     expirationTime:100000,          
});
dashboard.loadDatasource();

height

string

Defines the height of the embedding module in percentages or pixels.

• Optional: Yes
• Default: Inherits from the parent container

Example

var dashboard = BoldBI.create({
     height:"800px", //The dashboard is now rendered with a height of 800px
});
dashboard.loadDatasource();

mode

object

Defines the datasource rendering mode.

• Possible Values:
  • BoldBI.Mode.View
  • BoldBI.Mode.Design
  • BoldBI.Mode.Connection
  • BoldBI.Mode.DataSource
  • BoldBI.Mode.AIAssistant
• Default: BoldBI.Mode.View

Example

var dashboard = BoldBI.create({
     mode: BoldBI.Mode.DataSource,        
});
dashboard.loadDatasource();

serverUrl

string

The URL of the Bold BI application.

• Required: Yes
• Default: "" (empty)

Example

var dashboard = BoldBI.create({
     serverUrl: "https://mydashboard.com/bi/site/site1",
});
dashboard.loadDatasource();

token

string

Authenticates the dashboard without implementing the Authorization server endpoint. Required only if the Authorization url API is not configured. Refer to the token generation documentation for details.

• Default: "" (empty)

Example

var dashboard = BoldBI.create({
     token: "NjQ2ZDgwZjgtN2Q3MS00ZDQwLWFkNTItYTdkNDRhOGE2NmVi", // Use the generated API key
});
dashboard.loadDatasource();

To learn about the available limited supporting methods in embedding.

width

string

Defines the width of the embedding module in percentages or pixels.

• Optional: Yes
• Default: Inherits from the parent container

Example

var dashboard = BoldBI.create({
     width:"1200px", //The dashboard is now rendered with a width of 1200px.
});
dashboard.loadDatasource();

authorizationServer

url

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.

• Required: Yes
• Default: "" (empty)

Example

var dashboard = BoldBI.create({
     authorizationServer: {
          url:"https://serversample.com/embed-details/get",
     }
});
dashboard.loadDatasource();

headers

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.

• Optional: Yes
• Default: {} (empty object)
• Note: Please refer to the Knowledge Base article to know more.

Example

var dashboard = BoldBI.create({
     authorizationServer:{
          headers: {
               "Cookie": "Set-Cookie: sessionId=38afes7a8",
          }
     }
});
dashboard.loadDatasource();