This section describes the configuration properties of the DataGrid UI component.
Name Description accessKeySpecifies the shortcut key that sets focus on the UI component.
activeStateEnabledSpecifies whether the UI component changes its visual state as a result of user interaction.
allowColumnReorderingSpecifies whether a user can reorder columns.
allowColumnResizingSpecifies whether a user can resize columns.
autoNavigateToFocusedRowAutomatically scrolls the component to the focused row when the focusedRowKey is changed. Incompatible with infinite scrolling mode.
cacheEnabledSpecifies whether data should be cached.
cellHintEnabledEnables a hint that appears when a user hovers the mouse pointer over a cell with truncated content.
columnAutoWidthSpecifies whether columns should adjust their widths to the content.
columnChooserConfigures the column chooser.
columnFixingConfigures column fixing.
columnHidingEnabledSpecifies whether the UI component should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".
columnMinWidthSpecifies the minimum width of columns.
columnResizingModeSpecifies how the UI component resizes columns. Applies only if allowColumnResizing is true.
columnsAn array of grid columns.
columnWidthSpecifies the width for all data columns. Has a lower priority than the column.width property.
customizeColumnsCustomizes columns after they are created.
dataRowComponentAn alias for the dataRowTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
dataRowRenderAn alias for the dataRowTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
dataRowTemplateSpecifies a custom template for data rows.
dataSourceBinds the UI component to data.
dateSerializationFormatSpecifies the format in which date-time values should be sent to the server.
disabledSpecifies whether the UI component responds to user interaction.
editingConfigures editing.
elementAttrSpecifies the global attributes to be attached to the UI component's container element.
errorRowEnabledIndicates whether to show the error row.
exportConfigures client-side exporting.
filterBuilderConfigures the integrated filter builder.
filterBuilderPopupConfigures the popup in which the integrated filter builder is shown.
filterPanelConfigures the filter panel.
filterRowConfigures the filter row.
filterSyncEnabledSpecifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue property.
filterValueSpecifies a filter expression.
focusedColumnIndexThe index of the column that contains the focused data cell. This index is taken from the columns array.
focusedRowEnabledSpecifies whether the focused row feature is enabled.
focusedRowIndexSpecifies or indicates the focused data row's index.
focusedRowKeySpecifies initially or currently focused grid row's key.
groupingConfigures grouping.
groupPanelConfigures the group panel.
headerFilterConfigures the header filter feature.
heightSpecifies the UI component's height.
highlightChangesSpecifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true.
hintSpecifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabledSpecifies whether to highlight rows when a user moves the mouse pointer over them.
keyboardNavigationConfigures keyboard navigation.
keyExprSpecifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique. This property applies only if data is a simple array.
loadPanelConfigures the load panel.
masterDetailAllows you to build a master-detail interface in the grid.
noDataTextSpecifies a text string shown when the DataGrid does not display any data.
onAdaptiveDetailRowPreparingA function that is executed before an adaptive detail row is rendered.
onCellClickA function that is executed when a cell is clicked or tapped. Executed before onRowClick.
onCellDblClickA function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick.
onCellHoverChangedA function that is executed after the pointer enters or leaves a cell.
onCellPreparedA function that is executed after a grid cell is created.
onContentReadyA function that is executed when the UI component is rendered and each time the component is repainted.
onContextMenuPreparingA function that is executed before the context menu is rendered.
onDataErrorOccurredA function that is executed when an error occurs in the data source.
onDisposingA function that is executed before the UI component is disposed of.
onEditCanceledA function that is executed after row changes are discarded.
onEditCancelingA function that is executed when the edit operation is canceled, but row changes are not yet discarded.
onEditingStartA function that is executed before a cell or row switches to the editing state.
onEditorPreparedA function that is executed after an editor is created. Not executed for cells with an editCellTemplate.
onEditorPreparingA function used to customize cell editors. Not executed for cells with an editCellTemplate.
onExportingA function that is executed before data is exported.
onFocusedCellChangedA function that is executed after the focused cell changes. Applies only to cells in data or group rows.
onFocusedCellChangingA function that is executed before the focused cell changes. Applies only to cells in data or group rows.
onFocusedRowChangedA function that is executed after the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true.
onFocusedRowChangingA function that is executed before the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true.
onInitializedA function used in JavaScript frameworks to save the UI component instance.
onInitNewRowA function that is executed before a new row is added to the UI component.
onKeyDownA function that is executed when the UI component is in focus and a key has been pressed down.
onOptionChangedA function that is executed after a UI component property is changed.
onRowClickA function that is executed when a row is clicked or tapped.
onRowCollapsedA function that is executed after a row is collapsed.
onRowCollapsingA function that is executed before a row is collapsed.
onRowDblClickA function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick.
onRowExpandedA function that is executed after a row is expanded.
onRowExpandingA function that is executed before a row is expanded.
onRowInsertedA function that is executed after a new row has been inserted into the data source.
onRowInsertingA function that is executed before a new row is inserted into the data source.
onRowPreparedA function that is executed after a row is created.
onRowRemovedA function that is executed after a row has been removed from the data source.
onRowRemovingA function that is executed before a row is removed from the data source.
onRowUpdatedA function that is executed after a row has been updated in the data source.
onRowUpdatingA function that is executed before a row is updated in the data source.
onRowValidatingA function that is executed after cells in a row are validated against validation rules.
onSavedA function that is executed after row changes are saved.
onSavingA function that is executed before pending row changes are saved.
onSelectionChangedA function that is executed after selecting a row or clearing its selection.
onToolbarPreparingA function that is executed before the toolbar is created.
pagerConfigures the pager.
pagingConfigures paging.
remoteOperationsNotifies the DataGrid of the server's data processing operations.
renderAsyncSpecifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements.
repaintChangesOnlySpecifies whether to repaint only those cells whose data changed.
rowAlternationEnabledSpecifies whether rows should be shaded differently.
rowDraggingConfigures row reordering using drag and drop gestures.
rtlEnabledSwitches the UI component to a right-to-left representation.
scrollingConfigures scrolling.
searchPanelConfigures the search panel.
selectedRowKeysAllows you to select rows or determine which rows are selected. Applies only if selection.deferred is false.
selectionConfigures runtime selection.
selectionFilterSpecifies filters for the rows that must be selected initially. Applies only if selection.deferred is true.
showBordersSpecifies whether the outer borders of the UI component are visible.
showColumnHeadersSpecifies whether column headers are visible.
showColumnLinesSpecifies whether vertical lines that separate one column from another are visible.
showRowLinesSpecifies whether horizontal lines that separate one row from another are visible.
sortByGroupSummaryInfoAllows you to sort groups according to the values of group summary items.
sortingConfigures runtime sorting.
stateStoringConfigures state storing.
summarySpecifies the properties of the grid summary.
syncLookupFilterValuesSpecifies whether to show only relevant values in the header filter and filter row.
tabIndexSpecifies the number of the element when the Tab key is used for navigating.
toolbarConfigures the toolbar.
twoWayBindingEnabledSpecifies whether to enable two-way data binding.
visibleSpecifies whether the UI component is visible.
widthSpecifies the UI component's width.
wordWrapEnabledSpecifies whether text that does not fit into a column should be wrapped.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4