Search results

Events

dashboardSettings

beforeIconRender

dashboardSettings.beforeIconRender
This event will be triggered before the dashboard banner icons were rendered.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
iconsinformation array set Holds the information about the list of icons to be rendered in the Dashboard.
enableComment boolean get Holds the enableComment value.
dashboardPath string get Holds the current dashboard path value.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     dashboardSettings: {
          beforeIconRender: function (args) {
               // Write a code block to perform an operation before the dashboard banner icons were rendered
          } 
     }  
});
dashboard.loadDashboard();        

onIconClick

dashboardSettings.onIconClick
This event will be triggered after an icon from the dashboard banner is clicked.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
target array get Contains the parent element of the selected icon..
name string get Contains the name of the icon clicked.
dashboardPath string get Holds the current dashboard path value.
headertext string get Contains the title of the dashboard.
event object get Returns the current click event information like below. 1. currentTarget - It indicates the current DOM element
2. type - It indicates the click event.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     dashboardSettings: {
          onIconClick: function (args) {
               // Write a code block to perform an operation after an icon from dashboard banner is clicked
          } 
     }  
});
dashboard.loadDashboard();        

widgetSettings

widgetSettings.beforeIconRender

This event will be triggered before the widget banner icons were rendered.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
widgetInformation object get Holds the current triggered widget information as like below.
1. fontColor - Color of font in widget.
2. fontFamily - fontFamily of the text in the widget
3. type - Indicates the type of the widget like, grid, chart and so on,..
uniqueId string get Holds the current widget id.
iconsinformation array set Holds the information about the list of icons to be rendered in the dashboard.
isFilterWidget boolean get Holds the true, if the current widget is filter.
dashboardComment boolean get Holds the dashboardComment value.
enableComment boolean get Holds the enableComment value.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     widgetSettings: {
          beforeIconRender: function (args) {
               // Write a code block to perform an operation before the widget banner icons were rendered
          } 
     }  
});
dashboard.loadDashboard();        

widgetSettings.onIconClick

This event will be triggered after an icon from the widget banner is clicked.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
target array get Contains the parent element of the selected icon.
name string get Contains the name of the icon clicked.
dashboardPath string get Holds the current dashboard path value.
headertext string get Contains the title of the widget.
event object get Returns the current click event information as like below.
1. type - It indicates the type of event, here it is click.
2. currentTarget - It indicates the current DOM element
widgetId string get Holds the id of the widget where the menu icon is clicked.
dataWidgetId string get Holds the id of the widget where the menu icon is clicked.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     widgetSettings: {
          onIconClick: function (args) {
               // Write a code block to perform an operation after an icon from widget banner is clicked
          } 
     }  
});
dashboard.loadDashboard();        

widgetSettings.beforeWidgetControlMenuOpen

This event will be triggered after any option from the control menu icon is clicked.

Name Type Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
header string Contains the title of the widget.
menuItem array Contains array value present in the widget control menu.
widgetId string Holds the id of the widget where the menu icon is clicked.
cancel boolean Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     widgetSettings: {
          beforeWidgetControlMenuOpen: function (args) {
               // Write a code block to perform an operation after control menu icon from the widget banner is clicked.
          } 
     }  
});
dashboard.loadDashboard();        

widgetSettings.onWidgetControlMenuClick

This event will be triggered after any option from control menu icon is clicked.

Name Type Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
header string Contains the title of the widget.
menu array Contains details of newly added button in widget control menu.
widgetId string Holds the id of the widget where the menu icon is clicked.
cancel boolean Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     widgetSettings: {
          onWidgetControlMenuClick: function (args) {
               // Write a code block to perform an operation after any option from control menu icon from widget banner is clicked.
          } 
     }  
});

actionBegin

This event will be triggered at the beginning of every viewer actions while applying connection, layout and dashboard rendering, popup opening and closing, refreshing, filtering, exporting and more.

Name Type Access Description
eventType enum get Will hold the current event type that triggered the event
source object get This will contain the data related to the current event as like below.
1. data
2. element
source.element object get Holds the current event site UI element. If there involves no UI element will be returned as null
source.data object get Holds the current event data.

Example

