The following options can be set during initialization or at run time while working with the JS Viewer.
action
Description: The callback that is invoked before the JS Viewer opens the hyperlink, bookmark link, drill down report or toggles the report control visibility.
Type: function(actionType, actionParams)
Example:
action: (actionType, actionParams) => console.log('Action type: ' + actionType + '; Action parameters: ' + actionParams)
availableExports
Description: The array of export types available via Export functionality of JS Viewer. By default, PDF, Excel, Word, JSON, XML, CSV, and Image exports are available.
Type: Array
Example:
availableExports: ['Xml', 'Pdf']
displayMode
Description: Set up single page or continuous page.
Type: String
Accepted Value: 'single', 'continuous'
Example:
displayMode: 'Continuous'
documentLoaded
Description: The callback that is invoked when a document is loaded entirely on the server.
Type: function()
Example:
documentLoaded: () => console.log('The document is loaded entirely on the server')
Returns: Void
element
Description: JQuery selector that specifies the element that hosts the JS Viewer control.
Type: String
Example:
element: '#viewerContainer'
error
Description: 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.
Type: function(error)
Example: To hide the default error panel
error: (error) => {
if (error.message) {
// show error message.
alert("Internal error! Please ask administrator.");
// do not show default error message.
}
}
reportID
Description: The id of the report to be shown by the JS Viewer.
Type: String
Example:
reportID: 'AnnualReport.rdlx'
reportLoaded
Description: The callback that is invoked when the JS Viewer obtains the information about the requested report. The reportInfo object is passed in the callback including the TOC info, Parameters info and the link to the rendered report result.
Type: function(reportInfo)
Example:
reportLoaded: (reportInfo) => console.log('The report ' + reportInfo.name + ' was successfully loaded!')
reportParameters
Description: The array of the {name, value} pairs that describe the parameters values used to run the report.
Type: Array
Example:
reportParameters: [{ name: 'ReportParameter1', values: ['1']}]
reportService
Description: Set up the settings to connect the Web API.
Type: Object that has the url and optional securityToken properties.
Example:
reportService: {
url: 'http://example.com/api/reporting',
securityToken: '42A9CD80A4F3445A9BB60A221D042FCC',
};
backtoParent
Description: Makes the viewer to display the parent report of the drill-down report.
Syntax: backToParent()Void
viewer.backToParent()
Return Value: Void
create
Description: Creates a new instance of the Viewer and renders it in the specified DOM element.
Syntax: create()Void
Parameters:
const viewer = GrapeCity.ActiveReports.JSViewer.create({
element: '#root',
reportID: 'AnnualReport.rdlx',
availableExports: ['Xml', 'Pdf'],
// other properties
});
Return Value: Void
destroy
Description: Removes the viewer content from the element.
Syntax: destroy()Void
viewer.destroy()
Return Value: Void
export
Description: Exports the currently displayed report.
Syntax: export(exportType,callback,saveAsDialog,settings)Void
Parameters:
Example:
viewer.export('Pdf', downloadReport, true, { Title: '1997 Annual Report' })
Return Value: Void
getTOC
Description: Obtains the report TOC.
Syntax: viewer.getToc()
Example:
console.log(viewer.getToc())
Return Value: any
goToPage
Description: Makes the viewer to display the specific page.
Syntax: goToPage(number, offset, callback)Void
Parameters:
viewer.goToPage(1)
Return Value: Void
openReport
Description: Opens a report.
Syntax: openReport(reportID: string, reportParameters?: Array<Parameter>): void
Parameters:
viewer.openReport('Invoice.rdlx')
Return Value: Void
Description: Prints the currently displayed report if any.
Syntax: print()Void
viewer.print()
Return Value: Void
Refresh
Description: Refreshes the report preview.
Syntax: option(name,[value])Object
viewer.refresh()
Return Value: Void
Version
Description: A string that represents the current version of the JS Viewer.
Syntax: viewer.version
console.log(viewer.version)
Return Value: string
currentPage
Description: Gets the currently displayed page number.
Syntax: viewer.currentPage
console.log(viewer.currentPage())
Return Value: An integer representing currently displayed page number.
pageCount
Description: Gets the page count of the currently displayed report.
Syntax: viewer.pageCount
console.log(viewer.pageCount())
Return Value: An integer representing page count.