forked from DevExpress/DevExtreme
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdata_grid.d.ts
More file actions
2678 lines (2555 loc) · 77.7 KB
/
data_grid.d.ts
File metadata and controls
2678 lines (2555 loc) · 77.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { DataSource } from '../common/data';
import {
UserDefinedElement,
DxElement,
UserDefinedElementsArray,
} from '../core/element';
import {
DxPromise,
} from '../core/utils/deferred';
import {
template,
HorizontalAlignment,
Mode,
Scrollable,
SelectAllMode,
SortOrder,
ToolbarItemLocation,
} from '../common';
import {
Cancelable,
EventInfo,
NativeEventInfo,
InitializedEventInfo,
ChangedOptionInfo,
InteractionEvent,
} from '../events';
import {
dxToolbarItem,
} from './toolbar';
import Widget, {
} from './widget/ui.widget';
import {
Format,
} from '../localization';
import {
AdaptiveDetailRowPreparingInfo,
ColumnBase as ComponentColumnBase,
ColumnButtonBase as ComponentColumnButtonBase,
GridsContextMenuTarget,
EditingBase as ComponentEditingBase,
EditingTextsBase as ComponentEditingTextsBase,
DataChangeInfo,
DataErrorOccurredInfo,
DragDropInfo,
DragReorderInfo,
DragStartEventInfo,
FilterPanel as ComponentFilterPanel,
FilterPanelCustomizeTextArg as ComponentFilterPanelCustomizeTextArg,
GridBase,
GridBaseOptions,
GroupExpandMode,
KeyDownInfo,
NewRowInfo,
NewRowPosition,
PagingBase as ComponentPaging,
ReducedNativeEventInfo,
RowDragging as ComponentRowDragging,
RowDraggingEventInfo,
RowDraggingTemplateData,
RowInsertedInfo,
RowInsertingInfo,
RowKeyInfo,
RowRemovedInfo,
RowRemovingInfo,
RowUpdatedInfo,
RowUpdatingInfo,
RowValidatingInfo,
SavingInfo,
ScrollingBase as ComponentScrollingBase,
SelectionBase as ComponentSelectionBase,
SelectionChangedInfo,
SelectionColumnDisplayMode,
SummaryType,
ToolbarPreparingInfo,
AIColumnRequestCreatingInfo,
} from '../common/grids';
export {
DataType,
DragDirection,
Draggable,
DragHighlight,
HorizontalAlignment,
Mode,
Scrollable,
ScrollbarMode,
SearchMode,
SelectAllMode,
Sortable,
SortOrder,
ToolbarItemLocation,
} from '../common';
export {
ApplyFilterMode,
ColumnChooser,
ColumnChooserMode,
ColumnChooserSearchConfig,
ColumnChooserSelectionConfig,
ColumnCustomizeTextArg,
ColumnFixing,
ColumnFixingTexts,
ColumnHeaderFilter,
ColumnHeaderFilterSearchConfig,
ColumnLookup,
ColumnResizeMode,
GridsContextMenuTarget,
DataChange,
DataChangeType,
DataRenderMode,
EnterKeyAction,
EnterKeyDirection,
FilterOperation,
FilterPanelTexts,
FilterRow,
FilterRowOperationDescriptions,
FilterType,
FixedPosition,
GridsEditMode,
GridsEditRefreshMode,
GroupExpandMode,
HeaderFilter,
HeaderFilterSearchConfig,
HeaderFilterGroupInterval,
HeaderFilterTexts,
KeyboardNavigation,
LoadPanel,
NewRowPosition,
Pager,
RowDraggingTemplateData,
SearchPanel,
SelectedFilterOperation,
SelectionColumnDisplayMode,
Sorting,
StartEditAction,
StateStoreType,
StateStoring,
SummaryType,
} from '../common/grids';
export {
AdaptiveDetailRowPreparingInfo,
DataChangeInfo,
DataErrorOccurredInfo,
DragDropInfo,
DragReorderInfo,
DragStartEventInfo,
KeyDownInfo,
NewRowInfo,
RowDraggingEventInfo,
RowInsertedInfo,
RowInsertingInfo,
RowKeyInfo,
RowRemovedInfo,
RowRemovingInfo,
RowUpdatedInfo,
RowUpdatingInfo,
RowValidatingInfo,
SavingInfo,
SelectionChangedInfo,
ToolbarPreparingInfo,
} from '../common/grids';
/** @deprecated Use Column instead */
export type ColumnBase<TRowData = any> = ComponentColumnBase<TRowData>;
/** @deprecated Use ColumnButton instead */
export type ColumnButtonBase = ComponentColumnButtonBase;
/** @deprecated Use Editing instead */
export type EditingBase<TRowData = any, TKey = any> = ComponentEditingBase<TRowData, TKey>;
/** @deprecated Use EditingTexts instead */
export type EditingTextsBase = ComponentEditingTextsBase;
/** @deprecated Use Paging instead */
export type PagingBase = ComponentPaging;
/** @deprecated Use Scrolling instead */
export type ScrollingBase = ComponentScrollingBase;
/** @deprecated Use Selection instead */
export type SelectionBase = ComponentSelectionBase;
/** @public */
export type DataGridCommandColumnType = 'adaptive' | 'ai' | 'buttons' | 'detailExpand' | 'groupExpand' | 'selection' | 'drag';
/** @public */
export type DataGridExportFormat = 'pdf' | 'xlsx';
/** @public */
export type DataGridScrollMode = 'infinite' | 'standard' | 'virtual';
/** @public */
export type DataGridPredefinedColumnButton = 'cancel' | 'delete' | 'edit' | 'save' | 'undelete';
/** @public */
export type DataGridPredefinedToolbarItem = 'addRowButton' | 'applyFilterButton' | 'columnChooserButton' | 'exportButton' | 'groupPanel' | 'revertButton' | 'saveButton' | 'searchPanel';
type GroupKey = any[];
/**
* @docid
* @public
*/
export type GroupData<TRowData> = {
key: any;
items: Array<TRowData> | Array<GroupData<TRowData>> | null;
/** @deprecated Attention! This property is for internal purposes only. */
collapsedItems?: Array<TRowData> | Array<GroupData<TRowData>>;
/** @deprecated Attention! This property is for internal purposes only. */
aggregates?: Array<any>;
/** @deprecated Attention! This property is for internal purposes only. */
summary?: Array<any>;
/** @deprecated Attention! This property is for internal purposes only. */
isContinuation?: boolean;
/** @deprecated Attention! This property is for internal purposes only. */
isContinuationOnNextPage?: boolean;
};
/**
* @namespace DevExpress.ui
* @deprecated Use Editing instead
*/
export type GridBaseEditing<TRowData = any, TKey = any> = EditingBase<TRowData, TKey>;
/**
* @namespace DevExpress.ui
* @deprecated Use EditingTexts instead
*/
export type GridBaseEditingTexts = EditingTextsBase;
/**
* @namespace DevExpress.ui
* @deprecated Use Paging instead
*/
export type GridBasePaging = ComponentPaging;
/**
* @namespace DevExpress.ui
* @deprecated Use Scrolling instead
*/
export type GridBaseScrolling = ScrollingBase;
/**
* @namespace DevExpress.ui
* @deprecated Use Selection instead
*/
export type GridBaseSelection = SelectionBase;
/**
* @namespace DevExpress.ui
* @deprecated Use Column instead
*/
export type GridBaseColumn<TRowData = any> = ColumnBase<TRowData>;
/**
* @namespace DevExpress.ui
* @deprecated Use ColumnButton instead
*/
export type GridBaseColumnButton = ColumnButtonBase;
/**
* @docid _ui_data_grid_AdaptiveDetailRowPreparingEvent
* @public
* @type object
* @inherits EventInfo,AdaptiveDetailRowPreparingInfo
*/
export type AdaptiveDetailRowPreparingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & AdaptiveDetailRowPreparingInfo;
/**
* @docid _ui_data_grid_CellClickEvent
* @public
* @type object
* @inherits NativeEventInfo
*/
export type CellClickEvent<TRowData = any, TKey = any> = NativeEventInfo<dxDataGrid<TRowData, TKey>, PointerEvent | MouseEvent> & {
/**
* @docid _ui_data_grid_CellClickEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_CellClickEvent.key
* @type any
*/
readonly key: TKey;
/** @docid _ui_data_grid_CellClickEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_CellClickEvent.displayValue */
readonly displayValue?: any;
/** @docid _ui_data_grid_CellClickEvent.text */
readonly text: string;
/** @docid _ui_data_grid_CellClickEvent.columnIndex */
readonly columnIndex: number;
/**
* @docid _ui_data_grid_CellClickEvent.column
* @type object
*/
readonly column: Column<TRowData, TKey>;
/** @docid _ui_data_grid_CellClickEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_CellClickEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_CellClickEvent.cellElement */
readonly cellElement: DxElement;
/**
* @docid _ui_data_grid_CellClickEvent.row
* @type dxDataGridRowObject
*/
readonly row: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_CellDblClickEvent
* @public
* @type object
* @inherits NativeEventInfo
*/
export type CellDblClickEvent<TRowData = any, TKey = any> = NativeEventInfo<dxDataGrid<TRowData, TKey>, PointerEvent | MouseEvent> & {
/**
* @docid _ui_data_grid_CellDblClickEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_CellDblClickEvent.key
* @type any
*/
readonly key: TKey;
/** @docid _ui_data_grid_CellDblClickEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_CellDblClickEvent.displayValue */
readonly displayValue?: any;
/** @docid _ui_data_grid_CellDblClickEvent.text */
readonly text: string;
/** @docid _ui_data_grid_CellDblClickEvent.columnIndex */
readonly columnIndex: number;
/**
* @docid _ui_data_grid_CellDblClickEvent.column
* @type dxDataGridColumn
*/
readonly column: Column<TRowData, TKey>;
/** @docid _ui_data_grid_CellDblClickEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_CellDblClickEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_CellDblClickEvent.cellElement */
readonly cellElement: DxElement;
/**
* @docid _ui_data_grid_CellDblClickEvent.row
* @type dxDataGridRowObject
*/
readonly row: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_CellHoverChangedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type CellHoverChangedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_CellHoverChangedEvent.eventType */
readonly eventType: string;
/**
* @docid _ui_data_grid_CellHoverChangedEvent.data
* @type object
*/
readonly data: TRowData;
/** @docid _ui_data_grid_CellHoverChangedEvent.key */
readonly key: TKey;
/** @docid _ui_data_grid_CellHoverChangedEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_CellHoverChangedEvent.text */
readonly text: string;
/** @docid _ui_data_grid_CellHoverChangedEvent.displayValue */
readonly displayValue?: any;
/** @docid _ui_data_grid_CellHoverChangedEvent.columnIndex */
readonly columnIndex: number;
/** @docid _ui_data_grid_CellHoverChangedEvent.rowIndex */
readonly rowIndex: number;
/**
* @docid _ui_data_grid_CellHoverChangedEvent.column
* @type dxDataGridColumn
*/
readonly column: Column<TRowData, TKey>;
/** @docid _ui_data_grid_CellHoverChangedEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_CellHoverChangedEvent.cellElement */
readonly cellElement: DxElement;
/**
* @docid _ui_data_grid_CellHoverChangedEvent.row
* @type dxDataGridRowObject
*/
readonly row: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_CellPreparedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type CellPreparedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/**
* @docid _ui_data_grid_CellPreparedEvent.data
* @type object
*/
readonly data: TRowData;
/** @docid _ui_data_grid_CellPreparedEvent.key */
readonly key: TKey;
/** @docid _ui_data_grid_CellPreparedEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_CellPreparedEvent.displayValue */
readonly displayValue?: any;
/** @docid _ui_data_grid_CellPreparedEvent.text */
readonly text: string;
/** @docid _ui_data_grid_CellPreparedEvent.columnIndex */
readonly columnIndex: number;
/**
* @docid _ui_data_grid_CellPreparedEvent.column
* @type dxDataGridColumn
*/
readonly column: Column<TRowData, TKey>;
/** @docid _ui_data_grid_CellPreparedEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_CellPreparedEvent.rowType */
readonly rowType: string;
/**
* @docid _ui_data_grid_CellPreparedEvent.row
* @type dxDataGridRowObject
*/
readonly row: Row<TRowData, TKey>;
/** @docid _ui_data_grid_CellPreparedEvent.isSelected */
readonly isSelected?: boolean;
/** @docid _ui_data_grid_CellPreparedEvent.isExpanded */
readonly isExpanded?: boolean;
/** @docid _ui_data_grid_CellPreparedEvent.isNewRow */
readonly isNewRow?: boolean;
/** @docid _ui_data_grid_CellPreparedEvent.cellElement */
readonly cellElement: DxElement;
/** @docid _ui_data_grid_CellPreparedEvent.watch */
readonly watch?: Function;
/** @docid _ui_data_grid_CellPreparedEvent.oldValue */
readonly oldValue?: any;
};
/**
* @docid _ui_data_grid_ContentReadyEvent
* @public
* @type object
* @inherits EventInfo
*/
export type ContentReadyEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>>;
/**
* @docid _ui_data_grid_ContextMenuPreparingEvent
* @public
* @type object
* @inherits EventInfo
*/
export type ContextMenuPreparingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/**
* @docid _ui_data_grid_ContextMenuPreparingEvent.items
* @type Array<Object>
*/
items?: Array<any>;
/** @docid _ui_data_grid_ContextMenuPreparingEvent.target */
readonly target: GridsContextMenuTarget;
/** @docid _ui_data_grid_ContextMenuPreparingEvent.targetElement */
readonly targetElement: DxElement;
/** @docid _ui_data_grid_ContextMenuPreparingEvent.columnIndex */
readonly columnIndex: number;
/**
* @docid _ui_data_grid_ContextMenuPreparingEvent.column
* @type dxDataGridColumn
*/
readonly column?: Column<TRowData, TKey>;
/** @docid _ui_data_grid_ContextMenuPreparingEvent.rowIndex */
readonly rowIndex: number;
/**
* @docid _ui_data_grid_ContextMenuPreparingEvent.row
* @type dxDataGridRowObject
*/
readonly row?: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_DataErrorOccurredEvent
* @public
* @type object
* @inherits EventInfo,DataErrorOccurredInfo
*/
export type DataErrorOccurredEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & DataErrorOccurredInfo;
/**
* @docid _ui_data_grid_DisposingEvent
* @public
* @type object
* @inherits EventInfo
*/
export type DisposingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>>;
/**
* @docid _ui_data_grid_EditCanceledEvent
* @public
* @type object
* @inherits EventInfo,DataChangeInfo
*/
export type EditCanceledEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & DataChangeInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_EditCancelingEvent
* @public
* @type object
* @inherits Cancelable,EventInfo,DataChangeInfo
*/
export type EditCancelingEvent<TRowData = any, TKey = any> = Cancelable & EventInfo<dxDataGrid<TRowData, TKey>> & DataChangeInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_EditingStartEvent
* @public
* @type object
* @inherits Cancelable,EventInfo
*/
export type EditingStartEvent<TRowData = any, TKey = any> = Cancelable & EventInfo<dxDataGrid<TRowData, TKey>> & {
/**
* @docid _ui_data_grid_EditingStartEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_EditingStartEvent.key
* @type any
*/
readonly key: TKey;
/**
* @docid _ui_data_grid_EditingStartEvent.column
* @type object
*/
readonly column?: Column<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_EditorPreparedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type EditorPreparedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_EditorPreparedEvent.parentType */
readonly parentType: string;
/** @docid _ui_data_grid_EditorPreparedEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_EditorPreparedEvent.setValue */
readonly setValue?: any;
/** @docid _ui_data_grid_EditorPreparedEvent.updateValueTimeout */
updateValueTimeout?: number;
/** @docid _ui_data_grid_EditorPreparedEvent.width */
readonly width?: number;
/** @docid _ui_data_grid_EditorPreparedEvent.disabled */
readonly disabled: boolean;
/** @docid _ui_data_grid_EditorPreparedEvent.rtlEnabled */
readonly rtlEnabled: boolean;
/** @docid _ui_data_grid_EditorPreparedEvent.editorElement */
readonly editorElement: DxElement;
/** @docid _ui_data_grid_EditorPreparedEvent.readOnly */
readonly readOnly: boolean;
/** @docid _ui_data_grid_EditorPreparedEvent.dataField */
readonly dataField?: string;
/**
* @docid _ui_data_grid_EditorPreparedEvent.row
* @type dxDataGridRowObject
*/
readonly row?: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_EditorPreparingEvent
* @public
* @type object
* @inherits EventInfo
*/
export type EditorPreparingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_EditorPreparingEvent.parentType */
readonly parentType: string;
/** @docid _ui_data_grid_EditorPreparingEvent.value */
readonly value?: any;
/** @docid _ui_data_grid_EditorPreparingEvent.setValue */
readonly setValue?: any;
/** @docid _ui_data_grid_EditorPreparingEvent.updateValueTimeout */
updateValueTimeout?: number;
/** @docid _ui_data_grid_EditorPreparingEvent.width */
readonly width?: number;
/** @docid _ui_data_grid_EditorPreparingEvent.disabled */
readonly disabled: boolean;
/** @docid _ui_data_grid_EditorPreparingEvent.rtlEnabled */
readonly rtlEnabled: boolean;
/** @docid _ui_data_grid_EditorPreparingEvent.cancel */
cancel: boolean;
/** @docid _ui_data_grid_EditorPreparingEvent.editorElement */
readonly editorElement: DxElement;
/** @docid _ui_data_grid_EditorPreparingEvent.readOnly */
readonly readOnly: boolean;
/** @docid _ui_data_grid_EditorPreparingEvent.editorName */
editorName: string;
/**
* @docid _ui_data_grid_EditorPreparingEvent.editorOptions
* @type object
*/
editorOptions: any;
/** @docid _ui_data_grid_EditorPreparingEvent.dataField */
readonly dataField?: string;
/**
* @docid _ui_data_grid_EditorPreparingEvent.row
* @type dxDataGridRowObject
*/
readonly row?: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_ExportingEvent
* @public
* @type object
* @inherits Cancelable,EventInfo
*/
export type ExportingEvent<TRowData = any, TKey = any> = Cancelable & EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_ExportingEvent.fileName */
fileName?: string;
/** @docid _ui_data_grid_ExportingEvent.selectedRowsOnly */
selectedRowsOnly: boolean;
/**
* @docid _ui_data_grid_ExportingEvent.format
* @type Enums.DataGridExportFormat|string
*/
format: DataGridExportFormat | string;
};
/**
* @docid _ui_data_grid_FocusedCellChangedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type FocusedCellChangedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_FocusedCellChangedEvent.cellElement */
readonly cellElement: DxElement;
/** @docid _ui_data_grid_FocusedCellChangedEvent.columnIndex */
readonly columnIndex: number;
/** @docid _ui_data_grid_FocusedCellChangedEvent.rowIndex */
readonly rowIndex: number;
/**
* @docid _ui_data_grid_FocusedCellChangedEvent.row
* @type dxDataGridRowObject
*/
readonly row?: Row<TRowData, TKey>;
/**
* @docid _ui_data_grid_FocusedCellChangedEvent.column
* @type dxDataGridColumn
*/
readonly column?: Column<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_FocusedCellChangingEvent
* @public
* @type object
* @inherits Cancelable,NativeEventInfo
*/
export type FocusedCellChangingEvent<TRowData = any, TKey = any> = Cancelable & NativeEventInfo<dxDataGrid<TRowData, TKey>, InteractionEvent> & {
/** @docid _ui_data_grid_FocusedCellChangingEvent.cellElement */
readonly cellElement: DxElement;
/** @docid _ui_data_grid_FocusedCellChangingEvent.prevColumnIndex */
readonly prevColumnIndex: number;
/** @docid _ui_data_grid_FocusedCellChangingEvent.prevRowIndex */
readonly prevRowIndex: number;
/** @docid _ui_data_grid_FocusedCellChangingEvent.newColumnIndex */
newColumnIndex: number;
/** @docid _ui_data_grid_FocusedCellChangingEvent.newRowIndex */
newRowIndex: number;
/**
* @docid _ui_data_grid_FocusedCellChangingEvent.rows
* @type Array<dxDataGridRowObject>
*/
readonly rows: Array<Row<TRowData, TKey>>;
/**
* @docid _ui_data_grid_FocusedCellChangingEvent.columns
* @type Array<dxDataGridColumn>
*/
readonly columns: Array<Column<TRowData, TKey>>;
/** @docid _ui_data_grid_FocusedCellChangingEvent.isHighlighted */
isHighlighted: boolean;
};
/**
* @docid _ui_data_grid_FocusedRowChangedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type FocusedRowChangedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/** @docid _ui_data_grid_FocusedRowChangedEvent.rowElement */
readonly rowElement: DxElement;
/** @docid _ui_data_grid_FocusedRowChangedEvent.rowIndex */
readonly rowIndex: number;
/**
* @docid _ui_data_grid_FocusedRowChangedEvent.row
* @type dxDataGridRowObject
*/
readonly row?: Row<TRowData, TKey>;
};
/**
* @docid _ui_data_grid_FocusedRowChangingEvent
* @public
* @type object
* @inherits Cancelable,NativeEventInfo
*/
export type FocusedRowChangingEvent<TRowData = any, TKey = any> = Cancelable & NativeEventInfo<dxDataGrid<TRowData, TKey>, InteractionEvent> & {
/** @docid _ui_data_grid_FocusedRowChangingEvent.rowElement */
readonly rowElement: DxElement;
/** @docid _ui_data_grid_FocusedRowChangingEvent.prevRowIndex */
readonly prevRowIndex: number;
/** @docid _ui_data_grid_FocusedRowChangingEvent.newRowIndex */
newRowIndex: number;
/**
* @docid _ui_data_grid_FocusedRowChangingEvent.rows
* @type Array<dxDataGridRowObject>
*/
readonly rows: Array<Row<TRowData, TKey>>;
};
/**
* @docid _ui_data_grid_InitializedEvent
* @public
* @type object
* @inherits InitializedEventInfo
*/
export type InitializedEvent<TRowData = any, TKey = any> = InitializedEventInfo<dxDataGrid<TRowData, TKey>>;
/**
* @docid _ui_data_grid_InitNewRowEvent
* @public
* @type object
* @inherits EventInfo,NewRowInfo
*/
export type InitNewRowEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & NewRowInfo<TRowData>;
/**
* @docid _ui_data_grid_KeyDownEvent
* @public
* @type object
* @inherits NativeEventInfo,KeyDownInfo
*/
export type KeyDownEvent<TRowData = any, TKey = any> = NativeEventInfo<dxDataGrid<TRowData, TKey>, KeyboardEvent> & KeyDownInfo;
/**
* @docid _ui_data_grid_OptionChangedEvent
* @public
* @type object
* @inherits EventInfo,ChangedOptionInfo
*/
export type OptionChangedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & ChangedOptionInfo;
/**
* @docid _ui_data_grid_RowClickEvent
* @public
* @type object
* @inherits NativeEventInfo
*/
export type RowClickEvent<TRowData = any, TKey = any> = NativeEventInfo<dxDataGrid<TRowData, TKey>, PointerEvent | MouseEvent> & {
/**
* @docid _ui_data_grid_RowClickEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_RowClickEvent.key
* @type any
*/
readonly key: TKey;
/**
* @docid _ui_data_grid_RowClickEvent.values
* @type Array<any>
*/
readonly values: Array<any>;
/**
* @docid _ui_data_grid_RowClickEvent.columns
* @type Array<Object>
*/
readonly columns: Array<Column<TRowData, TKey>>;
/** @docid _ui_data_grid_RowClickEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_RowClickEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_RowClickEvent.isSelected */
readonly isSelected?: boolean;
/** @docid _ui_data_grid_RowClickEvent.isExpanded */
readonly isExpanded?: boolean;
/** @docid _ui_data_grid_RowClickEvent.isNewRow */
readonly isNewRow?: boolean;
/** @docid _ui_data_grid_RowClickEvent.groupIndex */
readonly groupIndex?: number;
/** @docid _ui_data_grid_RowClickEvent.rowElement */
readonly rowElement: DxElement;
/** @docid _ui_data_grid_RowClickEvent.handled */
readonly handled: boolean;
};
/**
* @docid _ui_data_grid_RowCollapsedEvent
* @public
* @type object
* @inherits EventInfo,RowKeyInfo
*/
export type RowCollapsedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowKeyInfo<TKey>;
/**
* @docid _ui_data_grid_RowCollapsingEvent
* @public
* @type object
* @inherits Cancelable,EventInfo,RowKeyInfo
*/
export type RowCollapsingEvent<TRowData = any, TKey = any> = Cancelable & EventInfo<dxDataGrid<TRowData, TKey>> & RowKeyInfo<TKey>;
/**
* @docid _ui_data_grid_RowDblClickEvent
* @public
* @type object
* @inherits NativeEventInfo
*/
export type RowDblClickEvent<TRowData = any, TKey = any> = NativeEventInfo<dxDataGrid<TRowData, TKey>, PointerEvent | MouseEvent> & {
/**
* @docid _ui_data_grid_RowDblClickEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_RowDblClickEvent.key
* @type any
*/
readonly key: TKey;
/**
* @docid _ui_data_grid_RowDblClickEvent.values
* @type Array<any>
*/
readonly values: Array<any>;
/**
* @docid _ui_data_grid_RowDblClickEvent.columns
* @type Array<dxDataGridColumn>
*/
readonly columns: Array<Column<TRowData, TKey>>;
/** @docid _ui_data_grid_RowDblClickEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_RowDblClickEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_RowDblClickEvent.isSelected */
readonly isSelected?: boolean;
/** @docid _ui_data_grid_RowDblClickEvent.isExpanded */
readonly isExpanded?: boolean;
/** @docid _ui_data_grid_RowDblClickEvent.isNewRow */
readonly isNewRow?: boolean;
/** @docid _ui_data_grid_RowDblClickEvent.groupIndex */
readonly groupIndex?: number;
/** @docid _ui_data_grid_RowDblClickEvent.rowElement */
readonly rowElement: DxElement;
};
/**
* @docid _ui_data_grid_RowExpandedEvent
* @public
* @type object
* @inherits EventInfo,RowKeyInfo
*/
export type RowExpandedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowKeyInfo<TKey>;
/**
* @docid _ui_data_grid_RowExpandingEvent
* @public
* @type object
* @inherits Cancelable,EventInfo,RowKeyInfo
*/
export type RowExpandingEvent<TRowData = any, TKey = any> = Cancelable & EventInfo<dxDataGrid<TRowData, TKey>> & RowKeyInfo<TKey>;
/**
* @docid _ui_data_grid_RowInsertedEvent
* @public
* @type object
* @inherits EventInfo,RowInsertedInfo
*/
export type RowInsertedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowInsertedInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_RowInsertingEvent
* @public
* @type object
* @inherits EventInfo,RowInsertingInfo
*/
export type RowInsertingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowInsertingInfo<TRowData>;
/**
* @docid _ui_data_grid_RowPreparedEvent
* @public
* @type object
* @inherits EventInfo
*/
export type RowPreparedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & {
/**
* @docid _ui_data_grid_RowPreparedEvent.data
* @type object
*/
readonly data: TRowData;
/**
* @docid _ui_data_grid_RowPreparedEvent.key
* @type any
*/
readonly key: TKey;
/**
* @docid _ui_data_grid_RowPreparedEvent.values
* @type Array<any>
*/
readonly values: Array<any>;
/**
* @docid _ui_data_grid_RowPreparedEvent.columns
* @type Array<dxDataGridColumn>
*/
readonly columns: Array<Column<TRowData, TKey>>;
/** @docid _ui_data_grid_RowPreparedEvent.rowIndex */
readonly rowIndex: number;
/** @docid _ui_data_grid_RowPreparedEvent.rowType */
readonly rowType: string;
/** @docid _ui_data_grid_RowPreparedEvent.groupIndex */
readonly groupIndex?: number;
/** @docid _ui_data_grid_RowPreparedEvent.isSelected */
readonly isSelected?: boolean;
/** @docid _ui_data_grid_RowPreparedEvent.isExpanded */
readonly isExpanded?: boolean;
/** @docid _ui_data_grid_RowPreparedEvent.isNewRow */
readonly isNewRow?: boolean;
/** @docid _ui_data_grid_RowPreparedEvent.rowElement */
readonly rowElement: DxElement;
};
/**
* @docid _ui_data_grid_RowRemovedEvent
* @public
* @type object
* @inherits EventInfo,RowRemovedInfo
*/
export type RowRemovedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowRemovedInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_RowRemovingEvent
* @public
* @type object
* @inherits EventInfo,RowRemovingInfo
*/
export type RowRemovingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowRemovingInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_RowUpdatedEvent
* @public
* @type object
* @inherits EventInfo,RowUpdatedInfo
*/
export type RowUpdatedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowUpdatedInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_RowUpdatingEvent
* @public
* @type object
* @inherits EventInfo,RowUpdatingInfo
*/
export type RowUpdatingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowUpdatingInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_RowValidatingEvent
* @public
* @type object
* @inherits EventInfo,RowValidatingInfo
*/
export type RowValidatingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & RowValidatingInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_SavedEvent
* @public
* @type object
* @inherits EventInfo,DataChangeInfo
*/
export type SavedEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & DataChangeInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_SavingEvent
* @public
* @type object
* @inherits EventInfo,SavingInfo
*/
export type SavingEvent<TRowData = any, TKey = any> = EventInfo<dxDataGrid<TRowData, TKey>> & SavingInfo<TRowData, TKey>;
/**
* @docid _ui_data_grid_SelectionChangedEvent