ExportOptions
Common model for grid and data export settings
Signature:
export interface ExportOptions extends ExportBaseOptionsExtends: ExportBaseOptions
Remarks
Inherits ExportBaseOptions. GridExportOptions, DataExportOptions are submodels.
[Superclass]
[subclass]
Events
| Property | Type | Description |
|---|---|---|
| booleanCallback | ExportValueCallback | Callback to be performed when outputting a boolean field |
| datetimeCallback | ExportValueCallback | Callback to be performed when outputting datetime field |
| numberCallback | ExportValueCallback | Callback to be performed when number field is output |
| objectCallback | ExportValueCallback | Callback to be performed when outputting object field |
| textCallback | ExportValueCallback | Callback to be performed when outputting text field |
Properties
| Property | Type | Description |
|---|---|---|
| booleanFormat | string | Format when in Boolean format |
| count | number | Number of rows to export |
| datetimeFormat | string | Format when in date format |
| replaceCrText | string | String to be replaced if cr(Carriage Return) is present |
| replaceLfText | string | String to be replaced if lf (Line Feed) exists |
| seperator | string | separator |
| start | number | Row to start exporting |
| trailPointZeroFormat | string | Format applied when the format is numeric and the decimal point is 0 |
Events Desc
booleanCallback
Callback to be performed when outputting a boolean field
Type - ExportValueCallback
datetimeCallback
Callback to be performed when outputting a datetime field
Type - ExportValueCallback
numberCallback
Callback to be performed when outputting the number field
Type - ExportValueCallback
objectCallback
Callback to be performed when outputting object field
Type - ExportValueCallback
textCallback
Callback to be performed when outputting text field
Type - ExportValueCallback
Remarks:
It was created to enable calculations in Excel when exporting time values in text type.
Properties Desc
booleanFormat
Format when in Boolean format
Type - string
count
Number of rows to export
Type - number
Remarks:
If specified as -1, the entire row will be exported.
datetimeFormat
Format when in date format
Type - string
replaceCrText
String to be replaced if cr(Carriage Return) is present
Type - string
replaceLfText
String to be replaced if lf (Line Feed) is present
Type - string
seperator
Separator
Type - string
Remarks:
Separator when exporting to csv
start
Row to start exporting
Type - number
trailPointZeroFormat
Format applied when the decimal point is 0 in numeric format
Type - string
Remarks:
Not applied when DataColumn.excelFormat is specified or when numberFormat or excelFormat is specified in the dynamic style.