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

## GridOptions

Complete grid configuration information

**Signature:**

```typescript
export interface GridOptions

```

## Remarks

Resetting subcomponents is not possible with [GridBase.getOptions()](/refs/Class/GridBase#getoptions).

Resetting subcomponents is possible with [GridBase.setOptions()](/refs/Class/GridBase#setoptions).

Practical use is in [GridView](/refs/Class/GridView){/* ​​*/} and [TreeView](/refs/Class/TreeView).

## Example

```js
let options = {
summaryMode: 'aggregate',
display: {
columnResizable : false
}
};
gridView.setOptions(options);
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [checkBar](/refs/Interface/GridOptions#checkbar) | [CheckBar](/refs/Interface/CheckBar) | Configuration model related to checkbars |
| [copy](/refs/Interface/GridOptions#copy) | [CopyOptions](/refs/Interface/CopyOptions) | Configuration model for copying grid contents to the clipboard |
| [dataDrop](/refs/Interface/GridOptions#datadrop) | [DataDropOptions](/refs/Interface/DataDropOptions) | Configuration model for handling data dragged from the grid |
| [display](/refs/Interface/GridOptions#display) | [DisplayOptions](/refs/Interface/DisplayOptions) | Configuration model for display information managed at the grid level |
| [edit](/refs/Interface/GridOptions#edit) | [EditOptions](/refs/Interface/EditOptions) | Configuration model for data editing in the grid |
| [editor](/refs/Interface/GridOptions#editor) | [EditorOptions](/refs/Interface/EditorOptions) | Configuration model for editor information managed at the grid level |
| [filtering](/refs/Interface/GridOptions#filtering) | [FilteringOptions](/refs/Interface/FilteringOptions) | Configuration model related to column filtering |
| [filterMode](/refs/Interface/GridOptions#filtermode) | [FilterMode](/refs/realgrid#filtermode) | Filter operation mode after data modification |
| [filterPanel](/refs/Interface/GridOptions#filterpanel) | [FilterPanel](/refs/Interface/FilterPanel) | Inline filter pane configuration information |
| [fixed](/refs/Interface/GridOptions#fixed) | [FixedOptions](/refs/Interface/FixedOptions) | Configuration model for the grid's fixed row and column areas |
| [footer](/refs/Interface/GridOptions#footer) | [GridFooter](/refs/Interface/GridFooter) | Single configuration model for the footer area |
| [footers](/refs/Interface/GridOptions#footers) | [GridFooterCollection](/refs/Interface/GridFooterCollection) | Collection model for the grid footer area |
| [format](/refs/Interface/GridOptions#format) | [FormatOptions](/refs/Interface/FormatOptions) | Configuration model for the conversion format of data field values |
| [header](/refs/Interface/GridOptions#header) | [GridHeader](/refs/Interface/GridHeader) | Configuration model for the header area |
| [headerSummaries](/refs/Interface/GridOptions#headersummaries) | [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) | Collection model for the header summary area |
| [headerSummary](/refs/Interface/GridOptions#headersummary) | [HeaderSummary](/refs/Interface/HeaderSummary) | Single configuration model for the header summary area |
| [hideDeletedRows](/refs/Interface/GridOptions#hidedeletedrows) | boolean | Whether to hide deleted rows when the DataProvider's softDeleting is `true`{/* */} |
| [mobile](/refs/Interface/GridOptions#mobile) | [MobileOptions](/refs/Interface/MobileOptions) | |
| [paste](/refs/Interface/GridOptions#paste) | [PasteOptions](/refs/Interface/PasteOptions) | Configuration model for pasting data from the clipboard into the grid |
| [rowIndicator](/refs/Interface/GridOptions#rowindicator) | [RowIndicator](/refs/Interface/RowIndicator) | Configuration model for the grid's indicator |
| [sorting](/refs/Interface/GridOptions#sorting) | [SortingOptions](/refs/Interface/SortingOptions) | Configuration model for data sorting |
| [sortMode](/refs/Interface/GridOptions#sortmode) | [SortMode](/refs/realgrid#sortmode) | Sorting behavior mode after data modification |
| [stateBar](/refs/Interface/GridOptions#statebar) | [StateBar](/refs/Interface/StateBar) | Configuration model related to the status bar that displays the status of rows |
| [summaryMode](/refs/Interface/GridOptions#summarymode) | [SummaryMode](/refs/realgrid#summarymode) | How to calculate the sum of each column in the grid |
| [undoable](/refs/Interface/GridOptions#undoable) | boolean | Whether to undo grid edits |

## Properties Desc

### checkBar

Configuration model related to checkbars

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

<hr/>

### copy

Configuration model for copying grid contents to the clipboard

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

<hr/>

### dataDrop

Configuration model for handling data dragged from the grid

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

<hr/>

### display

Configuration model for display information managed at the grid level

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

<hr/>

### edit

Configuration model for editing data in the grid

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

<hr/>

### editor

Configuration model for editor information managed at the grid level.

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

<hr/>

### filtering

Configuration model related to column filtering.

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

<hr/>

### filterMode

Filter operation mode after data modification.

`Type` - [FilterMode](/refs/realgrid#filtermode)

<hr/>

### filterPanel

Inline filter window configuration information.

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

<hr/>

### fixed

Configuration model for the grid's fixed row and column areas.

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

<hr/>

### footer

A single configuration model for the footer area.

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

<hr/>

### footers

A collection model for the grid footer area.

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

<hr/>

### format

Configuration model for the conversion format of data field values

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

<hr/>

### header

Configuration model for the header area

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

<hr/>

### headerSummaries

Collection model for the header summary area

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

<hr/>

### headerSummary

A single configuration model for the header summary area

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

<hr/>

### hideDeletedRows

Whether deleted rows are hidden when the DataProvider's softDelete is `true`{/* */}

`Type` - boolean

<hr/>

### mobile

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

<hr/>

### paste

Configuration model for pasting data from the clipboard into the grid

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

<hr/>

### rowIndicator

Configuration model for the grid's indicator

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

<hr/>

### sorting

Configuration model for data sorting

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

<hr/>

### sortMode

Sorting mode after data modification

`Type` - [SortMode](/refs/realgrid#sortmode)

<hr/>

### stateBar

Configuration model related to the status bar displaying the row status.

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

<hr/>

### summaryMode

How to calculate the sum of each column in the grid.

`Type` - [SummaryMode](/refs/realgrid#summarymode)

<hr/>

### undoable

Whether grid edits can be undo'd.

`Type` - boolean

**Remarks:**

If `true`{/* */}, edits can be undoed/redoed before commit.

<hr/>