var dashboard = BoldBI.create({
     actionBegin: function (args) {
          // Write a code block to perform an operation on beginning of every viewer actions 
     } 
});
dashboard.loadDashboard();    

Event Types

Event Types Description
renderLayout This event will trigger when the layout of the dashboard started to render.
renderDashboard This event will trigger when the dashboard started to render.
renderWidget This event will trigger when the widget started to render.
resizeDashboard This event will trigger when we invoke the resize dashboard method or when you resize the browser window.
exportDialogOpen This event will trigger when the export dialog box opens, when you click on the export option in the context menu.
exportDialogClose This event will trigger when the export dialog box closes.
maximizeDialogOpen This event will trigger when the Maximize dialog box opens, when you click on the Maximize icon in the widget header.
maximizeDialogClose This event will trigger when the Maximize dialog closes.
filterOverViewOpen This event will trigger when the filter overview drop-down opens.
filterOverViewClose This event will trigger when the filter overview drop-down closes.
clearFilter This event will trigger when you clear the filters in each widget and also from the filter overview drop-down.

actionComplete

This event will be triggered when all viewer actions are completed.

Name Type Access Description
eventType enum get Will hold the current event type that triggered the event
source object get This will contain the data related to the current event as below.
1. element
2. data
source.element object get Holds the current event site UI element. If there involves no UI element will be returned as null
source.data object get Holds the current event data.

Example

var dashboard = BoldBI.create({
     actionComplete: function (args) {
          // Write a code block to perform an operation on every viewer action which completes 
     } 
});
dashboard.loadDashboard(); 

Event Types

Event Types Description
layoutRendered This event will trigger after the layout rendering is completed.
dashboardRendered This event will trigger after the dashboard rendering is completed.
viewDataDialogOpen This event will trigger when the ViewData dialog box opens, when you click on the ViewData option in the context menu.
viewDataDialogClose This event will trigger when the ViewData dialog box closes.
informationOpen This event will trigger when the information pop-up opens, when you click on the info icon.
informationClose This event will trigger when the information pop-up closes.
getLinkDialogOpen This event will trigger when the Get Link dialog box opens when you click the Get Link icon option in the context menu present on dashboard header.
getLinkDialogClose This event will trigger when the Get Link dialog box closes.
exporting This event will trigger when the dashboard exporting gets started.
exportCompleted This event will trigger when the dashboard exporting gets completed.
clearAllFilter This event will trigger when you clear all the filters from the filter overview drop-down.
clearIndividualFilter This event will trigger when you clear all the filters in each widget and also from the filter overview drop-down.
interactionCompleted This event will trigger once the master widget interactions completed.
Save This event will trigger once the Publish option is clicked in dashboard designer mode.
SaveAs This event will trigger once the Publish As option is clicked in dashboard designer mode.

beforeContextMenuRender

This event will be triggered before the dashboard context menu is rendered.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
dashboardPath string get Holds the current dashboard path value.
iconsinformation array set Holds the information about the list of icons to be rendered in the dashboard.
enableComment boolean get Holds the enableComment value.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     beforeContextMenuRender: function (args) {
          // Write a code block to perform an operation before the dashboard context menu is rendered 
     } 
});
dashboard.loadDashboard();        

beforeNavigateUrlLinking

This event will be triggered before the URL linking navigations are called.

Name Type Access Description
type enum get Will holds the current event type that triggered the event
linkInfo object set Will holds the linking information
model object get Holds the dashboard viewer's object.
widgetId string get Holds the current widget id information
widgetName string get Holds the current widget name information
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     beforeNavigateUrlLinking: function (args) {
          // Write a code block to perform an operation before the url linking navigation called. 
     } 
});
dashboard.loadDashboard();

beforeDashboardMobileMenuOpen

This event will be triggered after a More option icon from the dashboard banner is clicked.

Name Type Access Description
data array get Will holds the array of menu list

Example

var dashboard = BoldBI.create({
     beforeDashboardMobileMenuOpen: function (args) {
          // Write a code block to perform an operation before the url linking navigation called. 
     } 
});
dashboard.loadDashboard();

beforeFilterApply

This event will be triggered before the filter is applied.

