Documentation

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

getWidgetData()

This method will help you to get the detail of the widget in a clientFnc method with arguments.

Example

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.getWidgetData(widgetName, clientFnc, dashboardId); // widgetName ->Define the name of the widget to be Refresh , clientFnc -> It acts as a method, in this method only details of the widget are passed in an argument. , dashboardId -> Define the unique id of the dashboard if it is present within the multitab dashboard.

refreshWidgetData()

This method will refresh the particular widgets in the current dashboard.

Example

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.refreshWidgetData(widgetNames, hideLoader, dashboardId); // widgetnames ->Define the name of the widget to be Refresh , hideLoader -> Define whether to show or hide loading indicator while processing , dashboardId -> Define the unique id of the dashboard if it is present within the multitab dashboard.

getWidgetInstance()

This method will used to get instance of that specific widget using Id.

Example

var dashboard = BoldBI.create(options);
var widgetId = "2583540a-f970-41a1-9fc8-31c0581e7aa3"; // For getting widget ID please refer `How to get widget Id`.
var widgetInstance = dashboard.getWidgetInstance(widgetId);

setFilterParameters()

This method is used to set the filter parameters to the widget instance. These filter parameters would be applied to the respective widget at the initial rendering.

If that widget acts as a master, the filter will be applied to the slave widgets. To know about widget ID of the specific widget, please refer this link.

NOTE: Currently, we have provided support for the text field only.

Example

var widgetId = "2583540a-f970-41a1-9fc8-31c0581e7aa3";
var filtersValue = ["Average", "Good"]; 
var widgetInstance = dashboard.getWidgetInstance(widgetId).setFilterParameters(filtersValue);

exportDashboardAsPdf()

This method will export the dashboard as Pdf.

Example

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

var exportInformation ={'dashboardId':"",'fileName':"",'pageSize':"",'pageOrientation':"",'showAppliedFilters':};

