Fires during drill through action done in report. If you want to perform any operation when a drill through action is performed, you can make use of the drillThrough event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
actionInfo | Object | returns the actionInfo's parameters bookmarkLink, reportName, parameters. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
drillThrough: function (args) {
// Write a code block to perform any operation when drill through action occurs in report.
}
});
</script>
Fires before report rendering is completed. If you want to perform any operation before the rendering of report,you can make use of the renderingBegin event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
//rendering begin event for report.
$("#report-viewer").boldReportViewer({
renderingBegin:function(args) {
// Write a code block to perform any operation before rendering.
}
});
</script>
Fires after report rendering completed. If you want to perform any operation after the rendering of report,you can make use of this renderingComplete event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
model | object | returns the report model. |
type | string | returns the name of the event. |
reportParameters | object | returns the collection of parameters. |
Example
<div id="report-viewer"></div>
<script>
//rendering complete event for report viewer control.
$("#report-viewer").boldReportViewer({
renderingComplete:function(args) {
// Write a code block to perform any operation after rendering completed.
}
});
</script>
Fires when any error occurred while rendering the report. If you want to perform any operation when an error occurs in the report, you can make use of the reportError event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
error | string | returns the error details. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
reportError: function (args) {
// Write a code block to perform any operation when report error occurs.
}
});
</script>
Fires when the report is being exported. If you want to perform any operation before exporting of report, you can make use of the reportExport event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
reportExport: function (args) {
// Write a code block to perform any action before exporting of report.
}
});
</script>
Fires when the report is loaded. If you want to perform any operation after the successful loading of report, you can make use of the reportLoaded event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
reportLoaded: function(args) {
// Write a code block to perform any action when the report is loaded successfully.
}
});
</script>
Fires when user clicks on a failed report item in the rendered report, before displaying error details dialog. If you want to show custom error detail or perform any action before viewing error detail, you can make use of the showError event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
errorCode | string | returns the error code. |
message | string | returns the error message. |
detail | string | returns the detailed error information. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
showError: function (args) {
// Write a code block to perform any operation when user clicks a failed item in a report.
}
});
</script>
Fires when click the View Report Button.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
parameters | Object | returns the parameter collection. |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
viewReportClick: function (args) {
// Write a code block to perform any operation after destroy of report viewer.
}
});
</script>
Fires before the AJAX request process started.
Name | Type | Description |
---|---|---|
reportViewerToken | string | returns the reportViewerToken. |
serviceAuthorizationToken | string | returns the serviceAuthorizationToken. |
headerReq | Object | Send the header request collection. |
headers | Object | Send the headers collection. |
data | string | Send the custom data. |
actionName | string | Change the Web API action with custom endpoint. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
ajaxBeforeLoad: function (args) {
// Write a code block to perform any operation after destroy of report viewer.
}
});
</script>
Fires when AJAX post call succeed.
Name | Type | Description |
---|---|---|
data | object | returns the success data. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
ajaxSuccess: function (args) {
// Write a code block to perform any operation after destroy of report viewer.
}
});
</script>
Fires when AJAX request failed.
Name | Type | Description |
---|---|---|
msg | string | returns the error details |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
ajaxError: function (args) {
// Write a code block to perform any operation after destroy of report viewer.
}
});
</script>
This event will be triggered on rendering the report viewer toolbar.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
model | object | returns the report model. |
type | string | returns the name of the event. |
target | JQuery | returns the toolbar container. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
toolbarRendering: function(args) {
// Write a code block to customize the report viewer toolbar.
}
});
</script>
Fires when the export progress is changed. To perform any operation when the export progress is changed, use the exportProgressChanged event.
Name | Type | Description |
---|---|---|
format | string | returns the export format |
stage | string | returns the stage of export processing. |
handled | boolean | true if the event should be handled; otherwise, false. |
containerId | string | returns report viewer container Id. |
`waitingPopupTemplate` | string | Set the `waitingPopupTemplate` in report viewer. |
actionName | string | Change the Web API action with custom endpoint. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
exportProgressChanged : function(args) {
// Write a code block to perform any action when the export progress changed.
}
});
</script>
Fires when the print progress is changed. To perform any operation when the print progress is changed, use the printProgressChanged event.
Name | Type | Description |
---|---|---|
stage | string | returns the stage of export processing. |
currentPage | string | returns the currentPage value |
totalPages | string | returns the totalPages value |
handled | boolean | true if the event should be handled; otherwise, false. |
containerId | string | returns report viewer container Id. |
`waitingPopupTemplate` | string | Set the `waitingPopupTemplate` in report viewer. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
printProgressChanged : function(args) {
// Write a code block to perform any action when the print progress changed.
}
});
</script>
Fires when the export items are clicked. To perform any operation when the export items are clicked, use the exportItemClick event.
Name | Type | Description |
---|---|---|
value | string | returns the export format value. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
exportItemClick : function(args) {
// Write a code block to perform any action when the export item clicked.
}
});
</script>
Fires when the toolbar items are clicked. To perform any operation when the toolbar items are clicked, use the toolBarItemClick event.
Name | Type | Description |
---|---|---|
target | string | returns the toolbar clicked item name . |
cssClass | string | returns the CSS class name specified for the toolbar item |
groupIndex | string | returns the Toolbar item rendered group index |
Index | string | returns the Toolbar item rendered index |
value | string | returns the Toolbar item value. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
toolBarItemClick : function(args) {
// Write a code block to perform any action when the toolbar item clicked.
}
});
</script>
Fires when the hyperlink action is performed in the report. To perform any operation during the hyperlink action, use the hyperlink event.
Name | Type | Description |
---|---|---|
cancel | boolean | true if the event should be canceled; otherwise, false. |
actionInfo | Object | returns the actionInfo's hyperLink detail |
model | object | returns the report model. |
type | string | returns the name of the event. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
hyperlink: function (args) {
// Write a code block to perform any operation when hyperlink action occurs in report.
}
});
</script>
Fires when the report print action is performed in the report. To perform any operation during the report print action, use the ReportPrint event.
Name | Type | Description |
---|---|---|
isStyleLoad | boolean | true if you have to load the external style file; otherwise, false. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
reportPrint : function(args) {
// Write a code block to perform any action when the export item clicked.
}
});
</script>
Fires when begin to add the parameter element in the report viewer parameter block. To perform any changes in parameter element, use the beforeParameterAdd event.
Name | Type | Description |
---|---|---|
parameterModel | object | returns the parameter model. |
containerId | string | returns the current report parameter container id |
handled | boolean | true if the event should be handled; otherwise, false. |
parameterSettings | object | returns the parameter settings. |
customProperties | object | set custom properties to the report parameter. |
Example
<div id="report-viewer"></div>
<script>
$("#report-viewer").boldReportViewer({
beforeParameterAdd : function(args) {
// Write a code block to perform any change in report parameter element before add it to the viewer block.
}
});
</script>