Name Type Access Description
eventType enum get Holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
source object get This will contain the data related to the current event as like below.
1. element - Which holds the DOM elements.
2. data
source.data object get Holds the current event data.
source.data.widgetName string get Holds the interacted widget name information
source.data.widgetProperties object get Holds the Widget properties of interacted widget as like below.
1. UniqueId - It denotes the interacted widget Id
source.data.selectedFilterValues array get Holds the Filter Values of interacted widget.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     beforeFilterApply: function (args) {
          // Write a code block to perform an operation before the dashboard context menu is rendered 
     } 
});
dashboard.loadDashboard();        

afterFilterApply

This event will be triggered after the filter is applied.

Name Type Access Description
eventType enum get Will holds the current event type that triggered the event
model object get Holds the dashboard viewer's object.
source object get This will contain the data related to the current event
1. element - Which holds the DOM element.
2. data
source.data object get Holds the current event data.
source.data.widgetName string get Holds the interacted widget name information
source.data.widgetProperties object get Holds the Widget properties of interacted widget as like,UniqueId which represent Widget Id of the interacted widget.
source.data.selectedFilterValues array set Holds the filter values of interacted widget and able to modify the filter values here.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     afterFilterApply: function (args) {
          // Write a code block to perform an operation before the dashboard context menu is rendered 
     } 
});
dashboard.loadDashboard();        

beforePublishAs

This event will be triggered in following actions.

  1. To Publish or Save the new dashboard.

  2. To PublishAs or SaveAs the existing dashboards.

Name Type Description
args.source.data.dashboardId string Holds the unique GUID for the dashboard.
args.source.data.dashboardName string Holds the name of the dashboard.
args.source.data.dashboardDescription string Holds the description of the dashboard.
args.source.data.isPublicDashboard string Holds the dashboard is public or not.

Example

var dashboard = BoldBI.create({
     mode: BoldBI.Mode.Design,
     dashboardSettings:
      { 
         beforePublishAs :function (args) {
         } 
      } 
});
dashboard.loadDesigner();        

ajaxBeforeLoad

This event is used to customize headers in the ajax call before sending them to the designer service.

Name Type Description
args.headers array[] Able to add new payload header.
args.serviceAuthorizationToken string Holds the service AuthorizationToken value
actionType string Holds action type of the ajax call.

Example

var dashboard = BoldBI.create({
     ajaxBeforeLoad: function (args) {
          // Write a code block to add a new payload header. 
          // var header = { key : 'UserId',value : '1005'};
          // args.headers.push(header);
     } 
});
dashboard.loadDashboard();

beforeDesignerToolbarButtonsRendered

This event will be triggered before the tool bar button is rendered.

Name Type Description
args.toolbarButtons array[] Holds the details all the tool bar Buttons
args.toolbarButtons.class ->Set the Class name of newly added tool bar button
args.toolbarButtons.elementId ->Set the Id of newly added tool bar button.
args.toolbarButtons.label ->Set the Label of newly added tool bar button.

Example For adding new button

var dashboard = BoldBI.create({
        mode: BoldBI.Mode.Design,
        dashboardSettings:
           {    
                beforeDesignerToolbarButtons :function (args) {
               // Write a code block to add a button before the dashboard banner icons are rendered.
               //  args.toolbarButtons.push(
               //       {
               //            class:'new-btn-class',
               //            elementId:'new_id',
               //            label:'External Button',    
               //       });
               } 
          } 
});
dashboard.loadDesigner();  

Example For removing a button

var dashboard = BoldBI.create({
      mode: BoldBI.Mode.Design,
      dashboardSettings:
       { 
        beforeDesignerToolbarButtons :function (args) {
         //  Write a code block to remove an existing button before the dashboard banner icons are rendered. You need to mention the index value to remove the specific button.
         //  args.toolbarButtons.splice(1); 
        } 
       } 
});
dashboard.loadDesigner();  

beforeDatasourceSave

This event will be triggered before the data source save action is called.

