Documentation
Demos
Support
Blog
Schedule Free Demo
Search results

Events

dashboardSettings

beforeIconRender

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

Name Type Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
iconsinformation array Holds the information about the list of icons to be rendered in the Dashboard.
enableComment boolean Holds the enableComment value.
dashboardPath string Holds the current dashboard path value.
cancel boolean 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 Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
target array Contains the parent element of the selected icon..
name string Contains the name of the icon clicked.
dashboardPath string Holds the current dashboard path value.
headertext string Contains the title of the dashboard.
event object Returns the current click event information.
cancel boolean 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 Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
widgetInformation object Holds the current triggered widget information.
uniqueId string Holds the current widget id.
iconsinformation array Holds the information about the list of icons to be rendered in the dashboard.
isFilterWidget boolean Holds the true, if the current widget is filter.
dashboardComment boolean Holds the dashboardComment value.
enableComment boolean Holds the enableComment value.
cancel boolean 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 Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewer's Object.
target array Contains the parent element of the selected icon..
name string Contains the name of the icon clicked.
dashboardPath string Holds the current dashboard path value.
headertext string Contains the title of the widget.
event object Returns the current click event information.
widgetId string Holds the id of the widget where the menu icon is clicked.
dataWidgetId 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: {
          onIconClick: function (args) {
               // Write a code block to perform an operation after an icon from widget banner is clicked
          } 
     }  
});
dashboard.loadDashboard();

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 Description
eventType Enum Will hold the current event type that triggered the event
source object This will contain the data related to the current event
Source.element object Holds the current event site UI element. If there involves no UI element will be returned as null
Source.data object 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 Description
eventType Enum Will hold the current event type that triggered the event
source object This will contain the data related to the current event
Source.element object Holds the current event site UI element. If there involves no UI element will be returned as null
Source.data object 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.

beforeContextMenuRender

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

Name Type Description
type Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewers Object.
dashboardPath string Holds the current dashboard path value.
iconsinformation array Holds the information about the list of icons to be rendered in the dashboard.
enableComment boolean Holds the enableComment value.
cancel boolean 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 Description
linkInfo object Will holds the linking information
model object Holds the Dashboard Viewers Object.
type Enum Will holds the current event type that triggered the event
widgetId string Holds the current widget id information
widgetName string Holds the current widget name information
cancel boolean 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();

beforeDatasourceSave

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

Name Type Description
eventType Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewers Object.
designer object Holds the information about the dashboard designer .
cancel boolean 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 Description
eventType Enum Will holds the current event type that triggered the event
model object Holds the Dashboard Viewers Object.
designer object Holds the information about the dashboard designer .
cancel boolean Holds the cancel value of the current operation.
dataSourceId string Holds the current data source id.
schema object Holds the current data source schema information
status boolean Holds the status of the data source save action

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 Description
args object 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 Description
args object 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 Description
args object 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 Description
args object 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 Description
args object 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();
Previous
Next