@syncfusion/ej2-grids 18.3.48 → 18.3.50-85492

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/CHANGELOG.md +1800 -1790
  2. package/README.md +81 -81
  3. package/dist/ej2-grids.umd.min.js +1 -10
  4. package/dist/ej2-grids.umd.min.js.map +1 -1
  5. package/dist/es6/ej2-grids.es2015.js +94 -80
  6. package/dist/es6/ej2-grids.es2015.js.map +1 -1
  7. package/dist/es6/ej2-grids.es5.js +649 -633
  8. package/dist/es6/ej2-grids.es5.js.map +1 -1
  9. package/helpers/e2e/index.js +3 -3
  10. package/license +10 -10
  11. package/package.json +81 -81
  12. package/src/grid/actions/batch-edit.js +2 -2
  13. package/src/grid/actions/dialog-edit.js +13 -13
  14. package/src/grid/actions/edit.js +4 -4
  15. package/src/grid/actions/excel-filter.js +13 -13
  16. package/src/grid/actions/foreign-key.js +13 -13
  17. package/src/grid/actions/inline-edit.js +13 -13
  18. package/src/grid/actions/normal-edit.js +2 -2
  19. package/src/grid/actions/print.js +4 -4
  20. package/src/grid/actions/resize.js +4 -1
  21. package/src/grid/actions/selection.js +15 -15
  22. package/src/grid/actions/toolbar.js +8 -8
  23. package/src/grid/base/grid-model.d.ts +1283 -1283
  24. package/src/grid/base/grid.d.ts +44 -44
  25. package/src/grid/base/grid.js +23 -23
  26. package/src/grid/base/interface.d.ts +1 -0
  27. package/src/grid/base/util.js +3 -3
  28. package/src/grid/common/excel-filter-base.js +13 -13
  29. package/src/grid/models/aggregate-model.d.ts +74 -74
  30. package/src/grid/models/aggregate.js +19 -19
  31. package/src/grid/models/column-chooser-settings-model.d.ts +8 -8
  32. package/src/grid/models/column-chooser-settings.js +19 -19
  33. package/src/grid/models/column-model.d.ts +11 -11
  34. package/src/grid/models/column.d.ts +2 -2
  35. package/src/grid/models/column.js +6 -6
  36. package/src/grid/models/page-settings-model.d.ts +36 -36
  37. package/src/grid/models/page-settings.js +19 -19
  38. package/src/grid/renderer/caption-cell-renderer.js +13 -13
  39. package/src/grid/renderer/command-column-renderer.js +13 -13
  40. package/src/grid/renderer/content-renderer.js +3 -0
  41. package/src/grid/renderer/detail-expand-cell-renderer.js +13 -13
  42. package/src/grid/renderer/detail-header-indent-renderer.js +13 -13
  43. package/src/grid/renderer/dropdown-edit-cell.js +2 -2
  44. package/src/grid/renderer/edit-renderer.js +2 -2
  45. package/src/grid/renderer/expand-cell-renderer.js +13 -13
  46. package/src/grid/renderer/filter-cell-renderer.js +13 -13
  47. package/src/grid/renderer/footer-renderer.js +13 -13
  48. package/src/grid/renderer/freeze-renderer.js +13 -13
  49. package/src/grid/renderer/group-lazy-load-renderer.js +13 -13
  50. package/src/grid/renderer/header-cell-renderer.js +13 -13
  51. package/src/grid/renderer/header-indent-renderer.js +13 -13
  52. package/src/grid/renderer/indent-cell-renderer.js +13 -13
  53. package/src/grid/renderer/row-drag-drop-renderer.js +13 -13
  54. package/src/grid/renderer/row-drag-header-indent-render.js +13 -13
  55. package/src/grid/renderer/stacked-cell-renderer.js +13 -13
  56. package/src/grid/renderer/summary-cell-renderer.js +13 -13
  57. package/src/grid/renderer/virtual-content-renderer.js +13 -13
  58. package/src/grid/renderer/virtual-freeze-renderer.js +13 -13
  59. package/src/grid/services/focus-strategy.d.ts +2 -1
  60. package/src/grid/services/focus-strategy.js +26 -16
  61. package/src/grid/services/group-model-generator.js +13 -13
  62. package/src/grid/services/summary-model-generator.js +13 -13
  63. package/src/pager/pager-dropdown.js +1 -1
  64. package/src/pager/pager-model.d.ts +59 -59
  65. package/src/pager/pager.js +19 -19
  66. package/styles/bootstrap-dark.css +0 -4
  67. package/styles/bootstrap.css +0 -4
  68. package/styles/bootstrap4.css +5 -4
  69. package/styles/bootstrap5-dark.css +0 -0
  70. package/styles/bootstrap5-dark.scss +0 -0
  71. package/styles/bootstrap5.css +0 -0
  72. package/styles/bootstrap5.scss +0 -0
  73. package/styles/excel-filter/_all.scss +2 -2
  74. package/styles/excel-filter/_bootstrap-dark-definition.scss +54 -54
  75. package/styles/excel-filter/_bootstrap-definition.scss +61 -61
  76. package/styles/excel-filter/_bootstrap4-definition.scss +70 -70
  77. package/styles/excel-filter/_fabric-dark-definition.scss +54 -54
  78. package/styles/excel-filter/_fabric-definition.scss +59 -59
  79. package/styles/excel-filter/_highcontrast-definition.scss +54 -54
  80. package/styles/excel-filter/_highcontrast-light-definition.scss +50 -50
  81. package/styles/excel-filter/_layout.scss +387 -387
  82. package/styles/excel-filter/_material-dark-definition.scss +56 -56
  83. package/styles/excel-filter/_material-definition.scss +57 -57
  84. package/styles/excel-filter/_office-365-definition.scss +1 -1
  85. package/styles/excel-filter/_theme.scss +18 -18
  86. package/styles/excel-filter/bootstrap-dark.css +0 -1
  87. package/styles/excel-filter/bootstrap.css +0 -1
  88. package/styles/excel-filter/bootstrap.scss +1 -0
  89. package/styles/excel-filter/bootstrap4.css +5 -1
  90. package/styles/excel-filter/fabric.scss +1 -0
  91. package/styles/excel-filter/highcontrast.scss +1 -0
  92. package/styles/excel-filter/icons/_bootstrap-dark.scss +29 -29
  93. package/styles/excel-filter/icons/_bootstrap.scss +29 -29
  94. package/styles/excel-filter/icons/_bootstrap4.scss +29 -29
  95. package/styles/excel-filter/icons/_fabric-dark.scss +29 -29
  96. package/styles/excel-filter/icons/_fabric.scss +29 -29
  97. package/styles/excel-filter/icons/_highcontrast-light.scss +29 -29
  98. package/styles/excel-filter/icons/_highcontrast.scss +29 -29
  99. package/styles/excel-filter/icons/_material-dark.scss +29 -29
  100. package/styles/excel-filter/icons/_material.scss +29 -29
  101. package/styles/excel-filter/material.scss +1 -0
  102. package/styles/fabric-dark.css +0 -3
  103. package/styles/fabric.css +0 -3
  104. package/styles/grid/_all.scss +2 -2
  105. package/styles/grid/_bootstrap-dark-definition.scss +497 -497
  106. package/styles/grid/_bootstrap-definition.scss +500 -500
  107. package/styles/grid/_bootstrap4-definition.scss +501 -502
  108. package/styles/grid/_fabric-dark-definition.scss +499 -499
  109. package/styles/grid/_fabric-definition.scss +499 -499
  110. package/styles/grid/_highcontrast-definition.scss +498 -498
  111. package/styles/grid/_highcontrast-light-definition.scss +495 -495
  112. package/styles/grid/_layout.scss +2908 -2908
  113. package/styles/grid/_material-dark-definition.scss +495 -495
  114. package/styles/grid/_material-definition.scss +495 -495
  115. package/styles/grid/_office-365-definition.scss +1 -1
  116. package/styles/grid/_theme.scss +529 -529
  117. package/styles/grid/bootstrap-dark.css +0 -4
  118. package/styles/grid/bootstrap.css +0 -4
  119. package/styles/grid/bootstrap.scss +1 -0
  120. package/styles/grid/bootstrap4.css +5 -4
  121. package/styles/grid/fabric-dark.css +0 -3
  122. package/styles/grid/fabric.css +0 -3
  123. package/styles/grid/fabric.scss +1 -0
  124. package/styles/grid/highcontrast-light.css +0 -3
  125. package/styles/grid/highcontrast.css +0 -3
  126. package/styles/grid/highcontrast.scss +1 -0
  127. package/styles/grid/icons/_bootstrap-dark.scss +180 -180
  128. package/styles/grid/icons/_bootstrap.scss +180 -180
  129. package/styles/grid/icons/_bootstrap4.scss +180 -180
  130. package/styles/grid/icons/_fabric-dark.scss +180 -180
  131. package/styles/grid/icons/_fabric.scss +180 -180
  132. package/styles/grid/icons/_highcontrast-light.scss +180 -180
  133. package/styles/grid/icons/_highcontrast.scss +181 -181
  134. package/styles/grid/icons/_material-dark.scss +180 -180
  135. package/styles/grid/icons/_material.scss +180 -180
  136. package/styles/grid/material-dark.css +0 -3
  137. package/styles/grid/material.css +0 -3
  138. package/styles/grid/material.scss +1 -0
  139. package/styles/highcontrast-light.css +0 -3
  140. package/styles/highcontrast.css +0 -3
  141. package/styles/material-dark.css +0 -3
  142. package/styles/material.css +0 -3
  143. package/styles/pager/_all.scss +2 -2
  144. package/styles/pager/_bootstrap-dark-definition.scss +112 -112
  145. package/styles/pager/_bootstrap-definition.scss +112 -112
  146. package/styles/pager/_bootstrap4-definition.scss +111 -112
  147. package/styles/pager/_fabric-dark-definition.scss +113 -113
  148. package/styles/pager/_fabric-definition.scss +112 -112
  149. package/styles/pager/_highcontrast-definition.scss +112 -112
  150. package/styles/pager/_highcontrast-light-definition.scss +112 -112
  151. package/styles/pager/_layout.scss +575 -575
  152. package/styles/pager/_material-dark-definition.scss +112 -112
  153. package/styles/pager/_material-definition.scss +111 -111
  154. package/styles/pager/_theme.scss +129 -129
  155. package/styles/pager/icons/_bootstrap-dark.scss +49 -49
  156. package/styles/pager/icons/_bootstrap.scss +49 -49
  157. package/styles/pager/icons/_bootstrap4.scss +49 -49
  158. package/styles/pager/icons/_fabric-dark.scss +49 -49
  159. package/styles/pager/icons/_fabric.scss +49 -49
  160. package/styles/pager/icons/_highcontrast-light.scss +49 -49
  161. package/styles/pager/icons/_highcontrast.scss +41 -41
  162. package/styles/pager/icons/_material-dark.scss +49 -49
  163. package/styles/pager/icons/_material.scss +41 -41
  164. package/styles/tailwind-dark.css +0 -0
  165. package/styles/tailwind-dark.scss +0 -0
  166. package/styles/tailwind.css +0 -0
  167. package/styles/tailwind.scss +0 -0
  168. package/dist/global/ej2-grids.min.js +0 -11
  169. package/dist/global/ej2-grids.min.js.map +0 -1
  170. package/dist/global/index.d.ts +0 -14
@@ -1,4 +1,4 @@
1
- import { Component, ModuleDeclaration, ChildProperty, Browser, closest, extend, TouchEventArgs } from '@syncfusion/ej2-base';import { isNullOrUndefined, setValue, getValue, isBlazor, blazorTemplates } from '@syncfusion/ej2-base';import { addClass, removeClass, append, remove, updateBlazorTemplate, classList, setStyleAttribute } from '@syncfusion/ej2-base';import { Property, Collection, Complex, Event, NotifyPropertyChanges, INotifyPropertyChanged, L10n } from '@syncfusion/ej2-base';import { EventHandler, KeyboardEvents, KeyboardEventArgs as KeyArg, EmitType } from '@syncfusion/ej2-base';import { Query, DataManager, DataUtil, DataOptions } from '@syncfusion/ej2-data';import { ItemModel, ClickEventArgs } from '@syncfusion/ej2-navigations';import { createSpinner, hideSpinner, showSpinner, Tooltip } from '@syncfusion/ej2-popups';import { iterateArrayOrObject, prepareColumns, parentsUntil, wrap, templateCompiler, isGroupAdaptive, refreshForeignData } from './util';import { getRowHeight, setColumnIndex, Global, ispercentageWidth, renderMovable } from './util';import { setRowElements, resetRowIndex, compareChanges } from './util';import * as events from '../base/constant';import { ReturnType, BatchChanges } from '../base/type';import { IDialogUI, ScrollPositionType, ActionArgs, ExportGroupCaptionEventArgs, FilterUI, LazyLoadArgs } from './interface';import {AggregateQueryCellInfoEventArgs } from './interface';import { IRenderer, IValueFormatter, IFilterOperator, IIndex, RowDataBoundEventArgs, QueryCellInfoEventArgs } from './interface';import { CellDeselectEventArgs, CellSelectEventArgs, CellSelectingEventArgs, ParentDetails, ContextMenuItemModel } from './interface';import { PdfQueryCellInfoEventArgs, ExcelQueryCellInfoEventArgs, ExcelExportProperties, PdfExportProperties } from './interface';import { PdfHeaderQueryCellInfoEventArgs, ExcelHeaderQueryCellInfoEventArgs, ExportDetailDataBoundEventArgs } from './interface';import { ColumnMenuOpenEventArgs, BatchCancelArgs, RecordDoubleClickEventArgs, DataResult, PendingState } from './interface';import { HeaderCellInfoEventArgs, KeyboardEventArgs, RecordClickEventArgs } from './interface';import { FailureEventArgs, FilterEventArgs, ColumnDragEventArgs, GroupEventArgs, PrintEventArgs, ICustomOptr } from './interface';import { RowDeselectEventArgs, RowSelectEventArgs, RowSelectingEventArgs, PageEventArgs, RowDragEventArgs } from './interface';import { BeforeBatchAddArgs, BeforeBatchDeleteArgs, BeforeBatchSaveArgs, ResizeArgs, ColumnMenuItemModel, NotifyArgs } from './interface';import { BatchAddArgs, BatchDeleteArgs, BeginEditArgs, CellEditArgs, CellSaveArgs, BeforeDataBoundArgs, RowInfo } from './interface';import { DetailDataBoundEventArgs, ColumnChooserEventArgs, AddEventArgs, SaveEventArgs, EditEventArgs, DeleteEventArgs } from './interface';import { ExcelExportCompleteArgs, PdfExportCompleteArgs, DataStateChangeEventArgs, DataSourceChangedEventArgs } from './interface';import { SearchEventArgs, SortEventArgs, ISelectedCell, EJ2Intance, BeforeCopyEventArgs, ColumnDataStateChangeEventArgs} from './interface';import {BeforePasteEventArgs, CheckBoxChangeEventArgs, CommandClickEventArgs, BeforeAutoFillEventArgs } from './interface';import { Render } from '../renderer/render';import { Column, ColumnModel, ActionEventArgs } from '../models/column';import { SelectionType, GridLine, RenderType, SortDirection, SelectionMode, PrintMode, FilterType, FilterBarMode, ClipMode } from './enum';import { CheckboxSelectionType, HierarchyGridPrintMode, NewRowPosition } from './enum';import { WrapMode, ToolbarItems, ContextMenuItem, ColumnMenuItem, ToolbarItem, CellSelectionMode, EditMode, ResizeMode } from './enum';import { ColumnQueryModeType } from './enum';import { Data } from '../actions/data';import { Cell } from '../models/cell';import { RowRenderer } from '../renderer/row-renderer';import { CellRenderer } from '../renderer/cell-renderer';import { CellRendererFactory } from '../services/cell-render-factory';import { ServiceLocator } from '../services/service-locator';import { ValueFormatter } from '../services/value-formatter';import { RendererFactory } from '../services/renderer-factory';import { ColumnWidthService } from '../services/width-controller';import { AriaService } from '../services/aria-service';import { FocusStrategy } from '../services/focus-strategy';import { PageSettingsModel, AggregateRowModel, AggregateColumnModel, ColumnChooserSettingsModel } from '../models/models';import { PageSettings } from '../models/page-settings';import { ColumnChooserSettings } from '../models/column-chooser-settings';import { Sort } from '../actions/sort';import { Page } from '../actions/page';import { Selection } from '../actions/selection';import { Filter } from '../actions/filter';import { Search } from '../actions/search';import { Resize } from '../actions/resize';import { Reorder } from '../actions/reorder';import { RowDD } from '../actions/row-reorder';import { ShowHide } from '../actions/show-hide';import { Scroll } from '../actions/scroll';import { InfiniteScroll } from '../actions/infinite-scroll';import { Group } from '../actions/group';import { Print } from '../actions/print';import { DetailRow } from '../actions/detail-row';import { Toolbar } from '../actions/toolbar';import { AggregateRow } from '../models/aggregate';import { Edit } from '../actions/edit';import { Row } from '../models/row';import { ColumnChooser } from '../actions/column-chooser';import { ExcelExport } from '../actions/excel-export';import { PdfExport } from '../actions/pdf-export';import { Clipboard } from '../actions/clipboard';import { CommandColumn } from '../actions/command-column';import { ContextMenu } from '../actions/context-menu';import { BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';import { ColumnMenu } from '../actions/column-menu';import { CheckState } from './enum';import { Aggregate } from '../actions/aggregate';import { ILogger } from '../actions/logger';import { gridObserver, BlazorAction } from '../actions/blazor-action';import { IModelGenerator } from '../base/interface';import { RowModelGenerator } from '../services/row-model-generator';
1
+ import { Component, ModuleDeclaration, ChildProperty, Browser, closest, extend, TouchEventArgs } from '@syncfusion/ej2-base';
2
2
  import {ComponentModel} from '@syncfusion/ej2-base';
3
3
 
4
4
  /**
@@ -7,24 +7,24 @@ import {ComponentModel} from '@syncfusion/ej2-base';
7
7
  export interface SortDescriptorModel {
8
8
 
9
9
  /**
10
- * Defines the field name of sort column.
11
- * @default ''
12
- */
13
- field?: string;
10
+ * Defines the field name of sort column.
11
+ * @default ''
12
+ */
13
+ field?: string;
14
14
 
15
15
  /**
16
- * Defines the direction of sort column.
17
- * @default ''
18
- * @blazorDefaultValue null
19
- */
20
- direction?: SortDirection;
16
+ * Defines the direction of sort column.
17
+ * @default ''
18
+ * @blazorDefaultValue null
19
+ */
20
+ direction?: SortDirection;
21
21
 
22
22
  /**
23
- * @hidden
24
- * Defines the sorted column whether or from grouping operation.
25
- * @default false
26
- */
27
- isFromGroup?: boolean;
23
+ * @hidden
24
+ * Defines the sorted column whether or from grouping operation.
25
+ * @default false
26
+ */
27
+ isFromGroup?: boolean;
28
28
 
29
29
  }
