/** * DevExtreme (ui/data_grid.d.ts) * Version: 19.2.6 * Build date: Thu Jan 30 2020 * * Copyright (c) 2012 - 2020 Developer Express Inc. ALL RIGHTS RESERVED * Read about DevExtreme licensing here: https://js.devexpress.com/Licensing/ */ import '../jquery_augmentation'; import { dxElement } from '../core/element'; import { template } from '../core/templates/template'; import Store from '../data/abstract_store'; import DataSource, { DataSourceOptions } from '../data/data_source'; import { event } from '../events'; import { ExcelDataGridCell, ExcelFont } from '../exporter/excel/excel.doc_comments'; import dxDraggable from './draggable'; import { dxFilterBuilderOptions } from './filter_builder'; import { dxFormOptions, dxFormSimpleItem } from './form'; import { dxPopupOptions } from './popup'; import dxScrollable from './scroll_view/ui.scrollable'; import dxSortable from './sortable'; import { dxToolbarOptions } from './toolbar'; import { AsyncRule, CompareRule, CustomRule, EmailRule, NumericRule, PatternRule, RangeRule, RequiredRule, StringLengthRule } from './validation_engine'; import Widget, { format, WidgetOptions } from './widget/ui.widget'; /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseOptions extends WidgetOptions { /** * @docid GridBaseOptions.allowColumnReordering * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ allowColumnReordering?: boolean; /** * @docid GridBaseOptions.allowColumnResizing * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ allowColumnResizing?: boolean; /** * @docid GridBaseOptions.autoNavigateToFocusedRow * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ autoNavigateToFocusedRow?: boolean; /** * @docid GridBaseOptions.cacheEnabled * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ cacheEnabled?: boolean; /** * @docid GridBaseOptions.cellHintEnabled * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ cellHintEnabled?: boolean; /** * @docid GridBaseOptions.columnAutoWidth * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ columnAutoWidth?: boolean; /** * @docid GridBaseOptions.columnChooser * @type object * @prevFileNamespace DevExpress.ui * @public */ columnChooser?: { allowSearch?: boolean, emptyPanelText?: string, enabled?: boolean, height?: number, mode?: 'dragAndDrop' | 'select', searchTimeout?: number, title?: string, width?: number }; /** * @docid GridBaseOptions.columnFixing * @type object * @prevFileNamespace DevExpress.ui * @public */ columnFixing?: { enabled?: boolean, texts?: { fix?: string, leftPosition?: string, rightPosition?: string, unfix?: string } }; /** * @docid GridBaseOptions.columnHidingEnabled * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ columnHidingEnabled?: boolean; /** * @docid GridBaseOptions.columnMinWidth * @type number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ columnMinWidth?: number; /** * @docid GridBaseOptions.columnResizingMode * @type Enums.ColumnResizingMode * @default "nextColumn" * @prevFileNamespace DevExpress.ui * @public */ columnResizingMode?: 'nextColumn' | 'widget'; /** * @docid GridBaseOptions.columnWidth * @type number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ columnWidth?: number; /** * @docid GridBaseOptions.columns * @type Array * @fires GridBaseOptions.onOptionChanged * @default undefined * @prevFileNamespace DevExpress.ui * @public */ columns?: Array; /** * @docid GridBaseOptions.dataSource * @type string|Array|DataSource|DataSourceOptions * @default null * @prevFileNamespace DevExpress.ui * @public */ dataSource?: string | Array | DataSource | DataSourceOptions; /** * @docid GridBaseOptions.dateSerializationFormat * @type string * @prevFileNamespace DevExpress.ui * @public */ dateSerializationFormat?: string; /** * @docid GridBaseOptions.editing * @type object * @prevFileNamespace DevExpress.ui * @public */ editing?: GridBaseEditing; /** * @docid GridBaseOptions.errorRowEnabled * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ errorRowEnabled?: boolean; /** * @docid GridBaseOptions.filterBuilder * @type dxFilterBuilderOptions * @default {} * @prevFileNamespace DevExpress.ui * @public */ filterBuilder?: dxFilterBuilderOptions; /** * @docid GridBaseOptions.filterBuilderPopup * @type dxPopupOptions * @default {} * @prevFileNamespace DevExpress.ui * @public */ filterBuilderPopup?: dxPopupOptions; /** * @docid GridBaseOptions.filterPanel * @type object * @default {} * @prevFileNamespace DevExpress.ui * @public */ filterPanel?: { customizeText?: ((e: { component?: T, filterValue?: any, text?: string }) => string), filterEnabled?: boolean, texts?: { clearFilter?: string, createFilter?: string, filterEnabledHint?: string }, visible?: boolean }; /** * @docid GridBaseOptions.filterRow * @type object * @prevFileNamespace DevExpress.ui * @public */ filterRow?: { applyFilter?: 'auto' | 'onClick', applyFilterText?: string, betweenEndText?: string, betweenStartText?: string, operationDescriptions?: { between?: string, contains?: string, endsWith?: string, equal?: string, greaterThan?: string, greaterThanOrEqual?: string, lessThan?: string, lessThanOrEqual?: string, notContains?: string, notEqual?: string, startsWith?: string }, resetOperationText?: string, showAllText?: string, showOperationChooser?: boolean, visible?: boolean }; /** * @docid GridBaseOptions.filterSyncEnabled * @type boolean|Enums.Mode * @default "auto" * @prevFileNamespace DevExpress.ui * @public */ filterSyncEnabled?: boolean | 'auto'; /** * @docid GridBaseOptions.filterValue * @type Filter expression * @default null * @fires GridBase.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ filterValue?: string | Array | Function; /** * @docid GridBaseOptions.focusedColumnIndex * @type number * @default -1 * @fires GridBaseOptions.onFocusedCellChanged * @prevFileNamespace DevExpress.ui * @public */ focusedColumnIndex?: number; /** * @docid GridBaseOptions.focusedRowEnabled * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ focusedRowEnabled?: boolean; /** * @docid GridBaseOptions.focusedRowIndex * @type number * @default -1 * @fires GridBaseOptions.onFocusedRowChanged * @prevFileNamespace DevExpress.ui * @public */ focusedRowIndex?: number; /** * @docid GridBaseOptions.focusedRowKey * @type any * @default undefined * @fires GridBaseOptions.onFocusedRowChanged * @prevFileNamespace DevExpress.ui * @public */ focusedRowKey?: any; /** * @docid GridBaseOptions.headerFilter * @type object * @prevFileNamespace DevExpress.ui * @public */ headerFilter?: { allowSearch?: boolean, height?: number, searchTimeout?: number, texts?: { cancel?: string, emptyValue?: string, ok?: string }, visible?: boolean, width?: number }; /** * @docid GridBaseOptions.highlightChanges * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ highlightChanges?: boolean; /** * @docid GridBaseOptions.keyboardNavigation * @type object * @prevFileNamespace DevExpress.ui * @public */ keyboardNavigation?: { editOnKeyPress?: boolean, enabled?: boolean, enterKeyAction?: 'startEdit' | 'moveFocus', enterKeyDirection?: 'none' | 'column' | 'row' }; /** * @docid GridBaseOptions.loadPanel * @type object * @prevFileNamespace DevExpress.ui * @public */ loadPanel?: { enabled?: boolean | 'auto', height?: number, indicatorSrc?: string, shading?: boolean, shadingColor?: string, showIndicator?: boolean, showPane?: boolean, text?: string, width?: number }; /** * @docid GridBaseOptions.noDataText * @type string * @default "No data" * @prevFileNamespace DevExpress.ui * @public */ noDataText?: string; /** * @docid GridBaseOptions.onAdaptiveDetailRowPreparing * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 formOptions:object * @action * @prevFileNamespace DevExpress.ui * @public */ onAdaptiveDetailRowPreparing?: ((e: { component?: T, element?: dxElement, model?: any, formOptions?: any }) => any); /** * @docid GridBaseOptions.onDataErrorOccurred * @extends Action * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 error:Error * @action * @prevFileNamespace DevExpress.ui * @public */ onDataErrorOccurred?: ((e: { component?: T, element?: dxElement, model?: any, error?: Error }) => any); /** * @docid GridBaseOptions.onInitNewRow * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 promise:Promise * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onInitNewRow?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, promise?: Promise | JQueryPromise }) => any); /** * @docid GridBaseOptions.onKeyDown * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 handled:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onKeyDown?: ((e: { component?: T, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, handled?: boolean }) => any); /** * @docid GridBaseOptions.onRowCollapsed * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 key:any * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowCollapsed?: ((e: { component?: T, element?: dxElement, model?: any, key?: any }) => any); /** * @docid GridBaseOptions.onRowCollapsing * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 key:any * @type_function_param1_field5 cancel:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowCollapsing?: ((e: { component?: T, element?: dxElement, model?: any, key?: any, cancel?: boolean }) => any); /** * @docid GridBaseOptions.onRowExpanded * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 key:any * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowExpanded?: ((e: { component?: T, element?: dxElement, model?: any, key?: any }) => any); /** * @docid GridBaseOptions.onRowExpanding * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 key:any * @type_function_param1_field5 cancel:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowExpanding?: ((e: { component?: T, element?: dxElement, model?: any, key?: any, cancel?: boolean }) => any); /** * @docid GridBaseOptions.onRowInserted * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 error:Error * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowInserted?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, key?: any, error?: Error }) => any); /** * @docid GridBaseOptions.onRowInserting * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 cancel:boolean|Promise * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowInserting?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, cancel?: boolean | Promise | JQueryPromise }) => any); /** * @docid GridBaseOptions.onRowRemoved * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 error:Error * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowRemoved?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, key?: any, error?: Error }) => any); /** * @docid GridBaseOptions.onRowRemoving * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 cancel:boolean|Promise * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowRemoving?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, key?: any, cancel?: boolean | Promise | JQueryPromise }) => any); /** * @docid GridBaseOptions.onRowUpdated * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 error:Error * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowUpdated?: ((e: { component?: T, element?: dxElement, model?: any, data?: any, key?: any, error?: Error }) => any); /** * @docid GridBaseOptions.onRowUpdating * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 oldData:object * @type_function_param1_field5 newData:object * @type_function_param1_field6 key:any * @type_function_param1_field7 cancel:boolean|Promise * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowUpdating?: ((e: { component?: T, element?: dxElement, model?: any, oldData?: any, newData?: any, key?: any, cancel?: boolean | Promise | JQueryPromise }) => any); /** * @docid GridBaseOptions.onRowValidating * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 brokenRules:Array * @type_function_param1_field5 isValid:boolean * @type_function_param1_field6 key:any * @type_function_param1_field7 newData:object * @type_function_param1_field8 oldData:object * @type_function_param1_field9 errorText:string * @type_function_param1_field10 promise:Promise * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowValidating?: ((e: { component?: T, element?: dxElement, model?: any, brokenRules?: Array, isValid?: boolean, key?: any, newData?: any, oldData?: any, errorText?: string, promise?: Promise | JQueryPromise }) => any); /** * @docid GridBaseOptions.onSelectionChanged * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 currentSelectedRowKeys:Array * @type_function_param1_field5 currentDeselectedRowKeys:Array * @type_function_param1_field6 selectedRowKeys:Array * @type_function_param1_field7 selectedRowsData:Array * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onSelectionChanged?: ((e: { component?: T, element?: dxElement, model?: any, currentSelectedRowKeys?: Array, currentDeselectedRowKeys?: Array, selectedRowKeys?: Array, selectedRowsData?: Array }) => any); /** * @docid GridBaseOptions.onToolbarPreparing * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 toolbarOptions:dxToolbarOptions * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onToolbarPreparing?: ((e: { component?: T, element?: dxElement, model?: any, toolbarOptions?: dxToolbarOptions }) => any); /** * @docid GridBaseOptions.pager * @type object * @prevFileNamespace DevExpress.ui * @public */ pager?: { allowedPageSizes?: Array | 'auto', infoText?: string, showInfo?: boolean, showNavigationButtons?: boolean, showPageSizeSelector?: boolean, visible?: boolean | 'auto' }; /** * @docid GridBaseOptions.paging * @type object * @prevFileNamespace DevExpress.ui * @public */ paging?: GridBasePaging; /** * @docid GridBaseOptions.renderAsync * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ renderAsync?: boolean; /** * @docid GridBaseOptions.repaintChangesOnly * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ repaintChangesOnly?: boolean; /** * @docid GridBaseOptions.rowAlternationEnabled * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ rowAlternationEnabled?: boolean; /** * @docid GridBaseOptions.rowDragging * @type object * @prevFileNamespace DevExpress.ui * @public */ rowDragging?: { allowDropInsideItem?: boolean, allowReordering?: boolean, autoScroll?: boolean, boundary?: string | Element | JQuery, container?: string | Element | JQuery, cursorOffset?: string | { x?: number, y?: number }, data?: any, dragDirection?: 'both' | 'horizontal' | 'vertical', dragTemplate?: template | ((dragInfo: { itemData?: any, itemElement?: dxElement }, containerElement: dxElement) => string | Element | JQuery), dropFeedbackMode?: 'push' | 'indicate', filter?: string, group?: string, handle?: string, onAdd?: ((e: { event?: event, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any, dropInsideItem?: boolean }) => any), onDragChange?: ((e: { event?: event, cancel?: boolean, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any, dropInsideItem?: boolean }) => any), onDragEnd?: ((e: { event?: event, cancel?: boolean, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any, dropInsideItem?: boolean }) => any), onDragMove?: ((e: { event?: event, cancel?: boolean, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any, dropInsideItem?: boolean }) => any), onDragStart?: ((e: { event?: event, cancel?: boolean, itemData?: any, itemElement?: dxElement, fromIndex?: number, fromData?: any }) => any), onRemove?: ((e: { event?: event, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any }) => any), onReorder?: ((e: { event?: event, itemData?: any, itemElement?: dxElement, fromIndex?: number, toIndex?: number, fromComponent?: dxSortable | dxDraggable, toComponent?: dxSortable | dxDraggable, fromData?: any, toData?: any, dropInsideItem?: boolean }) => any), scrollSensitivity?: number, scrollSpeed?: number, showDragIcons?: boolean }; /** * @docid GridBaseOptions.scrolling * @type object * @prevFileNamespace DevExpress.ui * @public */ scrolling?: GridBaseScrolling; /** * @docid GridBaseOptions.searchPanel * @type object * @prevFileNamespace DevExpress.ui * @public */ searchPanel?: { highlightCaseSensitive?: boolean, highlightSearchText?: boolean, placeholder?: string, searchVisibleColumnsOnly?: boolean, text?: string, visible?: boolean, width?: number }; /** * @docid GridBaseOptions.selectedRowKeys * @type Array * @fires GridBaseOptions.onSelectionChanged * @prevFileNamespace DevExpress.ui * @public */ selectedRowKeys?: Array; /** * @docid GridBaseOptions.selection * @type object * @prevFileNamespace DevExpress.ui * @public */ selection?: GridBaseSelection; /** * @docid GridBaseOptions.showBorders * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ showBorders?: boolean; /** * @docid GridBaseOptions.showColumnHeaders * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ showColumnHeaders?: boolean; /** * @docid GridBaseOptions.showColumnLines * @type boolean * @default false [for](Material) * @default true * @prevFileNamespace DevExpress.ui * @public */ showColumnLines?: boolean; /** * @docid GridBaseOptions.showRowLines * @type boolean * @default true [for](iOS) * @default true [for](Material) * @default false * @prevFileNamespace DevExpress.ui * @public */ showRowLines?: boolean; /** * @docid GridBaseOptions.sorting * @type object * @prevFileNamespace DevExpress.ui * @public */ sorting?: { ascendingText?: string, clearText?: string, descendingText?: string, mode?: 'multiple' | 'none' | 'single', showSortIndexes?: boolean }; /** * @docid GridBaseOptions.stateStoring * @type object * @prevFileNamespace DevExpress.ui * @public */ stateStoring?: { customLoad?: (() => Promise | JQueryPromise), customSave?: ((gridState: any) => any), enabled?: boolean, savingTimeout?: number, storageKey?: string, type?: 'custom' | 'localStorage' | 'sessionStorage' }; /** * @docid GridBaseOptions.twoWayBindingEnabled * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ twoWayBindingEnabled?: boolean; /** * @docid GridBaseOptions.wordWrapEnabled * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ wordWrapEnabled?: boolean; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseEditing { /** * @docid GridBaseOptions.editing.form * @type dxFormOptions * @prevFileNamespace DevExpress.ui * @public */ form?: dxFormOptions; /** * @docid GridBaseOptions.editing.mode * @type Enums.GridEditMode * @default "row" * @prevFileNamespace DevExpress.ui * @public */ mode?: 'batch' | 'cell' | 'row' | 'form' | 'popup'; /** * @docid GridBaseOptions.editing.popup * @type dxPopupOptions * @prevFileNamespace DevExpress.ui * @public */ popup?: dxPopupOptions; /** * @docid GridBaseOptions.editing.refreshMode * @type Enums.GridEditRefreshMode * @default "full" * @prevFileNamespace DevExpress.ui * @public */ refreshMode?: 'full' | 'reshape' | 'repaint'; /** * @docid GridBaseOptions.editing.selectTextOnEditStart * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ selectTextOnEditStart?: boolean; /** * @docid GridBaseOptions.editing.startEditAction * @type Enums.GridStartEditAction * @default "click" * @prevFileNamespace DevExpress.ui * @public */ startEditAction?: 'click' | 'dblClick'; /** * @docid GridBaseOptions.editing.texts * @type object * @prevFileNamespace DevExpress.ui * @public */ texts?: GridBaseEditingTexts; /** * @docid GridBaseOptions.editing.useIcons * @type boolean * @default true [for](Material) * @default false * @prevFileNamespace DevExpress.ui * @public */ useIcons?: boolean; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseEditingTexts { /** * @docid GridBaseOptions.editing.texts.addRow * @type string * @default "Add a row" * @prevFileNamespace DevExpress.ui * @public */ addRow?: string; /** * @docid GridBaseOptions.editing.texts.cancelAllChanges * @type string * @default "Discard changes" * @prevFileNamespace DevExpress.ui * @public */ cancelAllChanges?: string; /** * @docid GridBaseOptions.editing.texts.cancelRowChanges * @type string * @default "Cancel" * @prevFileNamespace DevExpress.ui * @public */ cancelRowChanges?: string; /** * @docid GridBaseOptions.editing.texts.confirmDeleteMessage * @type string * @default "Are you sure you want to delete this record?" * @prevFileNamespace DevExpress.ui * @public */ confirmDeleteMessage?: string; /** * @docid GridBaseOptions.editing.texts.confirmDeleteTitle * @type string * @default "" * @prevFileNamespace DevExpress.ui * @public */ confirmDeleteTitle?: string; /** * @docid GridBaseOptions.editing.texts.deleteRow * @type string * @default "Delete" * @prevFileNamespace DevExpress.ui * @public */ deleteRow?: string; /** * @docid GridBaseOptions.editing.texts.editRow * @type string * @default "Edit" * @prevFileNamespace DevExpress.ui * @public */ editRow?: string; /** * @docid GridBaseOptions.editing.texts.saveAllChanges * @type string * @default "Save changes" * @prevFileNamespace DevExpress.ui * @public */ saveAllChanges?: string; /** * @docid GridBaseOptions.editing.texts.saveRowChanges * @type string * @default "Save" * @prevFileNamespace DevExpress.ui * @public */ saveRowChanges?: string; /** * @docid GridBaseOptions.editing.texts.undeleteRow * @type string * @default "Undelete" * @prevFileNamespace DevExpress.ui * @public */ undeleteRow?: string; /** * @docid GridBaseOptions.editing.texts.validationCancelChanges * @type string * @default "Cancel changes" * @prevFileNamespace DevExpress.ui * @public */ validationCancelChanges?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBasePaging { /** * @docid GridBaseOptions.paging.enabled * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ enabled?: boolean; /** * @docid GridBaseOptions.paging.pageIndex * @type number * @default 0 * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ pageIndex?: number; /** * @docid GridBaseOptions.paging.pageSize * @type number * @default 20 * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ pageSize?: number; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseScrolling { /** * @docid GridBaseOptions.scrolling.columnRenderingMode * @type Enums.GridColumnRenderingMode * @default "standard" * @prevFileNamespace DevExpress.ui * @public */ columnRenderingMode?: 'standard' | 'virtual'; /** * @docid GridBaseOptions.scrolling.preloadEnabled * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ preloadEnabled?: boolean; /** * @docid GridBaseOptions.scrolling.rowRenderingMode * @type Enums.GridRowRenderingMode * @default "standard" * @prevFileNamespace DevExpress.ui * @public */ rowRenderingMode?: 'standard' | 'virtual'; /** * @docid GridBaseOptions.scrolling.scrollByContent * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ scrollByContent?: boolean; /** * @docid GridBaseOptions.scrolling.scrollByThumb * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ scrollByThumb?: boolean; /** * @docid GridBaseOptions.scrolling.showScrollbar * @type Enums.ShowScrollbarMode * @default 'onScroll' * @prevFileNamespace DevExpress.ui * @public */ showScrollbar?: 'always' | 'never' | 'onHover' | 'onScroll'; /** * @docid GridBaseOptions.scrolling.useNative * @type boolean|Enums.Mode * @default "auto" * @prevFileNamespace DevExpress.ui * @public */ useNative?: boolean | 'auto'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseSelection { /** * @docid GridBaseOptions.selection.allowSelectAll * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowSelectAll?: boolean; /** * @docid GridBaseOptions.selection.mode * @type Enums.SelectionMode * @default "none" * @prevFileNamespace DevExpress.ui * @public */ mode?: 'multiple' | 'none' | 'single'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBase { /** * @docid GridBaseMethods.beginCustomLoading * @publicName beginCustomLoading(messageText) * @param1 messageText:string * @prevFileNamespace DevExpress.ui * @public */ beginCustomLoading(messageText: string): void; /** * @docid GridBaseMethods.byKey * @publicName byKey(key) * @param1 key:object|string|number * @return Promise * @prevFileNamespace DevExpress.ui * @public */ byKey(key: any | string | number): Promise & JQueryPromise; /** * @docid GridBaseMethods.cancelEditData * @publicName cancelEditData() * @prevFileNamespace DevExpress.ui * @public */ cancelEditData(): void; /** * @docid GridBaseMethods.cellValue * @publicName cellValue(rowIndex, dataField) * @param1 rowIndex:number * @param2 dataField:string * @return any * @prevFileNamespace DevExpress.ui * @public */ cellValue(rowIndex: number, dataField: string): any; /** * @docid GridBaseMethods.cellValue * @publicName cellValue(rowIndex, dataField, value) * @param1 rowIndex:number * @param2 dataField:string * @param3 value:any * @prevFileNamespace DevExpress.ui * @public */ cellValue(rowIndex: number, dataField: string, value: any): void; /** * @docid GridBaseMethods.cellValue * @publicName cellValue(rowIndex, visibleColumnIndex) * @param1 rowIndex:number * @param2 visibleColumnIndex:number * @return any * @prevFileNamespace DevExpress.ui * @public */ cellValue(rowIndex: number, visibleColumnIndex: number): any; /** * @docid GridBaseMethods.cellValue * @publicName cellValue(rowIndex, visibleColumnIndex, value) * @param1 rowIndex:number * @param2 visibleColumnIndex:number * @param3 value:any * @prevFileNamespace DevExpress.ui * @public */ cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; /** * @docid GridBaseMethods.clearFilter * @publicName clearFilter() * @prevFileNamespace DevExpress.ui * @public */ clearFilter(): void; /** * @docid GridBaseMethods.clearFilter * @publicName clearFilter(filterName) * @param1 filterName:string * @prevFileNamespace DevExpress.ui * @public */ clearFilter(filterName: string): void; /** * @docid GridBaseMethods.clearSelection * @publicName clearSelection() * @prevFileNamespace DevExpress.ui * @public */ clearSelection(): void; /** * @docid GridBaseMethods.clearSorting * @publicName clearSorting() * @prevFileNamespace DevExpress.ui * @public */ clearSorting(): void; /** * @docid GridBaseMethods.closeEditCell * @publicName closeEditCell() * @prevFileNamespace DevExpress.ui * @public */ closeEditCell(): void; /** * @docid GridBaseMethods.collapseAdaptiveDetailRow * @publicName collapseAdaptiveDetailRow() * @prevFileNamespace DevExpress.ui * @public */ collapseAdaptiveDetailRow(): void; /** * @docid GridBaseMethods.columnCount * @publicName columnCount() * @return number * @prevFileNamespace DevExpress.ui * @public */ columnCount(): number; /** * @docid GridBaseMethods.columnOption * @publicName columnOption(id) * @param1 id:number|string * @return object * @prevFileNamespace DevExpress.ui * @public */ columnOption(id: number | string): any; /** * @docid GridBaseMethods.columnOption * @publicName columnOption(id, optionName) * @param1 id:number|string * @param2 optionName:string * @return any * @prevFileNamespace DevExpress.ui * @public */ columnOption(id: number | string, optionName: string): any; /** * @docid GridBaseMethods.columnOption * @publicName columnOption(id, optionName, optionValue) * @param1 id:number|string * @param2 optionName:string * @param3 optionValue:any * @prevFileNamespace DevExpress.ui * @public */ columnOption(id: number | string, optionName: string, optionValue: any): void; /** * @docid GridBaseMethods.columnOption * @publicName columnOption(id, options) * @param1 id:number|string * @param2 options:object * @prevFileNamespace DevExpress.ui * @public */ columnOption(id: number | string, options: any): void; /** * @docid GridBaseMethods.deleteColumn * @publicName deleteColumn(id) * @param1 id:number|string * @prevFileNamespace DevExpress.ui * @public */ deleteColumn(id: number | string): void; /** * @docid GridBaseMethods.deleteRow * @publicName deleteRow(rowIndex) * @param1 rowIndex:number * @prevFileNamespace DevExpress.ui * @public */ deleteRow(rowIndex: number): void; /** * @docid GridBaseMethods.deselectAll * @publicName deselectAll() * @return Promise * @prevFileNamespace DevExpress.ui * @public */ deselectAll(): Promise & JQueryPromise; /** * @docid GridBaseMethods.deselectRows * @publicName deselectRows(keys) * @param1 keys:Array * @return Promise * @prevFileNamespace DevExpress.ui * @public */ deselectRows(keys: Array): Promise & JQueryPromise; /** * @docid GridBaseMethods.editCell * @publicName editCell(rowIndex, dataField) * @param1 rowIndex:number * @param2 dataField:string * @prevFileNamespace DevExpress.ui * @public */ editCell(rowIndex: number, dataField: string): void; /** * @docid GridBaseMethods.editCell * @publicName editCell(rowIndex, visibleColumnIndex) * @param1 rowIndex:number * @param2 visibleColumnIndex:number * @prevFileNamespace DevExpress.ui * @public */ editCell(rowIndex: number, visibleColumnIndex: number): void; /** * @docid GridBaseMethods.editRow * @publicName editRow(rowIndex) * @param1 rowIndex:number * @prevFileNamespace DevExpress.ui * @public */ editRow(rowIndex: number): void; /** * @docid GridBaseMethods.endCustomLoading * @publicName endCustomLoading() * @prevFileNamespace DevExpress.ui * @public */ endCustomLoading(): void; /** * @docid GridBaseMethods.expandAdaptiveDetailRow * @publicName expandAdaptiveDetailRow(key) * @param1 key:any * @prevFileNamespace DevExpress.ui * @public */ expandAdaptiveDetailRow(key: any): void; /** * @docid GridBaseMethods.filter * @publicName filter() * @return any * @prevFileNamespace DevExpress.ui * @public */ filter(): any; /** * @docid GridBaseMethods.filter * @publicName filter(filterExpr) * @param1 filterExpr:any * @prevFileNamespace DevExpress.ui * @public */ filter(filterExpr: any): void; focus(): void; /** * @docid GridBaseMethods.focus * @publicName focus(element) * @param1 element:Node|jQuery * @prevFileNamespace DevExpress.ui * @public */ focus(element: Element | JQuery): void; /** * @docid GridBaseMethods.getCellElement * @publicName getCellElement(rowIndex, dataField) * @param1 rowIndex:number * @param2 dataField:string * @return dxElement|undefined * @prevFileNamespace DevExpress.ui * @public */ getCellElement(rowIndex: number, dataField: string): dxElement | undefined; /** * @docid GridBaseMethods.getCellElement * @publicName getCellElement(rowIndex, visibleColumnIndex) * @param1 rowIndex:number * @param2 visibleColumnIndex:number * @return dxElement|undefined * @prevFileNamespace DevExpress.ui * @public */ getCellElement(rowIndex: number, visibleColumnIndex: number): dxElement | undefined; /** * @docid GridBaseMethods.getCombinedFilter * @publicName getCombinedFilter() * @return any * @prevFileNamespace DevExpress.ui * @public */ getCombinedFilter(): any; /** * @docid GridBaseMethods.getCombinedFilter * @publicName getCombinedFilter(returnDataField) * @param1 returnDataField:boolean * @return any * @prevFileNamespace DevExpress.ui * @public */ getCombinedFilter(returnDataField: boolean): any; getDataSource(): DataSource; /** * @docid GridBaseMethods.getKeyByRowIndex * @publicName getKeyByRowIndex(rowIndex) * @param1 rowIndex:numeric * @return any * @prevFileNamespace DevExpress.ui * @public */ getKeyByRowIndex(rowIndex: number): any; /** * @docid GridBaseMethods.getRowElement * @publicName getRowElement(rowIndex) * @param1 rowIndex:number * @return Array|jQuery|undefined * @prevFileNamespace DevExpress.ui * @public */ getRowElement(rowIndex: number): Array & JQuery | undefined; /** * @docid GridBaseMethods.getRowIndexByKey * @publicName getRowIndexByKey(key) * @param1 key:object|string|number * @return numeric * @prevFileNamespace DevExpress.ui * @public */ getRowIndexByKey(key: any | string | number): number; /** * @docid GridBaseMethods.getScrollable * @publicName getScrollable() * @return dxScrollable * @prevFileNamespace DevExpress.ui * @public */ getScrollable(): dxScrollable; /** * @docid GridBaseMethods.getVisibleColumnIndex * @publicName getVisibleColumnIndex(id) * @param1 id:number|string * @return number * @prevFileNamespace DevExpress.ui * @public */ getVisibleColumnIndex(id: number | string): number; /** * @docid GridBaseMethods.hasEditData * @publicName hasEditData() * @return boolean * @prevFileNamespace DevExpress.ui * @public */ hasEditData(): boolean; /** * @docid GridBaseMethods.hideColumnChooser * @publicName hideColumnChooser() * @prevFileNamespace DevExpress.ui * @public */ hideColumnChooser(): void; /** * @docid GridBaseMethods.isAdaptiveDetailRowExpanded * @publicName isAdaptiveDetailRowExpanded(key) * @param1 key:any * @return boolean * @prevFileNamespace DevExpress.ui * @public */ isAdaptiveDetailRowExpanded(key: any): boolean; /** * @docid GridBaseMethods.isRowFocused * @publicName isRowFocused(key) * @param1 key:any * @return boolean * @prevFileNamespace DevExpress.ui * @public */ isRowFocused(key: any): boolean; /** * @docid GridBaseMethods.isRowSelected(key) * @publicName isRowSelected(key) * @param1 key:any * @return boolean * @prevFileNamespace DevExpress.ui * @public */ isRowSelected(key: any): boolean; /** * @docid GridBaseMethods.keyOf * @publicName keyOf(obj) * @param1 obj:object * @return any * @prevFileNamespace DevExpress.ui * @public */ keyOf(obj: any): any; /** * @docid GridBaseMethods.navigateToRow * @publicName navigateToRow(key) * @param1 key:any * @prevFileNamespace DevExpress.ui * @public */ navigateToRow(key: any): void; /** * @docid GridBaseMethods.pageCount * @publicName pageCount() * @return numeric * @prevFileNamespace DevExpress.ui * @public */ pageCount(): number; /** * @docid GridBaseMethods.pageIndex * @publicName pageIndex() * @return numeric * @prevFileNamespace DevExpress.ui * @public */ pageIndex(): number; /** * @docid GridBaseMethods.pageIndex * @publicName pageIndex(newIndex) * @param1 newIndex:numeric * @return Promise * @prevFileNamespace DevExpress.ui * @public */ pageIndex(newIndex: number): Promise & JQueryPromise; /** * @docid GridBaseMethods.pageSize * @publicName pageSize() * @return numeric * @prevFileNamespace DevExpress.ui * @public */ pageSize(): number; /** * @docid GridBaseMethods.pageSize * @publicName pageSize(value) * @param1 value:numeric * @prevFileNamespace DevExpress.ui * @public */ pageSize(value: number): void; /** * @docid GridBaseMethods.refresh * @publicName refresh() * @return Promise * @prevFileNamespace DevExpress.ui * @public */ refresh(): Promise & JQueryPromise; /** * @docid GridBaseMethods.refresh * @publicName refresh(changesOnly) * @param1 changesOnly:boolean * @return Promise * @prevFileNamespace DevExpress.ui * @public */ refresh(changesOnly: boolean): Promise & JQueryPromise; /** * @docid GridBaseMethods.repaintRows * @publicName repaintRows(rowIndexes) * @param1 rowIndexes:Array * @prevFileNamespace DevExpress.ui * @public */ repaintRows(rowIndexes: Array): void; /** * @docid GridBaseMethods.saveEditData * @publicName saveEditData() * @return Promise * @prevFileNamespace DevExpress.ui * @public */ saveEditData(): Promise & JQueryPromise; /** * @docid GridBaseMethods.searchByText * @publicName searchByText(text) * @param1 text:string * @prevFileNamespace DevExpress.ui * @public */ searchByText(text: string): void; /** * @docid GridBaseMethods.selectAll * @publicName selectAll() * @return Promise * @prevFileNamespace DevExpress.ui * @public */ selectAll(): Promise & JQueryPromise; /** * @docid GridBaseMethods.selectRows * @publicName selectRows(keys, preserve) * @param1 keys:Array * @param2 preserve:boolean * @return Promise * @prevFileNamespace DevExpress.ui * @public */ selectRows(keys: Array, preserve: boolean): Promise & JQueryPromise; /** * @docid GridBaseMethods.selectRowsByIndexes * @publicName selectRowsByIndexes(indexes) * @param1 indexes:Array * @return Promise * @prevFileNamespace DevExpress.ui * @public */ selectRowsByIndexes(indexes: Array): Promise & JQueryPromise; /** * @docid GridBaseMethods.showColumnChooser * @publicName showColumnChooser() * @prevFileNamespace DevExpress.ui * @public */ showColumnChooser(): void; /** * @docid GridBaseMethods.state * @publicName state() * @return object * @prevFileNamespace DevExpress.ui * @public */ state(): any; /** * @docid GridBaseMethods.state * @publicName state(state) * @param1 state:object * @prevFileNamespace DevExpress.ui * @public */ state(state: any): void; /** * @docid GridBaseMethods.undeleteRow * @publicName undeleteRow(rowIndex) * @param1 rowIndex:number * @prevFileNamespace DevExpress.ui * @public */ undeleteRow(rowIndex: number): void; /** * @docid GridBaseMethods.updateDimensions * @publicName updateDimensions() * @prevFileNamespace DevExpress.ui * @public */ updateDimensions(): void; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseColumn { /** * @docid GridBaseColumn.alignment * @type Enums.HorizontalAlignment * @default undefined * @acceptValues undefined * @prevFileNamespace DevExpress.ui * @public */ alignment?: 'center' | 'left' | 'right' | undefined; /** * @docid GridBaseColumn.allowEditing * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowEditing?: boolean; /** * @docid GridBaseColumn.allowFiltering * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowFiltering?: boolean; /** * @docid GridBaseColumn.allowFixing * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowFixing?: boolean; /** * @docid GridBaseColumn.allowHeaderFiltering * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowHeaderFiltering?: boolean; /** * @docid GridBaseColumn.allowHiding * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowHiding?: boolean; /** * @docid GridBaseColumn.allowReordering * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowReordering?: boolean; /** * @docid GridBaseColumn.allowResizing * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowResizing?: boolean; /** * @docid GridBaseColumn.allowSearch * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowSearch?: boolean; /** * @docid GridBaseColumn.allowSorting * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowSorting?: boolean; /** * @docid GridBaseColumn.calculateCellValue * @type function(rowData) * @type_function_param1 rowData:object * @type_function_return any * @prevFileNamespace DevExpress.ui * @public */ calculateCellValue?: ((rowData: any) => any); /** * @docid GridBaseColumn.calculateDisplayValue * @type string|function(rowData) * @type_function_param1 rowData:object * @type_function_return any * @prevFileNamespace DevExpress.ui * @public */ calculateDisplayValue?: string | ((rowData: any) => any); /** * @docid GridBaseColumn.calculateFilterExpression * @type function(filterValue, selectedFilterOperation, target) * @type_function_param1 filterValue:any * @type_function_param2 selectedFilterOperation:string * @type_function_param3 target:string * @type_function_return Filter expression * @prevFileNamespace DevExpress.ui * @public */ calculateFilterExpression?: ((filterValue: any, selectedFilterOperation: string, target: string) => string | Array | Function); /** * @docid GridBaseColumn.calculateSortValue * @type string|function(rowData) * @type_function_param1 rowData:object * @type_function_return any * @prevFileNamespace DevExpress.ui * @public */ calculateSortValue?: string | ((rowData: any) => any); /** * @docid GridBaseColumn.caption * @type string * @default undefined * @prevFileNamespace DevExpress.ui * @public */ caption?: string; /** * @docid GridBaseColumn.cssClass * @type string * @default undefined * @prevFileNamespace DevExpress.ui * @public */ cssClass?: string; /** * @docid GridBaseColumn.customizeText * @type function(cellInfo) * @type_function_param1 cellInfo:object * @type_function_param1_field1 value:string|number|date * @type_function_param1_field2 valueText:string * @type_function_param1_field3 target:string * @type_function_param1_field4 groupInterval:string|number * @type_function_return string * @prevFileNamespace DevExpress.ui * @public */ customizeText?: ((cellInfo: { value?: string | number | Date, valueText?: string, target?: string, groupInterval?: string | number }) => string); /** * @docid GridBaseColumn.dataField * @type string * @default undefined * @prevFileNamespace DevExpress.ui * @public */ dataField?: string; /** * @docid GridBaseColumn.dataType * @type Enums.GridColumnDataType * @default undefined * @prevFileNamespace DevExpress.ui * @public */ dataType?: 'string' | 'number' | 'date' | 'boolean' | 'object' | 'datetime'; /** * @docid GridBaseColumn.editorOptions * @type object * @prevFileNamespace DevExpress.ui * @public */ editorOptions?: any; /** * @docid GridBaseColumn.encodeHtml * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ encodeHtml?: boolean; /** * @docid GridBaseColumn.falseText * @type string * @default "false" * @prevFileNamespace DevExpress.ui * @public */ falseText?: string; /** * @docid GridBaseColumn.filterOperations * @type Array * @acceptValues "=" | "<>" | "<" | "<=" | ">" | ">=" | "notcontains" | "contains" | "startswith" | "endswith" | "between" * @default undefined * @prevFileNamespace DevExpress.ui * @public */ filterOperations?: Array<'=' | '<>' | '<' | '<=' | '>' | '>=' | 'notcontains' | 'contains' | 'startswith' | 'endswith' | 'between'>; /** * @docid GridBaseColumn.filterType * @type Enums.FilterType * @default "include" * @prevFileNamespace DevExpress.ui * @public */ filterType?: 'exclude' | 'include'; /** * @docid GridBaseColumn.filterValue * @type any * @default undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ filterValue?: any; /** * @docid GridBaseColumn.filterValues * @type Array * @default undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ filterValues?: Array; /** * @docid GridBaseColumn.fixed * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ fixed?: boolean; /** * @docid GridBaseColumn.fixedPosition * @type Enums.HorizontalEdge * @default undefined * @prevFileNamespace DevExpress.ui * @public */ fixedPosition?: 'left' | 'right'; /** * @docid GridBaseColumn.formItem * @type dxFormSimpleItem * @prevFileNamespace DevExpress.ui * @public */ formItem?: dxFormSimpleItem; /** * @docid GridBaseColumn.format * @type format * @default "" * @prevFileNamespace DevExpress.ui * @public */ format?: format; /** * @docid GridBaseColumn.headerFilter * @type object * @default undefined * @prevFileNamespace DevExpress.ui * @public */ headerFilter?: { allowSearch?: boolean, dataSource?: Array | ((options: { component?: any, dataSource?: DataSourceOptions }) => any) | DataSourceOptions, groupInterval?: 'day' | 'hour' | 'minute' | 'month' | 'quarter' | 'second' | 'year' | number, height?: number, searchMode?: 'contains' | 'startswith' | 'equals', width?: number }; /** * @docid GridBaseColumn.hidingPriority * @type number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ hidingPriority?: number; /** * @docid GridBaseColumn.isBand * @type boolean * @default undefined * @prevFileNamespace DevExpress.ui * @public */ isBand?: boolean; /** * @docid GridBaseColumn.lookup * @type object * @default undefined * @prevFileNamespace DevExpress.ui * @public */ lookup?: { allowClearing?: boolean, dataSource?: Array | DataSourceOptions | Store | ((options: { data?: any, key?: any }) => Array | DataSourceOptions | Store), displayExpr?: string | ((data: any) => string), valueExpr?: string }; /** * @docid GridBaseColumn.minWidth * @type number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ minWidth?: number; /** * @docid GridBaseColumn.name * @type string * @default undefined * @prevFileNamespace DevExpress.ui * @public */ name?: string; /** * @docid GridBaseColumn.ownerBand * @type number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ ownerBand?: number; /** * @docid GridBaseColumn.renderAsync * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ renderAsync?: boolean; /** * @docid GridBaseColumn.selectedFilterOperation * @type Enums.FilterOperations * @default undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ selectedFilterOperation?: '<' | '<=' | '<>' | '=' | '>' | '>=' | 'between' | 'contains' | 'endswith' | 'notcontains' | 'startswith'; /** * @docid GridBaseColumn.setCellValue * @type function(newData, value, currentRowData) * @type_function_param1 newData:object * @type_function_param2 value:any * @type_function_param3 currentRowData:object * @type_function_return void|Promise * @prevFileNamespace DevExpress.ui * @public */ setCellValue?: ((newData: any, value: any, currentRowData: any) => void | Promise | JQueryPromise); /** * @docid GridBaseColumn.showEditorAlways * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ showEditorAlways?: boolean; /** * @docid GridBaseColumn.showInColumnChooser * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ showInColumnChooser?: boolean; /** * @docid GridBaseColumn.sortIndex * @type number * @default undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ sortIndex?: number; /** * @docid GridBaseColumn.sortOrder * @type Enums.SortOrder * @default undefined * @acceptValues undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ sortOrder?: 'asc' | 'desc' | undefined; /** * @docid GridBaseColumn.sortingMethod * @type function(value1, value2) * @type_function_param1 value1:any * @type_function_param2 value2:any * @type_function_return number * @default undefined * @prevFileNamespace DevExpress.ui * @public */ sortingMethod?: ((value1: any, value2: any) => number); /** * @docid GridBaseColumn.trueText * @type string * @default "true" * @prevFileNamespace DevExpress.ui * @public */ trueText?: string; /** * @docid GridBaseColumn.validationRules * @type Array * @prevFileNamespace DevExpress.ui * @public */ validationRules?: Array; /** * @docid GridBaseColumn.visible * @type boolean * @default true * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ visible?: boolean; /** * @docid GridBaseColumn.visibleIndex * @type number * @default undefined * @fires GridBaseOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ visibleIndex?: number; /** * @docid GridBaseColumn.width * @type number|string * @default undefined * @prevFileNamespace DevExpress.ui * @public */ width?: number | string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface GridBaseColumnButton { /** * @docid GridBaseColumnButton.cssClass * @type string * @prevFileNamespace DevExpress.ui * @public */ cssClass?: string; /** * @docid GridBaseColumnButton.hint * @type string * @prevFileNamespace DevExpress.ui * @public */ hint?: string; /** * @docid GridBaseColumnButton.icon * @type string * @prevFileNamespace DevExpress.ui * @public */ icon?: string; /** * @docid GridBaseColumnButton.text * @type string * @prevFileNamespace DevExpress.ui * @public */ text?: string; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridOptions extends GridBaseOptions { /** * @docid dxDataGridOptions.columns * @type Array * @default undefined * @prevFileNamespace DevExpress.ui * @public */ columns?: Array; /** * @docid dxDataGridOptions.customizeColumns * @type function(columns) * @type_function_param1 columns:Array * @prevFileNamespace DevExpress.ui * @public */ customizeColumns?: ((columns: Array) => any); /** * @docid dxDataGridOptions.customizeExportData * @type function(columns, rows) * @type_function_param1 columns:Array * @type_function_param2 rows:Array * @prevFileNamespace DevExpress.ui * @public */ customizeExportData?: ((columns: Array, rows: Array) => any); /** * @docid dxDataGridOptions.editing * @type object * @prevFileNamespace DevExpress.ui * @public */ editing?: dxDataGridEditing; /** * @docid dxDataGridOptions.export * @type object * @prevFileNamespace DevExpress.ui * @public */ export?: { allowExportSelectedData?: boolean, customizeExcelCell?: ((options: { component?: dxDataGrid, horizontalAlignment?: 'center' | 'centerContinuous' | 'distributed' | 'fill' | 'general' | 'justify' | 'left' | 'right', verticalAlignment?: 'bottom' | 'center' | 'distributed' | 'justify' | 'top', wrapTextEnabled?: boolean, backgroundColor?: string, fillPatternType?: 'darkDown' | 'darkGray' | 'darkGrid' | 'darkHorizontal' | 'darkTrellis' | 'darkUp' | 'darkVertical' | 'gray0625' | 'gray125' | 'lightDown' | 'lightGray' | 'lightGrid' | 'lightHorizontal' | 'lightTrellis' | 'lightUp' | 'lightVertical' | 'mediumGray' | 'none' | 'solid', fillPatternColor?: string, font?: ExcelFont, value?: string | number | Date, numberFormat?: string, gridCell?: ExcelDataGridCell }) => any), enabled?: boolean, excelFilterEnabled?: boolean, excelWrapTextEnabled?: boolean, fileName?: string, ignoreExcelErrors?: boolean, proxyUrl?: string, texts?: { exportAll?: string, exportSelectedRows?: string, exportTo?: string } }; /** * @docid dxDataGridOptions.groupPanel * @type object * @prevFileNamespace DevExpress.ui * @public */ groupPanel?: { allowColumnDragging?: boolean, emptyPanelText?: string, visible?: boolean | 'auto' }; /** * @docid dxDataGridOptions.grouping * @type object * @prevFileNamespace DevExpress.ui * @public */ grouping?: { allowCollapsing?: boolean, autoExpandAll?: boolean, contextMenuEnabled?: boolean, expandMode?: 'buttonClick' | 'rowClick', texts?: { groupByThisColumn?: string, groupContinuedMessage?: string, groupContinuesMessage?: string, ungroup?: string, ungroupAll?: string } }; /** * @docid dxDataGridOptions.keyExpr * @type string|Array * @default undefined * @prevFileNamespace DevExpress.ui * @public */ keyExpr?: string | Array; /** * @docid dxDataGridOptions.masterDetail * @type object * @prevFileNamespace DevExpress.ui * @public */ masterDetail?: { autoExpandAll?: boolean, enabled?: boolean, template?: template | ((detailElement: dxElement, detailInfo: { key?: any, data?: any, watch?: Function }) => any) }; /** * @docid dxDataGridOptions.onCellClick * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 data:object * @type_function_param1_field7 key:any * @type_function_param1_field8 value:any * @type_function_param1_field9 displayValue:any * @type_function_param1_field10 text:string * @type_function_param1_field11 columnIndex:number * @type_function_param1_field12 column:object * @type_function_param1_field13 rowIndex:number * @type_function_param1_field14 rowType:string * @type_function_param1_field15 cellElement:dxElement * @type_function_param1_field16 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onCellClick?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, data?: any, key?: any, value?: any, displayValue?: any, text?: string, columnIndex?: number, column?: any, rowIndex?: number, rowType?: string, cellElement?: dxElement, row?: dxDataGridRowObject }) => any) | string; /** * @docid dxDataGridOptions.onCellDblClick * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 event:event * @type_function_param1_field5 data:object * @type_function_param1_field6 key:any * @type_function_param1_field7 value:any * @type_function_param1_field8 displayValue:any * @type_function_param1_field9 text:string * @type_function_param1_field10 columnIndex:number * @type_function_param1_field11 column:dxDataGridColumn * @type_function_param1_field12 rowIndex:number * @type_function_param1_field13 rowType:string * @type_function_param1_field14 cellElement:dxElement * @type_function_param1_field15 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onCellDblClick?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, event?: event, data?: any, key?: any, value?: any, displayValue?: any, text?: string, columnIndex?: number, column?: dxDataGridColumn, rowIndex?: number, rowType?: string, cellElement?: dxElement, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onCellHoverChanged * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 eventType:string * @type_function_param1_field5 data:object * @type_function_param1_field6 key:any * @type_function_param1_field7 value:any * @type_function_param1_field8 text:string * @type_function_param1_field9 displayValue:any * @type_function_param1_field10 columnIndex:number * @type_function_param1_field11 rowIndex:number * @type_function_param1_field12 column:dxDataGridColumn * @type_function_param1_field13 rowType:string * @type_function_param1_field14 cellElement:dxElement * @type_function_param1_field15 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onCellHoverChanged?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, eventType?: string, data?: any, key?: any, value?: any, text?: string, displayValue?: any, columnIndex?: number, rowIndex?: number, column?: dxDataGridColumn, rowType?: string, cellElement?: dxElement, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onCellPrepared * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 value:any * @type_function_param1_field7 displayValue:any * @type_function_param1_field8 text:string * @type_function_param1_field9 columnIndex:number * @type_function_param1_field10 column:dxDataGridColumn * @type_function_param1_field11 rowIndex:number * @type_function_param1_field12 rowType:string * @type_function_param1_field13 row:dxDataGridRowObject * @type_function_param1_field14 isSelected:boolean * @type_function_param1_field15 isExpanded:boolean * @type_function_param1_field16 isNewRow:boolean * @type_function_param1_field17 cellElement:dxElement * @type_function_param1_field18 watch:function * @type_function_param1_field19 oldValue:any * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onCellPrepared?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, data?: any, key?: any, value?: any, displayValue?: any, text?: string, columnIndex?: number, column?: dxDataGridColumn, rowIndex?: number, rowType?: string, row?: dxDataGridRowObject, isSelected?: boolean, isExpanded?: boolean, isNewRow?: boolean, cellElement?: dxElement, watch?: Function, oldValue?: any }) => any); /** * @docid dxDataGridOptions.onContextMenuPreparing * @type function(e) * @type_function_param1 e:Object * @type_function_param1_field4 items:Array * @type_function_param1_field5 target:string * @type_function_param1_field6 targetElement:dxElement * @type_function_param1_field7 columnIndex:number * @type_function_param1_field8 column:dxDataGridColumn * @type_function_param1_field9 rowIndex:number * @type_function_param1_field10 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onContextMenuPreparing?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, items?: Array, target?: string, targetElement?: dxElement, columnIndex?: number, column?: dxDataGridColumn, rowIndex?: number, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onEditingStart * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 cancel:boolean * @type_function_param1_field7 column:object * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onEditingStart?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, data?: any, key?: any, cancel?: boolean, column?: any }) => any); /** * @docid dxDataGridOptions.onEditorPrepared * @type function(options) * @type_function_param1 options:object * @type_function_param1_field4 parentType:string * @type_function_param1_field5 value:any * @type_function_param1_field6 setValue(newValue, newText):any * @type_function_param1_field7 updateValueTimeout:number * @type_function_param1_field8 width:number * @type_function_param1_field9 disabled:boolean * @type_function_param1_field10 rtlEnabled:boolean * @type_function_param1_field11 editorElement:dxElement * @type_function_param1_field12 readOnly:boolean * @type_function_param1_field13 dataField:string * @type_function_param1_field14 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onEditorPrepared?: ((options: { component?: dxDataGrid, element?: dxElement, model?: any, parentType?: string, value?: any, setValue?: any, updateValueTimeout?: number, width?: number, disabled?: boolean, rtlEnabled?: boolean, editorElement?: dxElement, readOnly?: boolean, dataField?: string, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onEditorPreparing * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 parentType:string * @type_function_param1_field5 value:any * @type_function_param1_field6 setValue(newValue, newText):any * @type_function_param1_field7 updateValueTimeout:number * @type_function_param1_field8 width:number * @type_function_param1_field9 disabled:boolean * @type_function_param1_field10 rtlEnabled:boolean * @type_function_param1_field11 cancel:boolean * @type_function_param1_field12 editorElement:dxElement * @type_function_param1_field13 readOnly:boolean * @type_function_param1_field14 editorName:string * @type_function_param1_field15 editorOptions:object * @type_function_param1_field16 dataField:string * @type_function_param1_field17 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onEditorPreparing?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, parentType?: string, value?: any, setValue?: any, updateValueTimeout?: number, width?: number, disabled?: boolean, rtlEnabled?: boolean, cancel?: boolean, editorElement?: dxElement, readOnly?: boolean, editorName?: string, editorOptions?: any, dataField?: string, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onExported * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onExported?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any }) => any); /** * @docid dxDataGridOptions.onExporting * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 fileName:string * @type_function_param1_field5 cancel:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onExporting?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, fileName?: string, cancel?: boolean }) => any); /** * @docid dxDataGridOptions.onFileSaving * @type function(e) * @type_function_param1 e:object * @type_function_param1_field3 fileName:string * @type_function_param1_field4 format:string * @type_function_param1_field5 data:BLOB * @type_function_param1_field6 cancel:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onFileSaving?: ((e: { component?: dxDataGrid, element?: dxElement, fileName?: string, format?: string, data?: Blob, cancel?: boolean }) => any); /** * @docid dxDataGridOptions.onFocusedCellChanged * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 cellElement:dxElement * @type_function_param1_field5 columnIndex:number * @type_function_param1_field6 rowIndex:number * @type_function_param1_field7 row:dxDataGridRowObject * @type_function_param1_field8 column:dxDataGridColumn * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onFocusedCellChanged?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, cellElement?: dxElement, columnIndex?: number, rowIndex?: number, row?: dxDataGridRowObject, column?: dxDataGridColumn }) => any); /** * @docid dxDataGridOptions.onFocusedCellChanging * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 cellElement:dxElement * @type_function_param1_field5 prevColumnIndex:number * @type_function_param1_field6 prevRowIndex:number * @type_function_param1_field7 newColumnIndex:number * @type_function_param1_field8 newRowIndex:number * @type_function_param1_field9 event:event * @type_function_param1_field10 rows:Array * @type_function_param1_field11 columns:Array * @type_function_param1_field12 cancel:boolean * @type_function_param1_field13 isHighlighted:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onFocusedCellChanging?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, cellElement?: dxElement, prevColumnIndex?: number, prevRowIndex?: number, newColumnIndex?: number, newRowIndex?: number, event?: event, rows?: Array, columns?: Array, cancel?: boolean, isHighlighted?: boolean }) => any); /** * @docid dxDataGridOptions.onFocusedRowChanged * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 rowElement:dxElement * @type_function_param1_field5 rowIndex:number * @type_function_param1_field6 row:dxDataGridRowObject * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onFocusedRowChanged?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, rowElement?: dxElement, rowIndex?: number, row?: dxDataGridRowObject }) => any); /** * @docid dxDataGridOptions.onFocusedRowChanging * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 rowElement:dxElement * @type_function_param1_field5 prevRowIndex:number * @type_function_param1_field6 newRowIndex:number * @type_function_param1_field7 event:event * @type_function_param1_field8 rows:Array * @type_function_param1_field9 cancel:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onFocusedRowChanging?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, rowElement?: dxElement, prevRowIndex?: number, newRowIndex?: number, event?: event, rows?: Array, cancel?: boolean }) => any); /** * @docid dxDataGridOptions.onRowClick * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field4 jQueryEvent:jQuery.Event:deprecated(event) * @type_function_param1_field5 event:event * @type_function_param1_field6 data:object * @type_function_param1_field7 key:any * @type_function_param1_field8 values:Array * @type_function_param1_field9 columns:Array * @type_function_param1_field10 rowIndex:number * @type_function_param1_field11 rowType:string * @type_function_param1_field12 isSelected:boolean * @type_function_param1_field13 isExpanded:boolean * @type_function_param1_field14 isNewRow:boolean * @type_function_param1_field15 groupIndex:number * @type_function_param1_field16 rowElement:dxElement * @type_function_param1_field17 handled:boolean * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowClick?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, jQueryEvent?: JQueryEventObject, event?: event, data?: any, key?: any, values?: Array, columns?: Array, rowIndex?: number, rowType?: string, isSelected?: boolean, isExpanded?: boolean, isNewRow?: boolean, groupIndex?: number, rowElement?: dxElement, handled?: boolean }) => any) | string; /** * @docid dxDataGridOptions.onRowDblClick * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 event:event * @type_function_param1_field5 data:object * @type_function_param1_field6 key:any * @type_function_param1_field7 values:Array * @type_function_param1_field8 columns:Array * @type_function_param1_field9 rowIndex:number * @type_function_param1_field10 rowType:string * @type_function_param1_field11 isSelected:boolean * @type_function_param1_field12 isExpanded:boolean * @type_function_param1_field13 isNewRow:boolean * @type_function_param1_field14 groupIndex:number * @type_function_param1_field15 rowElement:dxElement * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowDblClick?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, event?: event, data?: any, key?: any, values?: Array, columns?: Array, rowIndex?: number, rowType?: string, isSelected?: boolean, isExpanded?: boolean, isNewRow?: boolean, groupIndex?: number, rowElement?: dxElement }) => any); /** * @docid dxDataGridOptions.onRowPrepared * @type function(e) * @type_function_param1 e:object * @type_function_param1_field4 data:object * @type_function_param1_field5 key:any * @type_function_param1_field6 values:Array * @type_function_param1_field7 columns:Array * @type_function_param1_field8 rowIndex:number * @type_function_param1_field9 rowType:string * @type_function_param1_field10 groupIndex:number * @type_function_param1_field11 isSelected:boolean * @type_function_param1_field12 isExpanded:boolean * @type_function_param1_field13 isNewRow:boolean * @type_function_param1_field14 rowElement:dxElement * @extends Action * @action * @prevFileNamespace DevExpress.ui * @public */ onRowPrepared?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, data?: any, key?: any, values?: Array, columns?: Array, rowIndex?: number, rowType?: string, groupIndex?: number, isSelected?: boolean, isExpanded?: boolean, isNewRow?: boolean, rowElement?: dxElement }) => any); /** * @docid dxDataGridOptions.remoteOperations * @type boolean|object|Enums.Mode * @default "auto" * @prevFileNamespace DevExpress.ui * @public */ remoteOperations?: boolean | { filtering?: boolean, groupPaging?: boolean, grouping?: boolean, paging?: boolean, sorting?: boolean, summary?: boolean } | 'auto'; /** * @docid dxDataGridOptions.rowTemplate * @type template|function * @type_function_param1 rowElement:dxElement * @type_function_param2 rowInfo:object * @prevFileNamespace DevExpress.ui * @public */ rowTemplate?: template | ((rowElement: dxElement, rowInfo: any) => any); /** * @docid dxDataGridOptions.scrolling * @type object * @prevFileNamespace DevExpress.ui * @public */ scrolling?: dxDataGridScrolling; /** * @docid dxDataGridOptions.selection * @type object * @prevFileNamespace DevExpress.ui * @public */ selection?: dxDataGridSelection; /** * @docid dxDataGridOptions.selectionFilter * @type Filter expression * @default [] * @fires dxDataGridOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ selectionFilter?: string | Array | Function; /** * @docid dxDataGridOptions.sortByGroupSummaryInfo * @type Array * @default undefined * @prevFileNamespace DevExpress.ui * @public */ sortByGroupSummaryInfo?: Array<{ groupColumn?: string, sortOrder?: 'asc' | 'desc', summaryItem?: string | number }>; /** * @docid dxDataGridOptions.summary * @type object * @prevFileNamespace DevExpress.ui * @public */ summary?: { calculateCustomSummary?: ((options: { component?: dxDataGrid, name?: string, summaryProcess?: string, value?: any, totalValue?: any, groupIndex?: number }) => any), groupItems?: Array<{ alignByColumn?: boolean, column?: string, customizeText?: ((itemInfo: { value?: string | number | Date, valueText?: string }) => string), displayFormat?: string, name?: string, showInColumn?: string, showInGroupFooter?: boolean, skipEmptyValues?: boolean, summaryType?: 'avg' | 'count' | 'custom' | 'max' | 'min' | 'sum' | string, valueFormat?: format }>, recalculateWhileEditing?: boolean, skipEmptyValues?: boolean, texts?: { avg?: string, avgOtherColumn?: string, count?: string, max?: string, maxOtherColumn?: string, min?: string, minOtherColumn?: string, sum?: string, sumOtherColumn?: string }, totalItems?: Array<{ alignment?: 'center' | 'left' | 'right', column?: string, cssClass?: string, customizeText?: ((itemInfo: { value?: string | number | Date, valueText?: string }) => string), displayFormat?: string, name?: string, showInColumn?: string, skipEmptyValues?: boolean, summaryType?: 'avg' | 'count' | 'custom' | 'max' | 'min' | 'sum' | string, valueFormat?: format }> }; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridEditing extends GridBaseEditing { /** * @docid dxDataGridOptions.editing.allowAdding * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ allowAdding?: boolean; /** * @docid dxDataGridOptions.editing.allowDeleting * @type boolean|function * @default false * @type_function_param1 options:object * @type_function_param1_field1 component:dxDataGrid * @type_function_param1_field2 row:dxDataGridRowObject * @type_function_return Boolean * @prevFileNamespace DevExpress.ui * @public */ allowDeleting?: boolean | ((options: { component?: dxDataGrid, row?: dxDataGridRowObject }) => boolean); /** * @docid dxDataGridOptions.editing.allowUpdating * @type boolean|function * @default false * @type_function_param1 options:object * @type_function_param1_field1 component:dxDataGrid * @type_function_param1_field2 row:dxDataGridRowObject * @type_function_return Boolean * @prevFileNamespace DevExpress.ui * @public */ allowUpdating?: boolean | ((options: { component?: dxDataGrid, row?: dxDataGridRowObject }) => boolean); /** * @docid dxDataGridOptions.editing.texts * @type object * @prevFileNamespace DevExpress.ui * @public */ texts?: any; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridScrolling extends GridBaseScrolling { /** * @docid dxDataGridOptions.scrolling.mode * @type Enums.GridScrollingMode * @default "standard" * @prevFileNamespace DevExpress.ui * @public */ mode?: 'infinite' | 'standard' | 'virtual'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridSelection extends GridBaseSelection { /** * @docid dxDataGridOptions.selection.deferred * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ deferred?: boolean; /** * @docid dxDataGridOptions.selection.selectAllMode * @type Enums.SelectAllMode * @default "allPages" * @prevFileNamespace DevExpress.ui * @public */ selectAllMode?: 'allPages' | 'page'; /** * @docid dxDataGridOptions.selection.showCheckBoxesMode * @type Enums.GridSelectionShowCheckBoxesMode * @default "onClick" * @prevFileNamespace DevExpress.ui * @public */ showCheckBoxesMode?: 'always' | 'none' | 'onClick' | 'onLongTap'; } /** * @docid dxDataGrid * @inherits GridBase * @module ui/data_grid * @export default * @prevFileNamespace DevExpress.ui * @public */ declare class dxDataGrid extends Widget implements GridBase { constructor(element: Element, options?: dxDataGridOptions) constructor(element: JQuery, options?: dxDataGridOptions) /** * @docid dxDataGridMethods.addColumn * @publicName addColumn(columnOptions) * @param1 columnOptions:object|string * @prevFileNamespace DevExpress.ui * @public */ addColumn(columnOptions: any | string): void; /** * @docid dxDataGridMethods.addRow * @publicName addRow() * @prevFileNamespace DevExpress.ui * @public */ addRow(): void; /** * @docid dxDataGridMethods.clearGrouping * @publicName clearGrouping() * @prevFileNamespace DevExpress.ui * @public */ clearGrouping(): void; /** * @docid dxDataGridMethods.collapseAll * @publicName collapseAll(groupIndex) * @param1 groupIndex:number | undefined * @prevFileNamespace DevExpress.ui * @public */ collapseAll(groupIndex?: number): void; /** * @docid dxDataGridMethods.collapseRow * @publicName collapseRow(key) * @param1 key:any * @return Promise * @prevFileNamespace DevExpress.ui * @public */ collapseRow(key: any): Promise & JQueryPromise; /** * @docid dxDataGridMethods.expandAll * @publicName expandAll(groupIndex) * @param1 groupIndex:number | undefined * @prevFileNamespace DevExpress.ui * @public */ expandAll(groupIndex?: number): void; /** * @docid dxDataGridMethods.expandRow * @publicName expandRow(key) * @param1 key:any * @return Promise * @prevFileNamespace DevExpress.ui * @public */ expandRow(key: any): Promise & JQueryPromise; /** * @docid dxDataGridMethods.exportToExcel * @publicName exportToExcel(selectionOnly) * @param1 selectionOnly:boolean * @prevFileNamespace DevExpress.ui * @public */ exportToExcel(selectionOnly: boolean): void; /** * @docid dxDataGridMethods.getSelectedRowKeys * @publicName getSelectedRowKeys() * @return Array | Promise * @prevFileNamespace DevExpress.ui * @public */ getSelectedRowKeys(): Array & Promise & JQueryPromise; /** * @docid dxDataGridMethods.getSelectedRowsData * @publicName getSelectedRowsData() * @return Array | Promise * @prevFileNamespace DevExpress.ui * @public */ getSelectedRowsData(): Array & Promise & JQueryPromise; /** * @docid dxDataGridMethods.getTotalSummaryValue * @publicName getTotalSummaryValue(summaryItemName) * @param1 summaryItemName:String * @return any * @prevFileNamespace DevExpress.ui * @public */ getTotalSummaryValue(summaryItemName: string): any; /** * @docid dxDataGridMethods.getVisibleColumns * @publicName getVisibleColumns() * @return Array * @prevFileNamespace DevExpress.ui * @public */ getVisibleColumns(): Array; /** * @docid dxDataGridMethods.getVisibleColumns * @publicName getVisibleColumns(headerLevel) * @param1 headerLevel:number * @return Array * @prevFileNamespace DevExpress.ui * @public */ getVisibleColumns(headerLevel: number): Array; /** * @docid dxDataGridMethods.getVisibleRows * @publicName getVisibleRows() * @return Array * @prevFileNamespace DevExpress.ui * @public */ getVisibleRows(): Array; /** * @docid dxDataGridMethods.insertRow * @publicName insertRow() * @deprecated dxDataGridMethods.addRow * @prevFileNamespace DevExpress.ui * @public */ insertRow(): void; /** * @docid dxDataGridMethods.isRowExpanded * @publicName isRowExpanded(key) * @param1 key:any * @return boolean * @prevFileNamespace DevExpress.ui * @public */ isRowExpanded(key: any): boolean; /** * @docid dxDataGridMethods.isRowSelected(data) * @publicName isRowSelected(data) * @param1 data:any * @return boolean * @prevFileNamespace DevExpress.ui * @public */ isRowSelected(data: any): boolean; isRowSelected(key: any): boolean; /** * @docid dxDataGridMethods.removeRow * @publicName removeRow(rowIndex) * @param1 rowIndex:number * @deprecated GridBaseMethods.deleteRow * @prevFileNamespace DevExpress.ui * @public */ removeRow(rowIndex: number): void; /** * @docid dxDataGridMethods.totalCount * @publicName totalCount() * @return numeric * @prevFileNamespace DevExpress.ui * @public */ totalCount(): number; beginCustomLoading(messageText: string): void; byKey(key: any | string | number): Promise & JQueryPromise; cancelEditData(): void; cellValue(rowIndex: number, dataField: string): any; cellValue(rowIndex: number, dataField: string, value: any): void; cellValue(rowIndex: number, visibleColumnIndex: number): any; cellValue(rowIndex: number, visibleColumnIndex: number, value: any): void; clearFilter(): void; clearFilter(filterName: string): void; clearSelection(): void; clearSorting(): void; closeEditCell(): void; collapseAdaptiveDetailRow(): void; columnCount(): number; columnOption(id: number | string): any; columnOption(id: number | string, optionName: string): any; columnOption(id: number | string, optionName: string, optionValue: any): void; columnOption(id: number | string, options: any): void; deleteColumn(id: number | string): void; deleteRow(rowIndex: number): void; deselectAll(): Promise & JQueryPromise; deselectRows(keys: Array): Promise & JQueryPromise; editCell(rowIndex: number, dataField: string): void; editCell(rowIndex: number, visibleColumnIndex: number): void; editRow(rowIndex: number): void; endCustomLoading(): void; expandAdaptiveDetailRow(key: any): void; filter(): any; filter(filterExpr: any): void; focus(): void; focus(element: Element | JQuery): void; getCellElement(rowIndex: number, dataField: string): dxElement | undefined; getCellElement(rowIndex: number, visibleColumnIndex: number): dxElement | undefined; getCombinedFilter(): any; getCombinedFilter(returnDataField: boolean): any; getDataSource(): DataSource; getKeyByRowIndex(rowIndex: number): any; getRowElement(rowIndex: number): Array & JQuery | undefined; getRowIndexByKey(key: any | string | number): number; getScrollable(): dxScrollable; getVisibleColumnIndex(id: number | string): number; hasEditData(): boolean; hideColumnChooser(): void; isAdaptiveDetailRowExpanded(key: any): boolean; isRowFocused(key: any): boolean; isRowSelected(key: any): boolean; keyOf(obj: any): any; navigateToRow(key: any): void; pageCount(): number; pageIndex(): number; pageIndex(newIndex: number): Promise & JQueryPromise; pageSize(): number; pageSize(value: number): void; refresh(): Promise & JQueryPromise; refresh(changesOnly: boolean): Promise & JQueryPromise; repaintRows(rowIndexes: Array): void; saveEditData(): Promise & JQueryPromise; searchByText(text: string): void; selectAll(): Promise & JQueryPromise; selectRows(keys: Array, preserve: boolean): Promise & JQueryPromise; selectRowsByIndexes(indexes: Array): Promise & JQueryPromise; showColumnChooser(): void; state(): any; state(state: any): void; undeleteRow(rowIndex: number): void; updateDimensions(): void; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridColumn extends GridBaseColumn { /** * @docid dxDataGridColumn.allowExporting * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowExporting?: boolean; /** * @docid dxDataGridColumn.allowGrouping * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ allowGrouping?: boolean; /** * @docid dxDataGridColumn.autoExpandGroup * @type boolean * @default true * @prevFileNamespace DevExpress.ui * @public */ autoExpandGroup?: boolean; /** * @docid dxDataGridColumn.buttons * @type Array * @prevFileNamespace DevExpress.ui * @public */ buttons?: Array<'cancel' | 'delete' | 'edit' | 'save' | 'undelete' | dxDataGridColumnButton>; /** * @docid dxDataGridColumn.calculateGroupValue * @type string|function(rowData) * @type_function_param1 rowData:object * @type_function_return any * @prevFileNamespace DevExpress.ui * @public */ calculateGroupValue?: string | ((rowData: any) => any); /** * @docid dxDataGridColumn.cellTemplate * @type template|function * @type_function_param1 cellElement:dxElement * @type_function_param2 cellInfo:object * @type_function_param2_field1 data:object * @type_function_param2_field2 component:dxDataGrid * @type_function_param2_field3 value:any * @type_function_param2_field4 oldValue:any * @type_function_param2_field5 displayValue:any * @type_function_param2_field6 text:string * @type_function_param2_field7 columnIndex:number * @type_function_param2_field8 rowIndex:number * @type_function_param2_field9 column:dxDataGridColumn * @type_function_param2_field10 row:dxDataGridRowObject * @type_function_param2_field11 rowType:string * @type_function_param2_field12 watch:function * @prevFileNamespace DevExpress.ui * @public */ cellTemplate?: template | ((cellElement: dxElement, cellInfo: { data?: any, component?: dxDataGrid, value?: any, oldValue?: any, displayValue?: any, text?: string, columnIndex?: number, rowIndex?: number, column?: dxDataGridColumn, row?: dxDataGridRowObject, rowType?: string, watch?: Function }) => any); /** * @docid dxDataGridColumn.columns * @type Array * @default undefined * @prevFileNamespace DevExpress.ui * @public */ columns?: Array; /** * @docid dxDataGridColumn.editCellTemplate * @type template|function * @type_function_param1 cellElement:dxElement * @type_function_param2 cellInfo:object * @type_function_param2_field1 setValue(newValue, newText):any * @type_function_param2_field2 data:object * @type_function_param2_field3 component:dxDataGrid * @type_function_param2_field4 value:any * @type_function_param2_field5 displayValue:any * @type_function_param2_field6 text:string * @type_function_param2_field7 columnIndex:number * @type_function_param2_field8 rowIndex:number * @type_function_param2_field9 column:dxDataGridColumn * @type_function_param2_field10 row:dxDataGridRowObject * @type_function_param2_field11 rowType:string * @type_function_param2_field12 watch:function * @prevFileNamespace DevExpress.ui * @public */ editCellTemplate?: template | ((cellElement: dxElement, cellInfo: { setValue?: any, data?: any, component?: dxDataGrid, value?: any, displayValue?: any, text?: string, columnIndex?: number, rowIndex?: number, column?: dxDataGridColumn, row?: dxDataGridRowObject, rowType?: string, watch?: Function }) => any); /** * @docid dxDataGridColumn.groupCellTemplate * @type template|function * @type_function_param1 cellElement:dxElement * @type_function_param2 cellInfo:object * @type_function_param2_field1 data:object * @type_function_param2_field2 component:dxDataGrid * @type_function_param2_field3 value:any * @type_function_param2_field4 text:string * @type_function_param2_field5 displayValue:any * @type_function_param2_field6 columnIndex:number * @type_function_param2_field7 rowIndex:number * @type_function_param2_field8 column:dxDataGridColumn * @type_function_param2_field9 row:dxDataGridRowObject * @type_function_param2_field10 summaryItems:Array * @type_function_param2_field11 groupContinuesMessage:string * @type_function_param2_field12 groupContinuedMessage:string * @prevFileNamespace DevExpress.ui * @public */ groupCellTemplate?: template | ((cellElement: dxElement, cellInfo: { data?: any, component?: dxDataGrid, value?: any, text?: string, displayValue?: any, columnIndex?: number, rowIndex?: number, column?: dxDataGridColumn, row?: dxDataGridRowObject, summaryItems?: Array, groupContinuesMessage?: string, groupContinuedMessage?: string }) => any); /** * @docid dxDataGridColumn.groupIndex * @type number * @default undefined * @fires dxDataGridOptions.onOptionChanged * @prevFileNamespace DevExpress.ui * @public */ groupIndex?: number; /** * @docid dxDataGridColumn.headerCellTemplate * @type template|function * @type_function_param1 columnHeader:dxElement * @type_function_param2 headerInfo:object * @type_function_param2_field1 component:dxDataGrid * @type_function_param2_field2 columnIndex:number * @type_function_param2_field3 column:dxDataGridColumn * @prevFileNamespace DevExpress.ui * @public */ headerCellTemplate?: template | ((columnHeader: dxElement, headerInfo: { component?: dxDataGrid, columnIndex?: number, column?: dxDataGridColumn }) => any); /** * @docid dxDataGridColumn.showWhenGrouped * @type boolean * @default false * @prevFileNamespace DevExpress.ui * @public */ showWhenGrouped?: boolean; /** * @docid dxDataGridColumn.type * @publicName type * @type Enums.GridCommandColumnType * @prevFileNamespace DevExpress.ui * @public */ type?: 'adaptive' | 'buttons' | 'detailExpand' | 'groupExpand' | 'selection'; } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridColumnButton extends GridBaseColumnButton { /** * @docid dxDataGridColumnButton.name * @type Enums.GridColumnButtonName|string * @prevFileNamespace DevExpress.ui * @public */ name?: 'cancel' | 'delete' | 'edit' | 'save' | 'undelete' | string; /** * @docid dxDataGridColumnButton.onClick * @type function(e)|string * @type_function_param1 e:object * @type_function_param1_field1 component:dxDataGrid * @type_function_param1_field2 element:dxElement * @type_function_param1_field3 model:object * @type_function_param1_field4 event:event * @type_function_param1_field5 row:dxDataGridRowObject * @type_function_param1_field6 column:dxDataGridColumn * @prevFileNamespace DevExpress.ui * @public */ onClick?: ((e: { component?: dxDataGrid, element?: dxElement, model?: any, event?: event, row?: dxDataGridRowObject, column?: dxDataGridColumn }) => any) | string; /** * @docid dxDataGridColumnButton.template * @type template|function * @type_function_param1 cellElement:dxElement * @type_function_param2 cellInfo:object * @type_function_param2_field1 component:dxDataGrid * @type_function_param2_field2 data:object * @type_function_param2_field3 key:any * @type_function_param2_field4 columnIndex:number * @type_function_param2_field5 column:dxDataGridColumn * @type_function_param2_field6 rowIndex:number * @type_function_param2_field7 rowType:string * @type_function_param2_field8 row:dxDataGridRowObject * @type_function_return string|Node|jQuery * @prevFileNamespace DevExpress.ui * @public */ template?: template | ((cellElement: dxElement, cellInfo: { component?: dxDataGrid, data?: any, key?: any, columnIndex?: number, column?: dxDataGridColumn, rowIndex?: number, rowType?: string, row?: dxDataGridRowObject }) => string | Element | JQuery); /** * @docid dxDataGridColumnButton.visible * @type boolean|function * @default true * @type_function_param1 options:object * @type_function_param1_field1 component:dxDataGrid * @type_function_param1_field2 row:dxDataGridRowObject * @type_function_param1_field3 column:dxDataGridColumn * @type_function_return Boolean * @prevFileNamespace DevExpress.ui * @public */ visible?: boolean | ((options: { component?: dxDataGrid, row?: dxDataGridRowObject, column?: dxDataGridColumn }) => boolean); } /** Warning! This type is used for internal purposes. Do not import it directly. */ export interface dxDataGridRowObject { /** * @docid dxDataGridRowObject.data * @type object * @prevFileNamespace DevExpress.ui * @public */ data?: any; /** * @docid dxDataGridRowObject.groupIndex * @type number * @prevFileNamespace DevExpress.ui * @public */ groupIndex?: number; /** * @docid dxDataGridRowObject.isEditing * @type boolean * @prevFileNamespace DevExpress.ui * @public */ isEditing?: boolean; /** * @docid dxDataGridRowObject.isExpanded * @type boolean * @prevFileNamespace DevExpress.ui * @public */ isExpanded?: boolean; /** * @docid dxDataGridRowObject.isNewRow * @type boolean * @prevFileNamespace DevExpress.ui * @public */ isNewRow?: boolean; /** * @docid dxDataGridRowObject.isSelected * @type boolean * @prevFileNamespace DevExpress.ui * @public */ isSelected?: boolean; /** * @docid dxDataGridRowObject.key * @type any * @prevFileNamespace DevExpress.ui * @public */ key?: any; /** * @docid dxDataGridRowObject.rowIndex * @type number * @prevFileNamespace DevExpress.ui * @public */ rowIndex?: number; /** * @docid dxDataGridRowObject.rowType * @type string * @prevFileNamespace DevExpress.ui * @public */ rowType?: string; /** * @docid dxDataGridRowObject.values * @type Array * @prevFileNamespace DevExpress.ui * @public */ values?: Array; } declare global { interface JQuery { dxDataGrid(): JQuery; dxDataGrid(options: "instance"): dxDataGrid; dxDataGrid(options: string): any; dxDataGrid(options: string, ...params: any[]): any; dxDataGrid(options: dxDataGridOptions): JQuery; } } /** Warning! This type is used for internal purposes. Do not import it directly. */ export type Options = dxDataGridOptions; /** @deprecated use Options instead */ /** Warning! This type is used for internal purposes. Do not import it directly. */ export type IOptions = dxDataGridOptions; /** Warning! This type is used for internal purposes. Do not import it directly. */ export type Column = dxDataGridColumn; /** Warning! This type is used for internal purposes. Do not import it directly. */ export default dxDataGrid;