{/* Do not edit this file. It is automatically generated by API Documenter. */}


## ExportBaseOptions

Model based settings for grid and data export

**Signature:**

```typescript
export interface ExportBaseOptions
```

## Remarks

[GridExportOptions](/refs/Interface/GridExportOptions){/* */}, [DataExportOptions](/refs/Interface/DataExportOptions) are submodels.

\[subclass\]

[GridExportOptions](/refs/Interface/GridExportOptions)

[DataExportOptions](/refs/Interface/DataExportOptions)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [compression](/refs/Interface/ExportBaseOptions#compression) | [ExportCompression](/refs/realgrid#exportcompression) | Compression method when creating a file |
| [compressionLevel](/refs/Interface/ExportBaseOptions#compressionlevel) | number | Compression level |
| [coreProperties](/refs/Interface/ExportBaseOptions#coreproperties) | [ExportCoreProperties](/refs/Interface/ExportCoreProperties) | You can specify properties of Excel files. |
| [done](/refs/Interface/ExportBaseOptions#done) | [ExportSimpleCallback](/refs/realgrid#exportsimplecallback) | Callback to be executed when export is complete |
| [exportMemo](/refs/Interface/ExportBaseOptions#exportmemo) | [ExportMemo](/refs/Interface/ExportMemo) | A model containing settings related to exporting cell memos.
| [fileName](/refs/Interface/ExportBaseOptions#filename) | string | File name when exporting |
| [nullDateText](/refs/Interface/ExportBaseOptions#nulldatetext) | string | Value displayed when the value of the Datetime field is `null` |
| [params](/refs/Interface/ExportBaseOptions#params) | [ConfigObject](/refs/realgrid#configobject) | Parameters to be sent to the server when target is "remote" |
| [prepareProgress](/refs/Interface/ExportBaseOptions#prepareprogress) | number | **_(ALPHA)_** |
| [progressCallback](/refs/Interface/ExportBaseOptions#progresscallback) | [ProgressCallback](/refs/realgrid#progresscallback) | Callback for custom Progress Bar |
| [progressMessage](/refs/Interface/ExportBaseOptions#progressmessage) | string | Message to be displayed when using the progress bar |
| [showProgress](/refs/Interface/ExportBaseOptions#showprogress) | boolean | Whether to show the progress bar when exporting |
| [streamFiles](/refs/Interface/ExportBaseOptions#streamfiles) | boolean | Whether to stream when creating a file |
| [target](/refs/Interface/ExportBaseOptions#target) | [ExportTarget](/refs/realgrid#exporttarget) \| string | Target / path to export |
| [type](/refs/Interface/ExportBaseOptions#type) | [ExportType](/refs/realgrid#exporttype) \| string | Type to export |
| [url](/refs/Interface/ExportBaseOptions#url) | string | URL of the server that receives the document stream exported by the grid and then downloads it back to the user's computer |
| [useComputedStyle](/refs/Interface/ExportBaseOptions#usecomputedstyle) | boolean | Specifies whether to extract cell styles based on CSS styles computed by the browser and reflect them in Excel styles. |
| [zip](/refs/Interface/ExportBaseOptions#zip) | any | <p>Specifies the JSZip module.</p><p>Specifies the imported module when importing and using JSZip.</p> |

## Properties Desc

### compression

Compression method when creating a file

`Type` - [ExportCompression](/refs/realgrid#exportcompression)

**Remarks:**

When saving using `STORE`{/* */}, the size is about 10 times larger than the compressed size, but the speed is improved by about 30%

`STORE` does not compress and saves the original as is. `DEFLATE` compresses to reduce the file size. See [JSZip.compression](https://stuk.github.io/jszip/documentation/api_jszip/generate_async.html#compression-and-compressionoptions-options) <hr/> ### compressionLevel Compression level `Type` - number **Remarks:** [ExportBaseOptions.compression](/refs/Interface/ExportBaseOptions#compression) `DEFLATE`{/* */}, enter the compression level as an integer from `1` \~ `9`{/* */}. See [JSZip.compressionOptions](https://stuk.github.io/jszip/documentation/api_jszip/generate_async.html#compression-and-compressionoptions-options) <hr/>

<hr/>

### compressionLevel

Compression level

`Type` - number

**Remarks:**

When [ExportBaseOptions.compression](/refs/Interface/ExportBaseOptions#compression) is `DEFLATE`{/* */}, the compression level

Enter an integer from `1` \~ `9`{/* */}. See [JSZip.compressionOptions](https://stuk.github.io/jszip/documentation/api_jszip/generate_async.html#compression-and-compressionoptions-options)

<hr/>

### coreProperties

You can specify the properties of the Excel file.

`Type` - [ExportCoreProperties](/refs/Interface/ExportCoreProperties)

<hr/>

### done

Callback to be performed when export is complete

`Type` - [ExportSimpleCallback](/refs/realgrid#exportsimplecallback)

**Remarks:**

If [ExportBaseOptions.target](/refs/Interface/ExportBaseOptions#target) is [ExportTarget.STREAM](/refs/realgrid#exporttarget), Base64 encoded data is delivered.

<hr/>

### exportMemo

Model containing settings related to exporting cell memos

`Type` - [ExportMemo](/refs/Interface/ExportMemo)

<hr/>

### fileName

File name when exporting

`Type` - string

**Example:**

`'gridExportSample.xlsx'`

<hr/>

### nullDateText

Value expressed when the value of the Datetime field is `null`

`Type` - string

<hr/>

### params

Parameters to be delivered to the server when the target is “remote”

`Type` - [ConfigObject](/refs/realgrid#configobject)

**Remarks:**

Used when there is additional information to be transmitted to the server when the target is remote.

**Example:**


```js
var params = {
 userId: "userId",
 param1: "param1",
 param2: "param2"
}
gridView.exportGrid({type:"excel", target:"local", params:params})
```

<hr/>

### prepareProgress

`Type` - number

<hr/>

### progressCallback

Callback for user Progress Bar

`Type` - [ProgressCallback](/refs/realgrid#progresscallback)

**Remarks:**

When progressCallback is set, the progressBar inside the Grid is not displayed.

<hr/>

### progressMessage

Message displayed when using the progress bar

`Type` - string

**Remarks:**


<hr/>

### showProgress

Whether to display progress bar when exporting

`Type` - boolean

<hr/>

### streamFiles

Whether to stream when creating a file

`Type` - boolean

**Remarks:**

If `false`{/* */}, store the compressed file in memory and add `crc32`{/* */} to the beginning of the file. If `true`{/* */}, add a data descriptor to the end of the file. See [JSZip.streamFiles](https://stuk.github.io/jszip/documentation/api_jszip/generate_async.html#streamfiles-option).

<hr/>

### target

Destination/path to export to

`Type` - [ExportTarget](/refs/realgrid#exporttarget) \| string

<hr/>

### type

Type to export

`Type` - [ExportType](/refs/realgrid#exporttype) \| string

<hr/>

### url

The URL of the server that receives the document stream exported by the grid and then downloads it back to the user's computer.

`Type` - string

<hr/>

### useComputedStyle

Specifies whether to extract cell styles based on browser-computed CSS styles and apply them to Excel styles.

`Type` - boolean

<hr/>

### zip

Specifies the JSZip module.

When using JSZip by importing, specify the imported module.

`Type` - any

<hr/>