Members

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> 
     // Embed Dashboard 
     var dashboard = BoldBI.create({
          embedContainerId: "container",        
     });
     dashboard.loadPinboard();
</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.loadPinboard();

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.loadPinboard();

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.loadPinboard();

mode

object

Defines the dashboard 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.View,        
});
dashboard.loadPinboard();

pinboardName

string

The pinboard that needs to be embedded in a page from your Bold BI application needs to be named.

  • Default: "" (empty)

Example

var pinboard = BoldBI.create({
     pinboardName: "Pinboard Name"                
});
pinboard.loadPinboard();

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.loadPinboard();

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.loadPinboard();

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 (If token or embedToken APIs are not used)
  • Default: "" (empty)

Example

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

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.loadDashboard();

settings

azureMapRequired

boolean

Specifies whether Azure Map-related files need to be downloaded.

  • Default: false
  • Note: Set to true if the Pinboard contains a Azure Map widget.

Example

var dashboard = BoldBI.create({
    settings: {
        azureMapRequired: false
    }
});
dashboard.loadPinboard();

hideErrorMessage

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.

  • Default: false
  • Use Case: Set to 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();

bingMapRequired

boolean

Specifies whether Bing Map-related files need to be downloaded.

  • Default: false
  • Note: Set to true if the dashboard contains a Bing Map widget.

Example

var dashboard = BoldBI.create({
     bingMapRequired: false,
});
dashboard.loadPinboard();

export

csv

boolean

Specifies whether to show or hide the CSV export option.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings:{
          export: {
               csv: true,
          }
     }
});
dashboard.loadPinboard();

excel

boolean

Specifies whether to show or hide the Excel export option.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings:{
          export: {
               excel: true,
          }
     }
});
dashboard.loadPinboard();

image

boolean

Specifies whether to show or hide the Image export option.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings: {
          export: {
               image: true
          }
     }
});
dashboard.loadPinboard();

pdf

boolean

Specifies whether to show or hide the PDF export option.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings:{
          export: {
               pdf: true,
          }
     }
});
dashboard.loadPinboard();

pinboard

Specifies whether to show or hide the header panel on the pinboard.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings: {
          pinboard: {
               header: true
          }
     }
});
dashboard.loadPinboard();

unpinWidget

boolean

Specifies whether to show or hide the Unpin option on the Pinboard.

  • Default: true

Example

var dashboard = BoldBI.create({
     settings: {
          pinboard: {
               unpinWidget: true
          }
     }
});
dashboard.loadPinboard();