Name Type Access Description
eventType enum get Will holds the current event type that triggered the event
model object get Holds the Data source Viewer's Object.
designer object get Holds the information about the dashboard designer.
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     beforeDatasourceSave: function (args) {
          // Write a code block to perform an operation before the data source save action is called 
     } 
});
dashboard.loadDatasource();

afterDatasourceSave

This event will be triggered after the data source save action is called.

Name Type Access Description
eventType enum get Will holds the current event type that triggered the event
model object get Holds the Data source Viewer's Object.
designer object get Holds the information about the dashboard designer .
dataSourceId string get Holds the current data source id.
schema object get Holds the current data source schema information such as data base table name, table Id, and so on.
status boolean get Holds the status of the data source save action
cancel boolean set Holds the cancel value of the current operation.

Example

var dashboard = BoldBI.create({
     afterDatasourceSave: function (args) {
          // Write a code block to perform an operation after the data source save action is called
     } 
});
dashboard.loadDatasource();

onUnpin

This event will be triggered when you unpin the widget from the pinboard.

Name Type Access Description
args object get Holds the Dashboard Viewers Object as follows.
1. ServerUrl - Bold BI server URL is passed to render the dashboard.
2. itemId - Unique id of the Bold BI Dashboard.
3. dashboardName - Unique name of the Bold BI Dashboard.

Example

var dashboard = BoldBI.create({
     onUnpin: function (args) {
          // Write a code block to perform an operation click the unpin widget.
     } 
});
dashboard.loadPinboard();

onDrag

This event will be triggered when you perform the drag widget from the pinboard.

Name Type Access Description
args object get Holds the Dashboard Viewers Object as follows.
1. ServerUrl - Bold BI server URL is passed to render the dashboard.
2. itemId - Unique id of the BoldBI Dashboard.
3. dashboardName - Unique name of the BoldBI Dashboard.

Example

var dashboard = BoldBI.create({
     onDrag: function (args) {
          // Write a code block to perform an operation click the unpin widget.
     } 
});
dashboard.loadPinboard();

onDrop

This event will be triggered when you drop the widget.

Name Type Access Description
args object get Holds the Dashboard Viewers Object as follows.
1. ServerUrl - Bold BI server URL is passed to render the dashboard.
2. itemId - Unique id of the BoldBI Dashboard.
3. dashboardName - Unique name of the BoldBI Dashboard.

Example

var dashboard = BoldBI.create({
     onDrop: function (args) {
          // Write a code block to perform an operation click the unpin widget.
     } 
});
dashboard.loadPinboard();

onLayoutChange

This event will be triggered when you change the layout of the pinboard.

Name Type Access Description
args object get Holds the Dashboard Viewers Object like below.
1. ServerUrl - BoldBI server URL passed to render the dashboard.
2. itemId - Unique id of the BoldBI Dashboard.
3. dashboardName - Unique name of the BoldBI Dashboard.

Example

var dashboard = BoldBI.create({
     onLayoutChange: function (args) {
          // Write a code block to perform an operation click the unpin widget.
     } 
});
dashboard.loadPinboard();

onResize

This event will be triggered when you resize the pinboard.

Name Type Access Description
args object get Holds the Dashboard Viewers Object like below.
1. ServerUrl - BoldBI server URL passed to render the dashboard.
2. itemId - Unique id of the BoldBI Dashboard.
3. dashboardName - Unique name of the BoldBI Dashboard.

Example

var dashboard = BoldBI.create({
     onResize: function (args) {
          // Write a code block to perform an operation click the unpin widget.
     } 
});
dashboard.loadPinboard();

DashboardProperties

This section describes the dashboard properties of the viewer object.

Name Type Access Description
serverUrl string get Hold the Bold BI server URL.
itemId string get Hold the unique id of the dashboard.
dashboardDescription string get Hold the description of dashboard.
dashboardName string get Hold the name of the dashboard is rendered.
environment string get Hold the embedding environment type.
mode string get Hold the mode of the dashboard.

DatasourceProperties

This section describes the data source properties of the viewer object.

Name Type Access Description
serverUrl string get Hold the Bold BI server URL.
datasource string get Hold the unique id of the data source.
datasourceName string get Hold the data source name.
environment string get Hold the embedding environment type.
mode string get Hold the mode of the data source.