Angular DataGrid Types

AdaptiveDetailRowPreparingEvent

The type of the adaptiveDetailRowPreparing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.AdaptiveDetailRowPreparingEvent

AIAssistantRequestCreatingEvent

The argument type in the aIAssistantRequestCreating event.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.AIAssistantRequestCreatingEvent
Accepted Values: 'context' | 'responseSchema' | 'additionalInfo'

AIColumnRequestCreatingEvent

The argument type in the aIColumnRequestCreating event.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.AIColumnRequestCreatingEvent

CellClickEvent

The type of the cellClick event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.CellClickEvent

CellDblClickEvent

The type of the cellDblClick event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.CellDblClickEvent

CellHoverChangedEvent

The type of the cellHoverChanged event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.CellHoverChangedEvent

CellPreparedEvent

The type of the cellPrepared event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.CellPreparedEvent

ColumnButtonClickEvent

The argument type in columns[].buttons[].onClick.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.ColumnButtonClickEvent

ContentReadyEvent

The type of the contentReady event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.ContentReadyEvent

ContextMenuPreparingEvent

The type of the contextMenuPreparing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.ContextMenuPreparingEvent

DataErrorOccurredEvent

The type of the dataErrorOccurred event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.DataErrorOccurredEvent

DataGridCommandColumnType

Specifies the command column that this object customizes.

Accepted Values: 'adaptive' | 'ai' | 'buttons' | 'detailExpand' | 'groupExpand' | 'selection' | 'drag'

DataGridCommandInfo

Information about a predefined DataGrid command.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.DataGridCommandInfo

DataGridCommandInfo contains the following fields:

DataGridExportFormat

Specifies the availability and captions of data export buttons.

Accepted Values: 'pdf' | 'xlsx'

DataGridPredefinedColumnButton

The name used to identify a built-in button.

Accepted Values: 'cancel' | 'delete' | 'edit' | 'save' | 'undelete'

DataGridPredefinedCommandNames

Names of predefined commands available in the DevExtreme DataGrid.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.DataGridPredefinedCommandNames

The following commands are available:

  • columnsVisibility
  • columnsReorder
  • columnsPinning
  • columnsResize
  • filterValue
  • clearFilter
  • focusRowByKey
  • focusRowByIndex
  • paging
  • pageSize
  • pageIndex
  • searching
  • selectByKeys
  • selectByIndexes
  • selectAll
  • deselectAll
  • clearSelection
  • sorting
  • clearSorting
  • grouping
  • clearGrouping
  • summary
  • clearSummary
See Also

DataGridPredefinedCommands

Predefined commands available in the DevExtreme DataGrid.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.DataGridPredefinedCommands

The following code snippet lists available commands with their arguments:

Code
columnsVisibility: {
    dataField: string;
    visible: boolean;
};
columnsReorder: {
    dataField: string;
    visibleIndex: number;
};
columnsPinning: {
    dataField: string;
    fixed: boolean;
    fixedPosition?: 'left' | 'right';
};
columnsResize: {
    dataField: string;
    width: number | string;
};
filterValue: {
    expression: FilterExprTree | null;
};
clearFilter: {};
focusRowByKey: {
    key: string | number | Array<CompositeKeyPair>;
};
focusRowByIndex: {
    index: number;
};
paging: {
    enabled: boolean;
};
pageSize: {
    pageSize: number;
};
pageIndex: {
    pageIndex: number;
};
searching: {
    text: string;
};
selectByKeys: {
    keys: Array<string | number | Array<CompositeKeyPair>>;
    preserve: boolean;
};
selectionByIndexes: {
    indexes: number[];
    mode: 'select' | 'deselect';
    scope: 'page' | 'allPages';
};
selectAll: {};
deselectAll: {};
clearSelection: {};
sorting: {
    dataField: string;
    sortOrder: SortOrder | 'none';
};
clearSorting: {};
grouping: {
    dataField: string;
    groupIndex: number;
};
clearGrouping: {};
summary: {
    totalItems: Array<SummaryCommandTotalItem>;
    groupItems: Array<SummaryCommandGroupItem>;
};
clearSummary: {};

DataGridPredefinedToolbarItem

A name used to identify the toolbar item.

Accepted Values: 'addRowButton' | 'aiAssistantButton' | 'applyFilterButton' | 'columnChooserButton' | 'exportButton' | 'groupPanel' | 'revertButton' | 'saveButton' | 'searchPanel'

DataGridScrollMode

Specifies the scrolling mode.

Accepted Values: 'infinite' | 'standard' | 'virtual'

DisposingEvent

