Interface PrintOptions

The callback that is invoked when an error occurs in the process of displaying the report. The default error panel does not appear if the callback returns true. The error parameter is an object that has a message property which allows the users to customize the error message and details property which allows to customize error details.

Example: To hide the default error panel:

// ESM usage
import { printReport } from './jsViewer.min.js';
printReport({
error: (error) => {
    if (error.message) {
        // show error message.
        alert("Internal error! Please ask administrator.");
        // do not show default error message.
    }
}
}):
Copy

Example: To customize the error message:

// ESM usage
import { printReport } from './jsViewer.min.js';
printReport({
error: (error) => {
    if (error.message) {
        // show error message.
        return {message = "Custom message", caption = "Custom caption"};
    }
}
}):
Copy

Example: To hide the default error panel:

// UMD usage
GrapeCity.ActiveReports.JSViewer.print({
error: (error) => {
    if (error.message) {
        // show error message.
        alert("Internal error! Please ask administrator.");
        // do not show default error message.
    }
}
}):
Copy

Example: To customize the error message:

// UMD usage
GrapeCity.ActiveReports.JSViewer.print({
error: (error) => {
    if (error.message) {
        // show error message.
        return {message = "Custom message", caption = "Custom caption"};
    }
}
}):
Copy

The id of the report to be shown by the JS Viewer.

Example: Usage example:

// ESM usage
import { printReport } from './jsViewer.min.js';
printReport({
reportID: 'AnnualReport.rdlx'
}):
Copy

Example: Usage example:

// UMD usage
GrapeCity.ActiveReports.JSViewer.print({
reportID: 'AnnualReport.rdlx'
}):
Copy

The array of the {name, value} pairs that describe the parameters values used to run the report.

Example: Usage example:

// ESM usage
import { printReport } from './jsViewer.min.js';
printReport({
reportParameters: [{ name: 'ReportParameter1', values: ['1']}]
}):
Copy

Example: Usage example:

// UMD usage
GrapeCity.ActiveReports.JSViewer.print({
reportParameters: [{ name: 'ReportParameter1', values: ['1']}]
}):
Copy

Set up the settings to connect the Web API.

Example: Usage example:

// ESM usage
import { printReport } from './jsViewer.min.js';
printReport({
reportService: {
    url: 'http://example.com/api/reporting',
    securityToken: '42A9CD80A4F3445A9BB60A221D042FCC',
}
}):
Copy

Example: Usage example:

// UMD usage
GrapeCity.ActiveReports.JSViewer.print({
reportService: {
    url: 'http://example.com/api/reporting',
    securityToken: '42A9CD80A4F3445A9BB60A221D042FCC',
}
}):
Copy