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


## GridExportOptions

Configuration model for grid export

**Signature:**

```typescript
export interface GridExportOptions extends ExportOptions
```
**Extends:** [ExportOptions](/refs/Interface/ExportOptions)

## Remarks

Inherits [ExportOptions](/refs/Interface/ExportOptions).

\[Superclass\]

[ExportOptions](/refs/Interface/ExportOptions)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [allColumns](/refs/Interface/GridExportOptions#allcolumns) | boolean | Whether to export hidden columns to Excel |
| [allItems](/refs/Interface/GridExportOptions#allitems) | boolean | Whether to export hidden rows to Excel |
| [applyDynamicStyles](/refs/Interface/GridExportOptions#applydynamicstyles) | boolean | Whether to export by applying Dynamic Styles |
| [applyFitStyle](/refs/Interface/GridExportOptions#applyfitstyle) | boolean | Whether to export with width applied with [GridFitStyle](/refs/realgrid#gridfitstyle) |
| [applyFixed](/refs/Interface/GridExportOptions#applyfixed) | boolean | Whether to fix the frame if there is a fixed column or row |
| [bulkImageDownload](/refs/Interface/GridExportOptions#bulkimagedownload) | boolean | When downloading images to include in Excel, download them one by one or in batches. |
| [checkBar](/refs/Interface/GridExportOptions#checkbar) | string | Whether to include grid checkbar area |
| [checkMark](/refs/Interface/GridExportOptions#checkmark) | string | How to display the selection value when exporting the grid check bar area |
| [documentSubtitle](/refs/Interface/GridExportOptions#documentsubtitle) | [DocumentTitle](/refs/Interface/DocumentTitle) | Subtitle of Excel document when exported |
| [documentTail](/refs/Interface/GridExportOptions#documenttail) | [DocumentTitle](/refs/Interface/DocumentTitle) | Footer in Excel document when exporting |
| [documentTitle](/refs/Interface/GridExportOptions#documenttitle) | [DocumentTitle](/refs/Interface/DocumentTitle) | Title of Excel document when exported |
| [exportGrids](/refs/Interface/GridExportOptions#exportgrids) | \{ grid: [GridBase](/refs/Class/GridBase){/* */}; sheetName: string; \}\[\] | The name of the GridBase control of the grid to be exported and the Excel sheet to be exported |
| [exportImage](/refs/Interface/GridExportOptions#exportimage) | boolean | Whether to include images when exporting to Excel |
| [exportLayout](/refs/Interface/GridExportOptions#exportlayout) | [ConfigObject](/refs/realgrid#configobject){/* */}\[\] | layout used when the shape to be exported to Excel is different from the screen |
| [exportLink](/refs/Interface/GridExportOptions#exportlink) | boolean | Whether to export the URL of LinkCellRenderer |
| [exportSeriesColumn](/refs/Interface/GridExportOptions#exportseriescolumn) | boolean | [Series](/refs/Interface/SeriesColumn){/* */}Whether to export the column |
| [exportShape](/refs/Interface/GridExportOptions#exportshape) | boolean | Whether to include the shapes of the ActualTargetBullt renderer and the Bar renderer when exporting to Excel |
| [exportTemplate](/refs/Interface/GridExportOptions#exporttemplate) | boolean | Whether to export TemplateCellRenderer |
| [fillMergeFooterValue](/refs/Interface/GridExportOptions#fillmergefootervalue) | boolean | Whether to output the value of the GroupFooter or GroupSummary cell when the grid is in the row merge grouping state and [GridExportOptions.separateRows](/refs/Interface/GridExportOptions#separaterows){/* */} is `true`{/* */} |
| [footer](/refs/Interface/GridExportOptions#footer) | string | Whether to include grid footer area |
| [header](/refs/Interface/GridExportOptions#header) | string | Whether to include grid header area |
| [headerSummary](/refs/Interface/GridExportOptions#headersummary) | string | Whether to include the grid Header Summary area |
| [hiddenColumns](/refs/Interface/GridExportOptions#hiddencolumns) | string\[\] | Hidden Column in Excel |
| [hideColumns](/refs/Interface/GridExportOptions#hidecolumns) | string\[\] | Arrange columns that you do not want to export to Excel |
| [indenting](/refs/Interface/GridExportOptions#indenting) | boolean | Whether to indent row grouping and tree grid data when exporting |
| [indicator](/refs/Interface/GridExportOptions#indicator) | string | Whether to include grid indicator area |
| [indicatorValue](/refs/Interface/GridExportOptions#indicatorvalue) | string | When exporting the grid indicator area, how to display the value of the area |
| [layoutExpand](/refs/Interface/GridExportOptions#layoutexpand) | [ExportLayoutExpand](/refs/realgrid#exportlayoutexpand) \| string | Whether to expand when exporting a column set to expandable |
| [linear](/refs/Interface/GridExportOptions#linear) | boolean | Whether to ungroup columns and export to Excel |
| [lookupDisplay](/refs/Interface/GridExportOptions#lookupdisplay) | boolean | Whether to export the lookupDisplay value of the column as the displayed value |
| [onlyCheckedItems](/refs/Interface/GridExportOptions#onlycheckeditems) | boolean | Whether to export only checked rows to Excel |
| [outlineSummaryBelow](/refs/Interface/GridExportOptions#outlinesummarybelow) | boolean | Whether the group summary row will be positioned below the group when exporting to Excel. |
| [outlineSummaryRight](/refs/Interface/GridExportOptions#outlinesummaryright) | boolean | Whether the group summary column will be positioned to the right of the group when exporting to Excel. |
| [pagingAllItems](/refs/Interface/GridExportOptions#pagingallitems) | boolean | Whether to export all data, including data that is not paged and visible when exporting to Excel |
| [protectPassword](/refs/Interface/GridExportOptions#protectpassword) | string | Enter the unlock password when using sheet protection. |
| [protectProperties](/refs/Interface/GridExportOptions#protectproperties) | [SheetProtectProperties](/refs/Interface/SheetProtectProperties) | Specifies properties to allow or lock when using sheet protection. |
| [separateRows](/refs/Interface/GridExportOptions#separaterows) | boolean | Whether to unmerge when exporting to Excel |
| [sheetAttrs](/refs/Interface/GridExportOptions#sheetattrs) | [ConfigObject](/refs/realgrid#configobject) | Attribute to add to sheet when exporting to Excel |
| [sheetName](/refs/Interface/GridExportOptions#sheetname) | string | Excel sheet name |
| [sheetProtect](/refs/Interface/GridExportOptions#sheetprotect) | boolean | Protect the contents of locked cells and worksheets |
| [showColumns](/refs/Interface/GridExportOptions#showcolumns) | string\[\] | Arrangement of columns to export to Excel |
| [showLevelOutline](/refs/Interface/GridExportOptions#showleveloutline) | boolean | When exporting row-grouped data, whether to display the tie line between groups located on the left side of Excel |
| [stylePrefix](/refs/Interface/GridExportOptions#styleprefix) | string | Used when there is a prefix to find the style when exporting to Excel |
| [unCheckMark](/refs/Interface/GridExportOptions#uncheckmark) | string | How to display unselected values when exporting the grid check bar area |
| [userCells](/refs/Interface/GridExportOptions#usercells) | [UserExportCell](/refs/Interface/UserExportCell){/* */}\[\] | custom output |
| [userCellsCallback](/refs/Interface/GridExportOptions#usercellscallback) | [UserCellsCallback](/refs/realgrid#usercellscallback) | If the callback userCells called to create a user output cell is specified, the callback is ignored. |
| [xOffset](/refs/Interface/GridExportOptions#xoffset) | number | Specifies the number of left margin columns. |
| [xOffsetWidth](/refs/Interface/GridExportOptions#xoffsetwidth) | number | Specifies the width of the left margin column. |
| [yOffset](/refs/Interface/GridExportOptions#yoffset) | number | Specifies the number of top margin lines. |

## Properties Desc

### allColumns

Whether to export hidden columns to Excel as well

`Type` - boolean

**Remarks:**

Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### allItems

Whether to export hidden rows to Excel as well

`Type` - boolean

**Remarks:**

Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### applyDynamicStyles

Whether to export by applying Dynamic Styles

`Type` - boolean

**Remarks:**

Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### applyFitStyle

Whether to export with the width applied with [GridFitStyle](/refs/realgrid#gridfitstyle)

`Type` - boolean

**Remarks:**

Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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.

<hr/>

### 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.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### checkMark

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

`Type` - string

**Remarks:**

Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### documentSubtitle

Subtitle of Excel document when exporting

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

<hr/>

### documentTail

Footer in Excel document when exporting

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

<hr/>

### documentTitle

Title of Excel document when exporting

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

<hr/>

### exportGrids

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

`Type` - \{ grid: [GridBase](/refs/Class/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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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.

<hr/>

### exportLayout

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

`Type` - [ConfigObject](/refs/realgrid#configobject){/* */}\[\]

**Remarks:**

Specify the desired layout and export it to Excel. Can only be used when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### exportSeriesColumn

[Series](/refs/Interface/SeriesColumn){/* */}Whether to export the column

`Type` - boolean

**Remarks:**

If set to `true`{/* */}, `sparkLine`{/* */}, `sparkColumn`{/* */}, and `sparkWinLoss` columns are exported.

The [DataColumn](/refs/Interface/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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/GridExportOptions#separaterows){/* */} is `true`{/* */}

`Type` - boolean

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### hiddenColumns

Hidden Column in Excel

`Type` - string\[\]

**Remarks:**

Hidden state when exported to Excel Specifies the column to be exported. [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### indenting

Indentation when exporting row grouping and tree grid data

`Type` - boolean

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### layoutExpand

Whether to expand when exporting a column set to expandable

`Type` - [ExportLayoutExpand](/refs/realgrid#exportlayoutexpand) \| string

**Remarks:**

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

<hr/>

### linear

Whether to ungroup columns and export to Excel

`Type` - boolean

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### lookupDisplay

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

`Type` - boolean

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### onlyCheckedItems

Whether to export only checked rows to Excel

`Type` - boolean

**Remarks:**

It is not supported in grouped rows or [TreeView](/refs/Class/TreeView).

<hr/>

### outlineSummaryBelow

Whether the group summary row will be located below the group when exporting to Excel

`Type` - boolean

**Remarks:**

Only available when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

When set to `true`{/* */}, the summary row will be displayed below the last row of the group. When set to `false`{/* */}, the summary row will be displayed above the first row of the group.

<hr/>

### outlineSummaryRight

Whether the group summary column is located on the right side of the group when exporting to Excel

`Type` - boolean

**Remarks:**

Only available when [Export type](/refs/Interface/ExportBaseOptions#type){/* */} is [Excel](/refs/realgrid#exporttype){/* */}.

When set to `true`{/* */}, the summary column is displayed on the right side of the last column of the group. When set to `false`{/* */}, the summary column is displayed on the left side of the first column of the group.

<hr/>

### pagingAllItems

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

`Type` - boolean

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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.

<hr/>

### protectProperties

Specifies properties to allow or lock when using sheet protection.

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

<hr/>

### separateRows

Whether to unmerge when exporting to Excel

`Type` - boolean

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### sheetAttrs

Attribute to add to sheet when exporting to Excel

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

**Remarks:**

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

**Example:**


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

<hr/>

### sheetName

Excel sheet name

`Type` - string

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### sheetProtect

Protect the contents of locked cells and worksheets

`Type` - boolean

**Remarks:**

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

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### 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.

<hr/>

### unCheckMark

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

`Type` - string

**Remarks:**

[Export type](/refs/Interface/ExportBaseOptions#type){/* */} is available only when [Excel](/refs/realgrid#exporttype){/* */}.

<hr/>

### userCells

custom output

`Type` - [UserExportCell](/refs/Interface/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.

<hr/>

### userCellsCallback

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

`Type` - [UserCellsCallback](/refs/realgrid#usercellscallback)

**Remarks:**

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

<hr/>

### 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.

<hr/>

### xOffsetWidth

Specifies the width of the left margin column.

`Type` - number

**Remarks:**

Specify in pixel units.

<hr/>

### 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.

<hr/>