The type of the disposing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.DisposingEvent

EditCanceledEvent

The type of the editCanceled event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.EditCanceledEvent

EditCancelingEvent

The type of the editCanceling event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.EditCancelingEvent

Editing

Configures editing.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

EditingStartEvent

The type of the editingStart event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.EditingStartEvent

EditorPreparedEvent

The type of the editorPrepared event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.EditorPreparedEvent

EditorPreparingEvent

The type of the editorPreparing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.EditorPreparingEvent

Export

Configures client-side exporting.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

ExportingEvent

The type of the exporting event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.ExportingEvent

ExportTexts

Configures the texts of export commands, buttons, and hints.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

FocusedCellChangedEvent

The type of the focusedCellChanged event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.FocusedCellChangedEvent

FocusedCellChangingEvent

The type of the focusedCellChanging event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.FocusedCellChangingEvent

FocusedRowChangedEvent

The type of the focusedRowChanged event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.FocusedRowChangedEvent

FocusedRowChangingEvent

The type of the focusedRowChanging event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.FocusedRowChangingEvent

GroupData

Specifies a group of elements in a template.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.GroupData

Grouping

Configures grouping.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

GroupingTexts

Defines the texts of grouping-related visual elements.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

GroupPanel

Configures the group panel.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

InitializedEvent

The type of the initialized event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.InitializedEvent

InitNewRowEvent

The type of the initNewRow event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.InitNewRowEvent

KeyDownEvent

The type of the keyDown event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.KeyDownEvent

MasterDetail

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

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

OptionChangedEvent

The type of the optionChanged event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.OptionChangedEvent

RowClickEvent

The type of the rowClick event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowClickEvent

RowCollapsedEvent

The type of the rowCollapsed event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowCollapsedEvent

RowCollapsingEvent

The type of the rowCollapsing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowCollapsingEvent

RowDblClickEvent

The type of the rowDblClick event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowDblClickEvent

RowExpandedEvent

The type of the rowExpanded event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowExpandedEvent

RowExpandingEvent

The type of the rowExpanding event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowExpandingEvent

RowInsertedEvent

The type of the rowInserted event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowInsertedEvent

RowInsertingEvent

The type of the rowInserting event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowInsertingEvent

RowPreparedEvent

The type of the rowPrepared event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowPreparedEvent

RowRemovedEvent

The type of the rowRemoved event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowRemovedEvent

RowRemovingEvent

The type of the rowRemoving event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowRemovingEvent

RowUpdatedEvent

The type of the rowUpdated event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowUpdatedEvent

RowUpdatingEvent

The type of the rowUpdating event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowUpdatingEvent

RowValidatingEvent

The type of the rowValidating event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.RowValidatingEvent

SavedEvent

The type of the saved event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.SavedEvent

SavingEvent

The type of the saving event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.SavingEvent

Scrolling

Configures scrolling.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

SelectionChangedEvent

The type of the selectionChanged event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.SelectionChangedEvent

SelectionSensitivity

Specifies sensitivity modes.

Accepted Values: 'base' | 'accent' | 'case' | 'variant'

SortByGroupSummaryInfoItem

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

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

Summary

Specifies the properties of the grid summary.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

SummaryCommandGroupItem

A group summary item in a DataGrid summary command.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.SummaryCommandGroupItem
Accepted Values: 'showInColumn' | 'displayFormat' | 'showInGroupFooter' | 'alignByColumn'

This object includes the following fields:

  • alignByColumn: Specifies whether the summary item is aligned to a column.
  • column: The summary item's data column.
  • displayFormat: The format of the summary item's text.
  • showInColumn: The column that displays the summary item.
  • showInGroupFooter: Specifies whether the summary item is displayed in the group footer.
  • summaryType: The summary calculation type (SummaryType).
See Also

SummaryCommandTotalItem

A total summary item in a DataGrid summary command.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.SummaryCommandTotalItem
Accepted Values: 'showInColumn' | 'displayFormat'

This object includes the following fields:

  • column: The summary item's data column.
  • displayFormat: The format of the summary item's text.
  • showInColumn: The column that displays the summary item.
  • summaryType: The summary calculation type (SummaryType).
See Also

SummaryGroupItem

Specifies items of the group summary.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

SummaryTexts

Contains properties that specify text patterns for summary items.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

SummaryTotalItem

Specifies items of the total summary.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"

ToolbarPreparingEvent

The type of the toolbarPreparing event handler's argument.

import { DxDataGridTypes } from "devextreme-angular/ui/data-grid"
Type: DxDataGridTypes.ToolbarPreparingEvent