instance.exportDashboardAsPdf(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multi-tab dashboard, and it is mandatory for a multi-tab dashboard and an empty string for other cases.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`pageSize`	Define the size of the page ('A3', 'A4', 'A5', 'Letter') and it is an optional parameter of string type.
`pageOrientation`	Define the page orientation ('Landscape,' 'Portrait'), and it is an optional parameter of string type.
`showAppliedFilters`	Define whether you need to export the dashboard with or without a filter, and it is an optional parameter of Boolean type.

exportDashboardAsImage()

This method will export dashboard as image.

Example

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

var exportInformation ={'dashboardId':"",'fileName':"",'exportImageFormat':"",'resolutionDpi':"",'showAppliedFilters':};

instance.exportDashboardAsImage(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multi-tab dashboard, and it is mandatory for a multi-tab dashboard and an empty string for other cases.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`exportImageFormat`	Define the format of the image to be exported('jpg','png' and 'bmp') and its an optional parameter of string type.
`resolutionDpi`	Define the resolution of the image (Integer value above 96) and its an optional parameter of integer type.
`showAppliedFilters`	Define whether you need to export the dashboard with or without a filter, and it is an optional parameter of Boolean type.

exportDashboardAsExcel()

This method will export dashboard as excel.

Example

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

var exportInformation ={'dashboardId':"",'fileName':"",'fileType':""};

instance.exportDashboardAsExcel(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multi-tab dashboard, and it is mandatory for a multi-tab dashboard and an empty string for other cases.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`fileType`	Define the type of file to be exported ('xlsx','xls') and its an optional parameter of string type.

exportWidgetAsPdf()

This method will export widget as PDF.

Example

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

var exportInformation ={'dashboardId':"",'widgetName':"",'fileName':"",'pageSize':"",'pageOrientation':"",'showAppliedFilters':};

instance.exportWidgetAsPdf(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multitab dashboard and the widget id if it is present within the pinboard. It is mandatory for the multitab dashboard, pinboard, and empty string for other cases.
`widgetName`	Define the name of the widget to be exported and its a mandatory parameter of string type.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`pageSize`	Define the size of the page ('A3', 'A4', 'A5', 'Letter') and it is an optional parameter of string type.
`pageOrientation`	Define the page orientation ('Landscape,' 'Portrait'), and it is an optional parameter of string type.
`showAppliedFilters`	Define whether you need to export the dashboard with or without a filter, and it is an optional parameter of Boolean type.

exportWidgetAsImage()

This method will export widget as image.

Example

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

var exportInformation ={'dashboardId':"",'widgetName':"",'fileName':"",'exportImageFormat':"",'resolutionDpi':"",'showAppliedFilters':};

instance.exportWidgetAsImage(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multitab dashboard and the widget id if it is present within the pinboard. It is mandatory for the multitab dashboard, pinboard, and empty string for other cases.
`widgetName`	Define the name of the widget to be exported and its a mandatory parameter of string type.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`exportImageFormat`	Define the format of the image to be exported('jpg','png' and 'bmp') and its an optional parameter of string type.
`resolutionDpi`	Define the resolution of the image (Integer value above 96) and its an optional parameter of integer type.
`showAppliedFilters`	Define whether you need to export the dashboard with or without a filter, and it is an optional parameter of Boolean type.

exportWidgetAsExcel()

This method will export widget as excel.

Example

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

var exportInformation ={'dashboardId':"",'widgetName':"",'fileName':"",'fileType':""};

instance.exportWidgetAsExcel(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multitab dashboard and the widget id if it is present within the pinboard. It is mandatory for the multitab dashboard, pinboard, and empty string for other cases.
`widgetName`	Define the name of the widget to be exported and its a mandatory parameter of string type.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.
`fileType`	Define the type of file to be exported ('xlsx','xls') and its an optional parameter of string type.

exportWidgetAsCsv()

This method will export widget as Csv.

Example

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

var exportInformation ={'dashboardId':"",'widgetName':"",'fileName':""};

instance.exportWidgetAsCsv(exportInformation);

Parameter	Description
`dashboardId`	Define the unique id of the dashboard if it is present within the multitab dashboard and the widget id if it is present within the pinboard. It is mandatory for the multitab dashboard, pinboard, and empty string for other cases.
`widgetName`	Define the name of the widget to be exported and it is a mandatory parameter of string type.
`fileName`	Define the name of the file to be exported, and it is an optional parameter of string type.

createDashboardCategory()

This method will be used Create an new category to server.

Example

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.createDashboardCategory(categoryName, categoryDescription, callBackFnc, containerId);
function callBackFnc(args)
{
   // The parameter args contains the status whether category is added or not.
}

Parameter	Type	Description
`categoryName`	`string`	Need to set the name to create a new category in the server.
`categoryDescription`	`string`	Need to set the description of new category.
`callBackFnc`	`string`	This method will act as call back function ,it will return the status of whether category is added or not.
`containerId`	`string`	Need to set embed container id.

getDashboardCategories()

This method will be used to get the dashboard categories from server.

Example

var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.getDashboardCategories(callBackFnc, containerId);
function callBackFnc(args)
{
   // The args parameter contains the list of categories available in the server as an array, which contains CategoryId and CategoryName
}

Parameter	Type	Description
`callBackFnc`	`string`	This method will act as call back function ,it will get the category list from the server.
`containerId`	`string`	Need to set the embed container id.

saveDashboard()

This method is used to publish the dashboard to the server with the dashboard name into the desired category and desired dashboard name.

To Publish or Save the new dashboard.
To Publish or Save the existing dashboard.

To PublishAs or SaveAs the existing dashboard.

Parameter Type Description

publishModel

object

This object contains the following Parameters:

category	Set the name of the category in the dashboard will be published.
categoryId	Set the unique id of category in the dashboard will be published, the category Id taken from getDashboardCategories().
description	Set the description in the dashboard will be published.
id	Save the new dashboard - Dashboard Id value can be empty here. Save the existing dashboard - Dashboard Id value should be valid. SaveAs the existing dashboard - Dashboard Id value can be empty here.
isPublic	Need to set the publish dashboard as public or not.
name	Set the Name of the dashboard in the dashboard will be published.

containerId string Set the embed container id.

Example for Save the new dashboard

var instance = BoldBI.getInstance("container"); //container -> embed container id
// For Save the New Dashboard case, Dashboard Id value is not needed
var publishModel = {category: "Sales",categoryId: "e6ed2f36-7205-423e-81e0-38a8ceb8e68c",description: "Published Using API",isPublic: false,name: "Publish API_01"}
instance.saveDashboard(publishModel, containerId);

Example for Save the existing dashboard

var instance = BoldBI.getInstance("container"); //container -> embed container id
// For Save the Existing Dashboard case, Dashboard Id value is needed
var publishModel = {category: "Sales",categoryId: "e6ed2f36-7205-423e-81e0-38a8ceb8e68c",description: "Published Using API",id: '451e17e5-e59f-4090-84a2-cf5537876e59',isPublic: false,name: "Publish API_01"}
instance.saveDashboard(publishModel, containerId);

Example for SaveAs the existing dashboard

var instance = BoldBI.getInstance("container"); //container -> embed container id
// For SaveAs the existing Dashboard case, Dashboard Id value is not needed
var publishModel = {category: "Sales",categoryId: "e6ed2f36-7205-423e-81e0-38a8ceb8e68c",description: "Published Using API",isPublic: false,name: "Publish API_01"}
instance.saveDashboard(publishModel, containerId);

Please provide additional information

Thank you for your feedback and comments.We will rectify this as soon as possible!