# ExportOptions

## Content

# Interface: ExportOptions

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

## Extends

- [`PrintOptions`](PrintOptions)

## Properties

### callback

```ts
callback: ExportCallback;
```

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

#### Examples

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

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

***

### error

```ts
error: (error) => void;
```

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

#### Parameters

##### error

[`ErrorInfo`](ErrorInfo)

#### Returns

`void`

#### Examples

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

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

#### Inherited from

[`PrintOptions`](PrintOptions).[`error`](PrintOptions#error)

***

### exportType

```ts
exportType: ExportTypes;
```

The document format type to report be exported to.

#### Examples

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

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

***

### reportID

```ts
reportID: string;
```

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

#### Examples

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

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

#### Inherited from

[`PrintOptions`](PrintOptions).[`reportID`](PrintOptions#reportid)

***

### reportParameters?

```ts
optional reportParameters?: Parameter[];
```

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

#### Examples

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

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

#### Inherited from

[`PrintOptions`](PrintOptions).[`reportParameters`](PrintOptions#reportparameters)

***

### reportService?

```ts
optional reportService?: ReportServiceSettings;
```

Set up the settings to connect the Web API.

#### Examples

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

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

#### Inherited from

[`PrintOptions`](PrintOptions).[`reportService`](PrintOptions#reportservice)

***

### saveAsDialog?

```ts
optional saveAsDialog?: boolean;
```

#### Examples

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

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

***

### settings?

```ts
optional settings?: any;
```

Export settings

#### Examples

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

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