Documentation
Demos
Support
Blog
Start Free Trial
Search results

Members

dashboardId

string

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

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

Example

var dashboard = BoldBI.create({
     dashboardId: "5cb065f7-dabb-4b0c-9b45-c60a5730e963"                
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");
</script>

embedToken

string

This property is used to pass the access token generated by the Embed Authorization Server, helping reduce redundant API calls and improve performance. Supported from version 12.1—ensure you’re using the compatible SDK and build. You can either provide the token directly or configure an authorization server. If the server is configured, setting the token manually is not required. A sample implementation is available to demonstrate how the API works.

  • Default: "" (empty)

Example

var dashboard = BoldBI.create({
    embedToken: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6ImRldm9wc0Bib2xkYmkuY29tIiwidXBuIjouYm9sZGJpZGVtby5jb20vYmkvc2l0ZS9zaXRlMSIsImF1ZCI6Imh0dHBzOi8vaG90Zml4LXdpbmRvd3MuYm9sZGJpZGVtby5jb20vYmkvc2l0ZS9zaXRlMSJ9.JzbqVr6Brv1mAEvnbHnE-FuShos"
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

To learn about the available limited supporting methods in embedding.

widgetList

Array

Specifies the value to set the list of specific widgets from a single dashboard, loaded with a single instance call.

  • Default: [] (empty)

Example

<div id="dashboard"></div>
<div id="widget1" style="height:500px;width:500px"></div> 
<div id="widget2" style="height:500px;width:500px"></div> 
<div id="widget3" style="height:500px;width:500px"></div>  
<script>  
var dashboard = BoldBI.create({
      dashboardId: "5cb065f7-dabb-4b0c-9b45-c60a5730e963",
      embedContainerId: "dashboard",
      widgetList: [{widgetName: "Medal details by Country", containerId: "widget1" },
                  {widgetName: "Total Medals by Country", containerId: "widget2" },
                  {widgetName: "Country", containerId: "widget3" }],
     });
dashboard.loadWidgets();
</script>

NOTE: We have enhanced the performance of loading multiple widgets in the javascript embedding. Please note that support will work and take effect if the embed SDK Wrapper and Bold BI Server are on the same version effectively from v8.1.41

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

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.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

excel

boolean

Specifies whether to show or hide the Excel export option.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        export: {
            excel: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

image

boolean

Specifies whether to show or hide the Image export option.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        export: {
            image: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

pdf

boolean

Specifies whether to show or hide the PDF export option.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        export: {
            pdf: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

widget

widget.export

boolean

Specifies whether to show or hide the Export icon in widget banner.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        widget: {
            export: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

filter

boolean

Specifies whether to show or hide the Clear Filter icon in widget banner.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        widget: {
            filter: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

maximize

boolean

Specifies whether to show or hide the Maximize icon in widget banner.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        widget: {
            maximize: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");

moreOption

boolean

Specifies whether to show or hide the Option icon in widget banner.

  • Default: true

Example

var dashboard = BoldBI.create({
    settings: {
        widget: {
            moreOption: true
        }
    }
});
dashboard.loadWidget("efbf2999-f7e7-4831-a492-53c4df394af0");
Previous
Next