GridExportOptions

Configuration model for grid export

Signature:

export interface GridExportOptions extends ExportOptions

Extends: ExportOptions

Remarks

Inherits ExportOptions.

[Superclass]

ExportOptions

Properties

Properties Desc

allColumns

Whether to export hidden columns to Excel as well

Type - boolean

Remarks:

Can only be used when Export type is Excel.

allItems

Whether to export hidden rows to Excel as well

Type - boolean

Remarks:

Can only be used when Export type is Excel.

applyDynamicStyles

Whether to export by applying Dynamic Styles

Type - boolean

Remarks:

Can only be used when Export type is Excel.

applyFitStyle

Whether to export with the width applied with GridFitStyle

Type - boolean

Remarks:

Can only be used when Export type is Excel.

applyFixed

Whether to fix the frame if there is a fixed column or row

Type - boolean

Remarks:

If there is a fixed Column or fixed Row, set Fix Frame when exporting to Excel.

bulkImageDownload

When downloading images to be included in Excel, download them one by one or in batches.

Type - boolean

Remarks:

If true, download in batches, and if false, download one by one.

checkBar

Whether to include the grid checkbar area

Type - string

Remarks:

When set to 'default', it is included according to the current status displayed in the grid, when set to 'hidden', it is not included, and when set to 'visible', it is included.

Can only be used when Export type is Excel.

checkMark

How to display the selected value when exporting the grid check bar area

Type - string

Remarks:

Can only be used when Export type is Excel.

documentSubtitle

Subtitle of Excel document when exporting

Type - DocumentTitle

documentTail

Footer in Excel document when exporting

Type - DocumentTitle

documentTitle

Title of Excel document when exporting

Type - DocumentTitle

exportGrids

GridBase control of the grid to be exported and the name of the Excel sheet to be exported

Type - { grid: GridBase; sheetName: string; }[]

Remarks:

If not specified, the grid instance that called the method is designated as a GridBase control and exported to 'sheet1'.

Can only be used when Export type is Excel.

exportImage

Whether to include images when exporting to Excel

Type - boolean

Remarks:

If true, images displayed using imageRenderer and iconRenderer are included in Excel. If displayOptions.rowHeight is -1, it is displayed at the top of the cell. In case of IE, Promise-related polyFill must be added.

exportLayout

Layout used when the shape you want to export to Excel is different from the screen.

Type - ConfigObject[]

Remarks:

Specify the desired layout and export it to Excel. Can only be used when Export type is Excel.

exportLink

Whether to export the URL of LinkCellRenderer

Type - boolean

Remarks:

If true is specified, the URL will be exported as HYPERLINK. Can only be used when Export type is Excel.

exportSeriesColumn

SeriesWhether to export the column

Type - boolean

Remarks:

If set to true, sparkLine, sparkColumn, and sparkWinLoss columns are exported.

The DataColumn referenced by Spark columns must be included and exported, and the name property of DataColumn must be specified. .

Additionally, DataColumn must be displayed in the order in which they are referenced.

Can only be used when Export type is Excel.

exportShape

Whether to include shapes of ActualTargetBullt and Bar renderers when exporting to Excel

Type - boolean

Remarks:

If true, ActualTargetBullt and Bar renderers are exported as shapes.

exportTemplate

Whether to export TemplateCellRenderer

Type - boolean

Remarks:

If specified as true, TemplateCellRenderer exports a string with tags removed from the rendered HTML. Can only be used when Export type is Excel.

fillMergeFooterValue

Whether to output the value of the GroupFooter or GroupSummary cell when the grid is in the row merge grouping state and GridExportOptions.separateRows is true

Type - boolean

footer

Whether to include grid footer area

Type - string

Remarks:

When set to 'default', it is included according to the current status displayed in the grid, when set to 'hidden', it is not included, and when set to 'visible', it is included.

Can only be used when Export type is Excel.

header

Whether to include the grid header area

Type - string

Remarks:

When set to 'default', it is included according to the current status displayed in the grid, when set to 'hidden', it is not included, and when set to 'visible', it is included.

Export type is available only when Excel.

headerSummary

Whether to include the grid Header Summary area

Type - string

Remarks:

