Interface: ExportOptions

The following options can be set during initialization or at run time while working with the JS Viewer.

Extends

• PrintOptions

Properties

callback

callback: ExportCallback;

The callback that is invoked before the export result request sent.

Examples

// ESM usage
import {exportReport} from './jsViewer.min.js';
exportReport({
 callback: ()=>console.log('test')
});

// UMD usage
GrapeCity.ActiveReports.JSViewer.export({
 callback: ()=>console.log('test')
});

error()

error: (error) => void;

The callback that is invoked when an error occurs in the process of displaying the report.

Parameters

error

ErrorInfo

Returns

void

Examples

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

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

Inherited from

PrintOptions.error

exportType

exportType: ExportTypes;

The document format type to report be exported to.

Examples

// ESM usage
import {exportReport} from './jsViewer.min.js';
exportReport({
 exportType: 'Pdf'
});

// UMD usage
GrapeCity.ActiveReports.JSViewer.export({
 exportType: 'Pdf'
});

reportID

reportID: string;

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

Examples

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

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

Inherited from

PrintOptions.reportID

reportParameters?

optional reportParameters: Parameter[];

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

Examples

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

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

Inherited from

PrintOptions.reportParameters

reportService?

optional reportService: ReportServiceSettings;

Set up the settings to connect the Web API.

Examples

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

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

Inherited from

PrintOptions.reportService

saveAsDialog?

optional saveAsDialog: boolean;

Examples

// ESM usage
import {exportReport} from './jsViewer.min.js';
exportReport({
 saveAsDialog: true
});

// UMD usage
GrapeCity.ActiveReports.JSViewer.export({
 saveAsDialog: true
});

settings?

optional settings: any;

Export settings

Examples

// ESM usage
import {exportReport} from './jsViewer.min.js';
exportReport({
settings : {
	EmbedFonts:'All',
	Title:'MyInvoice'
}});

// UMD usage
GrapeCity.ActiveReports.JSViewer.export({
settings : {
	EmbedFonts:'All',
	Title:'MyInvoice'
}});