Documentation
Demos
Support
Blog
Schedule Free Demo
Search results

Methods

create()

This method will initialize the Dashboard Viewer options and returns the object for rendering the dashboard.

Example 

var dashboard = BoldBI.create({
     serverUrl: "http://localhost:51777/bi/site/site1",
     dashboardId: "755e99c7-f858-4058-958b-67577b283309",
     embedContainerId: "dashboard-container",// This should be the container id where you want to embed the dashboard
     embedType: BoldBI.EmbedType.Component,
     environment: BoldBI.Environment.Enterprise,
     height: "800px",
     width: "1200px",
     authorizationServer: {
     url: "http://example.come/authorize/server"
     },
     expirationTime: "100000",     
});

loadDashboard()

This method will render the dashboard based on the dashboard options provided while calling the create method.

Example 

var dashboard = BoldBI.create(options);
dashboard.loadDashboard();

loadDashboardWidget()

This method will load the widget of current dashboard.

Example 

var dashboard = BoldBI.create(options);
dashboard.loadDashboardWidget("Sales by country");

loadDesigner()

This method will render the dashboard designer based on the dashboard options provided while calling the create method.

Example 

var dashboard = BoldBI.create(options);
dashboard.loadDesigner();

loadDatasource()

This method will render the data source based on the data source options provided while calling the create method.

Example 

var dashboard = BoldBI.create(options);
dashboard.loadDatasource();

loadPinboard()

This method will render the pinboard based on the provided pinboard name.

Example 

var dashboard = BoldBI.create(options);
dashboard.loadPinboard();

getInstance()

This method will return the object of the rendered dashboard using the container id assigned to the dashboard options.

Example 

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

destroy()

This method will destroy the dashboard based on the dashboard object provided while calling the create method.

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.destroy();

updateFilters()

This method will update the filter parameters of current dashboard. learn more details

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.updateFilters("Continent=Asia,Africa,Europe");

refreshDashboard()

This method will refresh the current dashboard.

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.refreshDashboard();

addWidgetToPinboard()

This method will add the widgets into the existing pinboard.

Example

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.addWidgetToPinboard(dashboardId, widgetId, widgetName);

updateDatasource()

This method will update the current data source page from the outside page.

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.updateDatasource();

resizeDashboard()

This method will resize the current dashboard.

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.resizeDashboard();

hidePopup()

This method will hide the current dashboard waiting pop-up.

Example 

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.hidePopup();
Previous
Next