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",
});
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();
This method will load the widget of current dashboard.
Example
var dashboard = BoldBI.create(options);
dashboard.loadDashboardWidget("Sales by country");
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();
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();
This method will render the pinboard based on the provided pinboard name.
Example
var dashboard = BoldBI.create(options);
dashboard.loadPinboard();
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>
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();
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");
This method will refresh the current dashboard.
Example
var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.refreshDashboard();
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);
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();
This method will resize the current dashboard.
Example
var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.resizeDashboard();
This method will hide the current dashboard waiting pop-up.
Example
var instance = BoldBI.getInstance("container"); //container -> embed container id
instance.hidePopup();
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.
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.
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. |
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. |
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. |
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 multi-tab dashboard, and it is mandatory for a multi-tab dashboard and an 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. |
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,it is mandatory for 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. |
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,it is mandatory for 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. |
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,it is mandatory for 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. |