30
30
 
@@ -34,17 +34,17 @@ export interface SortDescriptorModel {
34
34
  export interface SortSettingsModel {
35
35
 
36
36
  /**
37
- * Specifies the columns to sort at initial rendering of Grid.
38
- * Also user can get current sorted columns.
39
- * @default []
40
- */
41
- columns?: SortDescriptorModel[];
37
+ * Specifies the columns to sort at initial rendering of Grid.
38
+ * Also user can get current sorted columns.
39
+ * @default []
40
+ */
41
+ columns?: SortDescriptorModel[];
42
42
 
43
43
  /**
44
- * If `allowUnsort` set to false the user can not get the grid in unsorted state by clicking the sorted column header.
45
- * @default true
46
- */
47
- allowUnsort?: boolean;
44
+ * If `allowUnsort` set to false the user can not get the grid in unsorted state by clicking the sorted column header.
45
+ * @default true
46
+ */
47
+ allowUnsort?: boolean;
48
48
 
49
49
  }
50
50
 
@@ -54,130 +54,130 @@ export interface SortSettingsModel {
54
54
  export interface PredicateModel {
55
55
 
56
56
  /**
57
- * Defines the field name of the filter column.
58
- * @default ''
59
- */
60
- field?: string;
61
-
62
- /**
63
- * Defines the operator to filter records. The available operators and its supported data types are:
64
- * <table>
65
- * <tr>
66
- * <td colspan=1 rowspan=1>
67
- * Operator<br/></td><td colspan=1 rowspan=1>
68
- * Description<br/></td><td colspan=1 rowspan=1>
69
- * Supported Types<br/></td></tr>
70
- * <tr>
71
- * <td colspan=1 rowspan=1>
72
- * startswith<br/></td><td colspan=1 rowspan=1>
73
- * Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
74
- * String<br/></td></tr>
75
- * <tr>
76
- * <td colspan=1 rowspan=1>
77
- * endswith<br/></td><td colspan=1 rowspan=1>
78
- * Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
79
- * <br/>String<br/></td></tr>
80
- * <tr>
81
- * <td colspan=1 rowspan=1>
82
- * contains<br/></td><td colspan=1 rowspan=1>
83
- * Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
84
- * <br/>String<br/></td></tr>
85
- * <tr>
86
- * <td colspan=1 rowspan=1>
87
- * equal<br/></td><td colspan=1 rowspan=1>
88
- * Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
89
- * <br/>String | Number | Boolean | Date<br/></td></tr>
90
- * <tr>
91
- * <td colspan=1 rowspan=1>
92
- * notequal<br/></td><td colspan=1 rowspan=1>
93
- * Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
94
- * <br/>String | Number | Boolean | Date<br/></td></tr>
95
- * <tr>
96
- * <td colspan=1 rowspan=1>
97
- * greaterthan<br/></td><td colspan=1 rowspan=1>
98
- * Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
99
- * Number | Date<br/></td></tr>
100
- * <tr>
101
- * <td colspan=1 rowspan=1>
102
- * greaterthanorequal<br/></td><td colspan=1 rowspan=1>
103
- * Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
104
- * <br/>Number | Date<br/></td></tr>
105
- * <tr>
106
- * <td colspan=1 rowspan=1>
107
- * lessthan<br/></td><td colspan=1 rowspan=1>
108
- * Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
109
- * <br/>Number | Date<br/></td></tr>
110
- * <tr>
111
- * <td colspan=1 rowspan=1>
112
- * lessthanorequal<br/></td><td colspan=1 rowspan=1>
113
- * Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
114
- * <br/>Number | Date<br/></td></tr>
115
- * </table>
116
- * @default null
117
- * @blazorType Syncfusion.Blazor.Operator
118
- * @blazorDefaultValue Syncfusion.Blazor.Operator.None
119
- */
120
- operator?: string;
121
-
122
- /**
123
- * Defines the value used to filter records.
124
- * @default ''
125
- */
126
- value?: string | number | Date | boolean;
127
-
128
- /**
129
-      * If match case set to true, then filter records with exact match or else
130
- * filter records with case insensitive(uppercase and lowercase letters treated as same).
131
- * @default null
132
- */
133
- matchCase?: boolean;
134
-
135
- /**
136
- * If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
137
- * @default false
138
- */
139
- ignoreAccent?: boolean;
140
-
141
- /**
142
- * Defines the relationship between one filter query and another by using AND or OR predicate.
143
- * @default null
144
- */
145
- predicate?: string;
146
-
147
- /**
148
- * @hidden
149
- * Defines the actual filter value for the filter column.
150
- */
151
- actualFilterValue?: Object;
152
-
153
- /**
154
- * @hidden
155
- * Defines the actual filter operator for the filter column.
156
- */
157
- actualOperator?: Object;
158
-
159
- /**
160
- * @hidden
161
- * Defines the type of the filter column.
162
- */
163
- type?: string;
164
-
165
- /**
166
- * @hidden
167
- * Defines the predicate of filter column.
168
- */
169
- ejpredicate?: Object;
170
-
171
- /**
172
- * Defines the UID of filter column.
173
- */
174
- uid?: string;
175
-
176
- /**
177
- * @hidden
178
- * Defines the foreignKey availability in filtered columns.
179
- */
180
- isForeignKey?: boolean;
57
+ * Defines the field name of the filter column.
58
+ * @default ''
59
+ */
60
+ field?: string;
61
+
62
+ /**
63
+ * Defines the operator to filter records. The available operators and its supported data types are:
64
+ * <table>
65
+ * <tr>
66
+ * <td colspan=1 rowspan=1>
67
+ * Operator<br/></td><td colspan=1 rowspan=1>
68
+ * Description<br/></td><td colspan=1 rowspan=1>
69
+ * Supported Types<br/></td></tr>
70
+ * <tr>
71
+ * <td colspan=1 rowspan=1>
72
+ * startswith<br/></td><td colspan=1 rowspan=1>
73
+ * Checks whether the value begins with the specified value.<br/></td><td colspan=1 rowspan=1>
74
+ * String<br/></td></tr>
75
+ * <tr>
76
+ * <td colspan=1 rowspan=1>
77
+ * endswith<br/></td><td colspan=1 rowspan=1>
78
+ * Checks whether the value ends with the specified value.<br/><br/></td><td colspan=1 rowspan=1>
79
+ * <br/>String<br/></td></tr>
80
+ * <tr>
81
+ * <td colspan=1 rowspan=1>
82
+ * contains<br/></td><td colspan=1 rowspan=1>
83
+ * Checks whether the value contains the specified value.<br/><br/></td><td colspan=1 rowspan=1>
84
+ * <br/>String<br/></td></tr>
85
+ * <tr>
86
+ * <td colspan=1 rowspan=1>
87
+ * equal<br/></td><td colspan=1 rowspan=1>
88
+ * Checks whether the value is equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
89
+ * <br/>String | Number | Boolean | Date<br/></td></tr>
90
+ * <tr>
91
+ * <td colspan=1 rowspan=1>
92
+ * notequal<br/></td><td colspan=1 rowspan=1>
93
+ * Checks for values that are not equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
94
+ * <br/>String | Number | Boolean | Date<br/></td></tr>
95
+ * <tr>
96
+ * <td colspan=1 rowspan=1>
97
+ * greaterthan<br/></td><td colspan=1 rowspan=1>
98
+ * Checks whether the value is greater than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
99
+ * Number | Date<br/></td></tr>
100
+ * <tr>
101
+ * <td colspan=1 rowspan=1>
102
+ * greaterthanorequal<br/></td><td colspan=1 rowspan=1>
103
+ * Checks whether the value is greater than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
104
+ * <br/>Number | Date<br/></td></tr>
105
+ * <tr>
106
+ * <td colspan=1 rowspan=1>
107
+ * lessthan<br/></td><td colspan=1 rowspan=1>
108
+ * Checks whether the value is less than the specified value.<br/><br/></td><td colspan=1 rowspan=1>
109
+ * <br/>Number | Date<br/></td></tr>
110
+ * <tr>
111
+ * <td colspan=1 rowspan=1>
112
+ * lessthanorequal<br/></td><td colspan=1 rowspan=1>
113
+ * Checks whether the value is less than or equal to the specified value.<br/><br/></td><td colspan=1 rowspan=1>
114
+ * <br/>Number | Date<br/></td></tr>
115
+ * </table>
116
+ * @default null
117
+ * @blazorType Syncfusion.Blazor.Operator
118
+ * @blazorDefaultValue Syncfusion.Blazor.Operator.None
119
+ */
120
+ operator?: string;
121
+
122
+ /**
123
+ * Defines the value used to filter records.
124
+ * @default ''
125
+ */
126
+ value?: string | number | Date | boolean;
127
+
128
+ /**
129
+      * If match case set to true, then filter records with exact match or else
130
+ * filter records with case insensitive(uppercase and lowercase letters treated as same).
131
+ * @default null
132
+ */
133
+ matchCase?: boolean;
134
+
135
+ /**
136
+ * If ignoreAccent is set to true, then filter ignores the diacritic characters or accents while filtering.
137
+ * @default false
138
+ */
139
+ ignoreAccent?: boolean;
140
+
141
+ /**
142
+ * Defines the relationship between one filter query and another by using AND or OR predicate.
143
+ * @default null
144
+ */
145
+ predicate?: string;
146
+
147
+ /**
148
+ * @hidden
149
+ * Defines the actual filter value for the filter column.
150
+ */
151
+ actualFilterValue?: Object;
152
+
153
+ /**
154
+ * @hidden
155
+ * Defines the actual filter operator for the filter column.
156
+ */
157
+ actualOperator?: Object;
158
+
159
+ /**
160
+ * @hidden
161
+ * Defines the type of the filter column.
162
+ */
163
+ type?: string;
164
+
165
+ /**
166
+ * @hidden
167
+ * Defines the predicate of filter column.
168
+ */
169
+ ejpredicate?: Object;
170
+
171
+ /**
172
+ * Defines the UID of filter column.
173
+ */
174
+ uid?: string;
175
+
176
+ /**
177
+ * @hidden
178
+ * Defines the foreignKey availability in filtered columns.
179
+ */
180
+ isForeignKey?: boolean;
181
181
 
182
182
  }
183
183
 
@@ -187,22 +187,22 @@ export interface PredicateModel {
187
187
  export interface InfiniteScrollSettingsModel {
188
188
 
189
189
  /**
190
- * If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
191
- * @default false
192
- */
193
- enableCache?: boolean;
190
+ * If `enableCache` is set to true, the Grid will cache the loaded data to be reused next time it is needed.
191
+ * @default false
192
+ */
193
+ enableCache?: boolean;
194
194
 
195
195
  /**
196
- * Defines the number of blocks to be maintained in Grid while settings enableCache as true.
197
- * @default 3
198
- */
199
- maxBlocks?: number;
196
+ * Defines the number of blocks to be maintained in Grid while settings enableCache as true.
197
+ * @default 3
198
+ */
199
+ maxBlocks?: number;
200
200
 
201
201
  /**
202
- * Defines the number of blocks will render at the initial Grid rendering while enableCache is enabled.
203
- * @default 3
204
- */
205
- initialBlocks?: number;
202
+ * Defines the number of blocks will render at the initial Grid rendering while enableCache is enabled.
203
+ * @default 3
204
+ */
205
+ initialBlocks?: number;
206
206
 
207
207
  }
208
208
 
@@ -212,73 +212,73 @@ export interface InfiniteScrollSettingsModel {
212
212
  export interface FilterSettingsModel {
213
213
 
214
214
  /**
215
- * Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
216
- * @default []
217
- */
218
- columns?: PredicateModel[];
215
+ * Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
216
+ * @default []
217
+ */
218
+ columns?: PredicateModel[];
219
219
 
220
220
  /**
221
- * Defines options for filtering type. The available options are
222
- * * `Menu` - Specifies the filter type as menu.
223
- * * `CheckBox` - Specifies the filter type as checkbox.
224
- * * `FilterBar` - Specifies the filter type as filterbar.
225
- * * `Excel` - Specifies the filter type as checkbox.
226
- * @default FilterBar
227
- */
228
- type?: FilterType;
221
+ * Defines options for filtering type. The available options are
222
+ * * `Menu` - Specifies the filter type as menu.
223
+ * * `CheckBox` - Specifies the filter type as checkbox.
224
+ * * `FilterBar` - Specifies the filter type as filterbar.
225
+ * * `Excel` - Specifies the filter type as checkbox.
226
+ * @default FilterBar
227
+ */
228
+ type?: FilterType;
229
229
 
230
230
  /**
231
- * Defines the filter bar modes. The available options are,
232
- * * `OnEnter`: Initiates filter operation after Enter key is pressed.
233
- * * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
234
- * @default OnEnter
235
- */
236
- mode?: FilterBarMode;
231
+ * Defines the filter bar modes. The available options are,
232
+ * * `OnEnter`: Initiates filter operation after Enter key is pressed.
233
+ * * `Immediate`: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
234
+ * @default OnEnter
235
+ */
236
+ mode?: FilterBarMode;
237
237
 
238
238
  /**
239
-      * Shows or hides the filtered status message on the pager.
240
- * @default true
241
- */
242
- showFilterBarStatus?: boolean;
239
+      * Shows or hides the filtered status message on the pager.
240
+ * @default true
241
+ */
242
+ showFilterBarStatus?: boolean;
243
243
 
244
244
  /**
245
- * Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
246
- * @default 1500
247
- */
248
- immediateModeDelay?: number;
245
+ * Defines the time delay (in milliseconds) in filtering records when the `Immediate` mode of filter bar is set.
246
+ * @default 1500
247
+ */
248
+ immediateModeDelay?: number;
249
249
 
250
250
  /**
251
- * The `operators` is used to override the default operators in filter menu. This should be defined by type wise
252
- * (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
253
- *
254
- * > Check the [`Filter Menu Operator`](../../grid/how-to/#customizing-filter-menu-operators-list/) customization.
255
- * @default null
256
- */
257
- operators?: ICustomOptr;
251
+ * The `operators` is used to override the default operators in filter menu. This should be defined by type wise
252
+ * (string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
253
+ *
254
+ * > Check the [`Filter Menu Operator`](../../grid/how-to/#customizing-filter-menu-operators-list/) customization.
255
+ * @default null
256
+ */
257
+ operators?: ICustomOptr;
258
258
 
259
259
  /**
260
- * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
261
- *
262
- * > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
263
- * @default false
264
- */
265
- ignoreAccent?: boolean;
260
+ * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
261
+ *
262
+ * > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
263
+ * @default false
264
+ */
265
+ ignoreAccent?: boolean;
266
266
 
267
267
  /**
268
- * If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
269
- * operator. It will have no effect on number, boolean and Date fields.
270
- *
271
- * @default false
272
- */
273
- enableCaseSensitivity?: boolean;
268
+ * If `enableCaseSensitivity` is set to true then searches grid records with exact match based on the filter
269
+ * operator. It will have no effect on number, boolean and Date fields.
270
+ *
271
+ * @default false
272
+ */
273
+ enableCaseSensitivity?: boolean;
274
274
 
275
275
  /**
276
- * If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
277
- * in filterbar input
278
- *
279
- * @default false
280
- */
281
- showFilterBarOperator?: boolean;
276
+ * If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
277
+ * in filterbar input
278
+ *
279
+ * @default false
280
+ */
281
+ showFilterBarOperator?: boolean;
282
282
 
283
283
  }
284
284
 
@@ -288,64 +288,64 @@ export interface FilterSettingsModel {
288
288
  export interface SelectionSettingsModel {
289
289
 
290
290
  /**
291
- * Grid supports row, cell, and both (row and cell) selection mode.
292
- * @default Row
293
- */
294
- mode?: SelectionMode;
291
+ * Grid supports row, cell, and both (row and cell) selection mode.
292
+ * @default Row
293
+ */
294
+ mode?: SelectionMode;
295
295
 
296
296
  /**
297
- * The cell selection modes are flow and box. It requires the selection
298
- * [`mode`](grid/#mode-selectionmode/) to be either cell or both.
299
- * * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
300
- * * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
301
- * * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
302
- * @default Flow
303
- */
304
- cellSelectionMode?: CellSelectionMode;
297
+ * The cell selection modes are flow and box. It requires the selection
298
+ * [`mode`](grid/#mode-selectionmode/) to be either cell or both.
299
+ * * `Flow`: Selects the range of cells between start index and end index that also includes the other cells of the selected rows.
300
+ * * `Box`: Selects the range of cells within the start and end column indexes that includes in between cells of rows within the range.
301
+ * * `BoxWithBorder`: Selects the range of cells as like Box mode with borders.
302
+ * @default Flow
303
+ */
304
+ cellSelectionMode?: CellSelectionMode;
305
305
 
306
306
  /**
307
- * Defines options for selection type. They are
308
- * * `Single`: Allows selection of only a row or a cell.
309
- * * `Multiple`: Allows selection of multiple rows or cells.
310
- * @default Single
311
- */
312
- type?: SelectionType;
307
+ * Defines options for selection type. They are
308
+ * * `Single`: Allows selection of only a row or a cell.
309
+ * * `Multiple`: Allows selection of multiple rows or cells.
310
+ * @default Single
311
+ */
312
+ type?: SelectionType;
313
313
 
314
314
  /**
315
- * If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
316
- *
317
- * > To enable checkboxOnly selection, should specify the column type as`checkbox`.
318
- * @default false
319
- */
320
- checkboxOnly?: boolean;
315
+ * If 'checkboxOnly' set to true, then the Grid selection is allowed only through checkbox.
316
+ *
317
+ * > To enable checkboxOnly selection, should specify the column type as`checkbox`.
318
+ * @default false
319
+ */
320
+ checkboxOnly?: boolean;
321
321
 
322
322
  /**
323
- * If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
324
- * For persisting selection in the Grid, any one of the column should be enabled as a primary key.
325
- * @default false
326
- */
327
- persistSelection?: boolean;
323
+ * If 'persistSelection' set to true, then the Grid selection is persisted on all operations.
324
+ * For persisting selection in the Grid, any one of the column should be enabled as a primary key.
325
+ * @default false
326
+ */
327
+ persistSelection?: boolean;
328
328
 
329
329
  /**
330
- * Defines options for checkbox selection Mode. They are
331
- * * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
332
- * * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
333
- * rows can be selected by using CTRL or SHIFT key.
334
- * @default Default
335
- */
336
- checkboxMode?: CheckboxSelectionType;
330
+ * Defines options for checkbox selection Mode. They are
331
+ * * `Default`: This is the default value of the checkboxMode. In this mode, user can select multiple rows by clicking rows one by one.
332
+ * * `ResetOnRowClick`: In ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple
333
+ * rows can be selected by using CTRL or SHIFT key.
334
+ * @default Default
335
+ */
336
+ checkboxMode?: CheckboxSelectionType;
337
337
 
338
338
  /**
339
- * If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
340
- * @default false
341
- */
342
- enableSimpleMultiRowSelection?: boolean;
339
+ * If 'enableSimpleMultiRowSelection' set to true, then the user can able to perform multiple row selection with single clicks.
340
+ * @default false
341
+ */
342
+ enableSimpleMultiRowSelection?: boolean;
343
343
 
344
344
  /**
345
- * If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
346
- * @default true
347
- */
348
- enableToggle?: boolean;
345
+ * If 'enableToggle' set to true, then the user can able to perform toggle for the selected row.
346
+ * @default true
347
+ */
348
+ enableToggle?: boolean;
349
349
 
350
350
  }
351
351
 
@@ -355,66 +355,66 @@ export interface SelectionSettingsModel {
355
355
  export interface SearchSettingsModel {
356
356
 
357
357
  /**
358
- * Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
359
- * @default []
360
- */
361
- fields?: string[];
362
-
363
- /**
364
- * Specifies the key value to search Grid records at initial rendering.
365
- * You can also get the current search key.
366
- * @default ''
367
- */
368
- key?: string;
369
-
370
- /**
371
- * Defines the operator to search records. The available operators are:
372
- * <table>
373
- * <tr>
374
- * <td colspan=1 rowspan=1>
375
- * Operator<br/></td><td colspan=1 rowspan=1>
376
- * Description<br/></td></tr>
377
- * <tr>
378
- * <td colspan=1 rowspan=1>
379
- * startswith<br/></td><td colspan=1 rowspan=1>
380
- * Checks whether the string begins with the specified string.<br/></td></tr>
381
- * <tr>
382
- * <td colspan=1 rowspan=1>
383
- * endswith<br/></td><td colspan=1 rowspan=1>
384
- * Checks whether the string ends with the specified string.<br/></td></tr>
385
- * <tr>
386
- * <td colspan=1 rowspan=1>
387
- * contains<br/></td><td colspan=1 rowspan=1>
388
- * Checks whether the string contains the specified string. <br/></td></tr>
389
- * <tr>
390
- * <td colspan=1 rowspan=1>
391
- * equal<br/></td><td colspan=1 rowspan=1>
392
- * Checks whether the string is equal to the specified string.<br/></td></tr>
393
- * <tr>
394
- * <td colspan=1 rowspan=1>
395
- * notequal<br/></td><td colspan=1 rowspan=1>
396
- * Checks for strings not equal to the specified string. <br/></td></tr>
397
- * </table>
398
- * @default 'contains'
399
- * @blazorType Syncfusion.Blazor.Operator
400
- * @blazorDefaultValue Syncfusion.Blazor.Operator.Contains
401
- */
402
- operator?: string;
403
-
404
- /**
405
-      * If `ignoreCase` is set to false, searches records that match exactly, else
406
- * searches records that are case insensitive(uppercase and lowercase letters treated the same).
407
- * @default true
408
- */
409
- ignoreCase?: boolean;
410
-
411
- /**
412
- * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
413
- *
414
- * > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
415
- * @default false
416
- */
417
- ignoreAccent?: boolean;
358
+ * Specifies the collection of fields included in search operation. By default, bounded columns of the Grid are included.
359
+ * @default []
360
+ */
361
+ fields?: string[];
362
+
363
+ /**
364
+ * Specifies the key value to search Grid records at initial rendering.
365
+ * You can also get the current search key.
366
+ * @default ''
367
+ */
368
+ key?: string;
369
+
370
+ /**
371
+ * Defines the operator to search records. The available operators are:
372
+ * <table>
373
+ * <tr>
374
+ * <td colspan=1 rowspan=1>
375
+ * Operator<br/></td><td colspan=1 rowspan=1>
376
+ * Description<br/></td></tr>
377
+ * <tr>
378
+ * <td colspan=1 rowspan=1>
379
+ * startswith<br/></td><td colspan=1 rowspan=1>
380
+ * Checks whether the string begins with the specified string.<br/></td></tr>
381
+ * <tr>
382
+ * <td colspan=1 rowspan=1>
383
+ * endswith<br/></td><td colspan=1 rowspan=1>
384
+ * Checks whether the string ends with the specified string.<br/></td></tr>
385
+ * <tr>
386
+ * <td colspan=1 rowspan=1>
387
+ * contains<br/></td><td colspan=1 rowspan=1>
388
+ * Checks whether the string contains the specified string. <br/></td></tr>
389
+ * <tr>
390
+ * <td colspan=1 rowspan=1>
391
+ * equal<br/></td><td colspan=1 rowspan=1>
392
+ * Checks whether the string is equal to the specified string.<br/></td></tr>
393
+ * <tr>
394
+ * <td colspan=1 rowspan=1>
395
+ * notequal<br/></td><td colspan=1 rowspan=1>
396
+ * Checks for strings not equal to the specified string. <br/></td></tr>
397
+ * </table>
398
+ * @default 'contains'
399
+ * @blazorType Syncfusion.Blazor.Operator
400
+ * @blazorDefaultValue Syncfusion.Blazor.Operator.Contains
401
+ */
402
+ operator?: string;
403
+
404
+ /**
405
+      * If `ignoreCase` is set to false, searches records that match exactly, else
406
+ * searches records that are case insensitive(uppercase and lowercase letters treated the same).
407
+ * @default true
408
+ */
409
+ ignoreCase?: boolean;
410
+
411
+ /**
412
+ * If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
413
+ *
414
+ * > Check the [`Diacritics`](../../grid/filtering/#diacritics/) filtering.
415
+ * @default false
416
+ */
417
+ ignoreAccent?: boolean;
418
418
 
419
419
  }
420
420
 
@@ -424,10 +424,10 @@ export interface SearchSettingsModel {
424
424
  export interface RowDropSettingsModel {
425
425
 
426
426
  /**
427
- * Defines the ID of droppable component on which row drop should occur.
428
- * @default null
429
- */
430
- targetID?: string;
427
+ * Defines the ID of droppable component on which row drop should occur.
428
+ * @default null
429
+ */
430
+ targetID?: string;
431
431
 
432
432
  }
433
433
 
@@ -437,13 +437,13 @@ export interface RowDropSettingsModel {
437
437
  export interface TextWrapSettingsModel {
438
438
 
439
439
  /**
440
- * Defines the `wrapMode` of the Grid. The available modes are:
441
- * * `Both`: Wraps both the header and content.
442
- * * `Content`: Wraps the header alone.
443
- * * `Header`: Wraps the content alone.
444
- * @default Both
445
- */
446
- wrapMode?: WrapMode;
440
+ * Defines the `wrapMode` of the Grid. The available modes are:
441
+ * * `Both`: Wraps both the header and content.
442
+ * * `Content`: Wraps the header alone.
443
+ * * `Header`: Wraps the content alone.
444
+ * @default Both
445
+ */
446
+ wrapMode?: WrapMode;
447
447
 
448
448
  }
449
449
 
@@ -453,12 +453,12 @@ export interface TextWrapSettingsModel {
453
453
  export interface ResizeSettingsModel {
454
454
 
455
455
  /**
456
- * Defines the mode of Grid column resizing. The available modes are:
457
- * `Normal`: Columns will not be adjusted to fit the remaining space.
458
- * `Auto`: Resized column width will be adjusted by other columns automatically.
459
- * @default Normal
460
- */
461
- mode?: ResizeMode;
456
+ * Defines the mode of Grid column resizing. The available modes are:
457
+ * `Normal`: Columns will not be adjusted to fit the remaining space.
458
+ * `Auto`: Resized column width will be adjusted by other columns automatically.
459
+ * @default Normal
460
+ */
461
+ mode?: ResizeMode;
462
462
 
463
463
  }
464
464
 
@@ -468,66 +468,66 @@ export interface ResizeSettingsModel {
468
468
  export interface GroupSettingsModel {
469
469
 
470
470
  /**
471
- * If `showDropArea` is set to true, the group drop area element will be visible at the top of the Grid.
472
- * @default true
473
- */
474
- showDropArea?: boolean;
471
+ * If `showDropArea` is set to true, the group drop area element will be visible at the top of the Grid.
472
+ * @default true
473
+ */
474
+ showDropArea?: boolean;
475
475
 
476
476
  /**
477
- * If `allowReordering` is set to true, Grid allows the grouped elements to be reordered.
478
- * @default false
479
- */
480
- allowReordering?: boolean;
477
+ * If `allowReordering` is set to true, Grid allows the grouped elements to be reordered.
478
+ * @default false
479
+ */
480
+ allowReordering?: boolean;
481
481
 
482
482
  /**
483
- * If `showToggleButton` set to true, then the toggle button will be showed in the column headers which can be used to group
484
- * or ungroup columns by clicking them.
485
- * @default false
486
- */
487
- showToggleButton?: boolean;
483
+ * If `showToggleButton` set to true, then the toggle button will be showed in the column headers which can be used to group
484
+ * or ungroup columns by clicking them.
485
+ * @default false
486
+ */
487
+ showToggleButton?: boolean;
488
488
 
489
489
  /**
490
- * If `showGroupedColumn` is set to false, it hides the grouped column after grouping.
491
- * @default false
492
- */
493
- showGroupedColumn?: boolean;
490
+ * If `showGroupedColumn` is set to false, it hides the grouped column after grouping.
491
+ * @default false
492
+ */
493
+ showGroupedColumn?: boolean;
494
494
 
495
495
  /**
496
- * If `showUngroupButton` set to false, then ungroup button is hidden in dropped element.
497
- * It can be used to ungroup the grouped column when click on ungroup button.
498
- * @default true
499
- */
500
- showUngroupButton?: boolean;
496
+ * If `showUngroupButton` set to false, then ungroup button is hidden in dropped element.
497
+ * It can be used to ungroup the grouped column when click on ungroup button.
498
+ * @default true
499
+ */
500
+ showUngroupButton?: boolean;
501
501
 
502
502
  /**
503
- * If `disablePageWiseAggregates` set to true, then the group aggregate value will
504
- * be calculated from the whole data instead of paged data and two requests will be made for each page
505
- * when Grid bound with remote service.
506
- * @default false
507
- */
508
- disablePageWiseAggregates?: boolean;
503
+ * If `disablePageWiseAggregates` set to true, then the group aggregate value will
504
+ * be calculated from the whole data instead of paged data and two requests will be made for each page
505
+ * when Grid bound with remote service.
506
+ * @default false
507
+ */
508
+ disablePageWiseAggregates?: boolean;
509
509
 
510
510
  /**
511
- * Specifies the column names to group at initial rendering of the Grid.
512
- * You can also get the currently grouped columns.
513
- * @default []
514
- */
515
- columns?: string[];
511
+ * Specifies the column names to group at initial rendering of the Grid.
512
+ * You can also get the currently grouped columns.
513
+ * @default []
514
+ */
515
+ columns?: string[];
516
516
 
517
517
  /**
518
- * The Caption Template allows user to display the string or HTML element in group caption.
519
- * > It accepts either the
520
- * [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or the HTML element ID.
521
- * @default ''
522
- */
523
- captionTemplate?: string;
518
+ * The Caption Template allows user to display the string or HTML element in group caption.
519
+ * > It accepts either the
520
+ * [template string](https://ej2.syncfusion.com/documentation/common/template-engine/) or the HTML element ID.
521
+ * @default ''
522
+ */
523
+ captionTemplate?: string;
524
524
 
525
525
  /**
526
- * The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping.
527
- * The child rows of each caption will render only when we expand the captions.
528
- * @default false
529
- */
530
- enableLazyLoading?: boolean;
526
+ * The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping.
527
+ * The child rows of each caption will render only when we expand the captions.
528
+ * @default false
529
+ */
530
+ enableLazyLoading?: boolean;
531
531
 
532
532
  }
533
533
 
@@ -537,90 +537,90 @@ export interface GroupSettingsModel {
537
537
  export interface EditSettingsModel {
538
538
 
539
539
  /**
540
- * If `allowAdding` is set to true, new records can be added to the Grid.
541
- * @default false
542
- */
543
- allowAdding?: boolean;
540
+ * If `allowAdding` is set to true, new records can be added to the Grid.
541
+ * @default false
542
+ */
543
+ allowAdding?: boolean;
544
544
 
545
545
  /**
546
- * If `allowEditing` is set to true, values can be updated in the existing record.
547
- * @default false
548
- */
549
- allowEditing?: boolean;
546
+ * If `allowEditing` is set to true, values can be updated in the existing record.
547
+ * @default false
548
+ */
549
+ allowEditing?: boolean;
550
550
 
551
551
  /**
552
- * If `allowDeleting` is set to true, existing record can be deleted from the Grid.
553
- * @default false
554
- */
555
- allowDeleting?: boolean;
552
+ * If `allowDeleting` is set to true, existing record can be deleted from the Grid.
553
+ * @default false
554
+ */
555
+ allowDeleting?: boolean;
556
556
 
557
557
  /**
558
- * Defines the mode to edit. The available editing modes are:
559
- * * Normal
560
- * * Dialog
561
- * * Batch
562
- * @default Normal
563
- */
564
- mode?: EditMode;
558
+ * Defines the mode to edit. The available editing modes are:
559
+ * * Normal
560
+ * * Dialog
561
+ * * Batch
562
+ * @default Normal
563
+ */
564
+ mode?: EditMode;
565
565
 
566
566
  /**
567
- * If `allowEditOnDblClick` is set to false, Grid will not allow editing of a record on double click.
568
- * @default true
569
- */
570
- allowEditOnDblClick?: boolean;
567
+ * If `allowEditOnDblClick` is set to false, Grid will not allow editing of a record on double click.
568
+ * @default true
569
+ */
570
+ allowEditOnDblClick?: boolean;
571
571
 
572
572
  /**
573
- * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
574
- * @default true
575
- */
576
- showConfirmDialog?: boolean;
573
+ * if `showConfirmDialog` is set to false, confirm dialog does not show when batch changes are saved or discarded.
574
+ * @default true
575
+ */
576
+ showConfirmDialog?: boolean;
577
577
 
578
578
  /**
579
- * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
580
- * @default false
581
- */
582
- showDeleteConfirmDialog?: boolean;
579
+ * If `showDeleteConfirmDialog` is set to true, confirm dialog will show delete action. You can also cancel delete command.
580
+ * @default false
581
+ */
582
+ showDeleteConfirmDialog?: boolean;
583
583
 
584
584
  /**
585
- * Defines the custom edit elements for the dialog template.
586
- * @default ''
587
- * @aspType string
588
- */
589
- template?: string | Object;
585
+ * Defines the custom edit elements for the dialog template.
586
+ * @default ''
587
+ * @aspType string
588
+ */
589
+ template?: string | Object;
590
590
 
591
591
  /**
592
- * Defines the custom edit elements for the dialog header template.
593
- * @default ''
594
- * @aspType string
595
- */
596
- headerTemplate?: string | Object;
592
+ * Defines the custom edit elements for the dialog header template.
593
+ * @default ''
594
+ * @aspType string
595
+ */
596
+ headerTemplate?: string | Object;
597
597
 
598
598
  /**
599
- * Defines the custom edit elements for the dialog footer template.
600
- * @default ''
601
- * @aspType string
602
- */
603
- footerTemplate?: string | Object;
599
+ * Defines the custom edit elements for the dialog footer template.
600
+ * @default ''
601
+ * @aspType string
602
+ */
603
+ footerTemplate?: string | Object;
604
604
 
605
605
  /**
606
- * Defines the position of adding a new row. The available position are:
607
- * * Top
608
- * * Bottom
609
- * @default Top
610
- */
611
- newRowPosition?: NewRowPosition;
606
+ * Defines the position of adding a new row. The available position are:
607
+ * * Top
608
+ * * Bottom
609
+ * @default Top
610
+ */
611
+ newRowPosition?: NewRowPosition;
612
612
 
613
613
  /**
614
- * Defines the dialog params to edit.
615
- * @default {}
616
- */
617
- dialog?: IDialogUI;
614
+ * Defines the dialog params to edit.
615
+ * @default {}
616
+ */
617
+ dialog?: IDialogUI;
618
618
 
619
619
  /**
620
- * If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.
621
- * @default false
622
- */
623
- allowNextRowEdit?: boolean;
620
+ * If allowNextRowEdit is set to true, editing is done to next row. By default allowNextRowEdit is set to false.
621
+ * @default false
622
+ */
623
+ allowNextRowEdit?: boolean;
624
624
 
625
625
  }
626
626
 
@@ -630,1063 +630,1063 @@ export interface EditSettingsModel {
630
630
  export interface GridModel extends ComponentModel{
631
631
 
632
632
  /**
633
- * Gets the parent Grid details.
634
-
635
- */
636
- parentDetails?: ParentDetails;
637
-
638
- /**
639
-      * Defines the schema of dataSource.
640
-      * If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.    
641
-      * {% codeBlock src='grid/columns/index.md' %}{% endcodeBlock %}
642
- * @default []  
643
-      */
644
- columns?: Column[] | string[] | ColumnModel[];
633
+ * Gets the parent Grid details.
634
+ * @deprecated
635
+ */
636
+ parentDetails?: ParentDetails;
645
637
 
646
638
  /**
647
-      * If `enableAltRow` is set to true, the grid will render with `e-altrow` CSS class to the alternative tr elements.   
648
- * > Check the [`AltRow`](../../grid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
649
- * {% codeBlock src='grid/enableAltRow/index.md' %}{% endcodeBlock %}
650
- * @default true 
651
-      */
652
- enableAltRow?: boolean;
639
+      * Defines the schema of dataSource.
640
+      * If the `columns` declaration is empty or undefined then the `columns` are automatically generated from data source.    
641
+      * {% codeBlock src='grid/columns/index.md' %}{% endcodeBlock %}
642
+ * @default []  
643
+      */
644
+ columns?: Column[] | string[] | ColumnModel[];
653
645
 
654
646
  /**
655
-      * If `enableHover` is set to true, the row hover is enabled in the Grid.
656
- * {% codeBlock src='grid/enableHover/index.md' %}{% endcodeBlock %}
657
-      * @default true    
658
-      */
659
- enableHover?: boolean;
647
+      * If `enableAltRow` is set to true, the grid will render with `e-altrow` CSS class to the alternative tr elements.   
648
+ * > Check the [`AltRow`](../../grid/row/#styling-alternate-rows/) to customize the styles of alternative rows.
649
+ * {% codeBlock src='grid/enableAltRow/index.md' %}{% endcodeBlock %}
650
+ * @default true 
651
+      */
652
+ enableAltRow?: boolean;
660
653
 
661
654
  /**
662
-      * If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
663
- * It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
664
- * {% codeBlock src='grid/enableAutoFill/index.md' %}{% endcodeBlock %}
665
-      * @default false
666
-      */
667
- enableAutoFill?: boolean;
655
+      * If `enableHover` is set to true, the row hover is enabled in the Grid.
656
+ * {% codeBlock src='grid/enableHover/index.md' %}{% endcodeBlock %}
657
+      * @default true    
658
+      */
659
+ enableHover?: boolean;
668
660
 
669
661
  /**
670
-      * Enables or disables the key board interaction of Grid.
671
- * @default true
672
-      */
673
- allowKeyboard?: boolean;
662
+      * If `enableAutoFill` is set to true, then the auto fill icon will displayed on cell selection for copy cells.
663
+ * It requires the selection `mode` to be Cell and `cellSelectionMode` to be `Box`.
664
+ * {% codeBlock src='grid/enableAutoFill/index.md' %}{% endcodeBlock %}
665
+      * @default false
666
+      */
667
+ enableAutoFill?: boolean;
674
668
 
675
669
  /**
676
- * If `allowTextWrap` set to true,
677
- * then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
678
- * {% codeBlock src='grid/allowTextWrap/index.md' %}{% endcodeBlock %}
679
- * @default false
680
- */
681
- allowTextWrap?: boolean;
670
+      * Enables or disables the key board interaction of Grid.
671
+ * @default true
672
+      */
673
+ allowKeyboard?: boolean;
682
674
 
683
675
  /**
684
- * Configures the text wrap in the Grid.
685
- * {% codeBlock src='grid/textWrapSettings/index.md' %}{% endcodeBlock %}
686
- * @default {wrapMode:"Both"}
687
-      */
688
- textWrapSettings?: TextWrapSettingsModel;
676
+ * If `allowTextWrap` set to true,
677
+ * then text content will wrap to the next line when its text content exceeds the width of the Column Cells.
678
+ * {% codeBlock src='grid/allowTextWrap/index.md' %}{% endcodeBlock %}
679
+ * @default false
680
+ */
681
+ allowTextWrap?: boolean;
689
682
 
690
683
  /**
691
- * Defines the resizing behavior of the Grid.
692
- * @default {mode:"Normal"}
693
-      */
694
- resizeSettings?: ResizeSettingsModel;
684
+ * Configures the text wrap in the Grid.
685
+ * {% codeBlock src='grid/textWrapSettings/index.md' %}{% endcodeBlock %}
686
+ * @default {wrapMode:"Both"}
687
+      */
688
+ textWrapSettings?: TextWrapSettingsModel;
695
689
 
696
690
  /**
697
-      * If `allowPaging` is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.
698
- *
699
- * > Check the [`Paging`](../../grid/paging/) to configure the grid pager.
700
- * {% codeBlock src='grid/allowPaging/index.md' %}{% endcodeBlock %}
701
-      * @default false    
702
-      */
703
- allowPaging?: boolean;
691
+ * Defines the resizing behavior of the Grid.
692
+ * @default {mode:"Normal"}
693
+      */
694
+ resizeSettings?: ResizeSettingsModel;
704
695
 
705
696
  /**
706
- * Configures the pager in the Grid.
707
- * {% codeBlock src='grid/pageSettings/index.md' %}{% endcodeBlock %}
708
- * @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
709
-      */
710
- pageSettings?: PageSettingsModel;
697
+      * If `allowPaging` is set to true, the pager renders at the footer of the Grid. It is used to handle page navigation in the Grid.
698
+ *
699
+ * > Check the [`Paging`](../../grid/paging/) to configure the grid pager.
700
+ * {% codeBlock src='grid/allowPaging/index.md' %}{% endcodeBlock %}
701
+      * @default false    
702
+      */
703
+ allowPaging?: boolean;
711
704
 
712
705
  /**
713
- * If `enableVirtualization` set to true, then the Grid will render only the rows visible within the view-port
714
- * and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
715
- * {% codeBlock src='grid/enableVirtualization/index.md' %}{% endcodeBlock %}
716
- * @default false
717
- */
718
- enableVirtualization?: boolean;
706
+ * Configures the pager in the Grid.
707
+ * {% codeBlock src='grid/pageSettings/index.md' %}{% endcodeBlock %}
708
+ * @default {currentPage: 1, pageSize: 12, pageCount: 8, enableQueryString: false, pageSizes: false, template: null}
709
+      */
710
+ pageSettings?: PageSettingsModel;
719
711
 
720
712
  /**
721
- * If `enableColumnVirtualization` set to true, then the Grid will render only the columns visible within the view-port
722
- * and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.
723
- * {% codeBlock src='grid/enableColumnVirtualization/index.md' %}{% endcodeBlock %}
724
- * @default false
725
- */
726
- enableColumnVirtualization?: boolean;
713
+ * If `enableVirtualization` set to true, then the Grid will render only the rows visible within the view-port
714
+ * and load subsequent rows on vertical scrolling. This helps to load large dataset in Grid.
715
+ * {% codeBlock src='grid/enableVirtualization/index.md' %}{% endcodeBlock %}
716
+ * @default false
717
+ */
718
+ enableVirtualization?: boolean;
727
719
 
728
720
  /**
729
- * If `enableInfiniteScrolling` set to true, then the data will be loaded in Grid when the scrollbar reaches the end.
730
- * This helps to load large dataset in Grid.
731
- * {% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
732
- * @default false
733
-
734
- */
735
- enableInfiniteScrolling?: boolean;
721
+ * If `enableColumnVirtualization` set to true, then the Grid will render only the columns visible within the view-port
722
+ * and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Grid.
723
+ * {% codeBlock src='grid/enableColumnVirtualization/index.md' %}{% endcodeBlock %}
724
+ * @default false
725
+ */
726
+ enableColumnVirtualization?: boolean;
736
727
 
737
728
  /**
738
- * Configures the search behavior in the Grid.
739
- * {% codeBlock src='grid/searchSettings/index.md' %}{% endcodeBlock %}
740
- * @default { ignoreCase: true, fields: [], operator: 'contains', key: '' }
741
- */
742
- searchSettings?: SearchSettingsModel;
729
+ * If `enableInfiniteScrolling` set to true, then the data will be loaded in Grid when the scrollbar reaches the end.
730
+ * This helps to load large dataset in Grid.
731
+ * {% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
732
+ * @default false
733
+ * @deprecated
734
+ */
735
+ enableInfiniteScrolling?: boolean;
743
736
 
744
737
  /**
745
- * If `allowSorting` is set to true, it allows sorting of grid records when column header is clicked.
746
- *
747
- * > Check the [`Sorting`](../../grid/sorting/) to customize its default behavior.
748
- * {% codeBlock src='grid/allowSorting/index.md' %}{% endcodeBlock %}
749
- * @default false
750
- */
751
- allowSorting?: boolean;
738
+ * Configures the search behavior in the Grid.
739
+ * {% codeBlock src='grid/searchSettings/index.md' %}{% endcodeBlock %}
740
+ * @default { ignoreCase: true, fields: [], operator: 'contains', key: '' }
741
+ */
742
+ searchSettings?: SearchSettingsModel;
752
743
 
753
744
  /**
754
- * Defines the mode of clip. The available modes are,
755
- * `Clip`: Truncates the cell content when it overflows its area.
756
- * `Ellipsis`: Displays ellipsis when the cell content overflows its area.
757
- * `EllipsisWithTooltip`: Displays ellipsis when the cell content overflows its area,
758
- * also it will display the tooltip while hover on ellipsis is applied..
759
- * {% codeBlock src='grid/clipMode/index.md' %}{% endcodeBlock %}
760
- * @default Ellipsis
761
- */
762
- clipMode?: ClipMode;
745
+ * If `allowSorting` is set to true, it allows sorting of grid records when column header is clicked.
746
+ *
747
+ * > Check the [`Sorting`](../../grid/sorting/) to customize its default behavior.
748
+ * {% codeBlock src='grid/allowSorting/index.md' %}{% endcodeBlock %}
749
+ * @default false
750
+ */
751
+ allowSorting?: boolean;
763
752
 
764
753
  /**
765
- * If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the grid.
766
- * > `allowSorting` should be true.
767
- * {% codeBlock src='grid/allowMultiSorting/index.md' %}{% endcodeBlock %}
768
- * @default false
769
- */
770
- allowMultiSorting?: boolean;
754
+ * Defines the mode of clip. The available modes are,
755
+ * `Clip`: Truncates the cell content when it overflows its area.
756
+ * `Ellipsis`: Displays ellipsis when the cell content overflows its area.
757
+ * `EllipsisWithTooltip`: Displays ellipsis when the cell content overflows its area,
758
+ * also it will display the tooltip while hover on ellipsis is applied..
759
+ * {% codeBlock src='grid/clipMode/index.md' %}{% endcodeBlock %}
760
+ * @default Ellipsis
761
+ */
762
+ clipMode?: ClipMode;
771
763
 
772
764
  /**
773
- * If `allowExcelExport` set to true, then it will allow the user to export grid to Excel file.
774
- *
775
- * > Check the [`ExcelExport`](../../grid/excel-exporting/) to configure exporting document.
776
- * {% codeBlock src='grid/allowExcelExport/index.md' %}{% endcodeBlock %}
777
- * @default false
778
- */
779
- allowExcelExport?: boolean;
765
+ * If `allowMultiSorting` set to true, then it will allow the user to sort multiple column in the grid.
766
+ * > `allowSorting` should be true.
767
+ * {% codeBlock src='grid/allowMultiSorting/index.md' %}{% endcodeBlock %}
768
+ * @default false
769
+ */
770
+ allowMultiSorting?: boolean;
780
771
 
781
772
  /**
782
- * If `allowPdfExport` set to true, then it will allow the user to export grid to Pdf file.
783
- *
784
- * > Check the [`Pdfexport`](../../grid/pdf-export/) to configure the exporting document.
785
- * {% codeBlock src='grid/allowPdfExport/index.md' %}{% endcodeBlock %}
786
- * @default false
787
- */
788
- allowPdfExport?: boolean;
773
+ * If `allowExcelExport` set to true, then it will allow the user to export grid to Excel file.
774
+ *
775
+ * > Check the [`ExcelExport`](../../grid/excel-exporting/) to configure exporting document.
776
+ * {% codeBlock src='grid/allowExcelExport/index.md' %}{% endcodeBlock %}
777
+ * @default false
778
+ */
779
+ allowExcelExport?: boolean;
789
780
 
790
781
  /**
791
- * Configures the sort settings.
792
- * {% codeBlock src='grid/sortSettings/index.md' %}{% endcodeBlock %}
793
- * @default {columns:[]}
794
- */
795
- sortSettings?: SortSettingsModel;
782
+ * If `allowPdfExport` set to true, then it will allow the user to export grid to Pdf file.
783
+ *
784
+ * > Check the [`Pdfexport`](../../grid/pdf-export/) to configure the exporting document.
785
+ * {% codeBlock src='grid/allowPdfExport/index.md' %}{% endcodeBlock %}
786
+ * @default false
787
+ */
788
+ allowPdfExport?: boolean;
796
789
 
797
790
  /**
798
- * Configures the infinite scroll settings.
799
- * {% codeBlock src='grid/infiniteScrollSettings/index.md' %}{% endcodeBlock %}
800
- * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
801
-
802
- */
803
- infiniteScrollSettings?: InfiniteScrollSettingsModel;
791
+ * Configures the sort settings.
792
+ * {% codeBlock src='grid/sortSettings/index.md' %}{% endcodeBlock %}
793
+ * @default {columns:[]}
794
+ */
795
+ sortSettings?: SortSettingsModel;
796
+
797
+ /**
798
+ * Configures the infinite scroll settings.
799
+ * {% codeBlock src='grid/infiniteScrollSettings/index.md' %}{% endcodeBlock %}
800
+ * @default { enableCache: false, maxBlocks: 5, initialBlocks: 5 }
801
+ * @deprecated
802
+ */
803
+ infiniteScrollSettings?: InfiniteScrollSettingsModel;
804
804
 
805
- /**
806
- * If `allowSelection` is set to true, it allows selection of (highlight row) Grid records by clicking it.
807
- * {% codeBlock src='grid/allowSelection/index.md' %}{% endcodeBlock %}
808
- * @default true
809
- */
810
- allowSelection?: boolean;
805
+ /**
806
+ * If `allowSelection` is set to true, it allows selection of (highlight row) Grid records by clicking it.
807
+ * {% codeBlock src='grid/allowSelection/index.md' %}{% endcodeBlock %}
808
+ * @default true
809
+ */
810
+ allowSelection?: boolean;
811
811
 
812
- /**
813
- * The `selectedRowIndex` allows you to select a row at initial rendering.
814
- * You can also get the currently selected row index.
815
- * {% codeBlock src='grid/selectedRowIndex/index.md' %}{% endcodeBlock %}
816
- * @default -1
817
- */
818
- selectedRowIndex?: number;
812
+ /**
813
+ * The `selectedRowIndex` allows you to select a row at initial rendering.
814
+ * You can also get the currently selected row index.
815
+ * {% codeBlock src='grid/selectedRowIndex/index.md' %}{% endcodeBlock %}
816
+ * @default -1
817
+ */
818
+ selectedRowIndex?: number;
819
819
 
820
- /**
821
- * Configures the selection settings.
822
- * {% codeBlock src='grid/selectionSettings/index.md' %}{% endcodeBlock %}
823
- * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
824
- */
825
- selectionSettings?: SelectionSettingsModel;
820
+ /**
821
+ * Configures the selection settings.
822
+ * {% codeBlock src='grid/selectionSettings/index.md' %}{% endcodeBlock %}
823
+ * @default {mode: 'Row', cellSelectionMode: 'Flow', type: 'Single'}
824
+ */
825
+ selectionSettings?: SelectionSettingsModel;
826
826
 
827
827
  /**
828
- * If `allowFiltering` set to true the filter bar will be displayed.
829
- * If set to false the filter bar will not be displayed.
830
- * Filter bar allows the user to filter grid records with required criteria.
831
- *
832
- * > Check the [`Filtering`](../../grid/filtering/) to customize its default behavior.
833
- * {% codeBlock src='grid/allowFiltering/index.md' %}{% endcodeBlock %}
834
- * @default false
835
- */
836
- allowFiltering?: boolean;
828
+ * If `allowFiltering` set to true the filter bar will be displayed.
829
+ * If set to false the filter bar will not be displayed.
830
+ * Filter bar allows the user to filter grid records with required criteria.
831
+ *
832
+ * > Check the [`Filtering`](../../grid/filtering/) to customize its default behavior.
833
+ * {% codeBlock src='grid/allowFiltering/index.md' %}{% endcodeBlock %}
834
+ * @default false
835
+ */
836
+ allowFiltering?: boolean;
837
837
 
838
838
  /**
839
- * If `allowReordering` is set to true, Grid columns can be reordered.
840
- * Reordering can be done by drag and drop of a particular column from one index to another index.
841
- * > If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
842
- * {% codeBlock src='grid/allowReordering/index.md' %}{% endcodeBlock %}
843
- * @default false
844
- */
845
- allowReordering?: boolean;
839
+ * If `allowReordering` is set to true, Grid columns can be reordered.
840
+ * Reordering can be done by drag and drop of a particular column from one index to another index.
841
+ * > If Grid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.
842
+ * {% codeBlock src='grid/allowReordering/index.md' %}{% endcodeBlock %}
843
+ * @default false
844
+ */
845
+ allowReordering?: boolean;
846
846
 
847
847
  /**
848
- * If `allowResizing` is set to true, Grid columns can be resized.
849
- * {% codeBlock src='grid/allowResizing/index.md' %}{% endcodeBlock %}
850
- * @default false
851
- */
852
- allowResizing?: boolean;
848
+ * If `allowResizing` is set to true, Grid columns can be resized.
849
+ * {% codeBlock src='grid/allowResizing/index.md' %}{% endcodeBlock %}
850
+ * @default false
851
+ */
852
+ allowResizing?: boolean;
853
853
 
854
854
  /**
855
- * If `allowRowDragAndDrop` is set to true, you can drag and drop grid rows at another grid.
856
- * {% codeBlock src='grid/allowRowDragAndDrop/index.md' %}{% endcodeBlock %}
857
- * @default false
858
- */
859
- allowRowDragAndDrop?: boolean;
855
+ * If `allowRowDragAndDrop` is set to true, you can drag and drop grid rows at another grid.
856
+ * {% codeBlock src='grid/allowRowDragAndDrop/index.md' %}{% endcodeBlock %}
857
+ * @default false
858
+ */
859
+ allowRowDragAndDrop?: boolean;
860
860
 
861
861
  /**
862
- * Configures the row drop settings.
863
- * @default {targetID: ''}
864
- */
865
- rowDropSettings?: RowDropSettingsModel;
862
+ * Configures the row drop settings.
863
+ * @default {targetID: ''}
864
+ */
865
+ rowDropSettings?: RowDropSettingsModel;
866
866
 
867
867
  /**
868
- * Configures the filter settings of the Grid.
869
- * {% codeBlock src='grid/filterSettings/index.md' %}{% endcodeBlock %}
870
- * @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
871
- */
872
- filterSettings?: FilterSettingsModel;
868
+ * Configures the filter settings of the Grid.
869
+ * {% codeBlock src='grid/filterSettings/index.md' %}{% endcodeBlock %}
870
+ * @default {columns: [], type: 'FilterBar', mode: 'Immediate', showFilterBarStatus: true, immediateModeDelay: 1500 , operators: {}}
871
+ */
872
+ filterSettings?: FilterSettingsModel;
873
873
 
874
874
  /**
875
- * If `allowGrouping` set to true, then it will allow the user to dynamically group or ungroup columns.
876
- * Grouping can be done by drag and drop columns from column header to group drop area.
877
- *
878
- * > Check the [`Grouping`](../../grid/grouping/) to customize its default behavior.
879
- * {% codeBlock src='grid/allowGrouping/index.md' %}{% endcodeBlock %}
880
- * @default false
881
- */
882
- allowGrouping?: boolean;
875
+ * If `allowGrouping` set to true, then it will allow the user to dynamically group or ungroup columns.
876
+ * Grouping can be done by drag and drop columns from column header to group drop area.
877
+ *
878
+ * > Check the [`Grouping`](../../grid/grouping/) to customize its default behavior.
879
+ * {% codeBlock src='grid/allowGrouping/index.md' %}{% endcodeBlock %}
880
+ * @default false
881
+ */
882
+ allowGrouping?: boolean;
883
883
 
884
884
  /**
885
- * If `enableImmutableMode` is set to true, the grid will reuse old rows if it exists in the new result instead of
886
- * full refresh while performing the grid actions.
887
- * @default false
888
- */
889
- enableImmutableMode?: boolean;
885
+ * If `enableImmutableMode` is set to true, the grid will reuse old rows if it exists in the new result instead of
886
+ * full refresh while performing the grid actions.
887
+ * @default false
888
+ */
889
+ enableImmutableMode?: boolean;
890
890
 
891
891
  /**
892
- * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
893
- *
894
- * > Check the [`Column menu`](../../grid/columns/#column-menu/) for its configuration.
895
- * {% codeBlock src='grid/showColumnMenu/index.md' %}{% endcodeBlock %}
896
- * @default false
897
- */
898
- showColumnMenu?: boolean;
892
+ * If `showColumnMenu` set to true, then it will enable the column menu options in each columns.
893
+ *
894
+ * > Check the [`Column menu`](../../grid/columns/#column-menu/) for its configuration.
895
+ * {% codeBlock src='grid/showColumnMenu/index.md' %}{% endcodeBlock %}
896
+ * @default false
897
+ */
898
+ showColumnMenu?: boolean;
899
899
 
900
900
  /**
901
- * Configures the group settings.
902
- * {% codeBlock src='grid/groupSettings/index.md' %}{% endcodeBlock %}
903
- * @default {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}
904
- */
905
- groupSettings?: GroupSettingsModel;
901
+ * Configures the group settings.
902
+ * {% codeBlock src='grid/groupSettings/index.md' %}{% endcodeBlock %}
903
+ * @default {showDropArea: true, showToggleButton: false, showGroupedColumn: false, showUngroupButton: true, columns: []}
904
+ */
905
+ groupSettings?: GroupSettingsModel;
906
906
 
907
907
  /**
908
- * Configures the edit settings.
909
- * {% codeBlock src='grid/editSettings/index.md' %}{% endcodeBlock %}
910
- * @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
911
- * allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
912
- */
913
- editSettings?: EditSettingsModel;
908
+ * Configures the edit settings.
909
+ * {% codeBlock src='grid/editSettings/index.md' %}{% endcodeBlock %}
910
+ * @default { allowAdding: false, allowEditing: false, allowDeleting: false, mode:'Normal',
911
+ * allowEditOnDblClick: true, showConfirmDialog: true, showDeleteConfirmDialog: false }
912
+ */
913
+ editSettings?: EditSettingsModel;
914
914
 
915
915
  /**
916
- * Configures the Grid aggregate rows.
917
- * {% codeBlock src='grid/aggregates/index.md' %}{% endcodeBlock %}
918
- * > Check the [`Aggregates`](../../grid/aggregates/) for its configuration.
919
- * @default []
920
- */
921
- aggregates?: AggregateRowModel[];
916
+ * Configures the Grid aggregate rows.
917
+ * {% codeBlock src='grid/aggregates/index.md' %}{% endcodeBlock %}
918
+ * > Check the [`Aggregates`](../../grid/aggregates/) for its configuration.
919
+ * @default []
920
+ */
921
+ aggregates?: AggregateRowModel[];
922
922
 
923
923
  /**
924
- * If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
925
- *
926
- * > Check the [`ColumnChooser`](../../grid/columns/#column-chooser/) for its configuration.
927
- * {% codeBlock src='grid/showColumnChooser/index.md' %}{% endcodeBlock %}
928
- * @default false
929
- */
930
- showColumnChooser?: boolean;
931
-
932
- /**
933
- * Configures the column chooser in the Grid.
934
- * @default { columnChooserOperator: 'startsWith' }
935
-      */
936
- columnChooserSettings?: ColumnChooserSettingsModel;
937
-
938
- /**
939
- * If `enableHeaderFocus` set to true, then header element will be focused when focus moves to grid.
940
- * @default false
941
- */
942
- enableHeaderFocus?: boolean;
924
+ * If `showColumnChooser` is set to true, it allows you to dynamically show or hide columns.
925
+ *
926
+ * > Check the [`ColumnChooser`](../../grid/columns/#column-chooser/) for its configuration.
927
+ * {% codeBlock src='grid/showColumnChooser/index.md' %}{% endcodeBlock %}
928
+ * @default false
929
+ */
930
+ showColumnChooser?: boolean;
931
+
932
+ /**
933
+ * Configures the column chooser in the Grid.
934
+ * @default { columnChooserOperator: 'startsWith' }
935
+      */
936
+ columnChooserSettings?: ColumnChooserSettingsModel;
937
+
938
+ /**
939
+ * If `enableHeaderFocus` set to true, then header element will be focused when focus moves to grid.
940
+ * @default false
941
+ */
942
+ enableHeaderFocus?: boolean;
943
943
 
944
944
  /**
945
- * Defines the scrollable height of the grid content.
946
- * {% codeBlock src='grid/height/index.md' %}{% endcodeBlock %}
947
- * @default 'auto'
948
- */
949
- height?: string | number;
950
-
951
- /**
952
- * Defines the Grid width.
953
- * {% codeBlock src='grid/width/index.md' %}{% endcodeBlock %}
954
- * @default 'auto'
955
- */
956
- width?: string | number;
957
-
958
- /**
959
- * Defines the mode of grid lines. The available modes are,
960
- * * `Both`: Displays both horizontal and vertical grid lines.
961
- * * `None`: No grid lines are displayed.
962
- * * `Horizontal`: Displays the horizontal grid lines only.
963
- * * `Vertical`: Displays the vertical grid lines only.
964
- * * `Default`: Displays grid lines based on the theme.
965
- * {% codeBlock src='grid/gridLines/index.md' %}{% endcodeBlock %}
966
- * @default Default
967
- */
968
- gridLines?: GridLine;
969
-
970
- /**
971
- * The row template that renders customized rows from the given template.
972
- * By default, Grid renders a table row for every data source item.
973
- * > * It accepts either [template string](../../common/template-engine/) or HTML element ID.
974
- * > * The row template must be a table row.
975
- *
976
- * > Check the [`Row Template`](../../grid/row/) customization.
977
- */
978
- rowTemplate?: string;
979
-
980
- /**
981
- * The detail template allows you to show or hide additional information about a particular row.
982
- *
983
- * > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
984
- *
985
- * {% codeBlock src="grid/detail-template-api/index.ts" %}{% endcodeBlock %}
986
- */
987
- detailTemplate?: string;
988
-
989
- /**
990
- * Defines Grid options to render child Grid.
991
- * It requires the [`queryString`](/#querystring) for parent
992
- * and child relationship.
993
- *
994
- * > Check the [`Child Grid`](../../grid/hierarchy-grid/) for its configuration.
995
- * @blazorType GridModel<object>
996
- */
997
- childGrid?: GridModel;
998
-
999
- /**
1000
- * Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
1001
- */
1002
- queryString?: string;
1003
-
1004
- /**
1005
- * Defines the print modes. The available print modes are
1006
- * * `AllPages`: Prints all pages of the Grid.
1007
- * * `CurrentPage`: Prints the current page of the Grid.
1008
- * {% codeBlock src='grid/printMode/index.md' %}{% endcodeBlock %}
1009
- * @default AllPages
1010
- */
1011
- printMode?: PrintMode;
1012
-
1013
- /**
1014
- * Defines the hierarchy grid print modes. The available modes are
1015
- * * `Expanded` - Prints the master grid with expanded child grids.
1016
- * * `All` - Prints the master grid with all the child grids.
1017
- * * `None` - Prints the master grid alone.
1018
- * @default Expanded
1019
- */
1020
- hierarchyPrintMode?: HierarchyGridPrintMode;
1021
-
1022
- /**
1023
- * It is used to render grid table rows.
1024
- * If the `dataSource` is an array of JavaScript objects,
1025
- * then Grid will create instance of [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/)
1026
- * from this `dataSource`.
1027
- * If the `dataSource` is an existing [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/),
1028
- * the Grid will not initialize a new one.
1029
- *
1030
- * > Check the available [`Adaptors`](../../data/adaptors/) to customize the data operation.
1031
- * {% codeBlock src='grid/dataSource/index.md' %}{% endcodeBlock %}
1032
- * @default []
1033
- * @isGenericType true
1034
- */
1035
- dataSource?: Object | DataManager | DataResult;
1036
-
1037
- /**
1038
- * Defines the height of Grid rows.
1039
- * {% codeBlock src='grid/rowHeight/index.md' %}{% endcodeBlock %}
1040
- * @default null
1041
- */
1042
- rowHeight?: number;
1043
-
1044
- /**
1045
- * Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
1046
- * that will be executed along with data processing.
1047
- * {% codeBlock src='grid/query/index.md' %}{% endcodeBlock %}
1048
- * @default null
1049
- * @blazorType Syncfusion.Blazor.Data.Query
1050
- */
1051
- query?: Query;
1052
-
1053
- /**
1054
- * Defines the currencyCode format of the Grid columns
1055
- * @private
1056
- */
1057
- currencyCode?: string;
1058
-
1059
- /**
1060
- * `toolbar` defines the ToolBar items of the Grid.
1061
- * It contains built-in and custom toolbar items.
1062
- * If a string value is assigned to the `toolbar` option, it is considered as the template for the whole Grid ToolBar.
1063
- * If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid's Toolbar.
1064
- * <br><br>
1065
- * The available built-in ToolBar items are:
1066
- * * Add: Adds a new record.
1067
- * * Edit: Edits the selected record.
1068
- * * Update: Updates the edited record.
1069
- * * Delete: Deletes the selected record.
1070
- * * Cancel: Cancels the edit state.
1071
- * * Search: Searches records by the given key.
1072
- * * Print: Prints the Grid.
1073
- * * ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
1074
- * * PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
1075
- * * CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)<br><br>
1076
- * The following code example implements the custom toolbar items.
1077
- *
1078
- * > Check the [`Toolbar`](../../grid/tool-bar/#custom-toolbar-items/) to customize its default items.
1079
- *
1080
- * {% codeBlock src="grid/toolbar-api/index.ts" %}{% endcodeBlock %}
1081
- * {% codeBlock src='grid/toolbar/index.md' %}{% endcodeBlock %}
1082
- * @default null
1083
- */
1084
- toolbar?: (ToolbarItems | string | ItemModel | ToolbarItem)[];
1085
-
1086
- /**
1087
- * `contextMenuItems` defines both built-in and custom context menu items.
1088
- * <br><br>
1089
- * The available built-in items are,
1090
- * * `AutoFitAll` - Auto fit the size of all columns.
1091
- * * `AutoFit` - Auto fit the current column.
1092
- * * `Group` - Group by current column.
1093
- * * `Ungroup` - Ungroup by current column.
1094
- * * `Edit` - Edit the current record.
1095
- * * `Delete` - Delete the current record.
1096
- * * `Save` - Save the edited record.
1097
- * * `Cancel` - Cancel the edited state.
1098
- * * `Copy` - Copy the selected records.
1099
- * * `PdfExport` - Export the grid as Pdf format.
1100
- * * `ExcelExport` - Export the grid as Excel format.
1101
- * * `CsvExport` - Export the grid as CSV format.
1102
- * * `SortAscending` - Sort the current column in ascending order.
1103
- * * `SortDescending` - Sort the current column in descending order.
1104
- * * `FirstPage` - Go to the first page.
1105
- * * `PrevPage` - Go to the previous page.
1106
- * * `LastPage` - Go to the last page.
1107
- * * `NextPage` - Go to the next page.
1108
- *
1109
- * @default null
1110
- */
1111
- contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
1112
-
1113
- /**
1114
- * `columnMenuItems` defines both built-in and custom column menu items.
1115
- * <br><br>
1116
- * The available built-in items are,
1117
- * * `AutoFitAll` - Auto fit the size of all columns.
1118
- * * `AutoFit` - Auto fit the current column.
1119
- * * `Group` - Group by current column.
1120
- * * `Ungroup` - Ungroup by current column.
1121
- * * `SortAscending` - Sort the current column in ascending order.
1122
- * * `SortDescending` - Sort the current column in descending order.
1123
- * * `Filter` - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.
1124
- * @default null
1125
- */
1126
- columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
1127
-
1128
- /**
1129
- * It used to render toolbar template
1130
- * @default null
1131
- */
1132
- toolbarTemplate?: string;
1133
-
1134
- /**
1135
- * It used to render pager template
1136
- * @default null
1137
- */
1138
- pagerTemplate?: string;
1139
-
1140
- /**
1141
- * Gets or sets the number of frozen rows.
1142
- * {% codeBlock src='grid/frozenRows/index.md' %}{% endcodeBlock %}
1143
- * @default 0
1144
- */
1145
- frozenRows?: number;
1146
-
1147
- /**
1148
- * Gets or sets the number of frozen columns.
1149
- * {% codeBlock src='grid/frozenColumns/index.md' %}{% endcodeBlock %}
1150
- * @default 0
1151
- */
1152
- frozenColumns?: number;
1153
-
1154
- /**
1155
- * `columnQueryMode`provides options to retrive data from the datasource.Their types are
1156
- * * `All`: It Retrives whole datasource.
1157
- * * `Schema`: Retrives data for all the defined columns in grid from the datasource.
1158
- * * `ExcludeHidden`: Retrives data only for visible columns of grid from the dataSource.
1159
- * @default All
1160
- */
1161
- columnQueryMode?: ColumnQueryModeType;
1162
-
1163
- /**
1164
- * Gets or sets the current action details.
1165
- * @default {}
1166
- */
1167
- currentAction?: ActionArgs;
1168
-
1169
- /**
1170
-      * Triggers when the component is created.
1171
-      * @event
1172
- * @blazorProperty 'Created'
1173
-      */
1174
- created?: EmitType<Object>;
1175
-
1176
- /**
1177
-      * Triggers when the component is destroyed.
1178
-      * @event
1179
- * @blazorProperty 'Destroyed'
1180
-      */
1181
- destroyed?: EmitType<Object>;
1182
-
945
+ * Defines the scrollable height of the grid content.
946
+ * {% codeBlock src='grid/height/index.md' %}{% endcodeBlock %}
947
+ * @default 'auto'
948
+ */
949
+ height?: string | number;
950
+
951
+ /**
952
+ * Defines the Grid width.
953
+ * {% codeBlock src='grid/width/index.md' %}{% endcodeBlock %}
954
+ * @default 'auto'
955
+ */
956
+ width?: string | number;
957
+
958
+ /**
959
+ * Defines the mode of grid lines. The available modes are,
960
+ * * `Both`: Displays both horizontal and vertical grid lines.
961
+ * * `None`: No grid lines are displayed.
962
+ * * `Horizontal`: Displays the horizontal grid lines only.
963
+ * * `Vertical`: Displays the vertical grid lines only.
964
+ * * `Default`: Displays grid lines based on the theme.
965
+ * {% codeBlock src='grid/gridLines/index.md' %}{% endcodeBlock %}
966
+ * @default Default
967
+ */
968
+ gridLines?: GridLine;
969
+
970
+ /**
971
+ * The row template that renders customized rows from the given template.
972
+ * By default, Grid renders a table row for every data source item.
973
+ * > * It accepts either [template string](../../common/template-engine/) or HTML element ID.
974
+ * > * The row template must be a table row.
975
+ *
976
+ * > Check the [`Row Template`](../../grid/row/) customization.
977
+ */
978
+ rowTemplate?: string;
979
+
980
+ /**
981
+ * The detail template allows you to show or hide additional information about a particular row.
982
+ *
983
+ * > It accepts either the [template string](../../common/template-engine/) or the HTML element ID.
984
+ *
985
+ * {% codeBlock src="grid/detail-template-api/index.ts" %}{% endcodeBlock %}
986
+ */
987
+ detailTemplate?: string;
988
+
989
+ /**
990
+ * Defines Grid options to render child Grid.
991
+ * It requires the [`queryString`](/#querystring) for parent
992
+ * and child relationship.
993
+ *
994
+ * > Check the [`Child Grid`](../../grid/hierarchy-grid/) for its configuration.
995
+ * @blazorType GridModel<object>
996
+ */
997
+ childGrid?: GridModel;
998
+
999
+ /**
1000
+ * Defines the relationship between parent and child datasource. It acts as the foreign key for parent datasource.
1001
+ */
1002
+ queryString?: string;
1003
+
1004
+ /**
1005
+ * Defines the print modes. The available print modes are
1006
+ * * `AllPages`: Prints all pages of the Grid.
1007
+ * * `CurrentPage`: Prints the current page of the Grid.
1008
+ * {% codeBlock src='grid/printMode/index.md' %}{% endcodeBlock %}
1009
+ * @default AllPages
1010
+ */
1011
+ printMode?: PrintMode;
1012
+
1013
+ /**
1014
+ * Defines the hierarchy grid print modes. The available modes are
1015
+ * * `Expanded` - Prints the master grid with expanded child grids.
1016
+ * * `All` - Prints the master grid with all the child grids.
1017
+ * * `None` - Prints the master grid alone.
1018
+ * @default Expanded
1019
+ */
1020
+ hierarchyPrintMode?: HierarchyGridPrintMode;
1021
+
1022
+ /**
1023
+ * It is used to render grid table rows.
1024
+ * If the `dataSource` is an array of JavaScript objects,
1025
+ * then Grid will create instance of [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/)
1026
+ * from this `dataSource`.
1027
+ * If the `dataSource` is an existing [`DataManager`](https://ej2.syncfusion.com/documentation/api/data/dataManager/),
1028
+ * the Grid will not initialize a new one.
1029
+ *
1030
+ * > Check the available [`Adaptors`](../../data/adaptors/) to customize the data operation.
1031
+ * {% codeBlock src='grid/dataSource/index.md' %}{% endcodeBlock %}
1032
+ * @default []
1033
+ * @isGenericType true
1034
+ */
1035
+ dataSource?: Object | DataManager | DataResult;
1036
+
1037
+ /**
1038
+ * Defines the height of Grid rows.
1039
+ * {% codeBlock src='grid/rowHeight/index.md' %}{% endcodeBlock %}
1040
+ * @default null
1041
+ */
1042
+ rowHeight?: number;
1043
+
1044
+ /**
1045
+ * Defines the external [`Query`](https://ej2.syncfusion.com/documentation/data/api-query.html)
1046
+ * that will be executed along with data processing.
1047
+ * {% codeBlock src='grid/query/index.md' %}{% endcodeBlock %}
1048
+ * @default null
1049
+ * @blazorType Syncfusion.Blazor.Data.Query
1050
+ */
1051
+ query?: Query;
1052
+
1053
+ /**
1054
+ * Defines the currencyCode format of the Grid columns
1055
+ * @private
1056
+ */
1057
+ currencyCode?: string;
1058
+
1059
+ /**
1060
+ * `toolbar` defines the ToolBar items of the Grid.
1061
+ * It contains built-in and custom toolbar items.
1062
+ * If a string value is assigned to the `toolbar` option, it is considered as the template for the whole Grid ToolBar.
1063
+ * If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the Grid's Toolbar.
1064
+ * <br><br>
1065
+ * The available built-in ToolBar items are:
1066
+ * * Add: Adds a new record.
1067
+ * * Edit: Edits the selected record.
1068
+ * * Update: Updates the edited record.
1069
+ * * Delete: Deletes the selected record.
1070
+ * * Cancel: Cancels the edit state.
1071
+ * * Search: Searches records by the given key.
1072
+ * * Print: Prints the Grid.
1073
+ * * ExcelExport - Export the Grid to Excel(excelExport() method manually to make export.)
1074
+ * * PdfExport - Export the Grid to PDF(pdfExport() method manually to make export.)
1075
+ * * CsvExport - Export the Grid to CSV(csvExport() method manually to make export.)<br><br>
1076
+ * The following code example implements the custom toolbar items.
1077
+ *
1078
+ * > Check the [`Toolbar`](../../grid/tool-bar/#custom-toolbar-items/) to customize its default items.
1079
+ *
1080
+ * {% codeBlock src="grid/toolbar-api/index.ts" %}{% endcodeBlock %}
1081
+ * {% codeBlock src='grid/toolbar/index.md' %}{% endcodeBlock %}
1082
+ * @default null
1083
+ */
1084
+ toolbar?: (ToolbarItems | string | ItemModel | ToolbarItem)[];
1085
+
1086
+ /**
1087
+ * `contextMenuItems` defines both built-in and custom context menu items.
1088
+ * <br><br>
1089
+ * The available built-in items are,
1090
+ * * `AutoFitAll` - Auto fit the size of all columns.
1091
+ * * `AutoFit` - Auto fit the current column.
1092
+ * * `Group` - Group by current column.
1093
+ * * `Ungroup` - Ungroup by current column.
1094
+ * * `Edit` - Edit the current record.
1095
+ * * `Delete` - Delete the current record.
1096
+ * * `Save` - Save the edited record.
1097
+ * * `Cancel` - Cancel the edited state.
1098
+ * * `Copy` - Copy the selected records.
1099
+ * * `PdfExport` - Export the grid as Pdf format.
1100
+ * * `ExcelExport` - Export the grid as Excel format.
1101
+ * * `CsvExport` - Export the grid as CSV format.
1102
+ * * `SortAscending` - Sort the current column in ascending order.
1103
+ * * `SortDescending` - Sort the current column in descending order.
1104
+ * * `FirstPage` - Go to the first page.
1105
+ * * `PrevPage` - Go to the previous page.
1106
+ * * `LastPage` - Go to the last page.
1107
+ * * `NextPage` - Go to the next page.
1108
+ *
1109
+ * @default null
1110
+ */
1111
+ contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
1112
+
1113
+ /**
1114
+ * `columnMenuItems` defines both built-in and custom column menu items.
1115
+ * <br><br>
1116
+ * The available built-in items are,
1117
+ * * `AutoFitAll` - Auto fit the size of all columns.
1118
+ * * `AutoFit` - Auto fit the current column.
1119
+ * * `Group` - Group by current column.
1120
+ * * `Ungroup` - Ungroup by current column.
1121
+ * * `SortAscending` - Sort the current column in ascending order.
1122
+ * * `SortDescending` - Sort the current column in descending order.
1123
+ * * `Filter` - Filter options will show based on filterSettings property like checkbox filter, excel filter, menu filter.
1124
+ * @default null
1125
+ */
1126
+ columnMenuItems?: ColumnMenuItem[] | ColumnMenuItemModel[];
1127
+
1128
+ /**
1129
+ * It used to render toolbar template
1130
+ * @default null
1131
+ */
1132
+ toolbarTemplate?: string;
1133
+
1134
+ /**
1135
+ * It used to render pager template
1136
+ * @default null
1137
+ */
1138
+ pagerTemplate?: string;
1139
+
1140
+ /**
1141
+ * Gets or sets the number of frozen rows.
1142
+ * {% codeBlock src='grid/frozenRows/index.md' %}{% endcodeBlock %}
1143
+ * @default 0
1144
+ */
1145
+ frozenRows?: number;
1146
+
1147
+ /**
1148
+ * Gets or sets the number of frozen columns.
1149
+ * {% codeBlock src='grid/frozenColumns/index.md' %}{% endcodeBlock %}
1150
+ * @default 0
1151
+ */
1152
+ frozenColumns?: number;
1153
+
1154
+ /**
1155
+ * `columnQueryMode`provides options to retrive data from the datasource.Their types are
1156
+ * * `All`: It Retrives whole datasource.
1157
+ * * `Schema`: Retrives data for all the defined columns in grid from the datasource.
1158
+ * * `ExcludeHidden`: Retrives data only for visible columns of grid from the dataSource.
1159
+ * @default All
1160
+ */
1161
+ columnQueryMode?: ColumnQueryModeType;
1162
+
1163
+ /**
1164
+ * Gets or sets the current action details.
1165
+ * @default {}
1166
+ */
1167
+ currentAction?: ActionArgs;
1168
+
1169
+ /**
1170
+      * Triggers when the component is created.
1171
+      * @event
1172
+ * @blazorProperty 'Created'
1173
+      */
1174
+ created?: EmitType<Object>;
1175
+
1176
+ /**
1177
+      * Triggers when the component is destroyed.
1178
+      * @event
1179
+ * @blazorProperty 'Destroyed'
1180
+      */
1181
+ destroyed?: EmitType<Object>;
1182
+
1183
1183
  /**
1184
- * This event allows customization of Grid properties before rendering.
1185
-      * @event
1186
- * @blazorProperty 'OnLoad'
1187
-      */
1188
- load?: EmitType<Object>;
1189
-
1184
+ * This event allows customization of Grid properties before rendering.
1185
+      * @event
1186
+ * @blazorProperty 'OnLoad'
1187
+      */
1188
+ load?: EmitType<Object>;
1189
+
1190
1190
  /**
1191
-      * Triggered every time a request is made to access row information, element, or data.
1192
-      * This will be triggered before the row element is appended to the Grid element.
1193
- * @event
1194
- * @blazorProperty 'RowDataBound'
1195
-      */
1196
- rowDataBound?: EmitType<RowDataBoundEventArgs>;
1191
+      * Triggered every time a request is made to access row information, element, or data.
1192
+      * This will be triggered before the row element is appended to the Grid element.
1193
+ * @event
1194
+ * @blazorProperty 'RowDataBound'
1195
+      */
1196
+ rowDataBound?: EmitType<RowDataBoundEventArgs>;
1197
1197
 
1198
1198
  /**
1199
-      * Triggered every time a request is made to access cell information, element, or data.
1200
- * This will be triggered before the cell element is appended to the Grid element.
1201
-      * @event
1202
- * @blazorProperty 'QueryCellInfo'
1203
-      */
1204
- queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
1199
+      * Triggered every time a request is made to access cell information, element, or data.
1200
+ * This will be triggered before the cell element is appended to the Grid element.
1201
+      * @event
1202
+ * @blazorProperty 'QueryCellInfo'
1203
+      */
1204
+ queryCellInfo?: EmitType<QueryCellInfoEventArgs>;
1205
1205
 
1206
1206
  /**
1207
-      * Triggered for stacked header.
1208
-      * @event
1209
- * @blazorProperty 'HeaderCellInfo'
1210
-      */
1211
- headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
1207
+      * Triggered for stacked header.
1208
+      * @event
1209
+ * @blazorProperty 'HeaderCellInfo'
1210
+      */
1211
+ headerCellInfo?: EmitType<HeaderCellInfoEventArgs>;
1212
1212
 
1213
1213
  /**
1214
-      * Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
1215
- * {% codeBlock src='grid/actionBegin/index.md' %}{% endcodeBlock %}
1216
-      * @event
1217
- * @blazorProperty 'OnActionBegin'
1218
-      */
1219
- actionBegin?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1214
+      * Triggers when Grid actions such as sorting, filtering, paging, grouping etc., starts.
1215
+ * {% codeBlock src='grid/actionBegin/index.md' %}{% endcodeBlock %}
1216
+      * @event
1217
+ * @blazorProperty 'OnActionBegin'
1218
+      */
1219
+ actionBegin?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1220
1220
 
1221
1221
  /**
1222
-      * Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
1223
-      * @event
1224
- * @blazorProperty 'OnActionComplete'
1225
-      */
1226
- actionComplete?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1222
+      * Triggers when Grid actions such as sorting, filtering, paging, grouping etc. are completed.
1223
+      * @event
1224
+ * @blazorProperty 'OnActionComplete'
1225
+      */
1226
+ actionComplete?: EmitType<PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs | AddEventArgs | SaveEventArgs | EditEventArgs | DeleteEventArgs | ActionEventArgs>;
1227
1227
 
1228
1228
  /**
1229
-      * Triggers when any Grid action failed to achieve the desired results.
1230
-      * @event
1231
- * @blazorProperty 'OnActionFailure'
1232
-      */
1233
- actionFailure?: EmitType<FailureEventArgs>;
1229
+      * Triggers when any Grid action failed to achieve the desired results.
1230
+      * @event
1231
+ * @blazorProperty 'OnActionFailure'
1232
+      */
1233
+ actionFailure?: EmitType<FailureEventArgs>;
1234
1234
 
1235
1235
  /**
1236
-      * Triggers when data source is populated in the Grid.
1237
-      * @event
1238
- * @blazorProperty 'DataBound'
1239
-      */
1240
- dataBound?: EmitType<Object>;
1236
+      * Triggers when data source is populated in the Grid.
1237
+      * @event
1238
+ * @blazorProperty 'DataBound'
1239
+      */
1240
+ dataBound?: EmitType<Object>;
1241
1241
 
1242
1242
  /**
1243
-      * Triggers when record is double clicked.
1244
-      * @event
1245
- * @blazorProperty 'OnRecordDoubleClick'
1246
-      */
1247
- recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
1243
+      * Triggers when record is double clicked.
1244
+      * @event
1245
+ * @blazorProperty 'OnRecordDoubleClick'
1246
+      */
1247
+ recordDoubleClick?: EmitType<RecordDoubleClickEventArgs>;
1248
1248
 
1249
1249
  /**
1250
-      * Triggers when record is clicked.
1251
-      * @event
1252
- * @blazorProperty 'OnRecordClick'
1253
-      */
1254
- recordClick?: EmitType<RecordClickEventArgs>;
1250
+      * Triggers when record is clicked.
1251
+      * @event
1252
+ * @blazorProperty 'OnRecordClick'
1253
+      */
1254
+ recordClick?: EmitType<RecordClickEventArgs>;
1255
1255
 
1256
1256
  /**
1257
-      * Triggers before row selection occurs.
1258
-      * @event
1259
- * @blazorProperty 'RowSelecting'
1260
-      */
1261
- rowSelecting?: EmitType<RowSelectingEventArgs>;
1257
+      * Triggers before row selection occurs.
1258
+      * @event
1259
+ * @blazorProperty 'RowSelecting'
1260
+      */
1261
+ rowSelecting?: EmitType<RowSelectingEventArgs>;
1262
1262
 
1263
1263
  /**
1264
-      * Triggers after a row is selected.
1265
-      * @event
1266
- * @blazorProperty 'RowSelected'
1267
-      */
1268
- rowSelected?: EmitType<RowSelectEventArgs>;
1264
+      * Triggers after a row is selected.
1265
+      * @event
1266
+ * @blazorProperty 'RowSelected'
1267
+      */
1268
+ rowSelected?: EmitType<RowSelectEventArgs>;
1269
1269
 
1270
1270
  /**
1271
-      * Triggers before deselecting the selected row.
1272
-      * @event
1273
-      */
1274
- rowDeselecting?: EmitType<RowDeselectEventArgs>;
1271
+      * Triggers before deselecting the selected row.
1272
+      * @event
1273
+      */
1274
+ rowDeselecting?: EmitType<RowDeselectEventArgs>;
1275
1275
 
1276
1276
  /**
1277
-      * Triggers when a selected row is deselected.
1278
-      * @event
1279
- * @blazorProperty 'RowDeselected'
1280
-      */
1281
- rowDeselected?: EmitType<RowDeselectEventArgs>;
1277
+      * Triggers when a selected row is deselected.
1278
+      * @event
1279
+ * @blazorProperty 'RowDeselected'
1280
+      */
1281
+ rowDeselected?: EmitType<RowDeselectEventArgs>;
1282
1282
 
1283
1283
  /**
1284
-      * Triggers before any cell selection occurs.
1285
-      * @event
1286
- * @blazorProperty 'CellSelecting'
1287
-      */
1288
- cellSelecting?: EmitType<CellSelectingEventArgs>;
1284
+      * Triggers before any cell selection occurs.
1285
+      * @event
1286
+ * @blazorProperty 'CellSelecting'
1287
+      */
1288
+ cellSelecting?: EmitType<CellSelectingEventArgs>;
1289
1289
 
1290
1290
  /**
1291
-      * Triggers after a cell is selected.
1292
-      * @event
1293
- * @blazorProperty 'CellSelected'
1294
-      */
1295
- cellSelected?: EmitType<CellSelectEventArgs>;
1291
+      * Triggers after a cell is selected.
1292
+      * @event
1293
+ * @blazorProperty 'CellSelected'
1294
+      */
1295
+ cellSelected?: EmitType<CellSelectEventArgs>;
1296
1296
 
1297
1297
  /**
1298
-      * Triggers before the selected cell is deselecting.
1299
-      * @event
1300
-
1301
-      */
1302
- cellDeselecting?: EmitType<CellDeselectEventArgs>;
1298
+      * Triggers before the selected cell is deselecting.
1299
+      * @event
1300
+ * @deprecated
1301
+      */
1302
+ cellDeselecting?: EmitType<CellDeselectEventArgs>;
1303
1303
 
1304
1304
  /**
1305
-      * Triggers when a particular selected cell is deselected.
1306
-      * @event
1307
-
1308
-      */
1309
- cellDeselected?: EmitType<CellDeselectEventArgs>;
1305
+      * Triggers when a particular selected cell is deselected.
1306
+      * @event
1307
+ * @deprecated
1308
+      */
1309
+ cellDeselected?: EmitType<CellDeselectEventArgs>;
1310
1310
 
1311
1311
  /**
1312
-      * Triggers when column header element drag (move) starts.
1313
-      * @event
1314
-
1315
-      */
1316
- columnDragStart?: EmitType<ColumnDragEventArgs>;
1312
+      * Triggers when column header element drag (move) starts.
1313
+      * @event
1314
+ * @deprecated
1315
+      */
1316
+ columnDragStart?: EmitType<ColumnDragEventArgs>;
1317
1317
 
1318
1318
  /**
1319
-      * Triggers when column header element is dragged (moved) continuously.
1320
-      * @event
1321
-
1322
-      */
1323
- columnDrag?: EmitType<ColumnDragEventArgs>;
1319
+      * Triggers when column header element is dragged (moved) continuously.
1320
+      * @event
1321
+ * @deprecated
1322
+      */
1323
+ columnDrag?: EmitType<ColumnDragEventArgs>;
1324
1324
 
1325
1325
  /**
1326
- * Triggers when a column header element is dropped on the target column.
1327
-      * @event
1328
-
1329
-      */
1330
- columnDrop?: EmitType<ColumnDragEventArgs>;
1326
+ * Triggers when a column header element is dropped on the target column.
1327
+      * @event
1328
+ * @deprecated
1329
+      */
1330
+ columnDrop?: EmitType<ColumnDragEventArgs>;
1331
1331
 
1332
1332
  /**
1333
- * Triggers after print action is completed.
1334
-      * @event
1335
-
1336
-      */
1337
- printComplete?: EmitType<PrintEventArgs>;
1333
+ * Triggers after print action is completed.
1334
+      * @event
1335
+ * @deprecated
1336
+      */
1337
+ printComplete?: EmitType<PrintEventArgs>;
1338
1338
 
1339
1339
  /**
1340
- * Triggers before the print action starts.
1341
-      * @event
1342
-
1343
-      */
1344
- beforePrint?: EmitType<PrintEventArgs>;
1340
+ * Triggers before the print action starts.
1341
+      * @event
1342
+ * @deprecated
1343
+      */
1344
+ beforePrint?: EmitType<PrintEventArgs>;
1345
1345
 
1346
1346
  /**
1347
- * Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
1348
-      * @event
1349
-
1350
-      */
1351
- pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
1347
+ * Triggers before exporting each cell to PDF document. You can also customize the PDF cells.
1348
+      * @event
1349
+ * @deprecated
1350
+      */
1351
+ pdfQueryCellInfo?: EmitType<PdfQueryCellInfoEventArgs>;
1352
1352
 
1353
1353
  /**
1354
- * Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
1355
-      * @event
1356
-
1357
-      */
1358
- pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1354
+ * Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.
1355
+      * @event
1356
+ * @deprecated
1357
+      */
1358
+ pdfHeaderQueryCellInfo?: EmitType<PdfHeaderQueryCellInfoEventArgs>;
1359
1359
 
1360
1360
  /**
1361
- * Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
1362
-      * @event
1363
-
1364
-      */
1365
- pdfAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1361
+ * Triggers before exporting aggregate cell to PDF document. You can also customize the PDF cells.
1362
+      * @event
1363
+ * @deprecated
1364
+      */
1365
+ pdfAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1366
1366
 
1367
1367
  /**
1368
- * Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
1369
- * @event
1370
-
1371
- */
1372
- excelAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1368
+ * Triggers before exporting aggregate cell to Excel document. You can also customize the PDF cells.
1369
+ * @event
1370
+ * @deprecated
1371
+ */
1372
+ excelAggregateQueryCellInfo?: EmitType<AggregateQueryCellInfoEventArgs>;
1373
1373
 
1374
1374
  /**
1375
- * Triggers before exporting each detail Grid to PDF document.
1376
-      * @event
1377
-
1378
-      */
1379
- exportDetailDataBound?: EmitType<ExportDetailDataBoundEventArgs>;
1375
+ * Triggers before exporting each detail Grid to PDF document.
1376
+      * @event
1377
+ * @deprecated
1378
+      */
1379
+ exportDetailDataBound?: EmitType<ExportDetailDataBoundEventArgs>;
1380
1380
 
1381
1381
  /**
1382
- * Triggers before exporting each cell to Excel file.
1383
- * You can also customize the Excel cells.
1384
- * @event
1385
-
1386
- */
1387
- excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
1382
+ * Triggers before exporting each cell to Excel file.
1383
+ * You can also customize the Excel cells.
1384
+ * @event
1385
+ * @deprecated
1386
+ */
1387
+ excelQueryCellInfo?: EmitType<ExcelQueryCellInfoEventArgs>;
1388
1388
 
1389
1389
  /**
1390
- * Triggers before exporting each header cell to Excel file.
1391
- * You can also customize the Excel cells.
1392
- * @event
1393
-
1394
- */
1395
- excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1390
+ * Triggers before exporting each header cell to Excel file.
1391
+ * You can also customize the Excel cells.
1392
+ * @event
1393
+ * @deprecated
1394
+ */
1395
+ excelHeaderQueryCellInfo?: EmitType<ExcelHeaderQueryCellInfoEventArgs>;
1396
1396
 
1397
1397
  /**
1398
- * Triggers before Grid data is exported to Excel file.
1399
- * @event
1400
-
1401
- */
1402
- beforeExcelExport?: EmitType<Object>;
1398
+ * Triggers before Grid data is exported to Excel file.
1399
+ * @event
1400
+ * @deprecated
1401
+ */
1402
+ beforeExcelExport?: EmitType<Object>;
1403
1403
 
1404
1404
  /**
1405
- * Triggers after Grid data is exported to Excel file.
1406
- * @event
1407
-
1408
- */
1409
- excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
1405
+ * Triggers after Grid data is exported to Excel file.
1406
+ * @event
1407
+ * @deprecated
1408
+ */
1409
+ excelExportComplete?: EmitType<ExcelExportCompleteArgs>;
1410
1410
 
1411
1411
  /**
1412
- * Triggers before Grid data is exported to PDF document.
1413
- * @event
1414
- * @blazorProperty 'OnPdfExport'
1415
- */
1416
- beforePdfExport?: EmitType<Object>;
1412
+ * Triggers before Grid data is exported to PDF document.
1413
+ * @event
1414
+ * @blazorProperty 'OnPdfExport'
1415
+ */
1416
+ beforePdfExport?: EmitType<Object>;
1417
1417
 
1418
1418
  /**
1419
- * Triggers after Grid data is exported to PDF document.
1420
- * @event
1421
-
1422
- */
1423
- pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
1419
+ * Triggers after Grid data is exported to PDF document.
1420
+ * @event
1421
+ * @deprecated
1422
+ */
1423
+ pdfExportComplete?: EmitType<PdfExportCompleteArgs>;
1424
1424
 
1425
1425
  /**
1426
- * Triggers when row element's before drag(move).
1427
- * @event
1428
-
1429
-      */
1430
- rowDragStartHelper?: EmitType<RowDragEventArgs>;
1426
+ * Triggers when row element's before drag(move).
1427
+ * @event
1428
+ * @deprecated
1429
+      */
1430
+ rowDragStartHelper?: EmitType<RowDragEventArgs>;
1431
1431
 
1432
1432
  /**
1433
- * Triggers after detail row expands.
1434
- * > This event triggers at initial expand.
1435
-      * @event
1436
- * @blazorProperty 'DetailDataBound'
1437
-      */
1438
- detailDataBound?: EmitType<DetailDataBoundEventArgs>;
1433
+ * Triggers after detail row expands.
1434
+ * > This event triggers at initial expand.
1435
+      * @event
1436
+ * @blazorProperty 'DetailDataBound'
1437
+      */
1438
+ detailDataBound?: EmitType<DetailDataBoundEventArgs>;
1439
1439
 
1440
1440
  /**
1441
-      * Triggers when row element's drag(move) starts.
1442
-      * @event
1443
- * @blazorProperty 'RowDrag'
1444
-      */
1445
- rowDragStart?: EmitType<RowDragEventArgs>;
1441
+      * Triggers when row element's drag(move) starts.
1442
+      * @event
1443
+ * @blazorProperty 'RowDrag'
1444
+      */
1445
+ rowDragStart?: EmitType<RowDragEventArgs>;
1446
1446
 
1447
1447
  /**
1448
-      * Triggers when row elements are dragged (moved) continuously.
1449
-      * @event
1450
-
1451
-      */
1452
- rowDrag?: EmitType<RowDragEventArgs>;
1448
+      * Triggers when row elements are dragged (moved) continuously.
1449
+      * @event
1450
+ * @deprecated
1451
+      */
1452
+ rowDrag?: EmitType<RowDragEventArgs>;
1453
1453
 
1454
1454
  /**
1455
- * Triggers when row elements are dropped on the target row.
1456
-      * @event
1457
- * @blazorProperty 'RowDrop'
1458
-      */
1459
- rowDrop?: EmitType<RowDragEventArgs>;
1455
+ * Triggers when row elements are dropped on the target row.
1456
+      * @event
1457
+ * @blazorProperty 'RowDrop'
1458
+      */
1459
+ rowDrop?: EmitType<RowDragEventArgs>;
1460
1460
 
1461
1461
  /**
1462
- * Triggers when toolbar item is clicked.
1463
- * @event
1464
- * @blazorProperty 'OnToolbarClick'
1465
- * @blazorType Syncfusion.Blazor.Navigations.ClickEventArgs
1466
- */
1467
- toolbarClick?: EmitType<ClickEventArgs>;
1462
+ * Triggers when toolbar item is clicked.
1463
+ * @event
1464
+ * @blazorProperty 'OnToolbarClick'
1465
+ * @blazorType Syncfusion.Blazor.Navigations.ClickEventArgs
1466
+ */
1467
+ toolbarClick?: EmitType<ClickEventArgs>;
1468
1468
 
1469
1469
  /**
1470
- * Triggers before the columnChooser open.
1471
- * @event
1472
-
1473
- */
1474
- beforeOpenColumnChooser?: EmitType<ColumnChooserEventArgs>;
1470
+ * Triggers before the columnChooser open.
1471
+ * @event
1472
+ * @deprecated
1473
+ */
1474
+ beforeOpenColumnChooser?: EmitType<ColumnChooserEventArgs>;
1475
1475
 
1476
1476
  /**
1477
- * Triggers when records are added in batch mode.
1478
- * @event
1479
-
1480
- */
1481
- batchAdd?: EmitType<BatchAddArgs>;
1477
+ * Triggers when records are added in batch mode.
1478
+ * @event
1479
+ * @deprecated
1480
+ */
1481
+ batchAdd?: EmitType<BatchAddArgs>;
1482
1482
 
1483
1483
  /**
1484
- * Triggers when records are deleted in batch mode.
1485
- * @event
1486
-
1487
- */
1488
- batchDelete?: EmitType<BatchDeleteArgs>;
1484
+ * Triggers when records are deleted in batch mode.
1485
+ * @event
1486
+ * @deprecated
1487
+ */
1488
+ batchDelete?: EmitType<BatchDeleteArgs>;
1489
1489
 
1490
1490
  /**
1491
- * Triggers when cancel the batch edit changes batch mode.
1492
- * @event
1493
-
1494
- */
1495
- batchCancel?: EmitType<BatchCancelArgs>;
1491
+ * Triggers when cancel the batch edit changes batch mode.
1492
+ * @event
1493
+ * @deprecated
1494
+ */
1495
+ batchCancel?: EmitType<BatchCancelArgs>;
1496
1496
 
1497
1497
  /**
1498
- * Triggers before records are added in batch mode.
1499
- * @event
1500
- * @blazorProperty 'OnBatchAdd'
1501
- */
1502
- beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
1498
+ * Triggers before records are added in batch mode.
1499
+ * @event
1500
+ * @blazorProperty 'OnBatchAdd'
1501
+ */
1502
+ beforeBatchAdd?: EmitType<BeforeBatchAddArgs>;
1503
1503
 
1504
1504
  /**
1505
- * Triggers before records are deleted in batch mode.
1506
- * @event
1507
- * @blazorProperty 'OnBatchDelete'
1508
- */
1509
- beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
1505
+ * Triggers before records are deleted in batch mode.
1506
+ * @event
1507
+ * @blazorProperty 'OnBatchDelete'
1508
+ */
1509
+ beforeBatchDelete?: EmitType<BeforeBatchDeleteArgs>;
1510
1510
 
1511
1511
  /**
1512
- * Triggers before records are saved in batch mode.
1513
- * @event
1514
- * @blazorProperty 'OnBatchSave'
1515
- */
1516
- beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
1512
+ * Triggers before records are saved in batch mode.
1513
+ * @event
1514
+ * @blazorProperty 'OnBatchSave'
1515
+ */
1516
+ beforeBatchSave?: EmitType<BeforeBatchSaveArgs>;
1517
1517
 
1518
1518
  /**
1519
- * Triggers before the record is to be edit.
1520
- * @event
1521
- * @blazorProperty 'OnBeginEdit'
1522
- */
1523
- beginEdit?: EmitType<BeginEditArgs>;
1519
+ * Triggers before the record is to be edit.
1520
+ * @event
1521
+ * @blazorProperty 'OnBeginEdit'
1522
+ */
1523
+ beginEdit?: EmitType<BeginEditArgs>;
1524
1524
 
1525
1525
  /**
1526
- * Triggers when command button is clicked.
1527
- * @event
1528
- * @blazorProperty 'CommandClicked'
1529
- */
1530
- commandClick?: EmitType<CommandClickEventArgs>;
1526
+ * Triggers when command button is clicked.
1527
+ * @event
1528
+ * @blazorProperty 'CommandClicked'
1529
+ */
1530
+ commandClick?: EmitType<CommandClickEventArgs>;
1531
1531
 
1532
1532
  /**
1533
- * Triggers when the cell is being edited.
1534
- * @event
1535
- * @blazorProperty 'OnCellEdit'
1536
- */
1537
- cellEdit?: EmitType<CellEditArgs>;
1533
+ * Triggers when the cell is being edited.
1534
+ * @event
1535
+ * @blazorProperty 'OnCellEdit'
1536
+ */
1537
+ cellEdit?: EmitType<CellEditArgs>;
1538
1538
 
1539
1539
  /**
1540
- * Triggers when cell is saved.
1541
- * @event
1542
- * @blazorProperty 'OnCellSave'
1543
- */
1544
- cellSave?: EmitType<CellSaveArgs>;
1540
+ * Triggers when cell is saved.
1541
+ * @event
1542
+ * @blazorProperty 'OnCellSave'
1543
+ */
1544
+ cellSave?: EmitType<CellSaveArgs>;
1545
1545
 
1546
1546
  /**
1547
- * Triggers when cell is saved.
1548
- * @event
1549
- * @blazorProperty 'CellSaved'
1550
- */
1551
- cellSaved?: EmitType<CellSaveArgs>;
1547
+ * Triggers when cell is saved.
1548
+ * @event
1549
+ * @blazorProperty 'CellSaved'
1550
+ */
1551
+ cellSaved?: EmitType<CellSaveArgs>;
1552
1552
 
1553
1553
  /**
1554
- * Triggers when column resize starts.
1555
- * @event
1556
- * @blazorProperty 'OnResizeStart'
1557
- */
1558
- resizeStart?: EmitType<ResizeArgs>;
1554
+ * Triggers when column resize starts.
1555
+ * @event
1556
+ * @blazorProperty 'OnResizeStart'
1557
+ */
1558
+ resizeStart?: EmitType<ResizeArgs>;
1559
1559
 
1560
1560
  /**
1561
- * Triggers on column resizing.
1562
- * @event
1563
-
1564
- */
1565
- resizing?: EmitType<ResizeArgs>;
1561
+ * Triggers on column resizing.
1562
+ * @event
1563
+ * @deprecated
1564
+ */
1565
+ resizing?: EmitType<ResizeArgs>;
1566
1566
 
1567
1567
  /**
1568
- * Triggers when column resize ends.
1569
- * @event
1570
- * @blazorProperty 'ResizeStopped'
1571
- */
1572
- resizeStop?: EmitType<ResizeArgs>;
1568
+ * Triggers when column resize ends.
1569
+ * @event
1570
+ * @blazorProperty 'ResizeStopped'
1571
+ */
1572
+ resizeStop?: EmitType<ResizeArgs>;
1573
1573
 
1574
1574
  /**
1575
- * Triggers when any keyboard keys are pressed inside the grid.
1576
- * @event
1577
-
1578
- */
1579
- keyPressed?: EmitType<KeyboardEventArgs>;
1575
+ * Triggers when any keyboard keys are pressed inside the grid.
1576
+ * @event
1577
+ * @deprecated
1578
+ */
1579
+ keyPressed?: EmitType<KeyboardEventArgs>;
1580
1580
 
1581
1581
  /**
1582
- * Triggers before data is bound to Grid.
1583
- * @event
1584
- * @blazorProperty 'OnDataBound'
1585
- */
1586
- beforeDataBound?: EmitType<BeforeDataBoundArgs>;
1582
+ * Triggers before data is bound to Grid.
1583
+ * @event
1584
+ * @blazorProperty 'OnDataBound'
1585
+ */
1586
+ beforeDataBound?: EmitType<BeforeDataBoundArgs>;
1587
1587
 
1588
1588
  /**
1589
- * Triggers before context menu opens.
1590
- * @event
1591
-
1592
- */
1593
- contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
1589
+ * Triggers before context menu opens.
1590
+ * @event
1591
+ * @deprecated
1592
+ */
1593
+ contextMenuOpen?: EmitType<BeforeOpenCloseMenuEventArgs>;
1594
1594
 
1595
1595
  /**
1596
- * Triggers when click on context menu.
1597
- * @event
1598
- * @blazorProperty 'ContextMenuItemClicked'
1599
- * @blazorType ContextMenuClickEventArgs
1600
- */
1601
- contextMenuClick?: EmitType<MenuEventArgs>;
1596
+ * Triggers when click on context menu.
1597
+ * @event
1598
+ * @blazorProperty 'ContextMenuItemClicked'
1599
+ * @blazorType ContextMenuClickEventArgs
1600
+ */
1601
+ contextMenuClick?: EmitType<MenuEventArgs>;
1602
1602
 
1603
1603
  /**
1604
- * Triggers before column menu opens.
1605
- * @event
1606
-
1607
- */
1608
- columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
1604
+ * Triggers before column menu opens.
1605
+ * @event
1606
+ * @deprecated
1607
+ */
1608
+ columnMenuOpen?: EmitType<ColumnMenuOpenEventArgs>;
1609
1609
 
1610
1610
  /**
1611
- * Triggers when click on column menu.
1612
- * @event
1613
- * @blazorProperty 'ColumnMenuItemClicked'
1614
- * @blazorType ColumnMenuClickEventArgs
1615
- */
1616
- columnMenuClick?: EmitType<MenuEventArgs>;
1611
+ * Triggers when click on column menu.
1612
+ * @event
1613
+ * @blazorProperty 'ColumnMenuItemClicked'
1614
+ * @blazorType ColumnMenuClickEventArgs
1615
+ */
1616
+ columnMenuClick?: EmitType<MenuEventArgs>;
1617
1617
 
1618
1618
  /**
1619
- * Triggers when the check box state change in checkbox column.
1620
- * @event
1621
-
1622
- */
1623
- checkBoxChange?: EmitType<CheckBoxChangeEventArgs>;
1619
+ * Triggers when the check box state change in checkbox column.
1620
+ * @event
1621
+ * @deprecated
1622
+ */
1623
+ checkBoxChange?: EmitType<CheckBoxChangeEventArgs>;
1624
1624
 
1625
1625
  /**
1626
- * Triggers before Grid copy action.
1627
- * @event
1628
-
1629
- */
1630
- beforeCopy?: EmitType<BeforeCopyEventArgs>;
1626
+ * Triggers before Grid copy action.
1627
+ * @event
1628
+ * @deprecated
1629
+ */
1630
+ beforeCopy?: EmitType<BeforeCopyEventArgs>;
1631
1631
 
1632
1632
  /**
1633
- * Triggers before Grid paste action.
1634
- * @event
1635
-
1636
- */
1637
- beforePaste?: EmitType<BeforePasteEventArgs>;
1633
+ * Triggers before Grid paste action.
1634
+ * @event
1635
+ * @deprecated
1636
+ */
1637
+ beforePaste?: EmitType<BeforePasteEventArgs>;
1638
1638
 
1639
1639
  /**
1640
- * Triggers before Grid autoFill action.
1641
- * @event
1642
-
1643
- */
1644
- beforeAutoFill?: EmitType<BeforeAutoFillEventArgs>;
1640
+ * Triggers before Grid autoFill action.
1641
+ * @event
1642
+ * @deprecated
1643
+ */
1644
+ beforeAutoFill?: EmitType<BeforeAutoFillEventArgs>;
1645
1645
 
1646
1646
  /**
1647
- * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column `dataSource`.
1648
- * In this event,the current view column data and total record count should be assigned to the column `dataSource` based
1649
- * on the action performed.
1650
- * @event
1651
-
1652
- */
1653
- columnDataStateChange?: EmitType<ColumnDataStateChangeEventArgs>;
1647
+ * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done to get column `dataSource`.
1648
+ * In this event,the current view column data and total record count should be assigned to the column `dataSource` based
1649
+ * on the action performed.
1650
+ * @event
1651
+ * @deprecated
1652
+ */
1653
+ columnDataStateChange?: EmitType<ColumnDataStateChangeEventArgs>;
1654
1654
 
1655
1655
  /**
1656
- * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
1657
- * In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
1658
- * @event
1659
-
1660
- */
1661
- dataStateChange?: EmitType<DataStateChangeEventArgs>;
1656
+ * Triggers when the grid actions such as Sorting, Paging, Grouping etc., are done.
1657
+ * In this event,the current view data and total record count should be assigned to the `dataSource` based on the action performed.
1658
+ * @event
1659
+ * @deprecated
1660
+ */
1661
+ dataStateChange?: EmitType<DataStateChangeEventArgs>;
1662
1662
 
1663
1663
  /**
1664
- * Triggers when the grid data is added, deleted and updated.
1665
- * Invoke the done method from the argument to start render after edit operation.
1666
- * @event
1667
-
1668
- */
1669
- dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
1664
+ * Triggers when the grid data is added, deleted and updated.
1665
+ * Invoke the done method from the argument to start render after edit operation.
1666
+ * @event
1667
+ * @deprecated
1668
+ */
1669
+ dataSourceChanged?: EmitType<DataSourceChangedEventArgs>;
1670
1670
 
1671
1671
  /**
1672
- * Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
1673
- * @event
1674
-
1675
- */
1676
- exportGroupCaption?: EmitType<ExportGroupCaptionEventArgs>;
1672
+ * Triggers before exporting each caption row to PDF/Excel/CSV document. You can also customize the export caption row values.
1673
+ * @event
1674
+ * @deprecated
1675
+ */
1676
+ exportGroupCaption?: EmitType<ExportGroupCaptionEventArgs>;
1677
1677
 
1678
1678
  /**
1679
- * Triggers when expand the caption row in lazy load grouping.
1680
- * @event
1681
-
1682
- */
1683
- lazyLoadGroupExpand?: EmitType<LazyLoadArgs>;
1679
+ * Triggers when expand the caption row in lazy load grouping.
1680
+ * @event
1681
+ * @deprecated
1682
+ */
1683
+ lazyLoadGroupExpand?: EmitType<LazyLoadArgs>;
1684
1684
 
1685
1685
  /**
1686
- * Triggers when collapse the caption row in lazy load grouping.
1687
- * @event
1688
-
1689
- */
1690
- lazyLoadGroupCollapse?: EmitType<LazyLoadArgs>;
1686
+ * Triggers when collapse the caption row in lazy load grouping.
1687
+ * @event
1688
+ * @deprecated
1689
+ */
1690
+ lazyLoadGroupCollapse?: EmitType<LazyLoadArgs>;
1691
1691
 
1692
1692
  }