When set to 'default', it is included according to the current status displayed in the grid, when set to 'hidden', it is not included, and when set to 'visible', it is included.

Export type is available only when Excel.

hiddenColumns

Hidden Column in Excel

Type - string[]

Remarks:

Hidden state when exported to Excel Specifies the column to be exported. Export type is available only when Excel.

hideColumns

Arrange columns that you do not want to export to Excel

Type - string[]

Remarks:

visible is true, but specifies a column that you do not want to export. Export type is available only when Excel.

indenting

Indentation when exporting row grouping and tree grid data

Type - boolean

Remarks:

Export type is available only when Excel.

indicator

Whether to include the grid indicator area

Type - string

Remarks:

When set to 'default', it is included according to the current status displayed in the grid, when set to 'hidden', it is not included, and when set to 'visible', it is included.

Export type is available only when Excel.

indicatorValue

When exporting the grid indicator area, how to display the value of the area

Type - string

Remarks:

In the case of 'default', it is displayed starting from 1 in the case of 'row' and the unique number of the row in the case of 'item', depending on the current status displayed in the grid.

Export type is available only when Excel.

layoutExpand

Whether to expand when exporting a column set to expandable

Type - ExportLayoutExpand | string

Remarks:

Set when exporting in a collapsed or expanded state regardless of the expand state of the screen.

linear

Whether to ungroup columns and export to Excel

Type - boolean

Remarks:

Export type is available only when Excel.

lookupDisplay

Whether to export the lookupDisplay value of the column as the displayed value.

Type - boolean

Remarks:

Export type is available only when Excel.

onlyCheckedItems

Whether to export only checked rows to Excel

Type - boolean

Remarks:

It is not supported in grouped rows or TreeView.

pagingAllItems

When exporting to Excel, whether to export all data, including data that is paged and not visible.

Type - boolean

Remarks:

Export type is available only when Excel.

protectPassword

Enter the unlock password when using sheet protection.

Type - string

Remarks:

Only English letters/numbers/special characters must be entered. When entering Korean, sheet protection cannot be released.

protectProperties

Specifies properties to allow or lock when using sheet protection.

Type - SheetProtectProperties

separateRows

Whether to unmerge when exporting to Excel

Type - boolean

Remarks:

Export type is available only when Excel.

sheetAttrs

Attribute to add to sheet when exporting to Excel

Type - ConfigObject

Remarks:

Add the value entered in json format as an attribute of the sheetView element.

Example:

var sheetAttrs = {
 showGridLines: "0", // Hide grid lines
 view: "pageBreakPreview" // Preview page break
}
gridView.exportGrid({type:"excel", target:"local", sheetAttrs:sheetAttrs})

sheetName

Excel sheet name

Type - string

Remarks:

Export type is available only when Excel.

sheetProtect

Protect the contents of locked cells and worksheets

Type - boolean

Remarks:

Set sheet protection to prevent other users from modifying locked cells.

showColumns

Arrangement of columns to export to Excel

Type - string[]

Remarks:

Although visible is false, it specifies the column you want to export. Export type is available only when Excel.

showLevelOutline

When exporting row-grouped data, whether to display the tie line between groups located on the left side of Excel.

Type - boolean

Remarks:

Export type is available only when Excel.

stylePrefix

Used when there is a prefix to find the style when exporting to Excel.

Type - string

Remarks:

Used when the provided style has a className to limit the area.

unCheckMark

How to display unselected values when exporting the grid check bar area

Type - string

Remarks:

Export type is available only when Excel.

userCells

custom output

Type - UserExportCell[]

Remarks:

Used to output content other than the grid in the exported Excel file.

You should refrain from using the area where the grid outputs.

userCellsCallback

If the callback userCells called to create a user output cell is specified, the callback is ignored.

Type - UserCellsCallback

Remarks:

Used to change the position of a cell by referring to the number of columns and rows displayed.

xOffset

Specifies the number of left margin columns.

Type - number

Remarks:

When printing the grid, it is printed starting from the specified number of columns.

xOffsetWidth

Specifies the width of the left margin column.

Type - number

Remarks:

Specify in pixel units.

yOffset

Specifies the number of top margin lines.

Type - number

Remarks:

When printing the grid, it is printed starting from the specified number of rows.