Angular DataGrid API - DevExtreme Angular Documentation v23.2 (2024)

Name Description accessKey

Specifies the shortcut key that sets focus on the UI component.

activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.

allowColumnReordering

Specifies whether a user can reorder columns.

allowColumnResizing

Specifies whether a user can resize columns.

autoNavigateToFocusedRow

Automatically scrolls the component to the focused row when the focusedRowKey is changed. Incompatible with infinite scrolling mode.

cacheEnabled

Specifies whether data should be cached.

cellHintEnabled

Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content.

columnAutoWidth

Specifies whether columns should adjust their widths to the content.

columnChooser

Configures the column chooser.

columnFixing

Configures column fixing.

columnHidingEnabled

Specifies whether the UI component should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".

columnMinWidth

Specifies the minimum width of columns.

columnResizingMode

Specifies how the UI component resizes columns. Applies only if allowColumnResizing is true.

columns

An array of grid columns.

columnWidth

Specifies the width for all data columns. Has a lower priority than the column.width property.

customizeColumns

Customizes columns after they are created.

dataRowComponent

An alias for the dataRowTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.

dataRowRender

An alias for the dataRowTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.

dataRowTemplate

Specifies a custom template for data rows.

dataSource

Binds the UI component to data.

dateSerializationFormat

Specifies the format in which date-time values should be sent to the server.

disabled

Specifies whether the UI component responds to user interaction.

editing

Configures editing.

elementAttr

Specifies the global attributes to be attached to the UI component's container element.

errorRowEnabled

Indicates whether to show the error row.

export

Configures client-side exporting.

filterBuilder

Configures the integrated filter builder.

filterBuilderPopup

Configures the popup in which the integrated filter builder is shown.

filterPanel

Configures the filter panel.

filterRow

Configures the filter row.

filterSyncEnabled

Specifies whether to synchronize the filter row, header filter, and filter builder. The synchronized filter expression is stored in the filterValue property.

filterValue

Specifies a filter expression.

focusedColumnIndex

The index of the column that contains the focused data cell. This index is taken from the columns array.

focusedRowEnabled

Specifies whether the focused row feature is enabled.

focusedRowIndex

Specifies or indicates the focused data row's index.

focusedRowKey

Specifies initially or currently focused grid row's key.

grouping

Configures grouping.

groupPanel

Configures the group panel.

headerFilter

Configures the header filter feature.

height

Specifies the UI component's height.

highlightChanges

Specifies whether to highlight rows and cells with edited data. repaintChangesOnly should be true.

hint

Specifies text for a hint that appears when a user pauses on the UI component.

hoverStateEnabled

Specifies whether to highlight rows when a user moves the mouse pointer over them.

keyboardNavigation

Configures keyboard navigation.

keyExpr

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

loadPanel

Configures the load panel.

masterDetail

Allows you to build a master-detail interface in the grid.

noDataText

Specifies a text string shown when the DataGrid does not display any data.

onAdaptiveDetailRowPreparing

A function that is executed before an adaptive detail row is rendered.

onCellClick

A function that is executed when a cell is clicked or tapped. Executed before onRowClick.

onCellDblClick

A function that is executed when a cell is double-clicked or double-tapped. Executed before onRowDblClick.

onCellHoverChanged

A function that is executed after the pointer enters or leaves a cell.

onCellPrepared

A function that is executed after a grid cell is created.

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

onContextMenuPreparing

A function that is executed before the context menu is rendered.

onDataErrorOccurred

A function that is executed when an error occurs in the data source.

onDisposing

A function that is executed before the UI component is disposed of.

onEditCanceled

A function that is executed after row changes are discarded.

onEditCanceling

A function that is executed when the edit operation is canceled, but row changes are not yet discarded.

onEditingStart

A function that is executed before a cell or row switches to the editing state.

onEditorPrepared

A function that is executed after an editor is created. Not executed for cells with an editCellTemplate.

onEditorPreparing

A function used to customize a cell's editor. Not executed for cells with an editCellTemplate.

onExporting

A function that is executed before data is exported.

onFocusedCellChanged

A function that is executed after the focused cell changes. Applies only to cells in data or group rows.

