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


## GridBase

GridBase is the base class of [GridView](/refs/Class/GridView){/* */} and [TreeView](/refs/Class/TreeView){/* */}.

**Signature:**

```typescript
export declare abstract class GridBase
```

## Remarks

All properties and methods of GridBase can be called only from subclasses that inherit it.

\[subclass\]

[GridView](/refs/Class/GridView)

[TreeView](/refs/Class/TreeView)

## Events
| Property | Type | Description |
| --- | --- | --- |
| [onCellButtonClicked](/refs/Class/GridBase#oncellbuttonclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, column: [GridColumn](/refs/ Interface/GridColumn){/* */}) =&gt; void | Called when the user clicks the action button inside a data cell. |
| [onCellClicked](/refs/Class/GridBase#oncellclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, clickData: [ClickData](/refs/Interface/ClickData){/* */}) =&gt; void | A callback indicating that a grid cell has been clicked |
| [onCellDblClicked](/refs/Class/GridBase#oncelldblclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, clickData: [ClickData](/refs/Interface/ClickData){/* */}) =&gt; void | A callback indicating that a grid cell has been double-clicked |
| [onCellEdited](/refs/Class/GridBase#oncelledited) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, field: number) =&gt; void | A callback notifying that a field value of the edit item being modified or added has been edited |
| [onCellItemClicked](/refs/Class/GridBase#oncellitemclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, clickData: [ClickData](/refs/ Interface/ClickData){/* */}) =&gt; boolean | A callback notifying that an element contained in a grid cell has been clicked |
| [onCellPasting](/refs/Class/GridBase#oncellpasting) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any, editResult: [EditResult](/refs/Interface/EditResult){/* */}) =&gt; boolean | A callback that determines what to paste into a cell |
| [onColumnCheckedChanged](/refs/Class/GridBase#oncolumncheckedchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, checked: boolean) =&gt; void | A callback notifying that the user clicks a column header checkbox |
| [onColumnPropertyChanged](/refs/Class/GridBase#oncolumnpropertychanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, property: string, newValue: any, oldValue : any) =&gt; void | |
| [onCommandStackChanged](/refs/Class/GridBase#oncommandstackchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, undoable: boolean, redoable: boolean) =&gt; void | A callback notifying that the CommandStack has changed |
| [onContextMenuItemClicked](/refs/Class/GridBase#oncontextmenuitemclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, item: [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}, clickData: [ClickData](/refs/ Interface/ClickData){/* */}) =&gt; void | A callback notifying the click of a context menu item added via [setContextMenu()](/refs/Class/GridBase#setcontextmenu) |
| [onContextMenuPopup](/refs/Class/GridBase#oncontextmenupopup) | (grid: [GridBase](/refs/Class/GridBase){/* */}, x: number, y: number, clickData: [ClickData](/refs/Interface/ClickData){/* */}, menu : string, rightClick: boolean) =&gt; boolean \| string | A callback that determines the display of the ContextMenu with its coordinates |
| [onCopy](/refs/Class/GridBase#oncopy) | (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection) \| [Selection](/refs/Interface/Selection){/* */}\[\], event: ClipboardEvent) =&gt; boolean | A callback that determines copying with the control + c keys |
| [onCurrentChanged](/refs/Class/GridBase#oncurrentchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, newIndex: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void | A callback notifying the change in the position of the grid's focus cell |
| [onCurrentChanging](/refs/Class/GridBase#oncurrentchanging) | (grid: [GridBase](/refs/Class/GridBase){/* */}, oldIndex: [CellIndex](/refs/Interface/CellIndex){/* */}, newIndex: [CellIndex](/refs/ Interface/CellIndex){/* */}) =&gt; boolean | A callback that determines the change in position of the grid's focus cell |
| [onCurrentRowChanged](/refs/Class/GridBase#oncurrentrowchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, oldRow: number, newRow: number) =&gt; void | A callback notifying that the position of a data row has changed |
| [onCut](/refs/Class/GridBase#oncut) | (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection) \| [Selection](/refs/Interface/Selection){/* */}\[\], event: ClipboardEvent) =&gt; boolean | Callback to determine cut with control + x |
| [onDataLoadComplated](/refs/Class/GridBase#ondataloadcomplated) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | A callback that fires after the grid refresh is complete after executing dataProvider.setRows() |
| [onEditCanceled](/refs/Class/GridBase#oneditcanceled) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void | A callback notifying that the user enters the ESCAPE key while editing or [cancel()](/refs/Class/GridBase#cancel) is called to cancel editing. |
| [onEditChange](/refs/Class/GridBase#oneditchange) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any) =&gt; void | Callback notifying that the value of an item has changed due to the user entering a key, etc. |
| [onEditCommit](/refs/Class/GridBase#oneditcommit) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, oldValue: any, newValue: any) = &gt; boolean | A callback that determines whether user input is reflected in the cell |
| [onEditRowChanged](/refs/Class/GridBase#oneditrowchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, field: number, oldValue: any, newValue: any) =&gt; void | A callback notifying that the value changed by user input has been reflected in the row |
| [onEditRowPasted](/refs/Class/GridBase#oneditrowpasted) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, fields: number\[\], oldValues: any\[\], newValues: any\[\]) =&gt; void | A callback indicating that a grid cell has been pasted |
| [onEditSearch](/refs/Class/GridBase#oneditsearch) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, text: string) =&gt; void | A callback indicating that a search has been made |
| [onErrorClicked](/refs/Class/GridBase#onerrorclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, error: string) =&gt; void | A callback notifying that an error window in the grid has been clicked |
| [onFiltering](/refs/Class/GridBase#onfiltering) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [DataColumn](/refs/Interface/DataColumn){/* */}) =&gt; boolean | Callback to determine filtering |
| [onFilteringChanged](/refs/Class/GridBase#onfilteringchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, filter: [ColumnFilter](/refs/Interface/ColumnFilter){/* */}, reset: boolean) =&gt; void | A callback that notifies that a column has filters set and that the state of the filter has changed. |
| [onGetEditValue](/refs/Class/GridBase#ongeteditvalue) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, editResult: [EditResult](/refs/Interface/EditResult){/* */}) =&gt; boolean \| void | A callback that contains the cell position and edit result when cell editing is complete. |
| [onGridActivated](/refs/Class/GridBase#ongridactivated) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | A callback indicating that the grid has been selected |
| [onHideEditor](/refs/Class/GridBase#onhideeditor) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void | A callback to indicate that editing is complete and the editor has disappeared |
| [onInitialized](/refs/Class/GridBase#oninitialized) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | Callback that occurs after the grid is created |
| [onItemAllChecked](/refs/Class/GridBase#onitemallchecked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, checked: boolean) =&gt; void | A callback notifying that the user clicked on the header of the checkBar to select or deselect all, or entered checkAll `true` / `false` to select or deselect all |
| [onItemChecked](/refs/Class/GridBase#onitemchecked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, checked: boolean) =&gt; void | A callback notifying that the user has changed a check by clicking a checkbox in checkBar or calling checkItem |
| [onItemEditCancel](/refs/Class/GridBase#onitemeditcancel) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, state: string) =&gt; boolean | A callback that determines whether the user wants to cancel row editing |
| [onItemEditCanceled](/refs/Class/GridBase#onitemeditcanceled) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, state: string) =&gt; void | <p>Callback to indicate that the user canceled row editing</p><p>\[Parameter list\]</p><p>`grid` - GridBase control</p><p>`itemIndex` - Order of rows whose edits were canceled</p><p>`state` - Status of rows whose edits were canceled</p> |
| [onItemsChecked](/refs/Class/GridBase#onitemschecked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, items: number\[\], checked: boolean) =&gt; void | A callback notifying that the user has changed a check by clicking a checkbox in checkBar or calling checkItem |
| [onKeyDown](/refs/Class/GridBase#onkeydown) | (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; boolean | A callback that determines keystrokes |
| [onKeyPress](/refs/Class/GridBase#onkeypress) | (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; void | A callback to indicate that a key is being entered |
| [onKeyUp](/refs/Class/GridBase#onkeyup) | (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; void | A callback notifying that a key has been entered. |
| [onLayoutCollapsed](/refs/Class/GridBase#onlayoutcollapsed) | (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; void | A callback indicating that the group layout has been collapsed |
| [onLayoutCollapsing](/refs/Class/GridBase#onlayoutcollapsing) | (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; boolean | Callback that determines group layout collapse |
| [onLayoutExpanded](/refs/Class/GridBase#onlayoutexpanded) | (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; void | Callback notifying that the group layout has been expanded |
| [onLayoutExpanding](/refs/Class/GridBase#onlayoutexpanding) | (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; boolean | Callback that determines group layout expansion |
| [onLayoutPropertyChanged](/refs/Class/GridBase#onlayoutpropertychanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutItem](/refs/Interface/CellLayoutItem){/* */}, property: string, newValue: any, oldValue : any) =&gt; void | Callback notifying that displayWidth, displayIndex, and visible property values among Layout properties have changed |
| [onLeftPosChanged](/refs/Class/GridBase#onleftposchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, pos: number) =&gt; void | A callback notifying that the position of the horizontal scroll bar has changed |
| [onMenuItemClicked](/refs/Class/GridBase#onmenuitemclicked) | (grid: [GridBase](/refs/Class/GridBase){/* */}, item: [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}, clickData: [ClickData](/refs/ Interface/ClickData){/* */}) =&gt; void | Callback notifying that the added pop-up menu item is clicked |
| [onPaste](/refs/Class/GridBase#onpaste) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, event: ClipboardEvent) =&gt; boolean | A callback that determines what to paste into the grid |
| [onPasted](/refs/Class/GridBase#onpasted) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | A callback indicating that a paste has been made into the grid |
| [onRowInserting](/refs/Class/GridBase#onrowinserting) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, dataRow: number) =&gt; boolean | A callback that determines whether the user inserts a new row by pressing the Insert key or adds a row by pressing the down arrow on the last row |
| [onRowsDeleting](/refs/Class/GridBase#onrowsdeleting) | (grid: [GridBase](/refs/Class/GridBase){/* */}, rows: number\[\]) =&gt; boolean | <p>When the user presses Ctrl+Del or deletes with [deleteSelection()](/refs/Class/GridBase#deleteselection), a callback that determines the actual deletion</p><p>\[Parameter list\ ]</p><p>`grid` - GridBase control</p><p>`rows` - Array of data row orders of the rows to be deleted</p><p>\[Return value\] - null If a value other than that is returned, the specified text is displayed and deletion is canceled.</p> |
| [onRowsPasted](/refs/Class/GridBase#onrowspasted) | (grid: [GridBase](/refs/Class/GridBase){/* */}, items: number\[\]) =&gt; void | A callback to indicate that multiple rows have been pasted |
| [onScrollToBottom](/refs/Class/GridBase#onscrolltobottom) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | A callback called when the last row is displayed in the grid by the user operating the keyboard, scroll bar, etc. |
| [onSearchCellButtonClick](/refs/Class/GridBase#onsearchcellbuttonclick) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, text: string) =&gt; void | A callback indicating that a button was clicked in [SearchCellEditor](/refs/Interface/SearchCellEditor) |
| [onSelectionAdded](/refs/Class/GridBase#onselectionadded) | (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void | A callback notifying that a new selection area has been added |
| [onSelectionChanged](/refs/Class/GridBase#onselectionchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void | A callback notifying that the user has changed the size of the selection using the mouse or keyboard |
| [onSelectionCleared](/refs/Class/GridBase#onselectioncleared) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | A callback notifying that the existing selection area has been removed when the user changes the selection area with the mouse or keyboard |
| [onSelectionEnded](/refs/Class/GridBase#onselectionended) | (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void | A callback to notify the user that the selection area has been changed with the mouse |
| [onShowEditCommand](/refs/Class/GridBase#onshoweditcommand) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; boolean | A callback that determines whether to display the editCommand displayed on mobile |
| [onShowEditor](/refs/Class/GridBase#onshoweditor) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, props: any, attrs: any) = &gt; boolean | A callback that determines the display of the Editor opened for each cell |
| [onShowHeaderTooltip](/refs/Class/GridBase#onshowheadertooltip) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, value: any, layout: [CellLayoutItem](/refs/Interface/CellLayoutItem){/* */}, isEllipsis: boolean) =&gt;  boolean \| string \| [TooltipOptions](/refs/Interface/TooltipOptions) | A callback indicating that the tooltip for the column header has been displayed |
| [onShowRowBarTooltip](/refs/Class/GridBase#onshowrowbartooltip) | (grid: [GridBase](/refs/Class/GridBase){/* */}, cellType: [GridCellType](/refs/realgrid#gridcelltype){/* */}, itemIndex: number, dataRow: number) =&gt; string \| [TooltipOptions](/refs/Interface/TooltipOptions) | Callback notifying that the tooltip in the rowbar area has been displayed |
| [onShowTooltip](/refs/Class/GridBase#onshowtooltip) | (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any, isEllipsis: boolean) =&gt; boolean \| string \| [TooltipOptions](/refs/Interface/TooltipOptions) | Callback that notifies that a tooltip for a data cell has been displayed |
| [onSorting](/refs/Class/GridBase#onsorting) | (grid: [GridBase](/refs/Class/GridBase){/* */}, fields: number\[\], directions: string\[\]) =&gt; boolean | Callback to determine sorting |
| [onSortingChanged](/refs/Class/GridBase#onsortingchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void | Callback to indicate sorting |
| [onTopIndexChanged](/refs/Class/GridBase#ontopindexchanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number) =&gt; void | A callback notifying that the position of the vertical scroll bar has changed |
| [onTopIndexChanging](/refs/Class/GridBase#ontopindexchanging) | (grid: [GridBase](/refs/Class/GridBase){/* */}, currentTop: number, delta: number, focusing: boolean, adjust: boolean) =&gt; number | Callback called when gridView.topIndex changes |
| [onValidateColumn](/refs/Class/GridBase#onvalidatecolumn) | (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [DataColumn](/refs/Interface/DataColumn){/* */}, inserting: boolean, value: any, itemIndex: number, dataRow: number) =&gt; [ValidationError](/refs/Interface/ValidationError) \| undefined | A callback that determines the result of user validation via Javascript when editing a cell is complete and moving to another cell. |
| [onValidateRow](/refs/Class/GridBase#onvalidaterow) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, dataRow: number, inserting: boolean, values: any\[\]) =&gt; [ValidationError](/refs/Interface/ValidationError) | Callback to determine row-wise user verification result via Javascript |
| [onValidationFail](/refs/Class/GridBase#onvalidationfail) | (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, column: [GridColumn](/refs/Interface/GridColumn){/* */}, error: [ValidationError] (/refs/Interface/ValidationError){/* */}) =&gt; [ValidationError](/refs/Interface/ValidationError) | Callback that occurs when validation fails |
| [onWheel](/refs/Class/GridBase#onwheel) | (grid: [GridBase](/refs/Class/GridBase){/* */}, event: WheelEvent) =&gt; boolean | Callback notifying that a Wheel Event has occurred |

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(container, accessibility, waiOptions)](/refs/(constructor)) | | Constructs a new instance of the `GridBase` class |

## Properties
| Property | Type | Description |
| --- | --- | --- |
| [checkBar](/refs/Class/GridBase#checkbar) | [CheckBar](/refs/Interface/CheckBar) | Configuration model for grid checkbars |
| [copyOptions](/refs/Class/GridBase#copyoptions) | [CopyOptions](/refs/Interface/CopyOptions) | Settings model for copying to clipboard |
| [dataDropOptions](/refs/Class/GridBase#datadropoptions) | [DataDropOptions](/refs/Interface/DataDropOptions) | Setting model related to data drag and drop |
| [disabled](/refs/Class/GridBase#disabled) | boolean | Grid does not respond to mouse/keyboard events |
| [displayOptions](/refs/Class/GridBase#displayoptions) | [DisplayOptions](/refs/Interface/DisplayOptions) | Setting model for display information managed at grid level |
| [editOptions](/refs/Class/GridBase#editoptions) | [EditOptions](/refs/Interface/EditOptions) | Setting model for data editing |
| [editorOptions](/refs/Class/GridBase#editoroptions) | [EditorOptions](/refs/Interface/EditorOptions) | Setting model for editor |
| [filteringOptions](/refs/Class/GridBase#filteringoptions) | [FilteringOptions](/refs/Interface/FilteringOptions) | Settings model for data filtering |
| [filterPanel](/refs/Class/GridBase#filterpanel) | [FilterPanel](/refs/Interface/FilterPanel) | |
| [fixedOptions](/refs/Class/GridBase#fixedoptions) | [FixedOptions](/refs/Interface/FixedOptions) | Setting model for fixed rows and columns in grid |
| [footer](/refs/Class/GridBase#footer) | [GridFooter](/refs/Interface/GridFooter) | Configuration model for first footer |
| [footers](/refs/Class/GridBase#footers) | [GridFooterCollection](/refs/Interface/GridFooterCollection) | Configuration model for footers |
| [formatOptions](/refs/Class/GridBase#formatoptions) | [FormatOptions](/refs/Interface/FormatOptions) | Setting model for conversion format of data field values |
| [header](/refs/Class/GridBase#header) | [GridHeader](/refs/Interface/GridHeader) | Configuration model for grid header area |
| [headerSummaries](/refs/Class/GridBase#headersummaries) | [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) | Collection settings model for Header Summary displayed in grid header area |
| [headerSummary](/refs/Class/GridBase#headersummary) | [HeaderSummary](/refs/Interface/HeaderSummary) | Setting model for the first Header Summary displayed in the grid header area |
| [hideDeletedRows](/refs/Class/GridBase#hidedeletedrows) | boolean | Whether to hide deleted rows set in the grid |
| [mobileOptions](/refs/Class/GridBase#mobileoptions) | [MobileOptions](/refs/Interface/MobileOptions) | Mobile-specific settings model |
| [onGridFocusChanged](/refs/Class/GridBase#ongridfocuschanged) | (grid: [GridBase](/refs/Class/GridBase){/* */}, focused: boolean, event: Event) =&gt; void | <p>A callback that notifies the grid that it has or loses focus</p><p>\[Parameter List\] `grid` - GridBase control `focused` - Whether it is focused `event` - Event object</p> |
| [pasteOptions](/refs/Class/GridBase#pasteoptions) | [PasteOptions](/refs/Interface/PasteOptions) | Configuration model for pasting data from clipboard |
| [redoing](/refs/Class/GridBase#redoing) | boolean | Whether the grid is performing a redo |
| [rowIndicator](/refs/Class/GridBase#rowindicator) | [RowIndicator](/refs/Interface/RowIndicator) | Configuration model for grid indicators |
| [scrollBarHeight](/refs/Class/GridBase#scrollbarheight) | number | Change the height of the scrollbar |
| [scrollBarWidth](/refs/Class/GridBase#scrollbarwidth) | number | Change the width of the scrollbar |
| [sortingOptions](/refs/Class/GridBase#sortingoptions) | [SortingOptions](/refs/Interface/SortingOptions) | Set model for data sorting |
| [sortMode](/refs/Class/GridBase#sortmode) | [SortMode](/refs/realgrid#sortmode) | Sort operation mode after data modification |
| [stateBar](/refs/Class/GridBase#statebar) | [StateBar](/refs/Interface/StateBar) | Setting model for grid status bar |
| [summaryMode](/refs/Class/GridBase#summarymode) | [SummaryMode](/refs/realgrid#summarymode) | How to calculate sum of current grid |
| [undoable](/refs/Class/GridBase#undoable) | boolean | Availability of undo function |
| [undoing](/refs/Class/GridBase#undoing) | boolean | Whether the grid is performing an undo |

## Methods

| Method | Type | Description |
| --- | --- | --- |
| [activateAllColumnFilters(column, active)](/refs/Class/GridBase#activateallcolumnfilters) | activateAllColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, active: boolean): void; | Apply or cancel all filters registered in the column. |
| [activateColumnFilters(column, filterNames, active)](/refs/Class/GridBase#activatecolumnfilters) | activateColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filterNames: string \| string\[\], active: boolean): void; | Among the filters registered in the column, apply or disable filters with filter names included in `filterNames`. |
| [addColumn(column, index)](/refs/Class/GridBase#addcolumn) | addColumn(column: [ConfigObject](/refs/realgrid#configobject) \| string, index?: number): [GridColumn](/refs/Interface/GridColumn){/* */}; | Set additional columns in addition to the set columns. |
| [addColumnFilters(column, filters, overwrite)](/refs/Class/GridBase#addcolumnfilters) | addColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filters: [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\], overwrite ?: boolean): void; | Register one or more filters in a column. Not applied if column.autoFilter is true. |
| [addInvalidCell(itemIndex, fieldName, level, message)](/refs/Class/GridBase#addinvalidcell) | addInvalidCell(itemIndex: number, fieldName: string \| number, level: [ValidationLevel](/refs/realgrid#validationlevel){/* */}, message: string): void; | The user adds the result of the value validation to the grid. |
| [addInvalidCellOfRow(dataRow, fieldName, level, message)](/refs/Class/GridBase#addinvalidcellofrow) | addInvalidCellOfRow(dataRow: number, fieldName: string \| number, level: [ValidationLevel](/refs/realgrid#validationlevel){/* */}, message: string): void; | The user adds the result of the value validation to the grid. |
| [addLayout(source, index)](/refs/Class/GridBase#addlayout) | addLayout(source: [LayoutItem](/refs/realgrid#layoutitem) \| string, index?: number): [LayoutItem](/refs/realgrid#layoutitem){/* */}; | Add a column or group to the layout. |
| [addLookupSource(source)](/refs/Class/GridBase#addlookupsource) | addLookupSource(source: [LookupSource](/refs/Interface/LookupSource){/* */}): void; | Add and register [LookupSource](/refs/Interface/LookupSource) to be used in the lookup tree. |
| [addPopupMenu(name, menuItems)](/refs/Class/GridBase#addpopupmenu) | addPopupMenu(name: string, menuItems: ([PopupMenu](/refs/Interface/PopupMenu) \| [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */})\[\]): void; | Add a Popup Menu to the grid. |
| [addSelection(item, eventFire)](/refs/Class/GridBase#addselection) | addSelection(item: [Selection](/refs/Interface/Selection){/* */}, eventFire?: boolean): void; | Add an area to select in the grid. |
| [addUserCellStyle(dataRow, column, style)](/refs/Class/GridBase#addusercellstyle) | addUserCellStyle(dataRow: number, column: string \| -1, style: string \| [ColumnStyleObject](/refs/Interface/ColumnStyleObject){/* */}): void; | Specifies the style of the cell. |
| [applyCheckables()](/refs/Class/GridBase#applycheckables) | applyCheckables(): void; | Apply checkable to CheckBar based on Expression. |
| [autoFiltersRefresh(columns, applyFilters)](/refs/Class/GridBase#autofiltersrefresh) | autoFiltersRefresh(columns: (string \| [DataColumn](/refs/Interface/DataColumn){/* */})\[\], applyFilters: boolean): void; | If column.autoFilter is true, the filter list is updated. |
| [beginUpdate()](/refs/Class/GridBase#beginupdate) | beginUpdate(): void; | Whenever grid-related properties are changed, an update lock is applied to delay the internal change processing call. |
| [cancel()](/refs/Class/GridBase#cancel) | cancel(): boolean; | Cancels editing of the row currently being edited. |
| [cancelEditor()](/refs/Class/GridBase#canceleditor) | cancelEditor(): void; | Cancel editing and close the editor window. |
| [checkAll(checked, visibleOnly, checkableOnly, checkEvent)](/refs/Class/GridBase#checkall) | checkAll(checked?: boolean, visibleOnly?: boolean, checkableOnly?: boolean, checkEvent?: boolean): void; | Check and uncheck all data rows in the grid. |
| [checkItem(itemIndex, checked, exclusive, checkEvent)](/refs/Class/GridBase#checkitem) | checkItem(itemIndex: number, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void; | Check or uncheck the specified item. |
| [checkItems(itemIndices, checked, checkEvent)](/refs/Class/GridBase#checkitems) | checkItems(itemIndices: number\[\], checked?: boolean, checkEvent?: boolean): void; | Check or uncheck the items corresponding to the entered item array. |
| [checkModel(model, checked, exclusive, checkEvent)](/refs/Class/GridBase#checkmodel) | checkModel(model: [GridItem](/refs/Interface/GridItem){/* */}, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void; | Checks or unchecks the specified GridItem. |
| [checkRow(row, checked, exclusive, checkEvent)](/refs/Class/GridBase#checkrow) | checkRow(row: number, checked?: boolean, exclusive?: boolean, checkEvent?: boolean): void; | Checks or unchecks the specified data row. |
| [checkRows(rows, checked, checkEvent)](/refs/Class/GridBase#checkrows) | checkRows(rows: number\[\], checked?: boolean, checkEvent?: boolean): void; | Check or uncheck the items connected to the unique row numbers entered. |
| [clearColumnFilters(column)](/refs/Class/GridBase#clearcolumnfilters) | clearColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}): void; | Removes filters registered in a column. Not applied if column.autoFilter is true. |
| [clearCommandStack(all)](/refs/Class/GridBase#clearcommandstack) | clearCommandStack(all?: boolean): void; | Initialize the Command Stack. |
| [clearCurrent()](/refs/Class/GridBase#clearcurrent) | clearCurrent(): void; | Remove focus. |
| [clearInvalidCells(itemIndex, fieldName)](/refs/Class/GridBase#clearinvalidcells) | clearInvalidCells(itemIndex?: number, fieldName?: string \| number): void; | Deletes cell information that failed value validation. |
| [clearInvalidCellsOfRow(dataRow, fieldName)](/refs/Class/GridBase#clearinvalidcellsofrow) | clearInvalidCellsOfRow(dataRow: number, fieldName?: string \| number): void; | Deletes cell information that failed value validation. |
| [clearLookupData(sourceId)](/refs/Class/GridBase#clearlookupdata) | clearLookupData(sourceId: string): void; | Clears the lookup source corresponding to the specified SourceId. |
| [clearRowHeights(all)](/refs/Class/GridBase#clearrowheights) | clearRowHeights(all: boolean): void; | Returns the height of individual rows where changes have been applied to the initial value. |
| [clearSelection()](/refs/Class/GridBase#clearselection) | clearSelection(): void; | Removes all selected areas. |
| [closeList()](/refs/Class/GridBase#closelist) | closeList(): void; | Close the filter box or DropDown Editor. |
| [closeLoading()](/refs/Class/GridBase#closeloading) | closeLoading(): void; | Hide loading animation. |
| [closeProgress()](/refs/Class/GridBase#closeprogress) | closeProgress(): void; | Close the progress bar. |
| [columnByField(fieldName)](/refs/Class/GridBase#columnbyfield) | columnByField(fieldName: string \| number): [DataColumn](/refs/Interface/DataColumn){/* */}; | Returns the first column information linked to the data field specified by the field name. |
| [columnByName(name)](/refs/Class/GridBase#columnbyname) | columnByName(name: string): [DataColumn](/refs/Interface/DataColumn){/* */}; | Returns column setting information using the column name. |
| [columnByTag(tag)](/refs/Class/GridBase#columnbytag) | columnByTag(tag: any): [GridColumn](/refs/Interface/GridColumn){/* */}; | Retrieves a column with the entered tag value. |
| [columnsByTag(tag)](/refs/Class/GridBase#columnsbytag) | columnsByTag(tag: any): [GridColumn](/refs/Interface/GridColumn){/* */}\[\]; | Columns with input tag values are brought into an array. |
| [commit(force)](/refs/Class/GridBase#commit) | commit(force?: boolean): boolean; | Complete editing of the row being edited and save it to DataProvider. |
| [commitEditor(hideEditor, force)](/refs/Class/GridBase#commiteditor) | commitEditor(hideEditor?: boolean, force?: boolean): boolean; | Reflects the contents of the current editor to the cell. |
| [copyToClipboard(selection, copy)](/refs/Class/GridBase#copytoclipboard) | copyToClipboard(selection: [Selection](/refs/Interface/Selection){/* */}, copy?: boolean): string; | Copies or returns information on cells included in the selected area. |
| [deleteSelection(force)](/refs/Class/GridBase#deleteselection) | deleteSelection(force?: boolean): void; | Deletes rows in the current selection area. |
| [destroy()](/refs/Class/GridBase#destroy) | destroy(): any; | Turn off the grid. |
| [endUpdate(force)](/refs/Class/GridBase#endupdate) | endUpdate(force: boolean): void; | Release the update lock and redraw the grid. |
| [eraseSelection(force)](/refs/Class/GridBase#eraseselection) | eraseSelection(force?: boolean): void; | Deletes the values of cells in the selection area. In other words, change the value to undefined. |
| [existsCustomRenderer(type)](/refs/Class/GridBase#existscustomrenderer) | existsCustomRenderer(type: string): boolean; | Check if there is a user renderer. |
| [existsLookupData(sourceId, keys)](/refs/Class/GridBase#existslookupdata) | existsLookupData(sourceId: string, keys: string \| string\[\]): boolean; | Returns whether the specified key exists in the specified lookupsource. |
| [exportGrid(options)](/refs/Class/GridBase#exportgrid) | exportGrid(options: [GridExportOptions](/refs/Interface/GridExportOptions){/* */}): void; | The shape and data of the current grid are exported to an external document according to the specified settings. |
| [fillEditSearchItems(column, searchKey, values, labels, items)](/refs/Class/GridBase#filleditsearchitems) | fillEditSearchItems(column: string \| [GridColumn](/refs/Interface/GridColumn){/* */}, searchKey: string, values?: string\[\], labels?: string\[\], items?: [ListResult](/refs/realgrid#listresult){/* */}): void; | Items related to the input value are searched and displayed in the list. Used for partial search purposes. |
| [fillLookupData(sourceId, data)](/refs/Class/GridBase#filllookupdata) | fillLookupData(sourceId: string, data: [LookupData](/refs/realgrid#lookupdata){/* */}): void; | Add lookupData to lookupSource. |
| [fitHeaderHeight(apply, paddingHeight)](/refs/Class/GridBase#fitheaderheight) | fitHeaderHeight(apply?: boolean, paddingHeight?: number): void; | Changes the header height to match the text height. |
| [fitLayoutWidth(layout, maxWidth, minWidth, includeHeaderText, includeFooterText)](/refs/Class/GridBase#fitlayoutwidth) | fitLayoutWidth(layout?: string \| [LayoutItem](/refs/realgrid#layoutitem){/* */}, maxWidth?: number, minWidth?: number, includeHeaderText?: boolean, includeFooterText?: boolean): number; | Change the cell width to match the character length. |
| [fullItemCount()](/refs/Class/GridBase#fullitemcount) | fullItemCount(): number; | Returns the number of items displayed on the screen, excluding rows where only some of them are visible. |
| [getActiveColumnFilters(column, active)](/refs/Class/GridBase#getactivecolumnfilters) | getActiveColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, active?: boolean): [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[ \]; | Returns the name of the applied or canceled filter among registered filters. |
| [getCellBounds(itemIndex, column, outer)](/refs/Class/GridBase#getcellbounds) | getCellBounds(itemIndex: number, column: string \| [GridColumn](/refs/Interface/GridColumn){/* */}, outer?: boolean): [Rectangle](/refs/Interface/Rectangle){/* */}; | Returns the coordinate values of the specified cell in the grid. |
| [getCheckBar()](/refs/Class/GridBase#getcheckbar) | getCheckBar(): [CheckBar](/refs/Interface/CheckBar){/* */}; | Returns configuration information related to the grid check bar to the model of [CheckBar](/refs/Interface/CheckBar). |
| [getChildModel(parentModel, index, extended)](/refs/Class/GridBase#getchildmodel) | getChildModel(parentModel: [GridItem](/refs/Interface/GridItem){/* */}, index: number, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the child model of the item model. |
| [getChildModels(parentModel, extended)](/refs/Class/GridBase#getchildmodels) | getChildModels(parentModel: [GridItem](/refs/Interface/GridItem){/* */}, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}\[\]; | Returns the child models of the item model. |
| [getColumn(index)](/refs/Class/GridBase#getcolumn) | getColumn(index: number): [GridColumn](/refs/Interface/GridColumn){/* */}; | Returns the column at the corresponding index. |
| [getColumnFilter(column, filterName)](/refs/Class/GridBase#getcolumnfilter) | getColumnFilter(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filterName: string): [ColumnFilter](/refs/Interface/ColumnFilter){/* */}; | Returns the filter corresponding to the filter name in the specified column. |
| [getColumnFilters(column)](/refs/Class/GridBase#getcolumnfilters) | getColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}): [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]; | Returns filters from the specified column. |
| [getColumnNames(columnsOnly, visibleOnly)](/refs/Class/GridBase#getcolumnnames) | getColumnNames(columnsOnly?: boolean, visibleOnly?: boolean): string\[\]; | Returns the columns set in the grid. |
| [getColumnProperty(column, prop)](/refs/Class/GridBase#getcolumnproperty) | getColumnProperty(column: string \| [GridColumn](/refs/Interface/GridColumn){/* */}, prop: string): any; | Returns the properties of the corresponding column. |
| [getColumns()](/refs/Class/GridBase#getcolumns) | getColumns(): [GridColumn](/refs/Interface/GridColumn){/* */}\[\]; | Returns the columns set in the grid. |
| [getContainer()](/refs/Class/GridBase#getcontainer) | getContainer(): HTMLDivElement; | Returns the div where the grid is located. |
| [getCopyOptions()](/refs/Class/GridBase#getcopyoptions) | getCopyOptions(): [CopyOptions](/refs/Interface/CopyOptions){/* */}; | When copying the grid using ctrl+c, the settings applied are returned to the [CopyOptions](/refs/Interface/CopyOptions) model. |
| [getCurrent()](/refs/Class/GridBase#getcurrent) | getCurrent(): [CellIndex](/refs/Interface/CellIndex){/* */}; | Returns the location information of the currently focused cell. |
| [getDataDropOptions()](/refs/Class/GridBase#getdatadropoptions) | getDataDropOptions(): [DataDropOptions](/refs/Interface/DataDropOptions){/* */}; | Setting information related to data drag and drop is returned to the [DataDropOptions](/refs/Interface/DataDropOptions) model. |
| [getDataRow(itemIndex)](/refs/Class/GridBase#getdatarow) | getDataRow(itemIndex: number): number; | Returns the unique number of the specified grid row. |
| [getDataSource()](/refs/Class/GridBase#getdatasource) | getDataSource(): [LocalDataProvider](/refs/Class/LocalDataProvider) \| [LocalTreeDataProvider](/refs/Class/LocalTreeDataProvider){/* */}; | Returns the DataProvider connected to the grid. |
| [getDescendantModels(parentModel, extended)](/refs/Class/GridBase#getdescendantmodels) | getDescendantModels(parentModel: [GridItem](/refs/Interface/GridItem){/* */}, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}\[\]; | Returns the child models of the item model. |
| [getDisplayColumns()](/refs/Class/GridBase#getdisplaycolumns) | getDisplayColumns(): [GridColumn](/refs/Interface/GridColumn){/* */}\[\]; | Returns the currently displayed columns. |
| [getDisplayOptions()](/refs/Class/GridBase#getdisplayoptions) | getDisplayOptions(): [DisplayOptions](/refs/Interface/DisplayOptions){/* */}; | Setting information related to grid display is returned to the model of [DisplayOptions](/refs/Interface/DisplayOptions). |
| [getDisplayValues(itemIndex, useColumnName)](/refs/Class/GridBase#getdisplayvalues) | getDisplayValues(itemIndex: number, useColumnName?: boolean): object; | Returns the data values of the specified row as a JSON object with various formats or regular expressions applied. |
| [getDisplayValuesOfRow(dataRow, useColumnName)](/refs/Class/GridBase#getdisplayvaluesofrow) | getDisplayValuesOfRow(dataRow: number, useColumnName?: boolean): object; | Returns the data values of the row specified by the row unique number as a JSON object with various formats or regular expressions applied. |
| [getDistinctItemValues(field, maxCount, sortDir)](/refs/Class/GridBase#getdistinctitemvalues) | getDistinctItemValues(field: number \| string, maxCount?: number, sortDir?: [SortDirection](/refs/realgrid#sortdirection){/* */}): any\[\]; | Returns non-duplicate values of the field. |
| [getEditingItem()](/refs/Class/GridBase#geteditingitem) | getEditingItem(): [EditingItemInfo](/refs/Interface/EditingItemInfo){/* */}; | The grid returns information about the item being edited. |
| [getEditOptions()](/refs/Class/GridBase#geteditoptions) | getEditOptions(): [EditOptions](/refs/Interface/EditOptions){/* */}; | Information related to the grid editing method is returned to the [EditOptions](/refs/Interface/EditOptions) model. |
| [getEditorOptions()](/refs/Class/GridBase#geteditoroptions) | getEditorOptions(): [EditorOptions](/refs/Interface/EditorOptions){/* */}; | Returns editor display information in the [EditorOptions](/refs/Interface/EditorOptions) model. |
| [getEditValue()](/refs/Class/GridBase#geteditvalue) | getEditValue(): any; | When the grid is being edited, the value of the cell currently being edited is returned. |
| [getFilteredRows(sort)](/refs/Class/GridBase#getfilteredrows) | getFilteredRows(sort?: boolean): number\[\]; | |
| [getFilteringOptions()](/refs/Class/GridBase#getfilteringoptions) | getFilteringOptions(): [FilteringOptions](/refs/Interface/FilteringOptions){/* */}; | Setting information related to grid filtering is returned to the [FilteringOptions](/refs/Interface/FilteringOptions) model. |
| [getFixedOptions()](/refs/Class/GridBase#getfixedoptions) | getFixedOptions(): [FixedOptions](/refs/Interface/FixedOptions){/* */}; | Setting information about the grid fixed area is returned to the model of [FixedOptions](/refs/Interface/FixedOptions). |
| [getFooter()](/refs/Class/GridBase#getfooter) | getFooter(): [GridFooter](/refs/Interface/GridFooter){/* */}; | Returns configuration information related to the first grid footer to the [GridFooter](/refs/Interface/GridFooter) model. |
| [getFooters()](/refs/Class/GridBase#getfooters) | getFooters(): [GridFooterCollection](/refs/Interface/GridFooterCollection){/* */}; | Configuration information for grid footers[GridFooterCollection](/refs/Interface/GridFooterCollection) Returns as a model. |
| [getFormatOptions()](/refs/Class/GridBase#getformatoptions) | getFormatOptions(): [FormatOptions](/refs/Interface/FormatOptions){/* */}; | Returns [FormatOptions](/refs/Interface/FormatOptions) of the grid. |
| [getGroupModel(itemIndex, extended)](/refs/Class/GridBase#getgroupmodel) | getGroupModel(itemIndex: number, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the group model corresponding to itemIndex. |
| [getGroupSummary(model, field, statistical)](/refs/Class/GridBase#getgroupsummary) | getGroupSummary(model: [GridItem](/refs/Interface/GridItem){/* */}, field: string, statistical?: boolean): [GroupSummary](/refs/Interface/GroupSummary){/* */}; | Returns the total information of the specified group item model. |
| [getHeader()](/refs/Class/GridBase#getheader) | getHeader(): [GridHeader](/refs/Interface/GridHeader){/* */}; | Configuration information related to the grid header is returned to the [GridHeader](/refs/Interface/GridHeader) model. |
| [getHeaderSummaries()](/refs/Class/GridBase#getheadersummaries) | getHeaderSummaries(): [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection){/* */}; | Returns the setting information of grid header summaries to the [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) model. |
| [getHeaderSummary()](/refs/Class/GridBase#getheadersummary) | getHeaderSummary(): [HeaderSummary](/refs/Interface/HeaderSummary){/* */}; | Returns configuration information related to the first grid header summary to the [HeaderSummary](/refs/Interface/HeaderSummary) model. |
| [getIndexOfElement(element)](/refs/Class/GridBase#getindexofelement) | getIndexOfElement(element: HTMLElement): [CellIndex](/refs/Interface/CellIndex){/* */}; | Returns the location information of the cell to which the HTMLElemnt belongs. |
| [getInvalidCells(itemIndex)](/refs/Class/GridBase#getinvalidcells) | getInvalidCells(itemIndex?: number): [InvalidCell](/refs/Interface/InvalidCell){/* */}\[\]; | Returns cell information that failed value verification. |
| [getInvalidCellsOfRow(dataRow)](/refs/Class/GridBase#getinvalidcellsofrow) | getInvalidCellsOfRow(dataRow: number): [InvalidCell](/refs/Interface/InvalidCell){/* */}\[\]; | Among the cell information performed for value verification, the information corresponding to the entered dataRow is returned. |
| [getItemCount()](/refs/Class/GridBase#getitemcount) | getItemCount(): number; | Returns the number of Grid Items currently displayed in the grid. |
| [getItemIndex(dataRow)](/refs/Class/GridBase#getitemindex) | getItemIndex(dataRow: number): number; | Returns the row order by the row's unique number. |
| [getItemsOfRows(rows)](/refs/Class/GridBase#getitemsofrows) | getItemsOfRows(rows: number\[\]): number\[\]; | Returns the order of the rows using the unique numbers of the input data rows. |
| [getItemState(itemIndex)](/refs/Class/GridBase#getitemstate) | getItemState(itemIndex: number): [ItemState](/refs/realgrid#itemstate){/* */}; | Returns the status value of the item. |
| [getJsonRows()](/refs/Class/GridBase#getjsonrows) | getJsonRows(): object\[\]; | |
| [getLayoutByColumn(column)](/refs/Class/GridBase#getlayoutbycolumn) | getLayoutByColumn(column: string \| [GridColumn](/refs/Interface/GridColumn){/* */}): [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem){/* */}; | Returns the layout information of the corresponding column. |
| [getLeftPos()](/refs/Class/GridBase#getleftpos) | getLeftPos(): number; | Returns the x-coordinate value of the column displayed on the leftmost screen. |
| [getLookupData(sourceId, keys)](/refs/Class/GridBase#getlookupdata) | getLookupData(sourceId: string, keys: string \| string\[\]): [LookupDataKeyValues](/refs/Interface/LookupDataKeyValues){/* */}; | If there is a specified key in the specified lookupSource, keys and values are returned. |
| [getMobileOptions()](/refs/Class/GridBase#getmobileoptions) | getMobileOptions(): [MobileOptions](/refs/Interface/MobileOptions){/* */}; | Returns mobile-related setting information in the [MobileOptions](/refs/Interface/MobileOptions) model. |
| [getModel(itemIndex, extended)](/refs/Class/GridBase#getmodel) | getModel(itemIndex: number, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the model corresponding to itemIndex. |
| [getModelAs(itemIndex, itemType, extended)](/refs/Class/GridBase#getmodelas) | getModelAs(itemIndex: number, itemType?: [ItemType](/refs/realgrid#itemtype){/* */}, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */} ; | Returns the model corresponding to itemIndex and itemType. |
| [getModelOfRow(dataRow, extended)](/refs/Class/GridBase#getmodelofrow) | getModelOfRow(dataRow: number, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the item model corresponding to the row unique number. |
| [getModels(itemIndices, extended)](/refs/Class/GridBase#getmodels) | getModels(itemIndices: number \| number\[\], extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}\[\]; | Returns item models corresponding to the indices of the specified item. |
| [getModelsOfRows(dataRows, extended)](/refs/Class/GridBase#getmodelsofrows) | getModelsOfRows(dataRows: number \| number\[\], extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}\[\]; | Returns item models corresponding to row unique numbers. |
| [getOptions()](/refs/Class/GridBase#getoptions) | getOptions(): [GridOptions](/refs/Interface/GridOptions){/* */}; | Returns grid option information. |
| [getParentModel(model, extended)](/refs/Class/GridBase#getparentmodel) | getParentModel(model: [GridItem](/refs/Interface/GridItem){/* */}, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the parent item model of the item model. |
| [getPasteOptions()](/refs/Class/GridBase#getpasteoptions) | getPasteOptions(): [PasteOptions](/refs/Interface/PasteOptions){/* */}; | Settings applied when pasting into the grid are [PasteOptions](/refs/InTerface/PasteOptions) Returns as a model. |
| [getPopupMenu(name)](/refs/Class/GridBase#getpopupmenu) | getPopupMenu(name: string): [PopupMenu](/refs/Interface/PopupMenu){/* */}; | Returns pop-up menu setting information. |
| [getRootModel(model, extended)](/refs/Class/GridBase#getrootmodel) | getRootModel(model: [GridItem](/refs/Interface/GridItem){/* */}, extended?: boolean): [GridItem](/refs/Interface/GridItem){/* */}; | Returns the item model's highest ancestor item model. |
| [getRowHeight(itemIndex)](/refs/Class/GridBase#getrowheight) | getRowHeight(itemIndex: number): number; | Returns the row height. |
| [getRowIndicator()](/refs/Class/GridBase#getrowindicator) | getRowIndicator(): [RowIndicator](/refs/Interface/RowIndicator){/* */}; | Configuration information related to the grid indicator is returned to the [RowIndicator](/refs/Interface/RowIndicator) model. |
| [getRowsOfItems(items)](/refs/Class/GridBase#getrowsofitems) | getRowsOfItems(items: number\[\]): number\[\]; | Returns the unique numbers of the specified grid rows. |
| [getSelectedItems(dataOnly)](/refs/Class/GridBase#getselecteditems) | getSelectedItems(dataOnly: boolean): number\[\]; | Returns the indices of rows in the current selection. |
| [getSelectedRows()](/refs/Class/GridBase#getselectedrows) | getSelectedRows(): number\[\]; | Returns the unique numbers of data rows in the current selection area. |
| [getSelection(index)](/refs/Class/GridBase#getselection) | getSelection(index?: number): [Selection](/refs/Interface/Selection){/* */}; | Returns information on the currently selected area. |
| [getSelectionData(maxRows, index)](/refs/Class/GridBase#getselectiondata) | getSelectionData(maxRows?: number, index?: number): [RowObject](/refs/realgrid#rowobject){/* */}\[\]; | Returns the values of cells included in the current selection area. |
| [getSelections()](/refs/Class/GridBase#getselections) | getSelections(): [Selection](/refs/Interface/Selection){/* */}\[\]; | Returns information on the currently selected area in array form. |
| [getSelectionsData()](/refs/Class/GridBase#getselectionsdata) | getSelectionsData(): [RowObject](/refs/realgrid#rowobject){/* */}\[\]\[\]; | Returns the values of cells included in the current selection area. |
| [getSortedFields()](/refs/Class/GridBase#getsortedfields) | getSortedFields(): [SortedFields](/refs/Interface/SortedFields){/* */}\[\]; | Returns sorting information for currently sorted fields. |
| [getSortingOptions()](/refs/Class/GridBase#getsortingoptions) | getSortingOptions(): [SortingOptions](/refs/Interface/SortingOptions){/* */}; | Setting information related to grid sorting is returned to the [SortingOptions](/refs/Interface/SortingOptions) model. |
| [getStateBar()](/refs/Class/GridBase#getstatebar) | getStateBar(): [StateBar](/refs/Interface/StateBar){/* */}; | Returns the grid status bar setting information to the model of [StateBar](/refs/Interface/StateBar). |
| [getSummary(field, type)](/refs/Class/GridBase#getsummary) | getSummary(field: string \| number, type: [SummaryType](/refs/realgrid#summarytype){/* */}): number; | Returns the total value of the field. |
| [getTopItem()](/refs/Class/GridBase#gettopitem) | getTopItem(): number; | Returns the index of the specified row at the top of the grid. |
| [getUserCellStyle(dataRow, column)](/refs/Class/GridBase#getusercellstyle) | getUserCellStyle(dataRow: number, column: string \| -1): string \| [ColumnStyleObject](/refs/Interface/ColumnStyleObject){/* */}; | Imports the style specified with addUserCellStyle. |
| [getValue(itemIndex, field, editing)](/refs/Class/GridBase#getvalue) | getValue(itemIndex: number, field: string \| number, editing?: boolean): any; | Returns the value of the data cell specified by the row order and data field index. |
| [getValues(itemIndex)](/refs/Class/GridBase#getvalues) | getValues(itemIndex: number): object; | Returns the data values of the specified row as a JSON object. |
| [getWritable(itemIndex, column)](/refs/Class/GridBase#getwritable) | getWritable(itemIndex: number, column: string): boolean; | Returns whether the cell is editable. |
| [hideAllColumnFilters(column, hide)](/refs/Class/GridBase#hideallcolumnfilters) | hideAllColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, hide?: boolean): void; | Hide or show all filters registered in a column. Not applied if column.autoFilter is true. |
| [hideColumnFilters(column, filterNames, hide)](/refs/Class/GridBase#hidecolumnfilters) | hideColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filterNames: string \| string\[\], hide?: boolean): void; | Among the filters registered in the column, filters with filter names included in `filterNames` are hidden or displayed. Not applied if column.autoFilter is true. |
| [hideEditor()](/refs/Class/GridBase#hideeditor) | hideEditor(): void; | Closes the editor currently open in the grid. |
| [hideToast(action)](/refs/Class/GridBase#hidetoast) | hideToast(action: VoidFunction): void; | Hide the Toast pop-up window. |
| [indeterminateItem(itemIndex, indeterminate)](/refs/Class/GridBase#indeterminateitem) | indeterminateItem(itemIndex: number, indeterminate?: boolean): void; | Changes the specified item to the indeterminate state or removes it. |
| [indeterminateModel(model, indeterminate)](/refs/Class/GridBase#indeterminatemodel) | indeterminateModel(model: [GridItem](/refs/Interface/GridItem){/* */}, indeterminate: boolean): void; | Changes the indeterminate state of the corresponding model. |
| [indeterminateRow(row, indeterminate)](/refs/Class/GridBase#indeterminaterow) | indeterminateRow(row: number, indeterminate?: boolean): void; | Changes the specified data row to the indeterminate state or removes it. |
| [inlineFilterFocus(column)](/refs/Class/GridBase#inlinefilterfocus) | inlineFilterFocus(column: string): void; | Focuses on the input in the filter panel. |
| [isAllChecked()](/refs/Class/GridBase#isallchecked) | isAllChecked(): boolean; | Returns whether all items are checked. |
| [isCheckable(itemIndex)](/refs/Class/GridBase#ischeckable) | isCheckable(itemIndex: number): boolean; | Returns whether the checkbar is checkable with the specified item index. |
| [isCheckableModel(model)](/refs/Class/GridBase#ischeckablemodel) | isCheckableModel(model: [GridItem](/refs/Interface/GridItem){/* */}): boolean; | Returns whether the specified GridItem is checkable. |
| [isCheckableOfRow(dataRow)](/refs/Class/GridBase#ischeckableofrow) | isCheckableOfRow(dataRow: number): boolean; | Returns whether the checkbar is checkable with the unique number of the specified item. |
| [isCheckedItem(itemIndex)](/refs/Class/GridBase#ischeckeditem) | isCheckedItem(itemIndex: number): boolean; | Returns `true` if the checkbar is checked. |
| [isCheckedModel(model)](/refs/Class/GridBase#ischeckedmodel) | isCheckedModel(model: [GridItem](/refs/Interface/GridItem){/* */}): boolean; | Whether the specified GridItem is checked. |
| [isCheckedRow(row)](/refs/Class/GridBase#ischeckedrow) | isCheckedRow(row: number): boolean; | Whether the row is checked |
| [isEditing()](/refs/Class/GridBase#isediting) | isEditing(): boolean; | Returns `true` if the cell is currently being edited. |
| [isFiltered(column)](/refs/Class/GridBase#isfiltered) | isFiltered(column?: string \| [DataColumn](/refs/Interface/DataColumn){/* */}): boolean; | Returns whether a specific column in the grid is filtered. |
| [isIndeterminateItem(itemIndex)](/refs/Class/GridBase#isindeterminateitem) | isIndeterminateItem(itemIndex: number): boolean; | If the check bar is indeterminate, return `true`. |
| [isIndeterminateModel(model)](/refs/Class/GridBase#isindeterminatemodel) | isIndeterminateModel(model: [GridItem](/refs/Interface/GridItem){/* */}): boolean; | If the check bar is indeterminate, return `true`. |
| [isIndeterminateRow(row)](/refs/Class/GridBase#isindeterminaterow) | isIndeterminateRow(row: number): boolean; | Whether the row is indeterminate |
| [isItemEditing()](/refs/Class/GridBase#isitemediting) | isItemEditing(): boolean; | If cell editing is finished but not committed, return `true` if editing is in progress. |
| [isVisible()](/refs/Class/GridBase#isvisible) | isVisible(): boolean; | Returns `true` if the grid is displayed. |
| [layoutByColumn(column)](/refs/Class/GridBase#layoutbycolumn) | layoutByColumn(column: string): [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem){/* */}; | Finds the layout setting information of the column using the column name. |
| [layoutByName(name)](/refs/Class/GridBase#layoutbyname) | layoutByName(name: string): [LayoutItem](/refs/realgrid#layoutitem){/* */}; | Finds the layout setting information using the layout name. |
| [linearizeColumns(sortProps)](/refs/Class/GridBase#linearizecolumns) | linearizeColumns(sortProps?: string\[\]): void; | Remove all column groups and arrange only the columns that display data values ​​in a single line. |
| [mouseToIndex(x, y, coordianteByBody)](/refs/Class/GridBase#mousetoindex) | mouseToIndex(x: number, y: number, coordianteByBody?: boolean): [ConfigObject](/refs/realgrid#configobject){/* */}; | Returns the location information of the cell corresponding to the (x, y) coordinate. |
| [orderBy(fieldNames, sortDirs, textCases)](/refs/Class/GridBase#orderby) | orderBy(fieldNames?: string\[\] \| string, sortDirs?: [SortDirection](/refs/realgrid#sortdirection){/* */}\[\] \| [SortDirection](/refs/realgrid#sortdirection){/* */}, textCases?: [SortCase](/refs/realgrid#sortcase){/* */}\[\] \| [SortCase](/refs/realgrid#sortcase){/* */}): void; | Sorts Grid Items based on one or more data fields. |
| [ping(message)](/refs/Class/GridBase#ping) | ping(message: any): void; | Displays the message entered in the alert window. |
| [redo()](/refs/Class/GridBase#redo) | redo(): boolean; | When undoing a datasource connected to the grid, it returns to the state after modification. |
| [refresh(force)](/refs/Class/GridBase#refresh) | refresh(force?: boolean): void; | Redraws the grid internally. |
| [registerColumnLayouts(layouts)](/refs/Class/GridBase#registercolumnlayouts) | registerColumnLayouts(layouts: \{ name: string; items: (string \| [LayoutItem](/refs/realgrid#layoutitem){/* */})\[\]; \}\[\]): void; | Register column layouts in advance. |
| [registerCustomRenderer(type, renderer)](/refs/Class/GridBase#registercustomrenderer) | registerCustomRenderer(type: string, renderer: [CustomCellRenderer](/refs/Interface/CustomCellRenderer){/* */}): void; | Register a custom renderer. |
| [removeColumn(name)](/refs/Class/GridBase#removecolumn) | removeColumn(name: string): boolean; | Remove the corresponding column. |
| [removeColumnFilters(column, filterNames)](/refs/Class/GridBase#removecolumnfilters) | removeColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filterNames: string \| string\[\]): void; | Among the filters registered in the column, filters with filter names included in `filterNames`{/* */} are removed. Not applied if column.autoFilter is true. |
| [removeLayout(layout)](/refs/Class/GridBase#removelayout) | removeLayout(layout: [LayoutItem](/refs/realgrid#layoutitem) \| string): void; | <p>Remove layout.</p><p>Cannot be used if layout is not set. It must be used after changing to the layout state using gridView.setColumnLayout.</p> |
| [removeLookupSource(sourceId)](/refs/Class/GridBase#removelookupsource) | removeLookupSource(sourceId: string): void; | Deletes the specified lookup source. |
| [removePopupMenu(name)](/refs/Class/GridBase#removepopupmenu) | removePopupMenu(name: string): void; | Remove a specific Popup Menu from the grid. |
| [removeUserCellStyle(dataRow, column)](/refs/Class/GridBase#removeusercellstyle) | removeUserCellStyle(dataRow?: number \| null, column?: string \| -1 \| null): void; | Removes the style specified with addUserCellStyle. |
| [requestPrepareEditor()](/refs/Class/GridBase#requestprepareeditor) | requestPrepareEditor(): void; | After editing is complete, the cell's editor is updated when the screen is redrawn. |
| [resetCheckables(clearExpression)](/refs/Class/GridBase#resetcheckables) | resetCheckables(clearExpression: boolean): void; | Initializes the Checkable state of all rows applied to CheckBar. |
| [resetCurrent()](/refs/Class/GridBase#resetcurrent) | resetCurrent(): void; | Initialize the position of the focus cell to the first row and first column. |
| [resetFilters()](/refs/Class/GridBase#resetfilters) | resetFilters(): void; | Releases filters registered in all columns of the grid. |
| [resetSize(callback)](/refs/Class/GridBase#resetsize) | resetSize(callback?: any): void; | Change the size of the upper DIV area of the grid explicitly when the size of the grid does not change. |
| [restoreColumns()](/refs/Class/GridBase#restorecolumns) | restoreColumns(): void; | Returns the grid column positions to their initial state. |
| [saveColumnLayout()](/refs/Class/GridBase#savecolumnlayout) | saveColumnLayout(): [LayoutInfo](/refs/realgrid#layoutinfo){/* */}\[\]; | Returns layout information of the current screen. |
| [scrollPage(offset)](/refs/Class/GridBase#scrollpage) | scrollPage(offset: number): void; | Move the page based on the current time. |
| [searchCell(options)](/refs/Class/GridBase#searchcell) | searchCell(options: [SearchCellOptions](/refs/Interface/SearchCellOptions){/* */}): any; | Finds the cell corresponding to the values of the specified fields and returns [CellIndex](/refs/Interface/CellIndex){/* */}. |
| [searchItem(options)](/refs/Class/GridBase#searchitem) | searchItem(options: [SearchOptions](/refs/Interface/SearchOptions){/* */}): number; | Finds the first row corresponding to the values of the specified fields and returns the row number. |
| [setAllCheck(checked, itemChecked)](/refs/Class/GridBase#setallcheck) | setAllCheck(checked?: boolean, itemChecked?: boolean): void; | Check or uncheck all data rows in the grid using the options set in CheckBar. |
| [setCellStyleCallback(f)](/refs/Class/GridBase#setcellstylecallback) | setCellStyleCallback(f: [CellStyleCallback](/refs/realgrid#cellstylecallback) \| undefined): void; | Change the cell style. |
| [setCheckable(itemIndex, value)](/refs/Class/GridBase#setcheckable) | setCheckable(itemIndex: number, value: boolean): void; | Specifies whether the check bar of the specified item can be checked. |
| [setCheckableCallback(callback, apply)](/refs/Class/GridBase#setcheckablecallback) | setCheckableCallback(callback?: [CheckableCallback](/refs/realgrid#checkablecallback){/* */}, apply?: boolean): void; | Set checkableCallback in CheckBar and apply it. Or perform them simultaneously. |
| [setCheckableExpression(expression, apply)](/refs/Class/GridBase#setcheckableexpression) | setCheckableExpression(expression: string, apply?: boolean): void; | Set checkableExpression in CheckBar and apply it. Or perform them simultaneously. |
| [setCheckableOfRow(dataRow, value)](/refs/Class/GridBase#setcheckableofrow) | setCheckableOfRow(dataRow: number, value: boolean): void; | Specifies whether the check bar of the specified row can be checked. |
| [setCheckBar(value)](/refs/Class/GridBase#setcheckbar) | setCheckBar(value: [CheckBar](/refs/Interface/CheckBar){/* */}): void; | Set the grid check bar's configuration information to the model of [CheckBar](/refs/Interface/CheckBar). |
| [setColumn(value)](/refs/Class/GridBase#setcolumn) | setColumn(value: [ConfigObject](/refs/realgrid#configobject){/* */}): void; | Change the information of the column set in the grid. |
| [setColumnFilters(column, filters)](/refs/Class/GridBase#setcolumnfilters) | setColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filters: [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]): void; | Set a filter on the grid column. |
| [setColumnLayout(layout)](/refs/Class/GridBase#setcolumnlayout) | setColumnLayout(layout?: string \| (string \| [LayoutItem](/refs/realgrid#layoutitem){/* */})\[\]): void; | Set the column layout of the grid. |
| [setColumnProperty(column, prop, value)](/refs/Class/GridBase#setcolumnproperty) | setColumnProperty(column: string \| [GridColumn](/refs/Interface/GridColumn){/* */}, prop: string, value: any): void; | Change specific attribute information of a column set in the grid. |
| [setColumns(columns)](/refs/Class/GridBase#setcolumns) | setColumns(columns: ([DataColumn](/refs/Interface/DataColumn) \| [SeriesColumn](/refs/Interface/SeriesColumn) \| [LiteralColumn](/refs/Interface/LiteralColumn) \| [ConfigObject](/refs /realgrid#configobject) \| string)\[\]): void; | Remove all previously set columns and reorganize the grid with new columns. |
| [setContextMenu(menuItems)](/refs/Class/GridBase#setcontextmenu) | setContextMenu(menuItems: ([PopupMenu](/refs/Interface/PopupMenu) \| [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */})\[\]): [PopupMenu](/refs/Interface /PopupMenu){/* */}; | Specify menu items to be added to the context menu displayed when right-clicking on the grid. |
| [setCopyOptions(options)](/refs/Class/GridBase#setcopyoptions) | setCopyOptions(options: [CopyOptions](/refs/Interface/CopyOptions){/* */}): void; | Set copy information to the [CopyOptions](/refs/Interface/CopyOptions) model. |
| [setCurrent(current, select)](/refs/Class/GridBase#setcurrent) | setCurrent(current: [CellIndex](/refs/Interface/CellIndex){/* */}, select?: boolean): void; | Specifies the location of the focus cell. |
| [setDataDropOptions(options)](/refs/Class/GridBase#setdatadropoptions) | setDataDropOptions(options: [DataDropOptions](/refs/Interface/DataDropOptions){/* */}): void; | Configuration information related to data drag and drop is set to the [DataDropOptions](/refs/Interface/DataDropOptions) model. |
| [setDataSource(dataProvider)](/refs/Class/GridBase#setdatasource) | setDataSource(dataProvider: [LocalDataProvider](/refs/Class/LocalDataProvider) \| [LocalTreeDataProvider](/refs/Class/LocalTreeDataProvider){/* */}): void; | Connect the Data Provider to the grid. |
| [setDisplayOptions(options)](/refs/Class/GridBase#setdisplayoptions) | setDisplayOptions(options: [DisplayOptions](/refs/Interface/DisplayOptions){/* */}): void; | Set grid display information to the [DisplayOptions](/refs/Interface/DisplayOptions) model. |
| [setEditOptions(options)](/refs/Class/GridBase#seteditoptions) | setEditOptions(options: [EditOptions](/refs/Interface/EditOptions){/* */}): void; | Information related to the grid editing method is reset to the [EditOptions](/refs/Interface/EditOptions) model. |
| [setEditorOptions(options)](/refs/Class/GridBase#seteditoroptions) | setEditorOptions(options: [EditorOptions](/refs/Interface/EditorOptions){/* */}): void; | Set the editor display information to the [EditorOptions](/refs/Interface/EditorOptions) model. |
| [setEditValue(value, startEdit, dropdown)](/refs/Class/GridBase#seteditvalue) | setEditValue(value: any, startEdit?: boolean, dropdown?: boolean): void; | Sets the value in the cell where focus is located. |
| [setFilteringOptions(options)](/refs/Class/GridBase#setfilteringoptions) | setFilteringOptions(options: [FilteringOptions](/refs/Interface/FilteringOptions){/* */}): void; | Set information related to grid filtering in the [FilteringOptions](/refs/Interface/FilteringOptions) model. |
| [setFilterPanel(value)](/refs/Class/GridBase#setfilterpanel) | setFilterPanel(value: [FilterPanel](/refs/Interface/FilterPanel){/* */}): void; | Set the filter panel setting information to the [FilterPanel](/refs/Interface/FilterPanel) model. |
| [setFixedOptions(options)](/refs/Class/GridBase#setfixedoptions) | setFixedOptions(options: [FixedOptions](/refs/Interface/FixedOptions){/* */}): void; | Set information about the grid fixed area as a model in [FixedOptions](/refs/Interface/FixedOptions). |
| [setFocus()](/refs/Class/GridBase#setfocus) | setFocus(): void; | The grid is focused. |
| [setFooter(value)](/refs/Class/GridBase#setfooter) | setFooter(value: [GridFooter](/refs/Interface/GridFooter){/* */}): void; | Set the configuration information of the first grid footer to the [GridFooter](/refs/Interface/GridFooter) model. |
| [setFooters(value)](/refs/Class/GridBase#setfooters) | setFooters(value: [GridFooterCollection](/refs/Interface/GridFooterCollection) \| [GridFooter](/refs/Interface/GridFooter){/* */}\[\]): void; | Set the grid footer configuration information to the collection model of [GridFooter](/refs/Interface/GridFooter). |
| [setFormatOptions(options)](/refs/Class/GridBase#setformatoptions) | setFormatOptions(options: [FormatOptions](/refs/Interface/FormatOptions){/* */}): void; | Set [FormatOptions](/refs/Interface/FormatOptions) of the grid. |
| [setHeader(value)](/refs/Class/GridBase#setheader) | setHeader(value: [GridHeader](/refs/Interface/GridHeader){/* */}): void; | Set the grid header setting information to the [GridHeader](/refs/Interface/GridHeader) model. |
| [setHeaderSummaries(value)](/refs/Class/GridBase#setheadersummaries) | setHeaderSummaries(value: [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) \| [HeaderSummary](/refs/Interface/HeaderSummary){/* */}\[\]): void; | Set grid header summaries to the [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) model. |
| [setHeaderSummary(value)](/refs/Class/GridBase#setheadersummary) | setHeaderSummary(value: [HeaderSummary](/refs/Interface/HeaderSummary){/* */}): void; | Set the configuration information of the first grid header summary to the [HeaderSummary](/refs/Interface/HeaderSummary) model. |
| [setLeftCol(column)](/refs/Class/GridBase#setleftcol) | setLeftCol(column: string \| number): void; | The specified column is located on the left border of the grid. |
| [setLeftPos(position)](/refs/Class/GridBase#setleftpos) | setLeftPos(position: number): void; | The left border of the grid is located at the specified value. |
| [setLookups(sources)](/refs/Class/GridBase#setlookups) | setLookups(sources: [LookupSource](/refs/Interface/LookupSource){/* */}\[\]): void; | Register lookup sources to be used in the lookup tree. |
| [setMobileOptions(options)](/refs/Class/GridBase#setmobileoptions) | setMobileOptions(options: [MobileOptions](/refs/Interface/MobileOptions){/* */}): void; | Set mobile-related setting information using the [MobileOptions](/refs/Interface/MobileOptions) model. |
| [setOptions(options)](/refs/Class/GridBase#setoptions) | setOptions(options: [GridOptions](/refs/Interface/GridOptions){/* */}): void; | Reset grid option information. |
| [setPasteOptions(options)](/refs/Class/GridBase#setpasteoptions) | setPasteOptions(options: [PasteOptions](/refs/Interface/PasteOptions){/* */}): void; | Set paste information in the grid using the [PasteOptions](/refs/Interface/PasteOptions) model. |
| [setProgress(min, max, position, message)](/refs/Class/GridBase#setprogress) | setProgress(min: number, max: number, position: number, message?: string): void; | Sets the state of the progress bar. |
| [setRowHeight(itemIndex, height, refresh)](/refs/Class/GridBase#setrowheight) | setRowHeight(itemIndex: number, height?: number, refresh?: boolean): void; | Change the row height to the specified height. |
| [setRowIndicator(value)](/refs/Class/GridBase#setrowindicator) | setRowIndicator(value: [RowIndicator](/refs/Interface/RowIndicator){/* */}): void; | Set the configuration information related to the grid indicator to the [RowIndicator](/refs/Interface/RowIndicator) model. |
| [setRowStyleCallback(f)](/refs/Class/GridBase#setrowstylecallback) | setRowStyleCallback(f?: [RowStyleCallback](/refs/realgrid#rowstylecallback){/* */}): void; | Change the row style. |
| [setSelection(item, eventFire)](/refs/Class/GridBase#setselection) | setSelection(item: [Selection](/refs/Interface/Selection){/* */}, eventFire?: boolean): void; | Specifies the area to select in the grid. |
| [setSortingOptions(options)](/refs/Class/GridBase#setsortingoptions) | setSortingOptions(options: [SortingOptions](/refs/Interface/SortingOptions){/* */}): void; | Set information related to grid sorting in the [SortingOptions](/refs/Interface/SortingOptions) model. |
| [setStateBar(value)](/refs/Class/GridBase#setstatebar) | setStateBar(value: [StateBar](/refs/Interface/StateBar){/* */}): void; | Set the grid status bar setting information to the model of [StateBar](/refs/Interface/StateBar). |
| [setTopItem(itemIndex)](/refs/Class/GridBase#settopitem) | setTopItem(itemIndex?: number): void; | It is located in the specified row at the top of the grid. |
| [setValidations(value)](/refs/Class/GridBase#setvalidations) | setValidations(value: [EditValidation](/refs/Interface/EditValidation){/* */}\[\] \| [EditValidation](/refs/Interface/EditValidation) \| string \| string\[\]): void; | Sets a list of row-level edit verification conditions. |
| [setValue(itemIndex, field, value)](/refs/Class/GridBase#setvalue) | setValue(itemIndex: number, field: string \| number, value: any): void; | Change the row order and the value of the data cell specified by the data field index. |
| [setValues(itemIndex, values, strict)](/refs/Class/GridBase#setvalues) | setValues(itemIndex: number, values: any\[\] \| object, strict?: boolean): void; | Modifies the values of multiple fields in a specified row. |
| [setVisible(value)](/refs/Class/GridBase#setvisible) | setVisible(value: boolean): void; | Show or hide the grid. |
| [showEditor(dropdown)](/refs/Class/GridBase#showeditor) | showEditor(dropdown?: boolean): void; | Displays the grid editor in the currently located cell. |
| [showFilterSelector(column, searchText)](/refs/Class/GridBase#showfilterselector) | showFilterSelector(column: string, searchText?: string): boolean; | Displays the filter selector. |
| [showLoading(disabled)](/refs/Class/GridBase#showloading) | showLoading(disabled?: boolean): void; | Display loading animation. |
| [showMessage(message, x, y)](/refs/Class/GridBase#showmessage) | showMessage(message: string \| [TooltipOptions](/refs/Interface/TooltipOptions){/* */}, x: number \| [CellIndex](/refs/Interface/CellIndex){/* */}, y?: number): void; | Displays a message in a cell or a specified location on the screen. |
| [showPopup(x, y, menu)](/refs/Class/GridBase#showpopup) | showPopup(x: number, y: number, menu?: string): void; | Displays a pop-up menu in the grid. |
| [showPopup(index, menu)](/refs/Class/GridBase#showpopup) | showPopup(index: [CellIndex](/refs/Interface/CellIndex){/* */}, menu?: string): void; | Displays a pop-up menu in the grid. |
| [showProgress()](/refs/Class/GridBase#showprogress) | showProgress(): void; | Displays a progress bar. |
| [showToast(options, force)](/refs/Class/GridBase#showtoast) | showToast(options: [ToastOptions](/refs/Interface/ToastOptions){/* */}, force?: boolean): void; | Displays the Toast pop-up window. |
| [toggleAllColumnFilters(column)](/refs/Class/GridBase#toggleallcolumnfilters) | toggleAllColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}): void; | Toggles all filters specified for the corresponding column. |
| [toggleColumnFilters(column, filterNames)](/refs/Class/GridBase#togglecolumnfilters) | toggleColumnFilters(column: string \| [DataColumn](/refs/Interface/DataColumn){/* */}, filterNames: string \| string\[\]): void; | Toggles the specified filters for the corresponding column. |
| [undo()](/refs/Class/GridBase#undo) | undo(): boolean; | Returns the datasource connected to the grid to its previous state. |
| [unregisterAllCustomRenderer()](/refs/Class/GridBase#unregisterallcustomrenderer) | unregisterAllCustomRenderer(): void; | Unregister all custom renderers. |
| [unregisterCustomRenderer(type)](/refs/Class/GridBase#unregistercustomrenderer) | unregisterCustomRenderer(type: string): void; | Unregister the custom renderer. |
| [validateCells(itemIndices, visibleOnly, pageAllItems, columns)](/refs/Class/GridBase#validatecells) | validateCells(itemIndices: number \| number\[\] \| null, visibleOnly?: boolean, pageAllItems?: boolean, columns?: string \| string\[\]): object; | Rather than verifying upon input, verification is performed on the data in the grid in batches. |

## Construct Desc

### (constructor)

Constructs a new instance of the `GridBase` class

<hr/>

## Events Desc

### onCellButtonClicked

Called when the user clicks the action button inside a data cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, column: [GridColumn] (/refs/Interface/GridColumn){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the item containing the data cell

`column` - Column connected to data cell

**Example:**


```js
gridView.onCellButtonClicked = function (grid, index, col) {
 console.log(index);
};
```

<hr/>

### onCellClicked

A callback indicating that a grid cell has been clicked

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, clickData: [ClickData](/refs/Interface/ClickData){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`clickData` - Clicked cell information

**Example:**


```js
gridView.onCellClicked = function (grid, clickData) {
 console.log(clickData);
}
```

<hr/>

### onCellDblClicked

A callback indicating that a grid cell has been double-clicked.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, clickData: [ClickData](/refs/Interface/ClickData){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`clickData` - Clicked cell information

**Example:**


```js
gridView.onCellDblClicked = function (grid, clickData) {
 console.log(clickData);
}
```

<hr/>

### onCellEdited

A callback notifying that one field value of the edit item being modified or added has been edited.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, field: number) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - The order of the row being edited

`row` - Unique number of the row being edited

`field` - Index of the field just edited

**Example:**


```js
gridView.onCellEdited = function (grid, itemIndex, row, field) {
 console.log('Edit done! at ' + itemIndex + ', ' + field);
}
```

<hr/>

### onCellItemClicked

A callback notifying that an element contained in a grid cell has been clicked.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, clickData: [ClickData] (/refs/Interface/ClickData){/* */}) =&gt; boolean

**Remarks:**

If you handle a click within this event, you must return `false`{/* */} to not execute the element's default action.

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the clicked data cell

`clickData` - Clicked cell information

**Example:**


```js
gridView.onCellItemClicked = function (grid, index, clickData) {
 console.log(clickData);
 return true;
}
```

<hr/>

### onCellPasting

A callback that determines what to paste into a cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any, editResult: [EditResult](/refs/Interface/EditResult){/* */}) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the clicked data cell

`value` - the data value being pasted

`editResult` - Output information after pasting cells

\[Return value\] - If `false`{/* */} is returned, the paste will not be performed in that cell.

**Example:**


```js
gridView.onCellPasting = function (grid, index, value, editResult) {
     if (value === 'hello') {
         return false;
     }
     if (editResult.oldValue === 'expired') {
         return false;
     }
     return true;
};
```

<hr/>

### onColumnCheckedChanged

A callback that notifies the user's click on the column header checkbox.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, checked: boolean) = &gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`column` - column object

`checked` - Checked or not

**Example:**


```js
gridView.onColumnCheckedChanged = function (grid, col, chk) {
 console.log(col.name + "was checked as: " + chk);
};
```

<hr/>

### onColumnPropertyChanged

> Warning: This API is now obsolete.
>
> Replaced with callback [GridBase.onLayoutPropertyChanged](/refs/Class/GridBase#onlayoutpropertychanged){/* */} that notifies that the width, displayIndex, and visible property values of the column properties have changed.
>

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, property: string, newValue : any, oldValue: any) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`column` - Information on the changed column

`property` - Changed displayWidth, displayIndex, or visible properties of the column

`value` - The changed value is passed.

**Example:**


```js
gridView.onColumnPropertyChanged = function (grid, column, property, newValue, oldValue) {

 console.log(column + "s props werer changed!");
}
```

<hr/>

### onCommandStackChanged

Callback notifying that the CommandStack has changed

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, undoable: boolean, redoable: boolean) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`undoable` - back

`redoable` - forward

**Example:**


```js
gridView.onCommandStackChanged = function (grid, undoable, redoable) {
 if (undoable === true) {
 console.log('You can undo now!');
 }
};
```

<hr/>

### onContextMenuItemClicked

A callback notifying the click of a context menu item added via [setContextMenu()](/refs/Class/GridBase#setcontextmenu)

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, item: [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}, clickData: [ClickData] (/refs/Interface/ClickData){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`item` - information about the menu item that was clicked

`clickData` - Information about the clicked item

**Example:**


```js
gridView.onContextMenuItemClicked = function (grid, item, clickData) {
 console.log(clickData);
};
```

<hr/>

### onContextMenuPopup

A callback that determines the display of the ContextMenu with its coordinates

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, x: number, y: number, clickData: [ClickData](/refs/Interface/ClickData){/* */}, menu: string, rightClick: boolean) =&gt; boolean \| string

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`x` - x-coordinate value at which ContextMenu was called

`y` - y coordinate value where ContextMenu was called

`clickData` - Information about the clicked item

`menu` - menuName

`rightClick` - Whether to click the right button

\[Return value\] - If `false`{/* */} is returned, the context menu is not displayed. Also, if menuName is returned, the corresponding menu is displayed.

**Example:**


```js
gridView.onContextMenuPopup = function (grid, x, y, clickData, menu, rightClick) {
 console.log(clickData);
};
```

<hr/>

### onCopy

Callback to decide copy with control + c keys

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection) \| [Selection](/refs/Interface/Selection ){/* */}\[\], event: ClipboardEvent) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`selection` - selection information

`event` - Event information ([ClipboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent){/* */})

\[Return value\] - If `false`{/* */} is returned, copying is canceled.

**Example:**


```js
gridView.onCopy = function(grid, selection, event) {
 let data = JSON.stringify(grid.getSelectionData());
 if (data) {
  data = 'onCopy\r\n' + data;
  if (window.clipboardData) {
  window.clipboardData.setData("Text", data);
  } else {
  event.clipboardData.setData('text/plain', data);
  }
 }
 return false;
}
```

<hr/>

### onCurrentChanged

A callback that notifies the change in position of the grid's focus cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, newIndex: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void

**Remarks:**

Just before change, call [onCurrentChanging](/refs/Class/GridBase#oncurrentchanging)

\[Parameter list\]

`grid` - GridBase control

`newIndex` - Changed cell location information

**Example:**


```js
gridView.onCurrentChanged = function (grid, newIndex) {
 console.log(newIndex);
}
```

<hr/>

### onCurrentChanging

A callback that determines the change in position of the grid's focus cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, oldIndex: [CellIndex](/refs/Interface/CellIndex){/* */}, newIndex: [CellIndex] (/refs/Interface/CellIndex){/* */}) =&gt; boolean

**Remarks:**

After change, call [onCurrentChanged](/refs/Class/GridBase#oncurrentchanged).

\[Parameter list\]

`grid` - GridBase control

`oldIndex` - Cell location information before change

`newIndex` - Cell location information to be changed

\[Return value\] - If the callback function explicitly returns `false`{/* */}, current will not change.

**Example:**


```js
gridView.onCurrentChanging = function (grid, oldIndex, newIndex) {
 console.log(oldIndex);
 console.log(newIndex);
 // return false; If you do this, the location does not change.
};
```

<hr/>

### onCurrentRowChanged

A callback notifying that the position of a row of data has changed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, oldRow: number, newRow: number) =&gt; void

**Remarks:**

[onCurrentChanged](/refs/Class/GridBase#oncurrentchanged){/* */} occurs when the itemIndex of the selected cell changes. However, in the case of [onCurrentRowChanged](/refs/Class/GridBase#oncurrentrowchanged), it occurs when the index of the data row of the selected cell changes.

\[Parameter list\]

`grid` - GridBase control

`oldRow` - Position of the data row before change

`newRow` - Position of the data row after change. If `-1`{/* */}, it is a new row or `dataProvider`{/* */} is empty.

**Example:**


```js
gridView.onCurrentRowChanged = function (grid, oldRow, newRow) {
 console.log("oldRow => ", oldRow, "newRow => ", newRow);
};
```

<hr/>

### onCut

Callback to determine cut with control + x keys

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection) \| [Selection](/refs/Interface/Selection ){/* */}\[\], event: ClipboardEvent) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`selection` - selection information

`event` - Event information ([ClipboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent){/* */})

\[Return value\] - If `false`{/* */} is returned, the cut is cancelled.

<hr/>

### onDataLoadComplated

A callback that fires after the grid refresh is complete after executing dataProvider.setRows().

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onDataLoadComplated = function (grid) {
 console.log("Grid DataLoadComplated")
};
```

<hr/>

### onEditCanceled

A callback notifying that editing is canceled when the user presses the ESCAPE key while editing or when [cancel()](/refs/Class/GridBase#cancel) is called.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the data cell whose editing was canceled

**Example:**


```js
gridView.onEditCanceled = function (grid, index) {
 console.log("Edit Canceled at " + index.column);
}
```

<hr/>

### onEditChange

A callback notifying that the value of an item has changed due to the user entering a key, etc.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any) = &gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the currently focused cell

`value` - the data value of the cell being edited

**Example:**


```js
gridView.onEditChange = function (grid, index, value) {
 console.log("grid.onEditChange driven, " + index.column + ' at ' + index.dataRow + ' was replaced by value: ' + value);
}
```

<hr/>

### onEditCommit

A callback that determines whether user input is reflected in the cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, oldValue: any, newValue : any) =&gt; boolean

**Remarks:**

Occurs when you move from the cell being edited to another cell or call [commitEditor()](/refs/Class/GridBase#commiteditor). It does not occur when changed to user code such as [setValue()](/refs/Class/GridBase#setvalue).

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the changed cell

`oldValue` - Data value of the cell before editing

`newValue` - Data value of the cell after editing

\[Return value\] - If `false` is returned, it is not reflected in the cell.

**Example:**


```js
gridView.onEditCommit = function (grid, index, oldValue, newValue) {
 if (newValue === '') {
 return false;
 }
 console.log(oldValue + 'was changed to ' + newValue);
}
```

<hr/>

### onEditRowChanged

A callback that notifies the row that the value changed by user input has been reflected in the row.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, field: number, oldValue: any, newValue: any) =&gt; void

**Remarks:**

If [pasteOptions.noEditEvent](/refs/Interface/PasteOptions#noeditevent) is `true`, it does not occur.

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of changed rows

`row` - Unique number of the changed row

`field` - Index of the changed field

`oldValue` - Data value of the cell before editing

`newValue` - Data value of the cell after editing

**Example:**


```js
gridView.onEditRowChanged = function (grid, itemIndex, dataRow, field, oldValue, newValue) {
 let v = grid.getValue(itemIndex, field);
 console.log("onEditRowChanged, " + field + ": " + oldValue + " => " + newValue);
};
```

<hr/>

### onEditRowPasted

A callback indicating that something has been pasted into a grid cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, row: number, fields: number\[\], oldValues: any\[\], newValues : any\[\]) =&gt; void

**Remarks:**

When pasting multiple rows, refer to [onRowsPasted](/refs/Class/GridBase#onrowspasted)

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of changed rows

`row` - Unique number of the changed row

`fields` - indexes of fields

`oldValues` - Data values of the cell before editing

`newValues` - Data values of the cell after editing

**Example:**


```js
gridView.onEditRowPasted = function (grid, itemIndex, row, fields, oldValues, newValues) {
 console.log('Row pasted!: {' + newValues.join() + '}');
};
```

<hr/>

### onEditSearch

A callback indicating that a search has been performed

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, text: string) = &gt; void

**Remarks:**

Occurs when the conditions [searchLenght](/refs/Interface/SearchCellEditor#searchlength) and [searchDelay](/refs/Interface/SearchCellEditor#searchdelay) are met in [SearchCellEditor](/refs/Interface/SearchCellEditor){/* */} do. Or, it occurs when you press Ctrl+Enter or Enter key.

\[Parameter list\]

`grid` - GridBase control

`index` - Changed cell location information

`text` - the value entered into the cell

**Example:**


```js
gridView.onEditSearch = function (grid, index, text) {
 console.log(text + 'was searched!');
}
```

<hr/>

### onErrorClicked

A callback notifying that an error window in the grid has been clicked.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, error: string) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`error` - error message

**Example:**


```js
gridView.onErrorClicked = function (grid, error) {
 console.log(error);
}
```

<hr/>

### onFiltering

Callback to determine filtering

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [DataColumn](/refs/Interface/DataColumn){/* */}) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control `column` - Dispatched when the filter selector is displayed. It is not transmitted when changing the active status of the filter.

\[Return value\] - Default value: `true`{/* */}, specifies whether to perform filtering. If `false` is returned, filtering is canceled.

**Example:**


```js
gridView.onFiltering = function (grid, column) {
 if (column && column.name === "column") {
 return false; // Prevents specific columns from being filtered using the filter selector.
 }
 return true;
}
```

<hr/>

### onFilteringChanged

A callback notifying that filters are set in a column and that the state of the filter has changed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, filter: [ColumnFilter] (/refs/Interface/ColumnFilter){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`column` - Filtered column information

`filter` - information about the filter

`reset` - whether to click reset

**Example:**


```js
gridView.onFilteringChanged = function (grid, column, filter) {
 console.log('Filter changed!');
}
```

<hr/>

### onGetEditValue

A callback containing the cell position and editing result when cell editing is completed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, editResult: [EditResult] (/refs/Interface/EditResult){/* */}) =&gt; boolean

**Remarks:**

In the case of DropDownCellEditor, SearchCellEditor, and MultiCheckCellEditor, the value corresponding to the labels is output to editResult.text, and the value corresponding to the values is output to editResult.value.

In the case of DateCellEditor, a value formatted with the editor's datetimeFormat is output to editResult.text, and a Date object is output to editResult.value.

In the case of other editors, the same values are output for text and value.

If you return `boolean`{/* */}, [GridBase.onEditCommit](/refs/Class/GridBase#oneditcommit){/* */} will not be called.

It is output in the form of [EditResult](/refs/Interface/EditResult).

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the edited cell

`editResult` - A simple object with the text and value of the edited cell as properties; the output value varies depending on the type of cell editor.

\[Return value\] - If `false` is returned, it is not reflected in the cell.

**Example:**


```js
gridView.onGetEditValue = function (grid, index, editResult) {
 console.log(editResult);
}
```

<hr/>
### onGridActivated

A callback indicating that the grid has been selected

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

It is best to use the grid by storing it in a global variable.

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onGridActivated = function (grid) {
 alert('Selected!');
}
```

<hr/>

### onHideEditor

A callback to notify you that editing is complete and the editor has disappeared.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the edited cell

**Example:**


```js
gridView.onHideEditor = function (grid, index) {
 console.log("onHideEditor:" + index.itemIndex + "," + index.column);
}
```

<hr/>

### onInitialized

A callback that occurs after the grid is created.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

\[Parameter List\]

`grid` - GridBase control

**Example:**

```js
gridView.onInitialized = function (grid) {
console.log(`gridView initialized`);
}
```

<hr/>

### onItemAllChecked

A callback notifying that the user clicked on the header of the checkBar to select or deselect all, or entered checkAll `true` / `false` to select or deselect all.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, checked: boolean) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`checked` - true if checked, false if unchecked

**Example:**


```js
gridView.onItemAllChecked = function (grid, checked) {
 console.log('All checked as ' + checked);
};
```

<hr/>

### onItemChecked

A callback notifying that the user changed a check by clicking a checkbox in checkBar or calling checkItem.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, checked: boolean) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of checked data rows

`checked` - If checked, `true`{/* */} is output, if unchecked, `false`{/* */} is output.

**Example:**


```js
gridView.onItemChecked = function (grid, itemIndex, checked) {
 console.log('Checked as ' + checked + ' at ' + itemIndex);
};
```

<hr/>

### onItemEditCancel

A callback that determines whether the user wants to cancel row editing.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, state: string) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of rows for which editing was canceled

`state` - The state of the unedited row. updating, inserting, appending are returned.

\[Return value\] - Default value: `true`{/* */}, if `false` is returned, row edit cancellation is canceled. (Continued editing)

**Example:**


```js
gridView.onItemEditCancel = function (grid, itemIndex, state) {
 console.log(state);
 if (itemIndex % 5 === 0) {
 return false;
 }
}
```

<hr/>

### onItemEditCanceled

A callback indicating that the user canceled row editing.

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of rows for which editing was canceled

`state` - the state of the unedited row

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, state: string) =&gt; void

**Example:**


```js
gridView.onItemEditCanceled = function (grid, itemIndex, state) {
 console.log(state);
}
```

<hr/>

### onItemsChecked

A callback notifying that the user changed a check by clicking a checkbox in checkBar or calling checkItem.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, items: number\[\], checked: boolean) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`items` - Order of checked data rows

`checked` - `true`{/* */}: checked, `false`{/* */}: unchecked

**Example:**


```js
gridView.onItemsChecked = function (grid, items, checked){
 console.log(items.join() + ' are checked as ' + checked);
}
```

<hr/>

### onKeyDown

A callback that determines keystrokes

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; boolean

**Remarks:**

Occurs when KeyDown occurs. This occurs continuously while a key is being input.

\[Parameter list\]

`grid` - GridBase control

`event` - KeyboardEvent

\[Return value\] - Returns false when key input is prohibited/

**Example:**


```js
gridView.onKeyDown = function (grid, event) {
 console.log('You pressed... ' + event);
}
```

<hr/>

### onKeyPress

A callback to indicate that a key is being entered

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; void

**Remarks:**

Occurs when KeyPress is performed. This occurs continuously while a key is being input.

\[Parameter list\]

`grid` - GridBase control

`event` - KeyboardEvent

**Example:**


```js
gridView.onKeypress = function (grid, event) {
 console.log('You are pressing... ' + event);
}
```

<hr/>

### onKeyUp

A callback notifying that a key has been entered.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, event: KeyboardEvent) =&gt; void

**Remarks:**

Occurs when KeyUp occurs.

\[Parameter list\]

`grid` - GridBase control

`event` - KeyboardEvent

**Example:**


```js
gridView.onKeyUp = function (grid, event) {
 console.log('You pressed... ' + event);
}
```

<hr/>

### onLayoutCollapsed

Callback notifying that the group layout has been collapsed

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; void

**Remarks:**

\[Parameter list\] `grid` - GridBase control

`layout` - Collapsed group layout

**Example:**


```js
gridView.onLayoutCollapsed = function(grid, layout) {
 console.log("Layout Collapsed => " + layout.name)
}
```

<hr/>

### onLayoutCollapse

Callback to determine group layout collapse

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; boolean

**Remarks:**

If you return `false`{/* */}, folding is canceled. \[Parameter list\]

`grid` - GridBase control

`layout` - collapsing group layout

**Example:**


```js
gridView.onLayoutCollapsing = function(grid, layout) {
 if (layout.name === "group0") {
 return false;
 }
}
```

<hr/>

### onLayoutExpanded

Callback notifying that the group layout has been expanded

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; void

**Remarks:**

\[Parameter list\] `grid` - GridBase control

`layout` - group layout to expand

**Example:**


```js
gridView.onLayoutExpanded = function(grid, layout) {
 console.log("Layout Expanded => " + layout.name)
}
```

<hr/>

### onLayoutExpanding

Callback that determines group layout expansion

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutGroupItem](/refs/Interface/CellLayoutGroupItem){/* */}) =&gt; boolean

**Remarks:**

If you return `false`{/* */}, expansion is canceled. \[Parameter list\]

`grid` - GridBase control

`layout` - group layout to expand

**Example:**


```js
gridView.onLayoutExpanding = function(grid, layout) {
 if (layout.name === "group0") {
 return false;
 }
}
```

<hr/>

### onLayoutPropertyChanged

A callback notifying that the displayWidth, displayIndex, and visible property values among the layout properties have changed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, layout: [CellLayoutItem](/refs/Interface/CellLayoutItem){/* */}, property: string, newValue : any, oldValue: any) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`layout` - Information on changed layout

`property` - Changed displayWidth, displayIndex, or visible properties of the column

`newValue` - The value is passed after change.

`oldValue` - The value before change is transmitted.

**Example:**


```js
gridView.onLayoutPropertyChanged = function (grid, layout, property, newValue, oldValue) {

 console.log(layout + "s props werer changed!");
}
```

<hr/>

### onLeftPosChanged

A callback notifying that the position of the horizontal scroll bar has changed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, pos: number) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`pos` - Left position of grid when scrolling

**Example:**


```js
gridView.onLeftPosChanged = function (grid, pos) {
 console.log(pos + " was changed!");
}
```

<hr/>

### onMenuItemClicked

Callback notifying that the added pop-up menu item is clicked

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, item: [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */}, clickData: [ClickData] (/refs/Interface/ClickData){/* */}) =&gt; void

**Remarks:**

If [callback](/refs/Interface/PopupMenuItem#callback) is specified in MenuItem, it is not called.

\[Parameter list\]

`grid` - GridBase control

`item` - MenuItem object

`clickData` - Information about the clicked item

**Example:**


```js
gridView.onMenuItemClicked = function (grid, item, clickData) {
 console.log(item.label + "was clicked.");
};
```

<hr/>

### onPaste

A callback that determines what to paste into the grid.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, event: ClipboardEvent) = &gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Cell location information

`event` - Event information ([ClipboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent){/* */})

\[Return value\] - If `false`{/* */} is returned, the paste is canceled.

**Example:**


```js
gridView.onPaste = function (grid, index, event){
 console.log("Pasting Starts!");
}
```

<hr/>

### onPasted

A callback indicating that something has been pasted into the grid.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

This does not occur when the input editor is displayed.

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onPasted = function (grid){
 console.log("Pasted!");
}
```

<hr/>

### onRowInserting

A callback that determines whether the user inserts a new row by pressing the Insert key or adds a row by pressing the down arrow on the last row.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, dataRow: number) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of row insertion position

`dataRow` - Unique id of the row insertion location.

\[Return value\] - Message to be displayed to the user when adding rows is prohibited.

**Example:**


```js
gridView.onRowInserting = function (grid, itemIndex, dataRow) {
 console.log('Inserted: ' + dataRow + ' at ' + itemIndex);
}
```

<hr/>

### onRowsDeleting

When the user presses Ctrl+Del or deletes with [deleteSelection()](/refs/Class/GridBase#deleteselection), a callback that determines the actual deletion.

\[Parameter list\]

`grid` - GridBase control

`rows` - an array of data row sequences of the rows to be deleted

\[Return value\] - If a non-null value is returned, the specified text is displayed and deletion is canceled.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, rows: number\[\]) =&gt; boolean

**Example:**


```js
gridView.onRowsDeleting = function (grid, rows) {
 console.log('Deleted: ' + rows.join());
}
```

<hr/>

### onRowsPasted

Callback to indicate that multiple rows have been pasted

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, items: number\[\]) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`items` - the order in the grid of the pasted rows

**Example:**


```js
gridView.onRowsPasted = function (grid, items) {
 console.log('Rows pasted!: ' + items.join());
};
```

<hr/>

### onScrollToBottom

A callback that is called when the last row is displayed in the grid by the user operating the keyboard, scroll bar, etc.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onScrollToBottom = function (grid) {
 var data = {"SearchKey":"searchData"},
 $.ajax({
 url:"/loadData.do",
 data: data,
 type:"post",
 async:false;
 success: function (data, textStatus) {
 grid.fillJsonData(data.dataList, {fillMode:"append"});
 }
 })
});
```

<hr/>

### onSearchCellButtonClick

A callback notifying that a button was clicked in [SearchCellEditor](/refs/Interface/SearchCellEditor)

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, text: string) = &gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Clicked cell location information

`text` - the value entered into the cell

**Example:**


```js
gridView.onSearchCellButtonClick = function (grid, index, text) {
 console.log(text + 'button was clicked!');
}
```

<hr/>

### onSelectionAdded

> Warning: This API is now obsolete.
>
> Scheduled to be removed after version 2.6.0
>

Callback notifying that a new selection area has been added

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void

**Remarks:**

Information on the selection area being changed can be found with the [getSelectionData](/refs/Class/GridBase#getselectiondata) function. Does not occur when [GridBase.getSelection().style](/refs/Interface/Selection#style) is [SelectionStyle.NONE](/refs/realgrid#selectionstyle).

\[Parameter list\]

`grid` - GridBase control

`selection` - selection information

**Example:**


```js
gridView.onSelectionAdded = function (grid, selection) {
 console.log(selection);
}
```

<hr/>

### onSelectionChanged

A callback notifying that the user has changed the size of the selection using the mouse or keyboard.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void

**Remarks:**

Information on the selection area being changed can be found with the [getSelectionData](/refs/Class/GridBase#getselectiondata) function. Does not occur when [GridBase.displayOptions.selectionStyle](/refs/Interface/DisplayOptions#selectionstyle) is [SelectionStyle.NONE](/refs/realgrid#selectionstyle).

\[Parameter list\]

`grid` - GridBase control `selection` - Selection information

**Example:**


```js
gridView.onSelectionChanged = function (grid) {
 console.log('Selection changed!');
}
```

<hr/>

### onSelectionCleared

A callback notifying that the existing selection area has been removed when the user changes the selection area with the mouse or keyboard.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

This does not occur if there is no existing selection area.

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onSelectionCleared = function (grid) {
 console.log('Selection cleared');
}
```

<hr/>

### onSelectionEnded

> Warning: This API is now obsolete.
>
> Scheduled to be removed after version 2.6.0
>

A callback to notify the user of completion of changes to the selection with the mouse.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, selection: [Selection](/refs/Interface/Selection){/* */}) =&gt; void

**Remarks:**

Information on the changed selection area can be found with the [getSelection](/refs/Class/GridBase#getselection) function, and data on the selection area can be known with the [getSelectionData](/refs/Class/GridBase#getselectiondata) function. \[Parameter list\]

`grid` - GridBase control `selection` - Selection information

**Example:**


```js
gridView.onSelectionEnded = function (grid) {
 let cells = grid.getSelectionData();
 console.log(cells);
}
```

<hr/>

### onShowEditCommand

A callback that determines whether to display the editCommand displayed on mobile.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the cell where the editor is to be opened.

\[Return value\] - If false is returned, the EditCommand is not displayed.

<hr/>

### onShowEditor

A callback that determines the display of the editor opened for each cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, props: any, attrs : any) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`index` - Location information of the cell where the editor is to be opened.

`props` - [Cell Editor](/refs/Interface/CellEditor) configuration information

`attrs` - Internal editor element attributes. Values that the user can arbitrarily specify.

\[Return value\] - If false is returned, the Editor is not displayed.

**Example:**


```js
gridView.onShowEditor = function (grid, index, props, attrs) {
 console.log("onShowEditor:" + index.itemIndex + "," + index.column);
 if (index.column == "OrderID") {
  props.textCase = 'upper';
 }
}
```

<hr/>
### onShowHeaderTooltip

A callback that notifies that a column header tooltip has been displayed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [GridColumn](/refs/Interface/GridColumn){/* */}, value: any, layout: [CellLayoutItem](/refs/Interface/CellLayoutItem){/* */}, isEllipsis: boolean) =&gt; boolean \| string \| [TooltipOptions](/refs/Interface/TooltipOptions)

**Remarks:**

\[Parameter List\]

`grid` - GridBase control

`column` - The column on which the tooltip will be displayed. If it's a GroupHeader, it's the first column in the group.

`value` - The value to display in the tooltip. The default value is the column header text.

`layout` - The layout of the column where the tooltip will be displayed.

`isEllipsis` - Whether the data cell is ellipsoid.

[Return Value] - The value to display in the tooltip. If nothing is returned, no tooltip will be displayed.

**Example:**

```js
gridView.onShowHeaderTooltip = function (grid, column, value, layout) {
    return 'header-tooltip: ' + value;
}
```

<hr/>

### onShowRowBarTooltip

A callback that notifies that the tooltip for the Rowbar area has been displayed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, cellType: [GridCellType](/refs/realgrid#gridcelltype){/* */}, itemIndex: number, dataRow: number) =&gt; string \| [TooltipOptions](/refs/Interface/TooltipOptions)

**Remarks:**

\[Parameter List\]

`grid` - GridBase control

`cellType` - Grid cell type

`itemIndex` - Row order

`dataRow` - Row unique number

\[Return Value\] - The value to display in the tooltip. If nothing is returned, no tooltip will be displayed.

**Example:**

```js
grid.onShowRowBarTooltip = (grid, cellType, idx, row) => {
    if (cellType === GridCellType.INDICATOR) {
        return "row indicator" + idx+1 + "th";
    } else if (cellType === GridCellType.STATE){
        return `stateBar ${idx + 1}th`;
    } else if (cellType === GridCellType.CHECK) { 
        return `checkBar ${idx+1}th`; 
    } 
    return "";
}
```

<hr/>

### onShowTooltip

A callback to indicate that a data cell's tooltip has been displayed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, index: [CellIndex](/refs/Interface/CellIndex){/* */}, value: any, isEllipsis: boolean) =&gt; boolean \| string \| [TooltipOptions](/refs/Interface/TooltipOptions)

**Remarks:**

\[Parameter list\]

`grid` - GridBase control.

`index` - Cell location information in the area where the mouse pointer is located

`value` - the data where the mouse pointer is located

`isEllipsis` - whether the data cell is ellipsis

\[Return value\] - The value to display in the tooltip. If nothing is returned, the Tooltip is not displayed.

**Example:**


```js
gridView.onShowTooltip = function (grid, index, value) {
 if (index % 7 === 0) {
 return '7-multiple Row!'
 }
}
```

<hr/>

### onSorting

Callback to determine sorting

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, fields: number\[\], directions: string\[\]) =&gt; boolean

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`fields` - list of fields to sort by

`direction` - List of sorting methods for each field

\[Return value\] - If `false` is returned, sorting is canceled.

**Example:**


```js
gridView.onSorting = function (grid) {
 if (fields. length > 5) {
 return false;
 }
}
```

<hr/>

### onSortingChanged

A callback indicating that sorting has occurred.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

**Example:**


```js
gridView.onSortingChanged = function (grid) {
 console.log('Sorted! ');
}
```

<hr/>

### onTopIndexChanged

A callback notifying that the position of the vertical scroll bar has changed.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number) =&gt; void

**Remarks:**

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - The itemIndex value displayed at the top of the grid when scrolling.

**Example:**


```js
gridView.onTopIndexChanged = function (grid, idx) {
 console.log(idx + "was changed!");
}
```

<hr/>

### onTopIndexChanging

Callback called when gridView.topIndex changes

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, currentTop: number, delta: number, focusing: boolean, adjust: boolean) =&gt; number

**Remarks:**

Used to move by the value specified by the user when scrolling. You should not return more than the value shown on the page.

\[Parameter list\]

`grid` - GridBase control

`currentTop` - topIndex before change

`delta` - change value

`focusing` - `true` if topIndex changes due to focus change

`adjust` - `true` to adjust position within the grid

\[Return value\] - If `number`{/* */} is returned, topIndex is moved by the corresponding value.

**Example:**


```js
var userSetTopItem = false;
grid.onTopIndexChanging = function(_grid, current, delta, focusing, adjust) {
// When using mergeCell like a block, scrolling is also used to move in block units.
// In the case of setTopItem, since it cannot be distinguished in the event, a value that can be distinguished externally must be given.
// In case of rowGrouping, the code below cannot be used as is.

 var fcnt = _grid.fixedOptions.rowCount;
 // When moving to the first or last row, or when correcting the position within the grid, if 'null' is returned, it moves by the delta value to which it was originally intended to be moved.
 if (current + delta + _grid.fullItemCount() + fcnt >= _grid.getItemCount() || current + delta === 0 || (adjust && !focusing)) {
 console.log(current, delta, `scroll bottom or Top or adjust = ${adjust}`);
 return;
 }

 var top = current + delta; // topIndex where you want the grid to move
 var items = _grid.getMergedItems(top + fcnt, "merge column", true, true); // Items of block to move
 var curItems = _grid.getMergedItems(current + fcnt, "merge column", true, true); // Items of current top block

 if (delta < 0 || top === items[0] + fcnt || userSetTopItem) { // When scrolling up or moving to the top with fixedRow or when the user setsTopItem
 top = items[0]; // The first row of the block is topIndex
 } else { // When scrolling down
 top = items[0] === curItems[0] ? items[items.length - 1] + 1 : top = items[0]
 }

 return top - current - fcnt;
}

function setTop(index) {
 userSetTopItem = true;
 grid.setTopItem(index);
 userSetTopItem = false;
}
```

<hr/>

### onValidateColumn

A callback that determines the result of user verification through Javascript when completing cell editing and moving to another cell.

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, column: [DataColumn](/refs/Interface/DataColumn){/* */}, inserting: boolean, value : any, itemIndex: number, dataRow: number) =&gt; [ValidationError](/refs/Interface/ValidationError) \| undefined

**Remarks:**

If there is a problem with the corresponding column value, the verification error and error message are sent to the grid as a return value.

If an object containing `level`{/* */} and `message` values is passed to the grid, verification is judged to have failed.

It must be returned in the form [ValidationError](/refs/Interface/ValidationError).

\[Parameter list\]

`grid` - GridBase control

`column` - column object

`inserting` - `true`{/* */}: adding column, `false`{/* */}: modifying column

`value` - the value of the entered field

`itemIndex` - Order of cell-edited rows

`dataRow` - Unique number of the cell-edited row.

\[Return Value\] - [ValidationError](/refs/Interface/ValidationError)

**Example:**


```js
gridView.onValidateColumn = function (grid, column, inserting, value, itemIndex, dataRow) {
 if (column.name != "Knock Knock") {
 return {
 level: 'warning';
 messsage: "It's a dad joke! Do not " + JSON.stringify(column);
 }
 }
};
```

<hr/>

### onValidateRow

Callback to determine row-wise user verification results via Javascript

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, dataRow: number, inserting: boolean, values: any\[\]) =&gt; [ValidationError](/refs/Interface/ValidationError)

**Remarks:**

If there is a problem with the values in the row, the verification error and error message are sent to the grid as a return value.

`levelIf an object containing `{/* */} and `message` values is passed to the grid, verification is judged to have failed.

It must be returned in the form [ValidationError](/refs/Interface/ValidationError).

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Order of rows to verify

`dataRow` - Unique number of the row being verified

`inserting` - true: adding column, false: modifying column

`values` - Values of the entered fields

\[Return Value\] - [ValidationError](/refs/Interface/ValidationError)

**Example:**


```js
gridView.onValidateRow = function (grid, itemIndex, dataRow, inserting, values) {
 if (dataRow % 2 === 0) {
 return {
 level: 'info';
 messsage: "even!";
 }
 }
};
```

<hr/>

### onValidationFail

Callback that occurs when validation fails

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, itemIndex: number, column: [GridColumn](/refs/Interface/GridColumn){/* */}, error : [ValidationError](/refs/Interface/ValidationError){/* */}) =&gt; [ValidationError](/refs/Interface/ValidationError)

**Remarks:**

Separate error handling is possible in the callback function, and when an err object is returned, its own validation message is displayed and is not displayed in other cases.

If an object containing `level`{/* */} and `message` values is passed to the grid, verification is judged to have failed.

It must be returned in the form [ValidationError](/refs/Interface/ValidationError).

\[Parameter list\]

`grid` - GridBase control

`itemIndex` - Index of the row being verified

`column` - column object

`error` - verification result

\[Return Value\] - [ValidationError](/refs/Interface/ValidationError)

**Example:**


```js
gridView.onValidationFail = function (grid, itemIndex, column, err) {
 console.log("onValidationFail:" + itemIndex + "," + JSON.stringify(column) + "," + JSON.stringify(err));
 if (column.name != "Mortal") {
 var editValue = grid.getEditValue();
 err.message = "The entered "+editValue+" is an invalid value";
 return err;
 }
}
```

<hr/>

### onWheel

Callback notifying that a Wheel Event has occurred

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, event: WheelEvent) =&gt; boolean

**Remarks:**

Occurs when you turn the Mouse Wheel.

\[Parameter list\]

`grid` - GridBase control

`event` - WheelEvent

\[Return value\] - Return false to ignore the Wheel Event/

**Example:**


```js
gridView.onWheel = function (grid, event) {
 console.log('You wheeled... ' + event);
}
```

<hr/>

## Properties Desc

### checkBar

Configuration model for grid checkbars

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

**Remarks:**

Returns a [CheckBar](/refs/Interface/CheckBar) object. You can get or set CheckBar properties.

**Example:**


```js
gridView.checkBar.visibleOnly = true;
```

<hr/>

### copyOptions

Configuration model for copying to clipboard

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

**Remarks:**

[CopyOptions](/refs/Interface/CopyOptions) Returns an object. You can get or set the properties of CopyOptions.

**Example:**


```js
gridView.copyOptions.singleMode = true;
```

<hr/>

### dataDropOptions

Configuration model related to data drag and drop

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

**Remarks:**

Returns [dataDropOptions](/refs/Interface/DataDropOptions). You can get or set the properties of DataDropOptions.

**Example:**


```js
gridView.dataDropOptions.dropMode = 'copy';
```

<hr/>

### disabled

The grid does not respond to mouse/keyboard events.

`Type` - boolean

**Remarks:**

It can be changed by assigning a value.

**Example:**


```js
gridView.disabled = true;
```

<hr/>

### displayOptions

Setting model for display information managed at grid level

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

**Remarks:**

[DisplayOptions](/refs/Interface/DisplayOptions) Returns an object. You can get or set the properties of DisplayOptions.

**Example:**


```js
gridView.displayOptions.columnResizable = true;
```

<hr/>

### editOptions

Settings model for data editing

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

**Remarks:**

[EditOptions](/refs/Interface/EditOptions) Returns an object. You can get or set the properties of EditOptions.

**Example:**


```js
gridView.editOptions.deletable = true;
```

<hr/>

### editorOptions

Settings model for editors

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

**Remarks:**

[EditorOptions](/refs/Interface/EditorOptions) Returns an object. You can get or set the properties of EditorOptions.

**Example:**


```js
gridView.editorOptions.yearDisplayFormat = "Year {Y}";
```

<hr/>

### filteringOptions

Settings model for data filtering

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

**Remarks:**

[FilteringOptions](/refs/Interface/FilteringOptions) Returns an object. You can get or set the properties of FilteringOptions.

**Example:**


```js
gridView.filteringOptions.enabled = false;
```

<hr/>

### filterPanel

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

<hr/>

### fixedOptions

Setting model for fixed rows and columns in grid

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

**Remarks:**

[FixedOptions](/refs/Interface/FixedOptions) Returns an object. You can get or set properties of FixedOptions.

**Example:**


```js
gridView.fixedOptions.colCount = 2;
```

<hr/>

### footer

Configuration model for the first footer

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

**Remarks:**

Returns a [GridFooter](/refs/Interface/GridFooter) object. You can get or set the properties of GridFooter.

**Example:**


```js
gridView.footer.styleName = 'custom-footer-1';
```

<hr/>

### footers

Configuration model for footers

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

**Remarks:**

Returns a collection object of [GridFooter](/refs/Interface/GridFooter). [GridFooterCollection](/refs/You can get or set the properties of Interface/GridFooterCollection).

**Example:**


```js
gridView.footers.visible = false;
```

<hr/>

### formatOptions

Setting model for conversion format of data field values

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

**Remarks:**

[FormatOptions](/refs/Interface/FormatOptions) Returns an object. You can get or set the properties of FormatOptions.

**Example:**


```js
gridView.formatOptions.datetimeFormat = 'yyyy-mm-dd';
```

<hr/>

### header

Configuration model for the header area of the grid

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

**Remarks:**

Returns a [GridHeader](/refs/Interface/GridHeader) object. You can get or set the properties of GridHeader.

**Example:**


```js
gridView.header.showTooltip = true;
```

<hr/>

### headerSummaries

Collection setting model for Header Summary displayed in grid header area

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

**Remarks:**

Returns a collection object of [HeaderSummary](/refs/Interface/HeaderSummary). Retrieves the property of [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection).

**Example:**


```js
gridView.headerSummaries.visible = false;
```

<hr/>

### headerSummary

Setting model for the first Header Summary displayed in the grid header area

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

**Remarks:**

[HeaderSummary](/refs/Interface/HeaderSummary) Returns an object. You can get or set the properties of HeaderSummary.

**Example:**


```js
gridView.headerSummary.visible = false;
```

<hr/>

### hideDeletedRows

Whether or not deleted rows set in the grid are hidden

`Type` - boolean

**Remarks:**

It can be changed by assigning a value.

**Example:**


```js
gridView.hideDeletedRows = true;
```

<hr/>

### mobileOptions

Mobile-specific configuration model

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

**Remarks:**

Returns [mobileOptions](/refs/Interface/MobileOptions). You can get or set the properties of MobileOptions.

**Example:**


```js
gridView.mobileOptions.longTapDuration = false;
```

<hr/>

### onGridFocusChanged

A callback that notifies the grid that it has or loses focus

\[Parameter List\] `grid` - GridBase control `focused` - Whether it is focused `event` - an event object

`Type` - (grid: [GridBase](/refs/Class/GridBase){/* */}, focused: boolean, event: Event \| null) =&gt; void

<hr/>

### pasteOptions

Configuration model for pasting data from the clipboard

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

**Remarks:**

[PasteOptions](/refs/Interface/PasteOptions) Returns an object. You can get or set the properties of PasteOptions.

**Example:**


```js
gridView.pasteOptions.enabled = false;
```

<hr/>

### redoing

그리드가 redo를 실행중인지 여부

`Type` - boolean

**Example:**


```js
console.log(gridView.redoing);
```

<hr/>

### rowIndicator

Configuration model for grid indicators

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

**Remarks:**

Returns a [RowIndicator](/refs/Interface/RowIndicator) object. You can get or set the RowIndicator property.

**Example:**


```js
gridView.rowIndicator.displayValue = 'row';
```

<hr/>

### scrollBarHeight

Change the height of the scrollbar

`Type` - number

**Example:**


```js
gridView.scrollBarHeight = 24;
```

<hr/>

### scrollBarWidth

Change the width of the scrollbar

`Type` - number

**Example:**


```js
gridView.scrollBarWidth = 24;
```

<hr/>

### sortingOptions

Setting model for data sorting

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

**Remarks:**

[SortingOptions](/refs/Interface/SortingOptions) Returns an object. You can get or set the properties of SortingOptions.

**Example:**


```js
gridView.sortingOptions.style = 'reverse';
```

<hr/>

### sortMode

Sort operation mode after data modification

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

**Remarks:**

Returns [SortMode](/refs/realgrid#sortmode) set in the grid. It can be changed by assigning a value.

**Example:**


```js
gridView.sortMode = "explicit";
```

<hr/>

### stateBar

Configuration model for grid status bar

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

**Remarks:**

Returns a [StateBar](/refs/Interface/StateBar) object. You can get or set the StateBar property.

**Example:**


```js
gridView.stateBar.mark = 'image';
```

<hr/>

### summaryMode

How to calculate the sum of the current grid

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

**Remarks:**

Returns [SummaryMode](/refs/realgrid#summarymode) set in the grid. It can be changed by assigning a value.

**Example:**


```js
gridView.summaryMode = "aggregate";
```

<hr/>

### undoable

Is the undo feature available?

`Type` - boolean

**Remarks:**

It can be changed by assigning a value.

**Example:**


```js
gridView.undoable = false
```

<hr/>

### undoing

그리드가 undo를 실행중인지 여부

`Type` - boolean

**Example:**


```js
console.log(gridView.undoing);
```

<hr/>

## Method Desc

### activateAllColumnFilters

Apply or cancel all filters registered in the column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`active` - boolean

`true`{/* */}: Enabled, `false`{/* */}: Disabled.

**\[Return Value\] -** void

**Example:**


```js
gridView.activateAllColumnFilters('By administrative district', true);
```

<hr/>

### activateColumnFilters

Among the filters registered in the column, apply or disable filters with filter names included in `filterNames`.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`filterNames` - string \| string\[\]

Name of filter to apply or disable or array of names of filters

`active` - boolean

`true`{/* */}: Enabled, `false`{/* */}: Disabled.

**\[Return Value\] -** void

**Example:**


```js
gridView.activateColumnFilters('By administrative district', ['Previous'], true);
```

<hr/>

### addColumn

Set additional columns in addition to the set columns.

**\[Parameter List\]**

`column` - [ConfigObject](/refs/realgrid#configobject) \| string

Column to add (object such as [GridColumn](/refs/Interface/GridColumn))

`index` - number

The order in which the relevant columns will be located (including hidden columns). If no value is specified, it is added at the end of the column.

**\[Return Value\] -** [GridColumn](/refs/Interface/GridColumn)

**Example:**


```js
let col = {
 "name": "EmployeeID",
 "fieldName": "EmployeeID",
 "type": "data",
 "width": "90",
 "header": {
 "text": "Employee ID"
 }
}

gridView.addColumn(col);
```

<hr/>

### addColumnFilters

Register one or more filters in a column. Not applied if column.autoFilter is true.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`filters` - [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]

Array of filter objects to register, array of [ColumnFilter](/refs/Interface/ColumnFilter)

`overwrite` - boolean

Default value: `false`{/* */}, when overwrite is `false`, an error occurs if there is a filter with a duplicate name.

**\[Return Value\] -** void

**Example:**


```js
gridView.addColumnFilters('By administrative district', [{
 name: "Jeon",
 criteria: "value = 'Jeon'"
 }, {
 name: "Answer",
 criteria: "value = 'answer'"
 }])
```
<hr/>

### addInvalidCell

The user adds the result of the validation to the grid.

**\[Parameter List\]**

`itemIndex` - number

Row order

`fieldName` - string \| number

Field name or field order

`level` - [ValidationLevel](/refs/realgrid#validationlevel)

Error Level [ValidationLevel](/refs/realgrid#validationlevel)

`message` - string

Message content to display

**\[Return Value\] -** void

**Remarks:**

Used when the user manages the validation result.

**Example:**

```js
// Prevents the grid from performing validation.

gridview.editOptions.validateOnEdited = false; const validateFunc = (grid, itemIndex, dataRow, field, value) => {
    if (value === "fail") {
        return {level: "error", message: "Invalid value."}
    }
}

gridView.onCellEdited = (grid, itemIndex, dataRow, field) {
    const value = grid.getValue(itemIndex, field);
    const validate = validateFunc(grid, itemIndex, dataRow, field, value);
    if (validate) {
        grid.addInvalidCell(itemIndex, field, validate.error, validate.message)
    } else {
        grid.clearInvalidCells(itemIndex, field);
    }
}

```

<hr/>

### addInvalidCellOfRow

The user adds the result of validating the value to the grid.

**\[Parameter List\]**

`dataRow` - number

dataRow of the row

`fieldName` - string \| number

Field name or field order

`level` - [ValidationLevel](/refs/realgrid#validationlevel)

Error Level [ValidationLevel](/refs/realgrid#validationlevel)

`message` - string

Message to display

**\[Return Value\] -** void

**Remarks:**

Used when adding validation values ​​for rows that are not displayed on the screen.

<hr/>

### addLayout

Add a column or group to the layout.

**\[Parameter List\]**

`source` - [LayoutItem](/refs/realgrid#layoutitem) \| string

Column name or layout information to add

`index` - number

Position to be inserted

**\[Return Value\] -** [LayoutItem](/refs/realgrid#layoutitem)

**Remarks:**

It cannot be used if layout is not set. It must be used after changing to the layout state using gridView.setColumnLayout.

**Example:**


```js
gridView.setColumnLayout([]); // Add an empty layout.

const column1 = gridView.addColumn({fieldName: "field1", name: "col1"});
const column2 = gridView.addColumn({fieldName: "field2", name: "col2"});
const column3 = gridView.addColumn({fieldName: "field2", name: "col3"});
gridView.addLayout(column1); // gridView.addLayout("col1")
gridView.addLayout({name: "group0", items: [column2, column3]});
```

<hr/>

### addLookupSource

Add and register [LookupSource](/refs/Interface/LookupSource) to be used in the lookup tree.

**\[Parameter List\]**

`source` - [LookupSource](/refs/Interface/LookupSource)

[LookupSource](/refs/Interface/LookupSource) object

**\[Return Value\] -** void

**Remarks:**

If you want to add to the existing ID, use [fillLookupData()](/refs/Class/GridBase#filllookupdata).

**Example:**


```js
let area3codes = {
 id:"area2code",
 levels:3,
 keys: [['11', '11010', '1101053'], ['11', '11010', '1101054']],
 values: ['Sajik-dong', 'Samcheong-dong']
};
gridView.addLookupSource(area3codes);
```

<hr/>

### addPopupMenu

Add a Popup Menu to the grid.

**\[Parameter List\]**

`name` - string

menu name

`menuItems` - ([PopupMenu](/refs/Interface/PopupMenu) \| [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */})\[\]

Array following the [PopupMenuItem](/refs/Interface/PopupMenuItem) format, menu information in a hierarchical structure

**\[Return Value\] -** void

**Remarks:**

The added menu can be connected to data cells, etc.

**Example:**


```js
let menu = [{
 label: "menu1.",
 children: [{
 label: "This is submenu1."
 }, {
 label: "This is submenu2."
 }]
 }, {
 label: "This is menu2",
 }, {
 label: "-"
 }, {
 label: "This is menu3",
 type: "check",
 checked: true,
 tag: "check_menu"
 }];

gridView.addPopupMenu('menu1', menu);
```

<hr/>

### addSelection

Add an area to select in the grid.

**\[Parameter List\]**

`item` - [Selection](/refs/Interface/Selection)

[Selection](/refs/Interface/Selection) Setting information such as model. You only need to pass the properties of the area you want to select.

`eventFire` - boolean

**\[Return Value\] -** void

**Remarks:**

It is added only when [selectionMode](/refs/Interface/DisplayOptions#selectionmode){/* */} is [extended](/refs/realgrid#selectionmode){/* */}.

**Example:**


```js
let sel = {
 style: "block",
 startItem: 2;
 startColumn: "Nominate",
 endItem: 3;
 endColumn: "Unit"
}
gridView.addSelection(sel);
```

<hr/>

### addUserCellStyle

Specifies the style of the cell.

**\[Parameter List\]**

`dataRow` - number

unique number of the row

`column` - string \| -One

name of column

`style` - string \| [ColumnStyleObject](/refs/Interface/ColumnStyleObject)

string or [ColumnStyleObject](/refs/Interface/ColumnStyleObject)

**\[Return Value\] -** void

**Remarks:**

Used to apply a style when it is not possible to create rules to specify the style of a cell. If you enter `-1`{/* */} in column, it will be applied to the entire row.

<hr/>

### applyCheckables

Apply checkable to CheckBar based on Expression.

**Example:**


```js
gridView.applyCheckables();
```

<hr/>

### autoFiltersRefresh

If column.autoFilter is true, the filter list is updated.

**\[Parameter List\]**

`columns` - (string \| [DataColumn](/refs/Interface/DataColumn){/* */})\[\]
Array of column names or column objects. Entire column if not entered.

`applyFilters` - boolean

Whether to apply the active filter.

**\[Return Value\] -** void

**Remarks:**

Called when updating the list of autoFilter. Or, it is automatically updated when the user clicks the filter icon.

<hr/>

### beginUpdate

Whenever properties related to the grid are changed, an update lock is applied to delay the internal change processing call.

**Remarks:**

Use with [endUpdate()](/refs/Class/GridBase#endupdate).

**Example:**


```js
gridview.beginUpdate();
try {
 gridview.displayOptions( { ... });
 gridview.selectOptions( { ... });
...
} finally {
 gridview.endUpdate();
}
```

<hr/>

### cancel

Cancels editing of the row currently being edited.

**Remarks:**

If it's not editing, it doesn't do anything. When completing editing, you must call [commit()](/refs/Class/GridBase#commit).

**Example:**


```js
gridView.cancel();
```

<hr/>

### cancelEditor

Cancel editing and close the editor window.

**Example:**


```js
gridView.cancelEditor();
```

<hr/>

### checkAll

Check and uncheck all data rows in the grid.

**\[Parameter List\]**

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: checked, `false`{/* */}: unchecked

`visibleOnly` - boolean

Whether or not to include rows that are folded and invisible due to collapse

`checkableOnly` - boolean

Whether to check only checkable rows

`checkEvent` - boolean

Default: true, whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs.

**\[Return Value\] -** void

**Remarks:**

It is not affected by exclusive of [CheckBar](/refs/Interface/CheckBar).

**Example:**


```js
gridView.checkAll();
```

<hr/>

### checkItem

Check or uncheck the specified item.

**\[Parameter List\]**

`itemIndex` - number

index of the item

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: checked, `false`{/* */}: unchecked

`exclusive` - boolean

Default: `false`{/* */}, `true`{/* */}: If there are other checked items, uncheck them all and check only the item entered by the item index.

`checkEvent` - boolean

Default: `true`{/* */}, whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs.

**\[Return Value\] -** void

**Example:**


```js
gridView.checkItem(4);
```

<hr/>

### checkItems

Check or uncheck the items corresponding to the entered item array.

**\[Parameter List\]**

`itemIndices` - number\[\]

item index array

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: checked, `false`{/* */}: unchecked

`checkEvent` - boolean

Default: `true`{/* */}, whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs.

**\[Return Value\] -** void

**Example:**


```js
gridView.checkItems([1,2,3,4]);
```

<hr/>

### checkModel

Checks or unchecks the specified GridItem.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

GridItem

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: Check, `false`{/* */}: Uncheck

`exclusive` - boolean

Default: `false`{/* */}, `true`{/* */}: Uncheck all other checked items and check only the item entered as row

`checkEvent` - boolean

Default: `true`{/* */}, Whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs

**\[Return Value\] -** void

**Remarks:**

Used when changing the check of the header of a hidden group.

<hr/>

### checkRow

Checks or unchecks the specified data row.

**\[Parameter List\]**

`row` - number

unique row number

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: checked, `false`{/* */}: unchecked

`exclusive` - boolean

Default: `false`{/* */}, `true`{/* */}: If there are other checked items, uncheck them all and check only the items entered as a row.

`checkEvent` - boolean

Default: `true`{/* */}, whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs.

**\[Return Value\] -** void

**Example:**


```js
gridView.checkRow(4);
```

<hr/>

### checkRows

Check or uncheck items connected to the unique row numbers entered.

**\[Parameter List\]**

`rows` - number\[\]

array of unique row numbers

`checked` - boolean

Default: `true`{/* */}, `true`{/* */}: checked, `false`{/* */}: unchecked

`checkEvent` - boolean

Default: `true`{/* */}, whether [onItemChecked()](/refs/Class/GridBase#onitemchecked) occurs.

**\[Return Value\] -** void

**Example:**


```js
gridView.checkRows([1,2,3,4]);
```

<hr/>

### clearColumnFilters

Removes filters registered in a column. Not applied if column.autoFilter is true.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

**\[Return Value\] -** void

**Example:**


```js
gridView.clearColumnFilters();
```

<hr/>

### clearCommandStack

Initialize the Command Stack.

**\[Parameter List\]**

`all` - boolean

?

**\[Return Value\] -** void

**Example:**


```js
gridView.clearCommandStack();
```

<hr/>

### clearCurrent

Remove focus.

**Example:**


```js
gridView.clearCurrent();
```

<hr/>

### clearInvalidCells

Delete cell information that failed value verification.

**Remarks:**

This function is used to clear the list of data that failed verification when executing [validateCells()](/refs/Class/GridBase#validatecells).

**Example:**


```js
gridView.validateCells();
gridView.clearInvalidCells();
let invalids = gridView.getInvalidCells(); //null
```

<hr/>

### clearInvalidCellsOfRow

Deletes cell information that failed validation.

**\[Parameter List\]**

`dataRow` - number

dataRow of the row

`fieldName` - string \| number

If you enter a field name or index, only the corresponding cell information will be deleted.

**\[Return Value\] -** void

**Remarks:**

This function is used to clear the list of data that failed validation when executing [validateCells()](/refs/Class/GridBase#validatecells).

**Example:**

```js
gridView.validateCells();
gridView.clearInvalidCellsOfRow(0);
let invalids = gridView.getInvalidCellsOfRow(0); // null
```

<hr/>

### clearLookupData

Clears the lookup source corresponding to the specified SourceId.

**\[Parameter List\]**

`sourceId` - string

LookupSource id

**\[Return Value\] -** void

**Example:**


```js
gridView.clearLookupData('area1code');
```

<hr/>

### clearRowHeights

Returns the height of individual rows where changes have been applied to the initial value.

**\[Parameter List\]**

`all` - boolean

`true`{/* */}: All, `false`{/* */}: Only those changed with `setRowHeight()` are excluded.

**\[Return Value\] -** void

**Example:**


```js
gridView.clearRowHeights(true);
```

<hr/>

### clearSelection

Removes all selected areas.

**Example:**


```js
gridView.clearSelection();
```

<hr/>

### closeList

Close the filter box or DropDown Editor.

**Example:**


```js
gridView.closeList();
```

<hr/>

### closeLoading

Hide loading animation.

**Example:**


```js
gridView.closeLoading();
```

<hr/>

### closeProgress

Close the progress bar.

**Example:**


```js
gridView.closeProgress();
```

<hr/>

### columnByField

Returns information on the first column connected to the data field specified by the field name.

**\[Parameter List\]**

`fieldName` - string \| number

Field name or index

**\[Return Value\] -** [DataColumn](/refs/Interface/DataColumn)

**Example:**


```js
let col = gridView.columnByField('fieldName');
```

<hr/>

### columnByName

Returns column setting information using the column name.

**\[Parameter List\]**

`name` - string

column name

**\[Return Value\] -** [DataColumn](/refs/Interface/DataColumn)

**Example:**


```js
let col = gridView.columnByName('colName');
```

<hr/>

### columnByTag

Retrieves a column with the entered tag value.

**\[Parameter List\]**

`tag` - any

Tag specified in column

**\[Return Value\] -** [GridColumn](/refs/Interface/GridColumn)

**Remarks:**

If there is more than one column with the same tag, the first column among them is returned. If the corresponding column does not exist, null is returned.

**Example:**


```js
let col = gridView.columnByTag('tag');
```

<hr/>

### columnsByTag

Columns with input tag values are brought into an array.

**\[Parameter List\]**

`tag` - any

Tag specified in column

**\[Return Value\] -** [GridColumn](/refs/Interface/GridColumn){/* */}\[\]

**Example:**


```js
let cols = gridView.columnsByTag('tag');
```

<hr/>

### commit

Complete editing of the row being edited and save it to DataProvider.

**\[Parameter List\]**

`force` - boolean

Default: `false`{/* */}, `true`{/* */}: Commit the row whose editing was canceled during input/editing (no RowState change, marked as edited by Indicator).

**\[return value\] -** boolean

**Example:**


```js
gridView.commit();
```

<hr/>

### commitEditor

Reflects the contents of the current editor to the cell.

**\[Parameter List\]**

`hideEditor` - boolean

Default: `true`{/* */}, whether to exit the Editor or not.

`force` - boolean

Default: `true`{/* */}, When set to `true`{/* */}, [onEditCommit](/refs/Class/GridBase#oneditcommit){/* */} is not called.

**\[Return Value\] -** boolean

**Remarks:**

After running [onEditCommit](/refs/Class/GridBase#oneditcommit){/* */}, [onEditRowChanged](/refs/Class/GridBase#oneditrowchanged){/* */}, [onCellEditted](/refs/Class /GridBase#oncelledited) Events occur sequentially.

**Example:**


```js
gridView.commitEditor();
```

<hr/>

### copyToClipboard

Copies or returns information on cells included in the selected area.

**\[Parameter List\]**

`selection` - [Selection](/refs/Interface/Selection)

If the information in the selection area is not specified, the entire grid is copied.

`copy` - boolean

Default: `true`{/* */}, `true:` copy to clipboard, `false`{/* */}: return

**\[return value\] -** string

**Remarks:**

It cannot be used if there are multiple selected areas.

**Example:**


```js
let sel = gridView.getSelection();
let copied = gridView.copyToClipboard(sel);
```

<hr/>

### deleteSelection

Deletes rows in the current selection area.

**\[Parameter List\]**

`force` - boolean

If `true`, it is deleted immediately without displaying a dialog box. It is deleted even if `editOptions.deletable`{/* */} is `false`{/* */}.

**\[Return Value\] -** void

**Remarks:**

Does not work if [EditOptions.deletable](/refs/Interface/EditOptions#deletable) is false.

**Example:**


```js
gridView.deleteSelection(true);
```

<hr/>

### destroy

Turn off the grid.

**Example:**


```js
gridView.destroy();
```

<hr/>

### endUpdate

Release the update lock and redraw the grid.

**\[Parameter List\]**

`force` - boolean

The grid is redrawn regardless of whether beginUpdate() is called.

**\[Return Value\] -** void

**Remarks:**

Use with [beginUpdate()](/refs/Class/GridBase#beginupdate).

**Example:**

See [beginUpdate()](/refs/Class/GridBase#beginupdate)

<hr/>

### eraseSelection

Deletes the values of cells in the selection area. In other words, change the value to undefined.

**\[Parameter List\]**

`force` - boolean

If `true`{/* */}, the cell value is erased even if `editOptions.erasable`{/* */} is `false`{/* */}

**\[Return Value\] -** void

**Remarks:**

Does not work if [EditOptions.erasable](/refs/Interface/EditOptions#erasable){/* */} is false.

**Example:**


```js
gridView.eraseSelection();
```

<hr/>

### existsCustomRenderer

Check if there is a user renderer.

**\[Parameter List\]**

`type` - string

Registered renderer name

**\[return value\] -** boolean

<hr/>

### existsLookupData

Returns whether the specified key exists in the specified lookupsource.

**\[Parameter List\]**

`sourceId` - string

Id of LookupSource.

`keys` - string \| string\[\]

Key value, values to find.

**\[return value\] -** boolean

**Example:**


```js
gridView.existsLookupData('area1code', ['12']);
```

<hr/>

### exportGrid

The shape and data of the current grid are exported to an external document according to the specified settings.

**\[Parameter List\]**

`options` - [GridExportOptions](/refs/Interface/GridExportOptions)

A configuration model like [GridExportOptions](/refs/Interface/GridExportOptions) .

**\[Return Value\] -** void

**Example:**


```js
gridView.exportGrid({
 type: 'csv'
})
```

<hr/>

### fillEditSearchItems

Items related to the input value are searched and displayed in the list. Used for partial search purposes.

**\[Parameter List\]**

`column` - string \| [GridColumn](/refs/Interface/GridColumn)

Column object or column name where the list will be displayed

`searchKey` - string

Search key value

`values` - string\[\]

Retrieved value values

`labels` - string\[\]

Retrieved label values

`items` - [ListResult](/refs/realgrid#listresult)

Array of additional information to be passed to templateCallback

**\[Return Value\] -** void

**Example:**


```js
let CustomerNames = ["ALFKI", "ANATR", "ANTON", "AROUT", "BERGS", "BLAUS"];
dataProvider.setFields([
 {fieldName:"code"},
 {fieldName:"codeName"} // Field containing the code name
]);
gridView.setColumns([{
 fieldName:"code",
 name:"code",
 editor:{type:"search",searchLength:1, searchDelay:500, useCtrlEnterKey:true, useEnterKey:true },
 lookupDisplay:true;
 labelField:"codeName"
}]);

// Event that occurs after the last key is entered and searchDelay has passed
gridView.onEditSearch = function (grid, index, text) {
 console.log("onEditSearch:" + index.itemIndex + "," + index.column + ", " + text);
 let values = CustomerNames.filter(function (str) {
 return str.indexOf(text) == 0;
 });
 let labels = CustomerNames.filter(function (str) {
 return str.indexOf(text) == 0;
 });
 console.log(values);
 gridView.fillEditSearchItems(index.column, text, values, labels);
};

// Event that occurs when selection is made in searchEditor
gridView.onGetEditValue = function (grid, index, editResult) {
 if (index.column === "code") {
 grid.setValue(index.itemIndex, "codeName",editResult.text);
 };
};
```

<hr/>

### fillLookupData

Add lookupData to lookupSource.

**\[Parameter List\]**

`sourceId` - string

LookupSource id

`data` - [LookupData](/refs/realgrid#lookupdata)

[LookupData](/refs/realgrid#lookupdata) you want to set

**\[Return Value\] -** void

**Example:**


```js
gridView.fillLookupData("lookup1", {keys:[["14"],["15"]], values:["1,2,3,4"]});
```

<hr/>

### fitHeaderHeight

Changes the header height to match the text height.

**\[Parameter List\]**

`apply` - boolean

Whether to change the height

`paddingHeight` - number

The padding added

**\[Return Value\] -** void

**Remarks:**

Changes the height so that all displayed text is visible.

**Example:**

```js
gridView.fitHeaderHeight(true, 2);
```

<hr/>

### fitLayoutWidth

Change the cell width to match the character length.

**\[Parameter List\]**

`layout` - string \| [LayoutItem](/refs/realgrid#layoutitem)

layout name or column

`maxWidth` - number

max width

`minWidth` - number

minimum width

`includeHeaderText` - boolean

Whether to include header text defalut `true`

`includeFooterText` - boolean

**\[return value\] -** number

**Remarks:**

If there are subgroups of GroupLayout, they cannot be changed automatically. If grid.displayOptions.refreshMode is "visibleOnly", the width of columns that are not displayed on the screen are not adjusted.

**Example:**


```js
gridView.fitLayoutWidth('layout1')
```

<hr/>

### fullItemCount

Returns the number of items displayed on the screen, excluding rows where only some of them are visible.

**Remarks:**

Currently, `10`{/* */} rows are displayed on the screen, but if the last row is only partially visible, `9`{/* */} is returned.

**Example:**


```js
let totalCount = gridView.fullItemCount();
```

<hr/>

### getActiveColumnFilters

Returns the name of the applied or canceled filter among registered filters.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`active` - boolean

Default: true, `true`{/* */}: returns an enabled filter, `false`{/* */}: returns a disabled filter.

**\[Return Value\] -** [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]

**Example:**


```js
gridView.getActiveColumnFilters('By administrative district');
```

<hr/>

### getCellBounds

Returns the coordinate value of the specified cell in the grid.

**\[Parameter List\]**

`itemIndex` - number

order of rows

`column` - string \| [GridColumn](/refs/Interface/GridColumn)

Column name or column object

`outer` - boolean

If `false`{/* */}, the coordinates based on the grid container are returned.

**\[Return value\] -** [Rectangle](/refs/Interface/Rectangle)

**Example:**


```js
let bounds = gridView.getCellBounds(3, 'By administrative district');

// returns {x, y, width, height}
```

<hr/>

### getCheckBar

Returns configuration information related to the grid check bar to the model of [CheckBar](/refs/Interface/CheckBar).

**Example:**


```js
let checkBar = gridView.getCheckBar();
checkBar. exclusive = false;
gridView.setStateBar(checkBar);
```

<hr/>

### getChildModel

Returns the child model of the item model.

**\[Parameter List\]**

`parentModel` - [GridItem](/refs/Interface/GridItem)

Item model information

`index` - number

Index of the child model among child models

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in the format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let model = gridView.getModel(3);
let child = gridView.getChildModel(model, 2);
```

<hr/>

### getChildModels

Returns the child models of the item model.

**\[Parameter List\]**

`parentModel` - [GridItem](/refs/Interface/GridItem)

Item model information

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem){/* */}\[\]

**Remarks:**

Returns in array format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let model = gridView.getModel(3);
let children = gridView.getChildModels(model);
```

<hr/>

### getColumn

Returns the corresponding index column.

**\[Parameter List\]**

`index` - number

order in grid

**\[Return Value\] -** [GridColumn](/refs/Interface/GridColumn)

**Example:**


```js
let col = gridView.getColumn(0);
```

<hr/>

### getColumnFilter

Returns the filter corresponding to the filter name in the specified column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name or column object of the specified column

`filterName` - string

filter name

**\[Return Value\] -** [ColumnFilter](/refs/Interface/ColumnFilter)

**Example:**


```js
gridView.getColumnFilter('By administrative district', ['Previous']);
```

<hr/>

### getColumnFilters

Returns filters from the specified column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

**\[Return Value\] -** [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]

**Example:**


```js
gridView.getColumnFilters('By administrative district');
```

<hr/>

### getColumnNames

Returns the columns set in the grid.

**\[Parameter List\]**

`columnsOnly` - boolean

Default value: `false`{/* */}, if false, column groups are included when returned.

`visibleOnly` - boolean

Default value: `false`{/* */}, if false, hidden columns are included when returning.

**\[Return Value\] -** string\[\]

**Example:**


```js
let onlyColsNames = gridView.getColumnNames(true, false);
```

<hr/>

### getColumnProperty

Returns the properties of the corresponding column.

**\[Parameter List\]**

`column` - string \| [GridColumn](/refs/Interface/GridColumn)

Column name or column object

`prop` - string

attribute name

**\[return value\] -** any

**Example:**


```js
let colRenderer = getColumnProperty('colName', 'renderer');
```

<hr/>

### getColumns

Returns the columns set in the grid.

**\[Parameter List\]**

**\[Return Value\] -** [GridColumn](/refs/Interface/GridColumn){/* */}\[\]

**Example:**


```js
let cols = gridView.getColumns();
```

<hr/>

### getContainer

Returns the div where the grid is located.

**Example:**


```js
let gridContainer = gridView.getContainer;
```

<hr/>

### getCopyOptions

When copying the grid using ctrl+c, the settings applied are returned to the [CopyOptions](/refs/Interface/CopyOptions) model.

**Example:**


```js
let copy = gridView.getCopyOptions();
copy.enabled = false;
gridView.setCopyOptions(copy);
```

<hr/>

### getCurrent

Returns the location information of the currently focused cell.

**Example:**


```js
console.log(JSON.stringify(grid.getCurrent()));
```

<hr/>

### getDataDropOptions

Setting information related to data drag and drop is returned to the [DataDropOptions](/refs/Interface/DataDropOptions) model.

**Example:**


```js
let drop = gridView.getDataDropOptions();
drop.dropMode = 'copy'
gridView.setDataDropOptions(drop);
```

<hr/>

### getDataRow

Returns the unique number of the specified grid row.

**\[Parameter List\]**

`itemIndex` - number

order of rows

**\[return value\] -** number

**Example:**


```js
let row = gridView.getDataRow(0);
```

<hr/>

### getDataSource

Returns the DataProvider connected to the grid.

**Example:**


```js
let ds = gridView.getDataSource();
```

<hr/>

### getDescendantModels

Returns the child models of the item model.

**\[Parameter List\]**

`parentModel` - [GridItem](/refs/Interface/GridItem)

Item model information

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem){/* */}\[\]

**Remarks:**

Returns in array format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let model = gridView.getModel(3);
letdescendants = gridView.getChildModels(model);
```

<hr/>

### getDisplayColumns

Returns the currently displayed columns.

**Example:**


```js
let displayColumns = gridView.getDisplayColumns();
```

<hr/>

### getDisplayOptions

Setting information related to grid display is returned to the model of [DisplayOptions](/refs/Interface/DisplayOptions).

**Example:**


```js
let display = gridView.getDisplayOptions();
display.rowHeight = 20;
gridView.setDisplayOptions(display);
```

<hr/>

### getDisplayValues

Returns the data values of the specified row as a JSON object with various formats or regular expressions applied.

**\[Parameter List\]**

`itemIndex` - number

Order of rows to retrieve information from

`useColumnName` - boolean

If `true`{/* */}, the property name of the JSON object is set to column.name, not fieldName.

**\[return value\] -** object

**Example:**


```js
gridView.getDisplayValues(3);
```

<hr/>

### getDisplayValuesOfRow

Returns the data values of the row specified by the row unique number as a JSON object with various formats or regular expressions applied.

**\[Parameter List\]**

`dataRow` - number

unique number of the row

`useColumnName` - boolean

If `true`{/* */}, the property name of the JSON object is set to column.name, not fieldName.

**\[return value\] -** object

**Example:**


```js
gridView.getDisplayValuesOfRow(42);
```

<hr/>

### getDistinctItemValues

Returns non-duplicate values of the field.

**\[Parameter List\]**

`field` - number \| string

Field name or field index

`maxCount` - number

Maximum number of cases, sorted, cut by the number of cases from the top and returned. Default: `-1`

`sortDir` - [SortDirection](/refs/realgrid#sortdirection)

Sort method, default: [SortDirection.ASCENDING](/refs/realgrid#sortdirection)

**\[Return Value\] -** any\[\]

**Remarks:**

Excluding rows hidden by filtering and softDeleting, the values corresponding to the specified field are returned in a sorted state, excluding duplicates.

**Example:**


```js
gridView.getDistinctItemValues('field1');
```

<hr/>

### getEditingItem

The grid returns information about the item being edited.

**Example:**


```js
let eItemInfo = gridView.getEditingItem();
```

<hr/>

### getEditOptions

Information related to the grid editing method is returned to the [EditOptions](/refs/Interface/EditOptions) model.

**Example:**


```js
let edit = gridView.getEditOptions();
edit.editable = true;
gridView.setEditOptions(edit);
```

<hr/>

### getEditorOptions

Returns editor display information in the [EditorOptions](/refs/Interface/EditorOptions) model.

**Example:**


```js
let editor = gridView.getEditorOptions();
editor.yearDisplayFormat = '{Y} year';
gridView.setEditorOptions(editor);
```

<hr/>

### getEditValue

When the grid is being edited, the value of the cell currently being edited is returned.

**Example:**


```js
gridView.getEditValue();
```

<hr/>

### getFilteredRows

**\[Parameter list\]**

`sort` - boolean

Default: `true`{/* */}, `true`{/* */}: Return in ascending order, `false`{/* */}: Return in the order displayed on the screen.

**\[Return value\] -** number\[\]

**Example:** 

```js 
let filteredRow = gridView.getFilteredRows();
```

<hr/>

### getFilteringOptions

Setting information related to grid filtering is returned to the [FilteringOptions](/refs/Interface/FilteringOptions) model.

**Example:**


```js
let filtering = gridView.getFiteringOptions();
filtering.enabled = false;
gridView.setFiteringOptions(filtering);
```

<hr/>

### getFixedOptions

Setting information about the grid fixed area is returned to the model of [FixedOptions](/refs/Interface/FixedOptions).

**Example:**


```js
let fixed = gridView.getFixedOptions();
fixed.colCount = 1;
gridView.setFixedOptions(fixed);
```

<hr/>

### getFooter

Returns configuration information related to the first grid footer to the [GridFooter](/refs/Interface/GridFooter) model.

**Example:**


```js
let footer = gridView.getFooter();
footer.visible = false;
gridView.setFooter(footer);
```

<hr/>

### getFooters

Returns the grid footer configuration information to the [GridFooterCollection](/refs/Interface/GridFooterCollection) model.

**Example:**


```js
let footers = gridView.getFooters()
footers[0].visible = false;
gridView.setFooters(footers);
```

<hr/>

### getFormatOptions

Returns [FormatOptions](/refs/Interface/FormatOptions) of the grid.

**Example:**


```js
let format = gridView.getFormatOptions();
format.booleanFormat = 'X:O';
gridView.setFormatOptions(format);
```

<hr/>

### getGroupModel

Returns the group model corresponding to itemIndex.

**\[Parameter List\]**

`itemIndex` - number

index of the item

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in [GridItem](/refs/Interface/GridItem) format.

**Example:**


```js
let group = gridView.getGroupModel(1);
```

<hr/>

### getGroupSummary

Returns the total information of the specified group item model.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

Item model information

`field` - string

field name

`statistical` - boolean

Default: `false`{/* */}, [summaryMode](/refs/Class/GridBase#summarymode){/* */} to [statistical](/refs/realgrid#summarymode){/* */} If set to `true`{/* */}, if set to [aggregate](/refs/realgrid#summarymode){/* */}, set to `false`{/* */}.

**\[Return Value\] -** [GroupSummary](/refs/Interface/GroupSummary)

**Remarks:**

Returns meaningful values only for numeric fields.

Returned in [GroupSummary](/refs/Interface/GroupSummary) format.

**Example:**


```js
let group = gridView.getGroupModel(1);
let summary = gridView.getGroupSummary(group, 'fieldName', true);
```

<hr/>

### getHeader

Configuration information related to the grid header is returned to the [GridHeader](/refs/Interface/GridHeader) model.

**Example:**


```js
let header = gridView.getHeader();
header. sortable = false;
gridView.setHeader(header);
```

<hr/>

### getHeaderSummaries

Returns the setting information of grid header summaries to the [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) model.

**Example:**


```js
let headerSummaries = gridView.getHeaderSummaries()
headerSummaries[0].visible = false;
gridView.setHeaderSummaries(headerSummaries);
```

<hr/>

### getHeaderSummary

Setting information related to the first grid header summary is set to [HeaderSummary](/refs/Interface/HeaderSummary) returns as a model.

**Example:**


```js
let headerSummary = gridView.getHeaderSummary();
headerSummary.visible = false;
gridView.setHeaderSummary(headerSummary);
```

<hr/>

### getIndexOfElement

Returns the location information of the cell to which the HTMLElemnt belongs.

**\[Parameter List\]**

`element` - HTMLElement

HTMLElement

**\[Return Value\] -** [CellIndex](/refs/Interface/CellIndex)

**Remarks:**

Used in customRenderer to find the index of the cell containing the element created by the user.

<hr/>

### getInvalidCells

Returns cell information that failed value verification.

**\[Parameter List\]**

`itemIndex` - number

If you enter a unique number for a row, only cell information for the corresponding row is returned.

**\[Return Value\] -** [InvalidCell](/refs/Interface/InvalidCell){/* */}\[\]

**Remarks:**

This function is used when executing [validateCells()](/refs/Class/GridBase#validatecells) first, then modifying data that failed verification and then verifying it again.

**Example:**


```js
let invalids = gridView.getInvalidCells();
```

<hr/>

### getInvalidCellsOfRow

Among the cell information performed for value verification, the information corresponding to the entered dataRow is returned.

**\[Parameter List\]**

`dataRow` - number

dataRow of the row

**\[Return Value\] -** [InvalidCell](/refs/Interface/InvalidCell){/* */}\[\]

**Remarks:**


<hr/>

### getItemCount

Returns the number of Grid Items currently displayed in the grid.

**Remarks:**

If there is a header or footer in the rowGroup, it is included in itemCount.

**Example:**


```js
let count = gridView.getItemCount();
```

<hr/>

### getItemIndex

Returns the row order by the row's unique number.

**\[Parameter List\]**

`dataRow` - number

unique number of the row

```
let answerRow = gridView.getItemIndex(42);
```

**\[return value\] -** number

<hr/>

### getItemsOfRows

Returns the order of the rows using the unique numbers of the input data rows.

**\[Parameter List\]**

`rows` - number\[\]

array of unique numbers for rows

**\[return value\] -** number\[\]

**Example:**

let harshadRows = getItemsOfRows(\[10, 12, 18, 142857\]);

<hr/>

### getItemState

Returns the status value of the item.

**\[Parameter List\]**

`itemIndex` - number

Index of the item whose state you want to retrieve

**\[Return Value\] -** [ItemState](/refs/realgrid#itemstate)

**Example:**


```js
let itemStates = gridView.getItemState(3);
```

<hr/>

### getJsonRows

<hr/>

### getLayoutByColumn

Returns the layout information of the corresponding column.

**\[Parameter List\]**

`column` - string \| [GridColumn](/refs/Interface/GridColumn)

Name or column object of the column about which you want to obtain information

**\[Return Value\] -** [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem)

**Example:**


```js
let layout = gridView.getLayoutByColumn('OrderID');
```

<hr/>

### getLeftPos

Returns the x-coordinate value of the column displayed on the leftmost screen.

**Example:**


```js
let leftPos = gridView.getLeftPos();
```
<hr/>

### getLookupData

If there is a specified key in the specified lookupSource, keys and values are returned.

**\[Parameter list\]**

`sourceId` - string

LookupSource id

`keys` - string \| string\[\]

key value to find

**\[Return Value\] -** [LookupDataKeyValues](/refs/Interface/LookupDataKeyValues)

<hr/>

### getMobileOptions

Returns mobile-related setting information in the [MobileOptions](/refs/Interface/MobileOptions) model.

**Example:**


```js
let mobile = gridView.getMobileOptions();
mobile.longTabDuration = 400;
gridView.setMobileOptions(mobile);
```

<hr/>

### getModel

Returns the model corresponding to itemIndex.

**\[Parameter List\]**

`itemIndex` - number

index of the item

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in [GridItem](/refs/Interface/GridItem) format.

**Example:**


```js
let model = gridView.getModel(3);
```

<hr/>

### getModelAs

Returns the model corresponding to itemIndex and itemType.

**\[Parameter List\]**

`itemIndex` - number

index of the item

`itemType` - [ItemType](/refs/realgrid#itemtype)

If [Item Type](/refs/realgrid#itemtype) is omitted, it is the same as [GridBase.getModel()](/refs/Class/GridBase#getmodel){/* */}

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in [GridItem](/refs/Interface/GridItem) format.

**Example:**


```js
let model = gridView.getModelAs(3, 'row');
```

<hr/>

### getModelOfRow

Returns the item model corresponding to the row unique number.

**\[Parameter List\]**

`dataRow` - number

Row unique number

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in the format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let row = gridView.getModelOfRow(1);
```

<hr/>

### getModels

Returns item models corresponding to the indices of the specified item.

**\[Parameter List\]**

`itemIndices` - number \| number\[\]

Index array of items

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem){/* */}\[\]

**Remarks:**

Returns in array format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let models = gridView.getModels([1,2,3]);
```

<hr/>

### getModelsOfRows

Returns item models corresponding to row unique numbers.

**\[Parameter List\]**

`dataRows` - number \| number\[\]

Row unique number array

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem){/* */}\[\]

**Remarks:**

Returns in array format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let rows = gridView.getModelsOfRows([1,2,3]);
```

<hr/>

### getOptions

Returns grid option information.

**Remarks:**

Returns to the model of [GridOptions](/refs/Interface/GridOptions).

**Example:**


```js
let options = gridView.getOptions();
```

<hr/>

### getParentModel

Returns the parent item model of the item model.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

Item model information

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Remarks:**

Returned in the format of [GridItem](/refs/Interface/GridItem).

**Example:**


```js
let model = gridView.getModel(3);
let parent = gridView.getParentModel(model);
```

<hr/>

### getPasteOptions

The settings applied when pasting into the grid are returned as a [PasteOptions](/refs/Interface/PasteOptions) model.

**Example:**


```js
let paste = gridView.getPasteOptions();
paste.enabled = false;
gridView.setPasteOptions(paste);
```

<hr/>

### getPopupMenu

Returns pop-up menu setting information.

**\[Parameter List\]**

`name` - string

menu name

**\[Return Value\] -** [PopupMenu](/refs/Interface/PopupMenu)

**Remarks:**

When importing contextMenu, enter `gridContextMenu`{/* */}.

<hr/>

### getRootModel

Returns the item model's highest ancestor item model.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

model information

`extended` - boolean

Whether to include extended information, default: `false`

**\[Return Value\] -** [GridItem](/refs/Interface/GridItem)

**Example:**


```js
const idx = gridView.getCurrent();
const item = gridView.getModel(idx.itemIndex);
const root = gridView.getRootModel(item, extended);
```

<hr/>

### getRowHeight

Returns the row height.

**\[Parameter List\]**

`itemIndex` - number

Index of the row whose height you want to return

**\[return value\] -** number

**Example:**


```js
gridView.getRowHeight(2);
```

<hr/>

### getRowIndicator

Configuration information related to the grid indicator is returned to the [RowIndicator](/refs/Interface/RowIndicator) model.

**Example:**


```js
let indicator = gridView.getRowIndicator();
indicator. zeroBase = true;
gridView.setRowIndicator(indicator);
```

<hr/>

### getRowsOfItems

Returns the unique numbers of the specified grid rows.

**\[Parameter List\]**

`items` - number\[\]

Array of rows in order

**\[return value\] -** number\[\]

**Example:**


```js
let rows = gridView.getRowsOfItems([0, 2, 4, 6]);
```

<hr/>

### getSelectedItems

Returns the indices of rows in the current selection.

**\[Parameter List\]**

`dataOnly` - boolean

Only data rows are returned.

**\[return value\] -** number\[\]

**Example:**


```js
let selectedItems = gridView.getSelectedItems(true);
```

<hr/>

### getSelectedRows

Returns the unique numbers of data rows in the current selection area.

**Example:**


```js
let selectedRows = gridView.getSelectedRows();
```

<hr/>

### getSelection

Returns information on the currently selected area.

**\[Parameter List\]**

`index` - number

If there are multiple selection areas, the index of the selection area

**\[Return Value\] -** [Selection](/refs/Interface/Selection)

**Example:**


```js
let sel = gridView.getSelection();
console.log("Selection: ", JSON.stringify(sel, function(key, value) { return key.indexOf("Layout") >= 0 ? value.column : value }));
```

<hr/>

### getSelectionData

Returns the values of cells included in the current selection area.

**\[Parameter List\]**

`maxRows` - number

Maximum number of rows to return. Default: `-1`{/* */}. If the value is less than `0`{/* */}, all rows are returned without limitation.

`index` - number

Default index of selection area: `0`

**\[Return value\] -** [RowObject](/refs/realgrid#rowobject){/* */}\[\]

**Remarks:**

Even if there are multiple selected areas, only the data of the first selected area is returned.

**Example:**


```js
let selData = gridView.getSelectionData();
```

<hr/>

### getSelections

Returns information on the currently selected area in array form.

**Example:**


```js
let sels = gridView.getSelections();
console.log("Selection count: ", sels.length);
sels.forEach((sels) => {
 console.log("Selection: ", JSON.stringify(sel, (key, value) => {return key.indexOf("Layout") >= 0 ? value.column : value}));
})
```

<hr/>

### getSelectionsData

Returns the values of cells included in the current selection area.

**Remarks:**

Use when there are multiple selected areas.

<hr/>

### getSortedFields

Returns sorting information for currently sorted fields.

**Example:**


```js
let sFields = gridView.getSortedFields();

console.log(sFields[0]);
//{
// fieldName: "COMPANYNAME"
// orgFieldName: "CompanyName"
// direction: "descending"
//}
```

<hr/>

### getSortingOptions

Setting information related to grid sorting is returned to the [SortingOptions](/refs/Interface/SortingOptions) model.

**Example:**


```js
let sorting = gridView.getSortingOptions();
sorting.enabled = false;
gridView.setSortingOptions(sorting);
```

<hr/>

### getStateBar

Returns the grid status bar setting information to the model of [StateBar](/refs/Interface/StateBar).

**Example:**


```js
let stateBar = gridView.getStateBar();
stateBar.errorVisible = false;
gridView.setStateBar(stateBar);
```

<hr/>

### getSummary

Returns the total value of the field.

**\[Parameter List\]**

`field` - string \| number

The field name or index

`type` - [SummaryType](/refs/realgrid#summarytype)

Default: "sum", see [SummaryType](/refs/realgrid#summarytype) for other property values.

**\[return value\] -** number

**Remarks:**

The value that can be retrieved varies depending on [summaryMode](/refs/Class/GridBase#summarymode).

Only fields with numeric data type can get the total value.

If summaryMode is [none](/refs/realgrid#summarymode){/* */}, it is not calculated in advance.

If summaryMode is [aggregate](/refs/realgrid#summarymode){/* */}, get "sum","avg","min",'max","count", "datacount", "dataavg" You can.

In case of [statistical](/refs/realgrid#summarymode){/* */}, "var", "varp", "stdev", and "stdevp" can be additionally imported.

**Example:**


```js
let sum = gridView.getSummary('unitPrice', 'sum');
```

<hr/>

### getTopItem

Returns the index of the specified row at the top of the grid.

**Example:**


```js
let topItem = gridView.getTopItem();
```

<hr/>

### getUserCellStyle

Imports the style specified with addUserCellStyle.

**\[Parameter List\]**

`dataRow` - number

unique number of the row

`column` - string \| -One

name of column

**\[Return value\] -** string \| [ColumnStyleObject](/refs/Interface/ColumnStyleObject)

<hr/>

### getValue

Returns the value of the data cell specified by the row order and data field index.

**\[Parameter List\]**

`itemIndex` - number

order of rows

`field` - string \| number

Field index or field name

`editing` - boolean

If currently editing, whether or not to bring in the value being edited

**\[return value\] -** any

**Remarks:**

If the specified row is being modified, the modified value is returned. The value of a cell whose editing has not been completed cannot be retrieved.

**Example:**


```js
gridView.getValue(3, 'UnitPrice');
```

<hr/>

### getValues

Returns the data values of the specified row as a JSON object.

**\[Parameter List\]**

`itemIndex` - number

Order of rows to retrieve information from

**\[return value\] -** object

**Remarks:**

The unique number of the row connected to itemIndex is contained in \_\_rowId of the returned object.

**Example:**


```js
gridView.getValues('3');
```

<hr/>

### getWritable

Returns whether the cell is editable.

**\[Parameter List\]**

`itemIndex` - number

The order of the row to retrieve information from

`column` - string

The name of the column or the column object

**\[Return Value\] -** boolean

<hr/>

### hideAllColumnFilters

Hide or show all filters registered in a column. Not applied if column.autoFilter is true.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`hide` - boolean

Default: `true`{/* */}, `true`{/* */}: hidden, `false`{/* */}: visible.

**\[Return Value\] -** void

**Remarks:**

When hiding an activated filter, it is hidden in the activated state.

**Example:**


```js
gridView.hideAllColumnFilters('By administrative district');
```

<hr/>

### hideColumnFilters

Among the filters registered in the column, filters with filter names included in `filterNames` are hidden or displayed. Not applied if column.autoFilter is true.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`filterNames` - string \| string\[\]

Filter name or array of filter names

`hide` - boolean

Default: `true`{/* */}, `true`{/* */}: hidden, `false`{/* */}: visible.

**\[Return Value\] -** void

**Remarks:**

When hiding an activated filter, it is hidden in the activated state.

**Example:**


```js
gridView.hideColumnFilters('By administrative district', ['Previous']);
```

<hr/>

### hideEditor

Closes the editor currently open in the grid.

**Example:**


```js
gridView.hideEditor();
```

<hr/>

### hideToast

Hide the Toast pop-up window.

**\[Parameter List\]**

`action` - VoidFunction

Specifies the callback function to be executed after hiding the toast window.

**\[Return Value\] -** void

**Example:**


```js
const f = function () {
 console.log('hidden toast!');
}
gridView.hideToats(f);
```

<hr/>

### indeterminateItem

Changes the specified item to indeterminate or removes it.

**\[Parameter List\]**

`itemIndex` - number

Index of the item

`indeterminate` - boolean

Default: `true`{/* */}, `true`{/* */}: indeterminate state, `false`{/* */}: remove indeterminate state

**\[Return Value\] -** void

**Example:**

```js
gridView.indeterminateItem(4, true);
```

<hr/>

### indeterminateModel

Changes the indeterminate state of the model.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

GridItem

`indeterminate` - boolean

Enter the `indeterminate` value.

**\[Return Value\] -** void

<hr/>

### indeterminateRow

Changes the specified data row to or from indeterminate status.

**\[Parameter List\]**

`row` - number

Unique row number

`indeterminate` - boolean

Default: `true`{/* */}, `true`{/* */}: indeterminate status, `false`{/* */}: indeterminate status off

**\[Return Value\] -** void

**Example:**

```js
gridView.checkRow(4);
```

<hr/>

### inlineFilterFocus

filter panel에 있는 input에 포커스가 된다.

**\[매개변수 목록\]**

`column` - string

inline filter에 포커스를 줄 컬럼명

**\[반환값\] -** void

**Example:**


```js
gridView.inlineFilterFocus("KorName");
```

<hr/>

### isAllChecked

Returns whether all items are checked.

**Example:**


```js
let all = gridView.isAllChecked();
```

<hr/>

### isCheckable

Returns whether the check bar can be checked using the index of the specified item.

**\[Parameter List\]**

`itemIndex` - number

index of the item

**\[return value\] -** boolean

**Example:**


```js
let isCheckable = gridView.isCheckable(4);
```

<hr/>

### isCheckableModel

Returns whether the specified GridItem is checkable.

**\[Parameter List\]**

`model` - [GridItem](/refs/Interface/GridItem)

GridItem

**\[Return Value\] -** boolean

<hr/>

### isCheckableOfRow

Returns whether the check bar can be checked with the unique number of the specified item.

**\[Parameter List\]**

`dataRow` - number

dataRow of the item

**\[return value\] -** boolean

**Example:**


```js
gridView.isCheckableOfRow(4);
```

<hr/>

### isCheckedItem

If the check bar is checked, `true` is returned.

**\[Parameter List\]**

`itemIndex` - number

index of the item

**\[return value\] -** boolean

**Example:**


```js
gridView.isCheckedItem(4);
```

<hr/>

### isCheckedModel

Whether the specified GridItem is checked

**\[Parameters\]**

`model` - [GridItem](/refs/Interface/GridItem)

GridItem

**\[Returns\] -** boolean

<hr/>

### isCheckedRow

Is the row checked?

**\[Parameter List\]**

`row` - number

unique row number

**\[return value\] -** boolean

**Example:**


```js
gridView.isCheckedRow(4);
```

<hr/>

### isEditing

Returns `true` if the cell is currently being edited.

**Example:**


```js
let isEditing = gridView.isEditing();
```

<hr/>

### isFiltered

Returns whether a specific column in the grid is filtered.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

**\[return value\] -** boolean

**Remarks:**

If a column is omitted, `true`{/* */} is returned if there is a filtered column, and if not, `false`{/* */} is returned.

**Example:**


```js
gridView.isFiltered('By administrative district');
//
gridView.isFiltered();
```

<hr/>

### isIndeterminateItem

If the check bar is indeterminate, it returns `true`.

**\[Parameter List\]**

`itemIndex` - number

Item Index

**\[Return Value\] -** boolean

**Example:**

```js
gridView.isIndeterminateItem(4);
```

<hr/>

### isIndeterminateModel

If the check bar is indeterminate, it returns `true`.

**\[Parameters\]**

`model` - [GridItem](/refs/Interface/GridItem)

GridItem

**\[Returns\] -** boolean

<hr/>

### isIndeterminateRow

Whether the row is indeterminate

**\[Parameters\]**

`row` - number

Unique row number

**\[Returns\] -** boolean

**Example:**

```js
gridView.isIndeterminateRow(4);
```

<hr/>

### isItemEditing

When editing a cell is complete but not committed, `true` is returned if editing is in progress.

**Example:**


```js
let isItemEditing = gridView.isItemEditing();
```

<hr/>

### isVisible

Returns `true` if the grid is displayed.

**Example:**


```js
let visible = gridView.isVisible();
```

<hr/>

### layoutByColumn

Retrieves the layout setting information of a column using the column name.

**\[Parameter List\]**

`column` - string

name of column

**\[Return Value\] -** [CellLayoutColumnItem](/refs/Interface/CellLayoutColumnItem)

**Example:**


```js
let layout = gridView.layoutByName("column");
```

<hr/>

### layoutByName

Retrieves layout setting information using the name of the layout.

**\[Parameter List\]**

`name` - string

name of layout

**\[Return Value\] -** [LayoutItem](/refs/realgrid#layoutitem)

**Example:**


```js
let group = gridView.layoutByName("group");
group.direction = "vertical"
```

<hr/>

### linearizeColumns

Remove all column groups and arrange only columns that display data values in a row.

**\[Parameter List\]**

`sortProps` - string\[\]

**\[Return Value\] -** void

**Example:**


```js
gridView.linearizeColumns();
```

<hr/>

### mouseToIndex

Returns the location information of the cell corresponding to the (x, y) coordinates.

**\[Parameter List\]**

`x` - number

x coordinate

`y` - number

y coordinate

`coordianteByBody` - boolean

If the coordinate is passed based on the top-left of the body, set it to `true`{/* */}.

**\[Return value\] -** [ConfigObject](/refs/realgrid#configobject)

**Remarks:**

When creating the grid, the top-left of the `div`{/* */} element entered is calculated as `0`{/* */}. If `coordinateByBody`{/* */} is entered as `true`{/* */}, the top-left of the body is calculated as `0`{/* */}.

**Example:**


```js
console.log(gridView.mouseToIndex(10, 10));
```

<hr/>

### orderBy

Sort Grid Items based on one or more data fields.

**\[Parameter List\]**

`fieldNames` - string\[\] \| string

Sorted list of field names

`sortDirs` - [SortDirection](/refs/realgrid#sortdirection){/* */}\[\] \| [SortDirection](/refs/realgrid#sortdirection)

List of sorting methods for each field

`textCases` - [SortCase](/refs/realgrid#sortcase){/* */}\[\] \| [SortCase](/refs/realgrid#sortcase)

Case sensitive

**\[Return Value\] -** void

**Remarks:**

Sorting is performed at the Item Model level, and the actual positions of the Data Provider rows do not change.

**Example:**


```js
gridView.orderBy(['fruit'], ['descending'], ['insensitive']);

gridView.orderBy("fruit", "descending");
```

<hr/>

### ping

Displays the message entered in the alert window.

**\[Parameter List\]**

`message` - any

Entered message

**\[Return Value\] -** void

**Example:**


```
gridView.ping("Test");
```

<hr/>

### redo

When undoing a datasource connected to the grid, it returns to the state after modification.

**Example:**


```js
gridView.redo();
```

<hr/>

### refresh

The grid is redrawn internally all.

**Example:**


```
gridView.refresh()
```

<hr/>

### registerColumnLayouts

Register column layouts in advance.

**\[Parameter List\]**

`layouts` - \{ name: string; items: (string \| [LayoutItem](/refs/realgrid#layoutitem){/* */})\[\]; \}\[\]

Column Layout Array

**\[Return Value\] -** void

**Remarks:**

The registered layout is applied to the grid using [GridBase.setColumnLayout()](/refs/Class/GridBase#setcolumnlayout){/* */}.

**Example:**


```js
let layout =
 [{ "name": "layout1", // Name of the layout information to be registered.
 "items": ["text1", "text2"] // Column or group setting information
 },
 { "name": "layout2",
 "items": [{
 name: "group1", // Name of CellLayoutGroupItem.
 type: "group",
 items:[...]}]
 }
...
];
```

<hr/>

### registerCustomRenderer

Register a custom renderer.

**\[Parameter List\]**

`type` - string

User-specified renderer type (name)

`renderer` - [CustomCellRenderer](/refs/Interface/CustomCellRenderer)

[CustomCellRenderer](/refs/Interface/CustomCellRenderer) object

**\[Return Value\] -** void

**Example:**


```js
// CustomCellRenderer model
gridView.registerCustomRenderer("renderer01", {
 initContent(parent) {
 var span = this._span = document.createElement("span");
 parent.append(span);
 }
})
```

<hr/>

### removeColumn

Remove the corresponding column.

**\[Parameter List\]**

`name` - string

**\[return value\] -** boolean

**Example:**


```js
gridView.removeColumn('KorName');
```

<hr/>

### removeColumnFilters

Among the filters registered in the column, filters with filter names included in `filterNames`{/* */} are removed. Not applied if column.autoFilter is true.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`filterNames` - string \| string\[\]

Name of filter to remove or array of names of filters

**\[Return Value\] -** void

**Example:**


```js
gridView.removeColumnFilters('By administrative district', ['Previous']);
```

<hr/>

### removeLayout

Remove layout.

It cannot be used if layout is not set. It must be used after changing to the layout state using gridView.setColumnLayout.

**\[Parameter List\]**

`layout` - [LayoutItem](/refs/realgrid#layoutitem) \| string

layout or name of layout

**\[Return Value\] -** void

**Example:**


```js
gridView.removeLayout("group0");
gridView.removeLayout("column");
```

<hr/>

### removeLookupSource

Deletes the specified lookup source.

**\[Parameter List\]**

`sourceId` - string

LookupSource id to delete

**\[Return Value\] -** void

**Example:**


```js
gridView.removeLookupSource('area1code');
```

<hr/>

### removePopupMenu

Remove a specific Popup Menu from the grid.

**\[Parameter List\]**

`name` - string

Name of Popup Menu to be removed

**\[Return Value\] -** void

**Example:**


```js
gridView.removePopupMenu('menu1');
```

<hr/>

### removeUserCellStyle

Removes the style specified with addUserCellStyle.

**\[Parameter List\]**

`dataRow` - number \| null

unique number of the row

`column` - string \| -1 \| null

name of column

**\[Return Value\] -** void

**Remarks:**

Entering `null`{/* */} removes all styles applied to cells and rows.

<hr/>

### requestPrepareEditor

After editing is complete, the cell's editor is updated when the screen is redrawn.

**Remarks:**

Used to change the properties of the editor according to the value of the cell.

**Example:**


```js
 gridView.onCellEdited =function (grid, dataRow, itemIndex, fieldIndex) {
 if (fieldIndex === 3) {
 const val = grid.getValue(itemIndex, fieldIndex);
 if (val === "1") {
 grid.columnByName("columnName").editor = {type:"dropdown", textReadOnly: true}
 } else {
 grid.columnByName("columnName").editor = {type:"dropdown", textReadOnly: false}
 }
 grid.requestPrepareEditor();
 }
 }
```

<hr/>

### resetCheckables

Initializes the Checkable state of all rows applied to CheckBar.

**\[Parameter List\]**

`clearExpression` - boolean

Whether to clear CheckBar's checkableExpression

**\[Return Value\] -** void

<hr/>

### resetCurrent

Initialize the position of the focus cell to the first row and first column.

**Example:**


```js
gridView.resetCurrent();
```

<hr/>

### resetFilters

Releases filters registered in all columns of the grid.

**Example:**


```js
gridView.resetFilters();
```

<hr/>

### resetSize

Change the size of the upper DIV area of the grid explicitly when the size of the grid does not change.

**\[Parameter List\]**

`callback` - any

A callback to be executed after the size is reset

**\[Return Value\] -** void

**Remarks:**

If the grid is created before the size of the element on which the grid will be raised is determined or the style.display property of the element is none and the size of the grid is 0,

This is used when the size of the upper DIV area of the grid has been changed but the size of the grid does not change.

**Example:**


```js
const f = function() {
 console.log('resized1')
}
gridView.resetSize(f)
```

<hr/>

### restoreColumns

Returns the grid column positions to their initial state.

**Example:**


```js
gridView.restoreColumns();
```

<hr/>

### saveColumnLayout

Returns layout information of the current screen.

**Example:**


```js
let layouts = gridView.saveColumnLayout();
```

<hr/>

### scrollPage

Move the page based on the current time.

**\[Parameter List\]**

`offset` - number

The number of pages you want to navigate to, relative to the current time. Previous page is negative.

**\[Return Value\] -** void

**Example:**


```js
gridView.scrollPage(3);
```

<hr/>

### searchCell

Finds the cell corresponding to the values of the specified fields and returns [CellIndex](/refs/Interface/CellIndex){/* */}.

**\[Parameter List\]**

`options` - [SearchCellOptions](/refs/Interface/SearchCellOptions)

Setting information model in the form of [SearchCellOptions](/refs/Interface/SearchCellOptions)

**\[return value\] -** any

**Example:**


```js
function searchCellHandler() {
 let value = "PR20012392"
 let fields = [ "RequestType", "ServiceCode" ];
 let startFieldIndex = fields.indexOf(gridView.getCurrent().fieldName) + 1;
 let options = {
 fields : fields,
 value : value,
 startIndex: gridView.getCurrent().itemIndex,
 startFieldIndex : startFieldIndex,
 wrap : true,
 caseSensitive : false;
 partialMatch : true
 }
 let index = gridView.searchCell(options);
 gridView.setCurrent(index);
}
```

<hr/>

### searchItem

Finds the first row corresponding to the values of the specified fields and returns the row number.

**\[Parameter List\]**

`options` - [SearchOptions](/refs/Interface/SearchOptions)

Setting information model in the form of [SearchOptions](/refs/Interface/SearchOptions)

**\[return value\] -** number

**Example:**


```js
function searchItemHandler() {
 let values = ["PR20012392", "QF24212112"]
 let fields = [ "RequestType", "ServiceCode" ];
 let startFieldIndex = fields.indexOf(gridView.getCurrent().fieldName) + 1;
 let options = {
 fields : fields,
 values: values,
 startIndex: gridView.getCurrent().itemIndex,
 startFieldIndex : startFieldIndex,
 wrap : true,
 caseSensitive : false;
 partialMatch : true
 }
 let index = gridView.searchCell(options);
 gridView.setCurrent(index);
}
```

<hr/>

### setAllCheck

Check or uncheck all data rows in the grid using the options set in CheckBar.

**\[Parameter List\]**

`checked` - boolean

Default: true, true: checked, false, off

`itemChecked` - boolean

Default: true, whether display v in CheckBar.head is enabled or not.

**\[Return Value\] -** void

**Remarks:**

It is not affected by exclusive of [CheckBar](/refs/Interface/CheckBar). [onItemChecked()](/refs/Class/GridBase#onitemchecked) does not occur. Applies the v mark in CheckBar\|CheckBar.head to the active state.

**Example:**


```js
gridView.setAllCheck();
```

<hr/>

### setCellStyleCallback

Change the cell style.

**\[Parameter List\]**

`f` - [CellStyleCallback](/refs/realgrid#cellstylecallback) \| undefined

Callback to specify cell style

**\[Return Value\] -** void

**Remarks:**

To set per column, you must use [column styleCallback](/refs/Interface/ValueColumn#stylecallback).

To set per [footer](/refs/Interface/ColumnFooter) or [header summary](/refs/Interface/ColumnHeaderSummary), you must use the [styleCallback](/refs/Interface/ColumnSummary#stylecallback) property of the corresponding model.

**Example:**


```js
const f = function (grid, cell) {
 return {
 styleName: 'custom-cell'
 editor: 'text'
 }
}
gridView.setCellStyleCallback(f);
```

<hr/>

### setCheckable

Specifies whether the check bar of the specified item can be checked.

**\[Parameter List\]**

`itemIndex` - number

index of the item

`value` - boolean

Whether it is possible to check

**\[Return Value\] -** void

**Example:**


```js
gridView.setCheckable(4, false);
```

<hr/>

### setCheckableCallback

Set checkableCallback in CheckBar and apply it. Or perform them simultaneously.

**\[Parameter List\]**

`callback` - [CheckableCallback](/refs/realgrid#checkablecallback)

Callback for check availability

`apply` - boolean

Default: true, whether to apply immediately

**\[Return Value\] -** void

**Example:**


```js
const f = function(dataSource, item) {
 console.log("checked!")
 return true;
}
gridView.setCheckableCallback(f);
```

<hr/>

### setCheckableExpression

Set checkableExpression in CheckBar and apply it. Or perform them simultaneously.

**\[Parameter List\]**

`expression` - string

Formula for check availability

`apply` - boolean

Default: true, whether to apply immediately

**\[Return Value\] -** void

**Example:**


```js
gridView.setCheckableExpression("row % 2 = 1");
```

<hr/>

### setCheckableOfRow

Specifies whether the check bar of the specified row can be checked.

**\[Parameter List\]**

`dataRow` - number

dataRow of the item

`value` - boolean

Whether it is possible to check

**\[Return Value\] -** void

<hr/>

### setCheckBar

Set the grid check bar's configuration information to the model of [CheckBar](/refs/Interface/CheckBar).

**\[Parameter List\]**

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

[CheckBar](/refs/Interface/CheckBar) Information such as the model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setCheckBar({exclusive: true});
```

<hr/>

### setColumn

Change the information of the column set in the grid.

**\[Parameter List\]**

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

Information to change. The name of the column or an object of the model, such as [GridColumn](/refs/Interface/GridColumn).

**\[Return Value\] -** void

**Remarks:**

To reset column information, you must first retrieve the existing setting information using [columnByName](/refs/Class/GridBase#columnbyname).

**Example:**


```js
let col = {
 name: 'existed column'
}
col.editor = {
 type: 'text'
}
gridView.setColumn(col);
```

<hr/>

### setColumnFilters

Set a filter on the grid column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name or column object of the column to be set

`filters` - [ColumnFilter](/refs/Interface/ColumnFilter){/* */}\[\]

Array of filter objects, array of [ColumnFilter](/refs/Interface/ColumnFilter)

**\[Return Value\] -** void

**Remarks:**

Refer to Expression for available operators and variables.

**Example:**


```js
let filters = [{
 name: "Jeon",
 criteria: "value = 'Jeon'"
 }, {
 name: "Answer",
 criteria: "value = 'answer'"
 }, {
 name: "'Forest land' or 'factory land'",
 criteria: "(value = 'forest') or (value = 'factory land')"
 }, {
 name: "Land: value > 'Land'",
 criteria: "value > 'Earth'"
 }];

gridView.setColumnFilters('Column', filters);
```

<hr/>

### setColumnLayout

Set the column layout of the grid.

**\[Parameter List\]**

`layout` - string \| (string \| [LayoutItem](/refs/realgrid#layoutitem){/* */})\[\]

Layout information to change

**\[Return Value\] -** void

**Remarks:**

When entering `string`, it is set to a pre-registered layout.

**Example:**


```js
layout = [{
 "OrderID",
 {
 name: "companyGroup",
 items: [
 "Country",
 50,
 50,
 {
 column: "CompanyName",
 cellSpan: 2
 },
 50,
 50
 ],
 header: {
 text: "Company Group",
 visible: true
 }
 }
 }
];
gridView.setColumnLayout(layout)
```

<hr/>

### setColumnProperty

Change specific attribute information of a column set in the grid.

**\[Parameter List\]**

`column` - string \| [GridColumn](/refs/Interface/GridColumn)

Column name or column object

`prop` - string

attribute name

`value` - any

change value

**\[Return Value\] -** void

**Remarks:**

If you want to change the properties within the editor property, you must re-specify the entire editor.

If you change `values`{/* */}, `labels`{/* */}, they cannot be changed with [setColumnProperty()](/refs/Class/GridBase#setcolumnproperty) and cannot be changed with [setColumn()](/refs The column must be respecified with /Class/GridBase#setcolumn).

**Example:**


```js
gridView.setColumnProperty('colName', 'editor', {
 type: 'text'
});
```

<hr/>

### setColumns

Remove all previously set columns and reorganize the grid with new columns.

**\[Parameter List\]**

`columns` - ([DataColumn](/refs/Interface/DataColumn) \| [SeriesColumn](/refs/Interface/SeriesColumn) \| [LiteralColumn](/refs/Interface/LiteralColumn) \| [ConfigObject](/refs /realgrid#configobject) \| string)\[\]

Array of column setting information for objects such as [GridColumn](/refs/Interface/GridColumn)

**\[Return Value\] -** void

**Example:**


```js
 let cols = [{
 "name": "EmployeeID",
 "fieldName": "EmployeeID",
 "type": "data",
 "width": "90",
 "header": {
 "text": "Employee ID"
 }
 }, {
 "name": "OrderDate",
 "fieldName": "OrderDate",
 "type": "data",
 "width": "130",
 "header": {
 "text": "Order Date"
 }
 }]

 gridView.setColumns(cols);
```

<hr/>

### setContextMenu

Specify menu items to be added to the context menu displayed when right-clicking on the grid.

**\[Parameter List\]**

`menuItems` - ([PopupMenu](/refs/Interface/PopupMenu) \| [PopupMenuItem](/refs/Interface/PopupMenuItem){/* */})\[\]

Menu information arrangement

**\[Return Value\] -** [PopupMenu](/refs/Interface/PopupMenu)

**Remarks:**

When the menu is clicked, the [onContextMenuItemClicked](/refs/Class/GridBase#oncontextmenuitemclicked) callback is called.

**Example:**


```js
let menu = [{
 label: "menu1.",
 children: [{
 label: "This is submenu1."
 }, {
 label: "This is submenu2."
 }]
 }, {
 label: "This is menu2",
 }, {
 label: "-"
 }, {
 label: "This is menu3",
 type: "check",
 checked: true,
 tag: "check_menu"
 }];

gridView.setContextMenu(menu);
```

<hr/>

### setCopyOptions

Set copy information to the [CopyOptions](/refs/Interface/CopyOptions) model.

**\[Parameter List\]**

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

[CopyOptions](/refs/Interface/CopyOptions) Configuration information such as models. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setCopyOptions({enabled: false});
```

<hr/>

### setCurrent

Specifies the location of the focus cell.

**\[Parameter List\]**

`current` - [CellIndex](/refs/Interface/CellIndex)

Cell location information

`select` - boolean

Whether to initialize the selection area

**\[Return Value\] -** void

**Remarks:**

For rows, one of itemIndex or dataRow can be specified, and for columns, one of column (column name), fieldIndex, or fieldName can be specified.

However, if applied multiple times, they will be applied first in order from the latter.

**Example:**


```js
gridView.setCurrent({ itemIndex: 1, column: 'By administrative district' });
```

<hr/>

### setDataDropOptions

Configuration information related to data drag and drop is set to the [DataDropOptions](/refs/Interface/DataDropOptions) model.

**\[Parameter List\]**

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

Setting information such as [DataDropOptions](/refs/Interface/DataDropOptions). You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setDataDropOptions({dropMode: 'copy'});
```

<hr/>

### setDataSource

Connect the Data Provider to the grid.

**\[Parameter List\]**

`dataProvider` - [LocalDataProvider](/refs/Class/LocalDataProvider) \| [LocalTreeDataProvider](/refs/Class/LocalTreeDataProvider)

DataProvider object.

**\[Return Value\] -** void

**Example:**


```js
let dataProvider = new RealGrid.LocalDataProvider();
gridView = new RealGrid.GridView("realgrid");
gridView.setDataSource(dataProvider);
```

<hr/>

### setDisplayOptions

Set grid display information to the [DisplayOptions](/refs/Interface/DisplayOptions) model.

**\[Parameter List\]**

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

[DisplayOptions](/refs/Interface/DisplayOptions) Setting information such as model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setDisplayOptions({rowResizable: true});
```

<hr/>

### setEditOptions

Information related to the grid editing method is reset to the [EditOptions](/refs/Interface/EditOptions) model.

**\[Parameter List\]**

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

[EditOptions](/refs/Interface/EditOptions) Configuration information, such as models. You only need to pass the values you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setEditOptions({editable: false});
```

<hr/>

### setEditorOptions

Set the editor display information to the [EditorOptions](/refs/Interface/EditorOptions) model.

**\[Parameter List\]**

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

[EditorOptions](/refs/Interface/EditorOptions) Configuration information, such as models. You only need to pass the property you want to change.

**\[return value\] -** void

**Remarks:**

When changing the display format of the date editor, it must be set before the calendar pop-up is first run (created) (it cannot be changed once it is run).

**Example:**


```js
gridView.setEditorOptions({yearDisplayFormat: "{Y} year"});
```

<hr/>

### setEditValue

Sets the value in the cell where focus is located.

**\[Parameter List\]**

`value` - any

the value you want to set

`startEdit` - boolean

Default: `false`{/* */}, `true`{/* */}: Set a value and show the editor if the cell is not being edited. `false`{/* */}: Do not set a value.

`dropdown` - boolean

Default value: `true`{/* */}, `false`{/* */}: In the case of editors with dropdown, such as dropdownCellEditor, dateCellEditor, etc., dropdown is not displayed.

**\[Return Value\] -** void

**Example:**


```js
gridView.setEditValue('newValue');
```

<hr/>

### setFilteringOptions

Set information related to grid filtering in the [FilteringOptions](/refs/Interface/FilteringOptions) model.

**\[Parameter List\]**

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

[FilteringOptions](/refs/Interface/FilteringOptions) Configuration information, such as models. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Remarks:**

[FilterSelectorOptions](/refs/Interface/FilterSelectorOptions){/* */}, [FilterAutomatingOptions](/refs/Interface/FilterAutomatingOptions){/* */}, [ToastOptions](/refs/Interface/ToastOptions) are properties. You have to access it directly and fix it.

**Example:**


```js
gridView.setFilteringOptions({enabled: false});
```

<hr/>

### setFilterPanel

Set the filter panel setting information to the [FilterPanel](/refs/Interface/FilterPanel) model.

**\[Parameter List\]**

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

[FilterPanel](/refs/Interface/FilterPanel) Information such as models. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setFilterPanel({height: 30, visible: true, filterDelay: 500});
```

<hr/>

### setFixedOptions

Set information about the grid fixed area as a model in [FixedOptions](/refs/Interface/FixedOptions).

**\[Parameter List\]**

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

[FixedOptions](/refs/Interface/FixedOptions) Setting information such as models. You only need to pass the values you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setFixedOptions({colCount: 2});
```

<hr/>

### setFocus

The grid is focused.

**Example:**


```js
gridView.setFocus();
```

<hr/>

### setFooter

Set the configuration information of the first grid footer to the [GridFooter](/refs/Interface/GridFooter) model.

**\[Parameter List\]**

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

[GridFooter](/refs/Interface/GridFooter) Information such as the model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setFooter({className: 'custom-footer-1'});
```

<hr/>

### setFooters

Set the grid footer configuration information to the collection model of [GridFooter](/refs/Interface/GridFooter).

**\[Parameter List\]**

`value` - [GridFooterCollection](/refs/Interface/GridFooterCollection) \| [GridFooter](/refs/Interface/GridFooter){/* */}\[\]

Information such as the GridFooterCollection model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
//object
gridView.setFooters({
 visible: false;
 items: [
 {
 styleName: 'custom-footer-1';
 },
 {
 styleName: 'custom-footer-2';
 },
 ]
});

//array
gridView.setFooters([
 {
 styleName: 'custom-footer-1';
 },
 {
 styleName: 'custom-footer-2';
 },
 ]);
```

<hr/>

### setFormatOptions

Set [FormatOptions](/refs/Interface/FormatOptions) of the grid.

**\[Parameter List\]**

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

[FormatOptions](/refs/Interface/FormatOptions) Configuration information such as models. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setFormatOptions({booleanFormat: 'wrong:correct'});
```

<hr/>

### setHeader

Set the grid header setting information to the [GridHeader](/refs/Interface/GridHeader) model.

**\[Parameter List\]**

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

[GridHeader](/refs/Interface/GridHeader) Information such as model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setHeader({sortable: false});
```

<hr/>

### setHeaderSummaries

Set grid header summaries to the [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) model.

**\[Parameter List\]**

`value` - [HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) \| [HeaderSummary](/refs/Interface/HeaderSummary){/* */}\[\]

[HeaderSummaryCollection](/refs/Interface/HeaderSummaryCollection) Information such as the model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
//object
gridView.setHeaderSummaries({
 visible: false;
 items: [
 {
 styleName: 'custom-hsumarry-1';
 },
 {
 styleName: 'custom-hsumarry-2';
 },
 ]
});

//array
gridView.setFooters([
 {
 styleName: 'custom-hsumarry-1';
 },
 {
 styleName: 'custom-hsumarry-2';
 },
 ]);
```

<hr/>

### setHeaderSummary

Set the configuration information of the first grid header summary to the [HeaderSummary](/refs/Interface/HeaderSummary) model.

**\[Parameter List\]**

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

[HeaderSummary](/refs/Interface/HeaderSummary) Information such as model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setHeaderSummary({styleName: 'custom-hsummary-1'});
```

<hr/>

### setLeftCol

gridThe specified column is located on the left border.

**\[Parameter List\]**

`column` - string \| number

Column name or index

**\[Return Value\] -** void

**Example:**


```js
gridView.setLeftCol(10);
```

<hr/>

### setLeftPos

The left border of the grid is located at the specified value.

**\[Parameter List\]**

`position` - number

x-coordinate value

**\[Return Value\] -** void

**Example:**


```js
gridView.setLeftPos(10);
```

<hr/>

### setLookups

Register lookup sources to be used in the lookup tree.

**\[Parameter List\]**

`sources` - [LookupSource](/refs/Interface/LookupSource){/* */}\[\]

[LookupSource](/refs/Interface/LookupSource) Object array

**\[Return Value\] -** void

**Remarks:**

If you want to add to the existing ID, use [fillLookupData()](/refs/Class/GridBase#filllookupdata).

**Example:**


```js
let area1codes = {
 id: "area1code",
 levels: 1,
 keys: ['11', '21'],
 values: ['Seoul Metropolitan City', 'Busan Metropolitan City']
}

let area2codes = {
 id:"area2code",
 levels:2,
 keys: [['11', '11010'], ['11', '11020']],
 values: ['Jongno-gu', 'Jung-gu']
};

gridView.setLookups([area1codes, area2codes]);
```

<hr/>

### setMobileOptions

Set mobile-related setting information using the [MobileOptions](/refs/Interface/MobileOptions) model.

**\[Parameter List\]**

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

[MobileOptions](/refs/Interface/MobileOptions) Setting information such as model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setMobileOptions({longTapDuration: 300});
```

<hr/>

### setOptions

Reset grid option information.

**\[Parameter List\]**

`options` - [GridOptions](/refs/Interface/GridOptions)

Setting information

**\[Return Value\] -** void

**Remarks:**

Unlike [getOptions](/refs/Class/GridBase#getoptions), which returns only grid-level information, this method allows you to reset child components and other execution information at the same time. Set to the model of [GridOptions](/refs/Interface/GridOptions).

**Example:**


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

<hr/>

### setPasteOptions

Set paste information in the grid using the [PasteOptions](/refs/Interface/PasteOptions) model.

**\[Parameter List\]**

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

Setting information such as PasteOptions model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setPasteOptions({enabled: false});
```

<hr/>

### setProgress

Sets the state of the progress bar.

**\[Parameter List\]**

`min` - number

minimum value

`max` - number

maximum value

`position` - number

Current value between min and max

`message` - string

String to be displayed at the bottom of the progress bar, default string output if not specified

**\[Return Value\] -** void

**Remarks:**

Set the current minimum/maximum progress value and display text to be displayed on the screen.

**Example:**


```js
gridView.setProgress(0, 100, 50);
```

<hr/>

### setRowHeight

Change the row height to the specified height.

**\[Parameter List\]**

`itemIndex` - number

Order of rows whose height you want to change

`height` - number

Default: `0`{/* */}, row height. When specified as `0`{/* */}, the row height is changed to match [displayOptions](/refs/Interface/DisplayOptions){/* */}.minRowHeight, maxRowHeight.

`refresh` - boolean

Default value: `true`{/* */}, whether to immediately reflect the changed row height on the screen.

**\[Return Value\] -** void

**Example:**


```js
gridView.setRowHeight(2, 40);
```

<hr/>

### setRowIndicator

Set the configuration information related to the grid indicator to the [RowIndicator](/refs/Interface/RowIndicator) model.

**\[Parameter List\]**

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

Information such as the RowIndicator model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setRowIndicator({zeroBase: true});
```

<hr/>

### setRowStyleCallback

Change the row style.

**\[Parameter List\]**

`f` - [RowStyleCallback](/refs/realgrid#rowstylecallback)

Callback to specify row style

**\[Return Value\] -** void

**Example:**


```js
const f = function(grid, item, fixed) {
 if (fixed) {
 return 'custom-fixed-row';
 }
 else {
 return 'custom-data-row';
 }
}
gridView.setRowStyleCallback(f)
```

<hr/>

### setSelection

Specifies the area to select in the grid.

**\[Parameter List\]**

`item` - [Selection](/refs/Interface/Selection)

[Selection](/refs/Interface/Selection) Setting information such as model. You only need to pass the properties of the area you want to select.

`eventFire` - boolean

Does not generate selection-related events.

**\[Return Value\] -** void

**Remarks:**

If there is an existing selection area, it will be removed.

**Example:**


```js
let sel = {
 style: "block",
 startItem: 2;
 startColumn: "Nominate",
 endItem: 3;
 endColumn: "Unit"
}
gridView.setSelection(sel);
```

<hr/>

### setSortingOptions

Set information related to grid sorting in the [SortingOptions](/refs/Interface/SortingOptions) model.

**\[Parameter List\]**

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

[SortingOptions](/refs/Interface/SortingOptions) Configuration information, such as models. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Remarks:**

[ToastOptions](/refs/Interface/ToastOptions) must be accessed directly as a property and modified.

**Example:**


```js
gridView.setSortingOptions({enabled: false});
```

<hr/>

### setStateBar

Set the grid status bar setting information to the model of [StateBar](/refs/Interface/StateBar).

**\[Parameter List\]**

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

[StateBar](/refs/Interface/StateBar) Information such as the model. You only need to pass the property you want to change.

**\[Return Value\] -** void

**Example:**


```js
gridView.setStateBar({errorVisible: true});
```

<hr/>

### setTopItem

It is located in the specified row at the top of the grid.

**\[Parameter List\]**

`itemIndex` - number

Default: 0, index of the row you want to place at the top of the grid

**\[Return Value\] -** void

**Example:**


```js
gridView.setTopItem();
```
<hr/>

### setValidations

Sets a list of row-level edit verification conditions.

**\[Parameter List\]**

`value` - [EditValidation](/refs/Interface/EditValidation){/* */}\[\] \| [EditValidation](/refs/Interface/EditValidation) \| string \| string\[\]

[EditValidation](/refs/Interface/EditValidation) Array or validation expression of setting information such as model

**\[Return Value\] -** void

**Example:**


```js
// string
gridView.setValidations("values['UnitPrice'] > 100");

// object
gridView.setValidations({
 message: 'Too expensive!',
 criteria: "values['UnitPrice'] > 100"
})

// Arrangement
gridView.setValidations([{
 message: 'Too expensive!',
 criteria: "values['UnitPrice'] > 100"
}])
```

<hr/>

### setValue

Change the row order and the value of the data cell specified by the data field index.

**\[Parameter List\]**

`itemIndex` - number

order of rows

`field` - string \| number

Field index or field name

`value` - any

Value to set for field

**\[Return Value\] -** void

**Remarks:**

If the grid is being edited, only the value of the itemIndex being edited can be changed. After editing is completed, the value is reflected in the dataProvider. If the grid is not being edited, it is immediately reflected in the dataProvider.

**Example:**


```js
gridView.setValue(3, 'UnitPrice', 52);
```

<hr/>

### setValues

Modifies the values of multiple fields in a specified row.

**\[Parameter List\]**

`itemIndex` - number

Index of the row to retrieve information from

`values` - any\[\] \| object

Data values of the field to be modified

`strict` - boolean

Default value: `false`{/* */}, `true` If the field value is set to `undefined`, the existing value is maintained.

**\[Return Value\] -** void

**Example:**


```js
gridView.setValues(3, [123, 142, 'happy', 133]);
```

<hr/>

### setVisible

Show or hide the grid.

**\[Parameter List\]**

`value` - boolean

`true`{/* */}: Show grid, `false`{/* */}: Hide grid

**\[Return Value\] -** void

**Example:**


```js
gridView.setVisible(false);
```

<hr/>

### showEditor

Displays the grid editor in the currently located cell.

**Remarks:**

If the grid is in an uneditable state (editable: false), the editor is not displayed.

**Example:**


```js
gridView.showEditor();
```

<hr/>

### showFilterSelector

Displays the filter selector.

**\[Parameter List\]**

`column` - string

Column object or column name where the filter selector will be displayed

`searchText` - string

Enter the string you want to search for

**\[return value\] -** boolean

**Remarks:**

If there is no filter in the column, it is not displayed.

<hr/>

### showLoading

Display loading animation.

**\[Parameter List\]**

`disabled` - boolean

If true, mouse and keyboard operation is blocked. - Default: `false`{/* */},

**\[Return Value\] -** void

**Example:**


```js
gridView.showLoading();
```

<hr/>

### showMessage

Displays a message in a cell or at a specified location on the screen.

**\[Parameter List\]**

`message` - string \| [TooltipOptions](/refs/Interface/TooltipOptions)

Specifies the message to be displayed on the screen in the form of string or [TooltipOptions](/refs/Interface/TooltipOptions).

`x` - number \| [CellIndex](/refs/Interface/CellIndex)

Specifies the value of the `x`{/* */} axis in the form of `number`{/* */} or [CellIndex](/refs/Interface/CellIndex){/* */}.

`y` - number

Specifies the value of the `y`{/* */} axis.

**\[Return value\] -** void

**Remarks:**

If x, y are specified as `number`{/* */}, they are displayed at the specified location from the top left of the grid. If x is specified as [CellIndex](/refs/Interface/CellIndex){/* */}, they are displayed at the bottom left of the cell.

**Example:**

```js
// Display a message at the bottom left of the currently selected cell
gridView.showMessage("user message", grid.getCurrent());

// Display a message at a specific location in the grid
gridView.showMessage("<span style='color:red'>User</span>\n<span style='color:blue'>Message</span>", 100, 100);

// Message that disappears after a specified time
gridView.showMessage({message: "Message that disappears automatically", hideDuration: 10000}, grid.getCurrent());
```

<hr/>

### showPopup

Displays a pop-up menu in the grid.

**\[Parameter List\]**

`x` - number

The x-coordinate where the pop-up menu will be displayed.

`y` - number

The y-coordinate where the pop-up menu will be displayed.

`menu` - string

Enter the name of the menu to be displayed. If omitted, the popupMenu or contextMenu for the corresponding area will be displayed.

**\[Return Value\] -** void

**Remarks:**

The x- and y-axes are aligned to the top left of the grid.

**Example:**

```js
gridView.showPopup(10, 10, "popupMenu");
```

<hr/>

### showPopup

Displays a pop-up menu in the grid.

**\[Parameter List\]**

`index` - [CellIndex](/refs/Interface/CellIndex)

The index of the cell where the pop-up menu will be displayed.

`menu` - string

Enter the name of the menu to be displayed. If omitted, the popupMenu or contextMenu for the cell will be displayed.

**\[Return Value\] -** void

**Remarks:**

If the specified cell is not visible on the screen, the pop-up menu will not be displayed.

**Example:**

```js
gridView.showPopup({itemIndex: 0, column: "Column"});
```
<hr/>

### showProgress

Displays a progress bar.

**Remarks:**

A Progress Bar notifying progress is displayed on the screen.

Progress values and string information are set through [setProgress()](/refs/Class/GridBase#setprogress){/* */}.

**Example:**


```js
gridView.showProgress();
```

<hr/>

### showToast

Displays the Toast pop-up window.

**\[Parameter List\]**

`options` - [ToastOptions](/refs/Interface/ToastOptions)

Specifies the message and whether to display the message, an object of the same model as [ToastOptions](/refs/Interface/ToastOptions). Basically, you only need to specify a message.

`force` - boolean

Specifies whether to force the display again when the existing toast window is displayed.

**\[Return Value\] -** void

**Example:**


```js
let config = {
 message: 'Toast!'
}
gridView.showToast(config, true);
```

<hr/>

### toggleAllColumnFilters

Toggles all filters specified for the corresponding column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

**\[Return Value\] -** void

**Example:**


```js
gridView.toggleAllColumnFilters('By administrative district', ['All']);
```

<hr/>

### toggleColumnFilters

Toggles the specified filters for the corresponding column.

**\[Parameter List\]**

`column` - string \| [DataColumn](/refs/Interface/DataColumn)

Name of the corresponding column or column object

`filterNames` - string \| string\[\]

Name of filter to toggle or array of names of filters

**\[Return Value\] -** void

**Example:**


```js
gridView.toggleColumnFilters('By administrative district', ['Before', 'Answer']);
```

<hr/>

### undo

Returns the datasource connected to the grid to its previous state.

**Example:**


```js
gridView.undo();
```

<hr/>

### unregisterAllCustomRenderer

Unregister all custom renderers.

**Example:**


```js
gridView.unregisterAllCustomRenderer('Renderer01');
```

<hr/>

### unregisterCustomRenderer

Unregister the custom renderer.

**\[Parameter List\]**

`type` - string

Type of renderer to release (name)

**\[Return Value\] -** void

**Example:**


```js
gridView.unregisterCustomRenderer('Renderer01');
```

<hr/>

### validateCells

Rather than verifying upon input, verification is performed on the data in the grid in batches.

**\[Parameter List\]**

`itemIndices` - number\[\] \| null

Row indices of the grid, if specified as `null`{/* */}, verification is performed on all rows of the grid.

`visibleOnly` - boolean

Default value: `true`{/* */}, if `false`, invisible rows such as collapsed nodes in the tree grid are also included in the verification target. `false`{/* */} applies only when checking the entire row.

`pageAllItems` - boolean

If `true`{/* */}, verification is performed on the entire row, not the current page. Default value: `false`{/* */},

`columns` - string \| string\[\]

Specify the names or array of columns to be validated, and only the entered columns will be validated.

**\[return value\] -** object

**Remarks:**

Verification is performed using column validation and row validation is not performed.

**Example:**


```js
gridView.validateCells(null, false);
```

<hr/>