ExportBaseOptions

Model based settings for grid and data export

Signature:

export interface ExportBaseOptions

Remarks

GridExportOptions, DataExportOptions are submodels.

[subclass]

GridExportOptions

DataExportOptions

Properties

Properties Desc

compression

Compression method when creating a file

Type - 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 (opens in a new tab)

compressionLevel

Compression level

Type - number

Remarks:

When ExportBaseOptions.compression is DEFLATE, the compression level

Enter an integer from 1 ~ 9. See JSZip.compressionOptions (opens in a new tab)

coreProperties

You can specify the properties of the Excel file.

Type - ExportCoreProperties

done

Callback to be performed when export is complete

Type - ExportSimpleCallback

Remarks:

If ExportBaseOptions.target is ExportTarget.STREAM, Base64 encoded data is delivered.

exportMemo

Model containing settings related to exporting cell memos

Type - ExportMemo

fileName

File name when exporting

Type - string

Example:

'gridExportSample.xlsx'

nullDateText

Value expressed when the value of the Datetime field is null

Type - string

params

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

Type - ConfigObject

Remarks:

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

Example:

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

prepareProgress

Type - number

progressCallback

Callback for user Progress Bar

Type - ProgressCallback

Remarks:

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

progressMessage

Message displayed when using the progress bar

Type - string

Remarks:

showProgress

Whether to display progress bar when exporting

Type - boolean

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 (opens in a new tab).

target

Destination/path to export to

Type - ExportTarget | string

type

Type to export

Type - ExportType | string

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

zip

Specifies the JSZip module.

When using JSZip by importing, specify the imported module.

Type - any