onFocusedCellChanging

A function that is executed before the focused cell changes. Applies only to cells in data or group rows.

onFocusedRowChanged

A function that is executed after the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true.

onFocusedRowChanging

A function that is executed before the focused row changes. Applies only to data or group rows. focusedRowEnabled should be true.

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

onInitNewRow

A function that is executed before a new row is added to the UI component.

onKeyDown

A function that is executed when the UI component is in focus and a key has been pressed down.

onOptionChanged

A function that is executed after a UI component property is changed.

onRowClick

A function that is executed when a row is clicked or tapped.

onRowCollapsed

A function that is executed after a row is collapsed.

onRowCollapsing

A function that is executed before a row is collapsed.

onRowDblClick

A function that is executed when a row is double-clicked or double-tapped. Executed after onCellDblClick.

onRowExpanded

A function that is executed after a row is expanded.

onRowExpanding

A function that is executed before a row is expanded.

onRowInserted

A function that is executed after a new row has been inserted into the data source.

onRowInserting

A function that is executed before a new row is inserted into the data source.

onRowPrepared

A function that is executed after a row is created.

onRowRemoved

A function that is executed after a row has been removed from the data source.

onRowRemoving

A function that is executed before a row is removed from the data source.

onRowUpdated

A function that is executed after a row has been updated in the data source.

onRowUpdating

A function that is executed before a row is updated in the data source.

onRowValidating

A function that is executed after cells in a row are validated against validation rules.

onSaved

A function that is executed after row changes are saved.

onSaving

A function that is executed before pending row changes are saved.

onSelectionChanged

A function that is executed after selecting a row or clearing its selection.

onToolbarPreparing

A function that is executed before the toolbar is created.

pager

Configures the pager.

paging

Configures paging.

remoteOperations

Notifies the DataGrid of the server's data processing operations.

renderAsync

Specifies whether to render the filter row, command columns, and columns with showEditorAlways set to true after other elements.

repaintChangesOnly

Specifies whether to repaint only those cells whose data changed.

rowAlternationEnabled

Specifies whether rows should be shaded differently.

rowDragging

Configures row reordering using drag and drop gestures.

rtlEnabled

Switches the UI component to a right-to-left representation.

scrolling

Configures scrolling.

searchPanel

Configures the search panel.

selectedRowKeys

Allows you to select rows or determine which rows are selected. Applies only if selection.deferred is false.

selection

Configures runtime selection.

selectionFilter

Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true.

showBorders

Specifies whether the outer borders of the UI component are visible.

showColumnHeaders

Specifies whether column headers are visible.

showColumnLines

Specifies whether vertical lines that separate one column from another are visible.

showRowLines

Specifies whether horizontal lines that separate one row from another are visible.

sortByGroupSummaryInfo

Allows you to sort groups according to the values of group summary items.

sorting

Configures runtime sorting.

stateStoring

Configures state storing.

summary

Specifies the properties of the grid summary.

syncLookupFilterValues

Specifies whether to show only relevant values in the header filter and filter row.

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

toolbar

Configures the toolbar.

twoWayBindingEnabled

Specifies whether to enable two-way data binding.

visible

Specifies whether the UI component is visible.

width

Specifies the UI component's width.

wordWrapEnabled

Specifies whether text that does not fit into a column should be wrapped.

Angular DataGrid API - DevExtreme Angular Documentation v23.2 (2024)
Top Articles
Latest Posts
Article information

Author: Lakeisha Bayer VM

Last Updated:

Views: 5730

Rating: 4.9 / 5 (69 voted)

Reviews: 84% of readers found this page helpful

Author information

Name: Lakeisha Bayer VM

Birthday: 1997-10-17

Address: Suite 835 34136 Adrian Mountains, Floydton, UT 81036

Phone: +3571527672278

Job: Manufacturing Agent

Hobby: Skimboarding, Photography, Roller skating, Knife making, Paintball, Embroidery, Gunsmithing

Introduction: My name is Lakeisha Bayer VM, I am a brainy, kind, enchanting, healthy, lovely, clean, witty person who loves writing and wants to share my knowledge and understanding with you.