All docs
V24.2
24.2
24.1
23.2
23.1
22.2
The page you are viewing does not exist in version 22.2.
22.1
The page you are viewing does not exist in version 22.1.
21.2
The page you are viewing does not exist in version 21.2.
21.1
The page you are viewing does not exist in version 21.1.
20.2
The page you are viewing does not exist in version 20.2.
20.1
The page you are viewing does not exist in version 20.1.
19.2
The page you are viewing does not exist in version 19.2.
19.1
The page you are viewing does not exist in version 19.1.
18.2
The page you are viewing does not exist in version 18.2.
18.1
The page you are viewing does not exist in version 18.1.
17.2
The page you are viewing does not exist in version 17.2.
Box
Map

jQuery/JS Common Types - grids

ApplyChangesMode

Specifies when to apply changes made in the field chooser to the PivotGrid.

Accepted Values: 'instantly' | 'onDemand'

ApplyFilterMode

Specifies when to apply a filter.

Accepted Values: 'auto' | 'onClick'

ColumnChooser

Configures the column chooser.

import { ColumnChooser } from "devextreme/common/grids"
Type:

Object

ColumnChooserMode

Specifies how a user manages columns using the column chooser.

Accepted Values: 'dragAndDrop' | 'select'

ColumnChooserSearchConfig

Configures the column chooser's search functionality.

import { ColumnChooserSearchConfig } from "devextreme/common/grids"
Type:

Object

ColumnChooserSelectionConfig

Configures column selection functionality within the column chooser.

import { ColumnChooserSelectionConfig } from "devextreme/common/grids"
Type:

Object

ColumnFixing

Configures column fixing.

import { ColumnFixing } from "devextreme/common/grids"

ColumnFixingIcons

Configures column fixing icons.

import { ColumnFixingIcons } from "devextreme/common/grids"

ColumnFixingTexts

Contains properties that specify texts for column fixing commands in the context menu of a column header.

import { ColumnFixingTexts } from "devextreme/common/grids"

ColumnHeaderFilterSearchConfig

Configures the header filter's search.

import { ColumnHeaderFilterSearchConfig } from "devextreme/common/grids"

ColumnResizeMode

Specifies how the UI component resizes columns.

Accepted Values: 'nextColumn' | 'widget'

DataChangeType

Data change type.

Accepted Values: 'insert' | 'update' | 'remove'

DataRenderMode

Specifies the rendering mode for columns and rows.

Accepted Values: 'standard' | 'virtual'

EnterKeyAction

Specifies whether the Enter key switches the cell or row to the edit state or moves focus in the enterKeyDirection.

Accepted Values: 'startEdit' | 'moveFocus'

EnterKeyDirection

Specifies the direction in which to move focus when a user presses Enter.

Accepted Values: 'none' | 'column' | 'row'

FilterOperation

Specifies available filter operations.

Accepted Values: '=' | '<>' | '<' | '<=' | '>' | '>=' | 'contains' | 'endswith' | 'isblank' | 'isnotblank' | 'notcontains' | 'startswith' | 'between' | 'anyof' | 'noneof'

FilterPanel

Configures the filter panel.

import { FilterPanel } from "devextreme/common/grids"

FilterPanelTexts

Specifies texts for the filter panel's elements.

import { FilterPanelTexts } from "devextreme/common/grids"

FilterRow

Configures the filter row.

import { FilterRow } from "devextreme/common/grids"

FilterRowOperationDescriptions

Specifies descriptions for filter operations on the filter list.

import { FilterRowOperationDescriptions } from "devextreme/common/grids"

FilterType

Specifies whether a user changes the current filter by including (selecting) or excluding (clearing the selection of) values.

Accepted Values: 'exclude' | 'include'

FixedPosition

Specifies a position type for fixed columns.

Accepted Values: 'left' | 'right' | 'sticky'

GridsEditMode

Specifies how a user edits data.

Accepted Values: 'batch' | 'cell' | 'row' | 'form' | 'popup'

GridsEditRefreshMode

Specifies operations that are performed after saving changes.

Accepted Values: 'full' | 'reshape' | 'repaint'

GroupExpandMode

Specifies the event on which a group will be expanded/collapsed.

Accepted Values: 'buttonClick' | 'rowClick'

HeaderFilter

Configures the header filter feature.

import { HeaderFilter } from "devextreme/common/grids"

HeaderFilterGroupInterval

Specifies how the header filter combines values into groups.

Accepted Values: 'day' | 'hour' | 'minute' | 'month' | 'quarter' | 'second' | 'year'

HeaderFilterSearchConfig

Configures the header filter's search functionality.

import { HeaderFilterSearchConfig } from "devextreme/common/grids"
Type:

Object

HeaderFilterTexts

Contains properties that specify text for various elements of the popup menu.

import { HeaderFilterTexts } from "devextreme/common/grids"

KeyboardNavigation

Configures keyboard navigation.

import { KeyboardNavigation } from "devextreme/common/grids"

LoadPanel

Configures the load panel.

import { LoadPanel } from "devextreme/common/grids"

NewRowPosition

Specifies a position for a new row.

Accepted Values: 'first' | 'last' | 'pageBottom' | 'pageTop' | 'viewportBottom' | 'viewportTop'

Pager

Configures the pager.

import { Pager } from "devextreme/common/grids"
Type:

Object

Function parameters:
allowedPageSizes:
Object structure:
Name Type Description

Array

|

Mode

Specifies the available page sizes in the page size selector.

visible:
Object structure:
Name Type Description

Boolean

|

Mode

Specifies whether the pager is visible.

PagerDisplayMode

Specifies the pager's display mode.

Accepted Values: 'adaptive' | 'compact' | 'full'

PagerPageSize

Specifies the available page sizes in the page size selector.

Accepted Values: 'all' | 'auto'

RowDragging

Configures row reordering using drag and drop gestures.

import { RowDragging } from "devextreme/common/grids"

SearchPanel

Configures the search panel.

import { SearchPanel } from "devextreme/common/grids"

SelectedFilterOperation

Specifies a filter operation that applies when users use the filter row to filter the column.

Accepted Values: '<' | '<=' | '<>' | '=' | '>' | '>=' | 'between' | 'contains' | 'endswith' | 'notcontains' | 'startswith'

SelectionColumnDisplayMode

Specifies when to display the selection column and row selection checkboxes.

Accepted Values: 'always' | 'none' | 'onClick' | 'onLongTap'

Sorting

Configures runtime sorting.

import { Sorting } from "devextreme/common/grids"

StartEditAction

Specifies whether a single or double click should switch a cell to the editing state.

Accepted Values: 'click' | 'dblClick'

StateStoreType

Specifies the type of storage where the state is saved.

Accepted Values: 'custom' | 'localStorage' | 'sessionStorage'

StateStoring

Configures state storing.

import { StateStoring } from "devextreme/common/grids"

SummaryType

Specifies how to aggregate data for the group summary item, total summary item, or the field's data.

Accepted Values: 'avg' | 'count' | 'custom' | 'max' | 'min' | 'sum'