Gridoptions

Complete grid configuration information

Signature:

export interface GridOptions

Remarks

Resetting subcomponents is not possible with GridBase.getOptions().

Resetting subcomponents is possible with GridBase.setOptions().

Practical use is in GridView and TreeView.

Example

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

Properties

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