@syncfusion/ej2-grids 20.3.47-54738 → 20.3.47-54739
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.
- package/dist/ej2-grids.min.js +1 -0
- package/helpers/e2e/gridhelper.d.ts +59 -0
- package/helpers/e2e/index.d.ts +1 -0
- package/package.json +1 -1
- package/src/components.d.ts +5 -0
- package/src/grid/actions/aggregate.d.ts +31 -0
- package/src/grid/actions/batch-edit.d.ts +116 -0
- package/src/grid/actions/blazor-action.d.ts +47 -0
- package/src/grid/actions/checkbox-filter.d.ts +47 -0
- package/src/grid/actions/clipboard.d.ts +69 -0
- package/src/grid/actions/column-chooser.d.ts +114 -0
- package/src/grid/actions/column-menu.d.ts +99 -0
- package/src/grid/actions/command-column.d.ts +31 -0
- package/src/grid/actions/context-menu.d.ts +102 -0
- package/src/grid/actions/data.d.ts +110 -0
- package/src/grid/actions/detail-row.d.ts +73 -0
- package/src/grid/actions/dialog-edit.d.ts +21 -0
- package/src/grid/actions/edit.d.ts +271 -0
- package/src/grid/actions/excel-export.d.ts +89 -0
- package/src/grid/actions/excel-filter.d.ts +53 -0
- package/src/grid/actions/export-helper.d.ts +67 -0
- package/src/grid/actions/filter.d.ts +253 -0
- package/src/grid/actions/foreign-key.d.ts +20 -0
- package/src/grid/actions/freeze.d.ts +17 -0
- package/src/grid/actions/group.d.ts +178 -0
- package/src/grid/actions/infinite-scroll.d.ts +146 -0
- package/src/grid/actions/inline-edit.d.ts +21 -0
- package/src/grid/actions/lazy-load-group.d.ts +40 -0
- package/src/grid/actions/logger.d.ts +30 -0
- package/src/grid/actions/normal-edit.d.ts +76 -0
- package/src/grid/actions/page.d.ts +117 -0
- package/src/grid/actions/pdf-export.d.ts +142 -0
- package/src/grid/actions/print.d.ts +67 -0
- package/src/grid/actions/reorder.d.ts +95 -0
- package/src/grid/actions/resize.d.ts +117 -0
- package/src/grid/actions/row-reorder.d.ts +92 -0
- package/src/grid/actions/scroll.d.ts +114 -0
- package/src/grid/actions/search.d.ts +72 -0
- package/src/grid/actions/selection.d.ts +481 -0
- package/src/grid/actions/show-hide.d.ts +55 -0
- package/src/grid/actions/sort.d.ts +138 -0
- package/src/grid/actions/toolbar.d.ts +84 -0
- package/src/grid/actions/virtual-scroll.d.ts +23 -0
- package/src/grid/actions.d.ts +39 -0
- package/src/grid/aggregate.d.ts +4 -0
- package/src/grid/base/constant.d.ts +559 -0
- package/src/grid/base/enum.d.ts +704 -0
- package/src/grid/base/grid.d.ts +3627 -0
- package/src/grid/base/interface.d.ts +2567 -0
- package/src/grid/base/string-literals.d.ts +87 -0
- package/src/grid/base/type.d.ts +42 -0
- package/src/grid/base/util.d.ts +747 -0
- package/src/grid/base.d.ts +11 -0
- package/src/grid/column-chooser.d.ts +4 -0
- package/src/grid/column-menu.d.ts +4 -0
- package/src/grid/command-column.d.ts +4 -0
- package/src/grid/common/checkbox-filter-base.d.ts +137 -0
- package/src/grid/common/excel-filter-base.d.ts +115 -0
- package/src/grid/common/filter-interface.d.ts +42 -0
- package/src/grid/common/index.d.ts +5 -0
- package/src/grid/common.d.ts +6 -0
- package/src/grid/context-menu.d.ts +4 -0
- package/src/grid/detail-row.d.ts +4 -0
- package/src/grid/edit.d.ts +4 -0
- package/src/grid/excel-export.d.ts +4 -0
- package/src/grid/filter.d.ts +4 -0
- package/src/grid/foreign-key.d.ts +4 -0
- package/src/grid/freeze.d.ts +4 -0
- package/src/grid/group.d.ts +4 -0
- package/src/grid/index.d.ts +9 -0
- package/src/grid/infinite-scroll.d.ts +4 -0
- package/src/grid/lazy-load-group.d.ts +4 -0
- package/src/grid/logger.d.ts +4 -0
- package/src/grid/models/aggregate.d.ts +138 -0
- package/src/grid/models/cell.d.ts +38 -0
- package/src/grid/models/column-chooser-settings.d.ts +20 -0
- package/src/grid/models/column.d.ts +1122 -0
- package/src/grid/models/models.d.ts +7 -0
- package/src/grid/models/page-settings.d.ts +55 -0
- package/src/grid/models/row.d.ts +62 -0
- package/src/grid/models.d.ts +7 -0
- package/src/grid/page.d.ts +4 -0
- package/src/grid/pdf-export.d.ts +4 -0
- package/src/grid/renderer/autocomplete-edit-cell.d.ts +20 -0
- package/src/grid/renderer/batch-edit-renderer.d.ts +23 -0
- package/src/grid/renderer/boolean-edit-cell.d.ts +30 -0
- package/src/grid/renderer/boolean-filter-ui.d.ts +42 -0
- package/src/grid/renderer/caption-cell-renderer.d.ts +45 -0
- package/src/grid/renderer/cell-merge-renderer.d.ts +23 -0
- package/src/grid/renderer/cell-renderer.d.ts +91 -0
- package/src/grid/renderer/column-freeze-renderer.d.ts +166 -0
- package/src/grid/renderer/combobox-edit-cell.d.ts +19 -0
- package/src/grid/renderer/command-column-renderer.d.ts +31 -0
- package/src/grid/renderer/content-renderer.d.ts +210 -0
- package/src/grid/renderer/date-filter-ui.d.ts +31 -0
- package/src/grid/renderer/datepicker-edit-cell.d.ts +20 -0
- package/src/grid/renderer/default-edit-cell.d.ts +22 -0
- package/src/grid/renderer/detail-expand-cell-renderer.d.ts +21 -0
- package/src/grid/renderer/detail-header-indent-renderer.d.ts +20 -0
- package/src/grid/renderer/dialog-edit-renderer.d.ts +39 -0
- package/src/grid/renderer/dropdown-edit-cell.d.ts +32 -0
- package/src/grid/renderer/edit-cell-base.d.ts +25 -0
- package/src/grid/renderer/edit-renderer.d.ts +35 -0
- package/src/grid/renderer/expand-cell-renderer.d.ts +28 -0
- package/src/grid/renderer/filter-cell-renderer.d.ts +36 -0
- package/src/grid/renderer/filter-menu-operator.d.ts +43 -0
- package/src/grid/renderer/filter-menu-renderer.d.ts +65 -0
- package/src/grid/renderer/footer-renderer.d.ts +50 -0
- package/src/grid/renderer/freeze-renderer.d.ts +142 -0
- package/src/grid/renderer/group-lazy-load-renderer.d.ts +177 -0
- package/src/grid/renderer/header-cell-renderer.d.ts +54 -0
- package/src/grid/renderer/header-indent-renderer.d.ts +20 -0
- package/src/grid/renderer/header-renderer.d.ts +156 -0
- package/src/grid/renderer/indent-cell-renderer.d.ts +20 -0
- package/src/grid/renderer/inline-edit-renderer.d.ts +39 -0
- package/src/grid/renderer/inputmask-edit-cell.d.ts +18 -0
- package/src/grid/renderer/multiselect-edit-cell.d.ts +18 -0
- package/src/grid/renderer/number-filter-ui.d.ts +30 -0
- package/src/grid/renderer/numeric-edit-cell.d.ts +27 -0
- package/src/grid/renderer/render.d.ts +104 -0
- package/src/grid/renderer/responsive-dialog-renderer.d.ts +84 -0
- package/src/grid/renderer/row-drag-drop-renderer.d.ts +20 -0
- package/src/grid/renderer/row-drag-header-indent-render.d.ts +20 -0
- package/src/grid/renderer/row-renderer.d.ts +55 -0
- package/src/grid/renderer/stacked-cell-renderer.d.ts +23 -0
- package/src/grid/renderer/string-filter-ui.d.ts +39 -0
- package/src/grid/renderer/summary-cell-renderer.d.ts +15 -0
- package/src/grid/renderer/template-edit-cell.d.ts +13 -0
- package/src/grid/renderer/timepicker-edit-cell.d.ts +18 -0
- package/src/grid/renderer/toggleswitch-edit-cell.d.ts +27 -0
- package/src/grid/renderer/virtual-content-renderer.d.ts +221 -0
- package/src/grid/renderer/virtual-freeze-renderer.d.ts +382 -0
- package/src/grid/renderer.d.ts +42 -0
- package/src/grid/reorder.d.ts +4 -0
- package/src/grid/resize.d.ts +4 -0
- package/src/grid/row-reorder.d.ts +4 -0
- package/src/grid/selection.d.ts +4 -0
- package/src/grid/services/aria-service.d.ts +34 -0
- package/src/grid/services/cell-render-factory.d.ts +14 -0
- package/src/grid/services/focus-strategy.d.ts +192 -0
- package/src/grid/services/freeze-row-model-generator.d.ts +14 -0
- package/src/grid/services/group-model-generator.d.ts +68 -0
- package/src/grid/services/intersection-observer.d.ts +23 -0
- package/src/grid/services/renderer-factory.d.ts +14 -0
- package/src/grid/services/row-model-generator.d.ts +41 -0
- package/src/grid/services/service-locator.d.ts +14 -0
- package/src/grid/services/summary-model-generator.d.ts +43 -0
- package/src/grid/services/value-formatter.d.ts +16 -0
- package/src/grid/services/virtual-row-model-generator.d.ts +55 -0
- package/src/grid/services/width-controller.d.ts +35 -0
- package/src/grid/services.d.ts +11 -0
- package/src/grid/sort.d.ts +4 -0
- package/src/grid/toolbar.d.ts +4 -0
- package/src/grid/virtual-scroll.d.ts +4 -0
- package/src/index.d.ts +5 -0
- package/src/pager/external-message.d.ts +55 -0
- package/src/pager/index.d.ts +9 -0
- package/src/pager/numeric-container.d.ts +78 -0
- package/src/pager/pager-dropdown.d.ts +68 -0
- package/src/pager/pager-message.d.ts +50 -0
- package/src/pager/pager.d.ts +341 -0
|
@@ -0,0 +1,2567 @@
|
|
|
1
|
+
import { Component, NumberFormatOptions, DateFormatOptions, EmitType } from '@syncfusion/ej2-base';
|
|
2
|
+
import { KeyboardEventArgs as BaseKeyboardEventArgs, L10n } from '@syncfusion/ej2-base';
|
|
3
|
+
import { Query, DataManager, Group, Predicate } from '@syncfusion/ej2-data';
|
|
4
|
+
import { ItemModel, MenuItemModel, BeforeOpenCloseMenuEventArgs, MenuEventArgs } from '@syncfusion/ej2-navigations';
|
|
5
|
+
import { ButtonModel, CheckBoxModel, SwitchModel } from '@syncfusion/ej2-buttons';
|
|
6
|
+
import { Column, ColumnModel } from '../models/column';
|
|
7
|
+
import { SortSettingsModel, TextWrapSettingsModel, SelectionSettingsModel, FilterSettingsModel, SearchSettingsModel, InfiniteScrollSettingsModel, ResizeSettingsModel } from './grid-model';
|
|
8
|
+
import { PageSettingsModel, AggregateRowModel, ColumnChooserSettingsModel } from '../models/models';
|
|
9
|
+
import { RowDropSettingsModel, GroupSettingsModel, GridModel, EditSettingsModel, LoadingIndicatorModel } from './grid-model';
|
|
10
|
+
import { Cell } from '../models/cell';
|
|
11
|
+
import { Row } from '../models/row';
|
|
12
|
+
import { GridLine, Action, CellType, SortDirection, PrintMode, ToolbarItems, CommandButtonType, ContextMenuItem, ExcelBorderLineStyle } from './enum';
|
|
13
|
+
import { MultipleExportType, ExportType, ExcelHAlign, ExcelVAlign, BorderLineStyle, ToolbarItem, AggregateTemplateType } from './enum';
|
|
14
|
+
import { PredicateModel } from './grid-model';
|
|
15
|
+
import { SentinelType, Offsets } from './type';
|
|
16
|
+
import { CheckState, ColumnQueryModeType, HierarchyGridPrintMode, ClipMode, freezeMode } from './enum';
|
|
17
|
+
import { ResponsiveDialogAction, RowRenderingDirection } from './enum';
|
|
18
|
+
import { Edit } from '../actions/edit';
|
|
19
|
+
import { Selection } from '../actions/selection';
|
|
20
|
+
import { Resize } from '../actions/resize';
|
|
21
|
+
import { DropDownListModel, MultiSelectModel, ComboBoxModel } from '@syncfusion/ej2-dropdowns';
|
|
22
|
+
import { NumericTextBoxModel, MaskedTextBoxModel } from '@syncfusion/ej2-inputs';
|
|
23
|
+
import { FormValidator } from '@syncfusion/ej2-inputs';
|
|
24
|
+
import { Data } from '../actions/data';
|
|
25
|
+
import { DatePickerModel, DateTimePickerModel, TimePickerModel } from '@syncfusion/ej2-calendars';
|
|
26
|
+
import { PdfStandardFont, PdfTrueTypeFont, PdfGridCell, PdfTextWebLink, PdfImage, PdfStringFormat } from '@syncfusion/ej2-pdf-export';
|
|
27
|
+
import { Matrix, FocusStrategy } from '../services/focus-strategy';
|
|
28
|
+
import { CheckBoxFilterBase } from '../common/checkbox-filter-base';
|
|
29
|
+
import { PdfPageSize, PageOrientation, ContentType, PdfPageNumberType, PdfDashStyle, PdfHAlign, PdfVAlign } from './enum';
|
|
30
|
+
import { FlMenuOptrUI } from '../renderer/filter-menu-operator';
|
|
31
|
+
import { Dialog, DialogModel } from '@syncfusion/ej2-popups';
|
|
32
|
+
import { Render } from '../renderer/render';
|
|
33
|
+
import { DetailRow } from '../actions/detail-row';
|
|
34
|
+
import { Print } from '../actions/print';
|
|
35
|
+
import { PdfPaddings } from '@syncfusion/ej2-pdf-export';
|
|
36
|
+
import { AutoCompleteModel } from '@syncfusion/ej2-dropdowns';
|
|
37
|
+
import { Page } from '../actions/page';
|
|
38
|
+
import { Scroll } from '../actions/scroll';
|
|
39
|
+
import { Aggregate } from '../actions/aggregate';
|
|
40
|
+
import { InfiniteScroll } from '../actions/infinite-scroll';
|
|
41
|
+
import { Filter } from '../actions/filter';
|
|
42
|
+
import { ContextMenu } from '../actions/context-menu';
|
|
43
|
+
/**
|
|
44
|
+
* Specifies grid interfaces.
|
|
45
|
+
*
|
|
46
|
+
* @hidden
|
|
47
|
+
*/
|
|
48
|
+
export interface IGrid extends Component<HTMLElement> {
|
|
49
|
+
currentViewData?: Object[];
|
|
50
|
+
currentAction?: ActionArgs;
|
|
51
|
+
/**
|
|
52
|
+
* Specifies the columns for Grid.
|
|
53
|
+
*
|
|
54
|
+
* @default []
|
|
55
|
+
*/
|
|
56
|
+
columns?: Column[] | string[] | ColumnModel[];
|
|
57
|
+
/**
|
|
58
|
+
* Specifies whether the enableAltRow is enable or not.
|
|
59
|
+
*
|
|
60
|
+
* @default null
|
|
61
|
+
*/
|
|
62
|
+
enableAltRow?: boolean;
|
|
63
|
+
/**
|
|
64
|
+
* Specifies whether the enable row hover is enable or not.
|
|
65
|
+
*
|
|
66
|
+
* @default null
|
|
67
|
+
*/
|
|
68
|
+
enableHover?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* Specifies the allowKeyboard Navigation for the Grid.
|
|
71
|
+
*
|
|
72
|
+
* @default null
|
|
73
|
+
*/
|
|
74
|
+
allowKeyboard?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* If 'enableStickyHeader' set to true, then the user can able to make the column headers visible when the document is scrolled.
|
|
77
|
+
*
|
|
78
|
+
* @default null
|
|
79
|
+
*/
|
|
80
|
+
enableStickyHeader?: boolean;
|
|
81
|
+
/**
|
|
82
|
+
* Specifies whether the allowTextWrap is enabled or not.
|
|
83
|
+
*
|
|
84
|
+
* @default null
|
|
85
|
+
*/
|
|
86
|
+
allowTextWrap?: boolean;
|
|
87
|
+
/**
|
|
88
|
+
* Specifies the 'textWrapSettings' for Grid.
|
|
89
|
+
*
|
|
90
|
+
* @default []
|
|
91
|
+
*/
|
|
92
|
+
textWrapSettings?: TextWrapSettingsModel;
|
|
93
|
+
/**
|
|
94
|
+
* Specifies whether the paging is enable or not.
|
|
95
|
+
*
|
|
96
|
+
* @default null
|
|
97
|
+
*/
|
|
98
|
+
allowPaging?: boolean;
|
|
99
|
+
/**
|
|
100
|
+
* Specifies the 'enableAutoFill' for Grid.
|
|
101
|
+
*
|
|
102
|
+
* @default []
|
|
103
|
+
*/
|
|
104
|
+
enableAutoFill?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* Specifies the pageSettings for Grid.
|
|
107
|
+
*
|
|
108
|
+
* @default PageSettings
|
|
109
|
+
*/
|
|
110
|
+
pageSettings?: PageSettingsModel;
|
|
111
|
+
/**
|
|
112
|
+
* Configures the Loading Indicator of the Grid.
|
|
113
|
+
*
|
|
114
|
+
* @default LoadingIndicator
|
|
115
|
+
*/
|
|
116
|
+
loadingIndicator?: LoadingIndicatorModel;
|
|
117
|
+
/**
|
|
118
|
+
* Specifies the shimmer effect for Grid virtual and infinite scrolling.
|
|
119
|
+
*
|
|
120
|
+
* @default true
|
|
121
|
+
*/
|
|
122
|
+
enableVirtualMaskRow?: boolean;
|
|
123
|
+
enableVirtualization: boolean;
|
|
124
|
+
enableColumnVirtualization: boolean;
|
|
125
|
+
enableInfiniteScrolling: boolean;
|
|
126
|
+
/**
|
|
127
|
+
* Specifies whether the sorting is enable or not.
|
|
128
|
+
*
|
|
129
|
+
* @default null
|
|
130
|
+
*/
|
|
131
|
+
allowSorting?: boolean;
|
|
132
|
+
/**
|
|
133
|
+
* Defines the mode of clip. The available modes are,
|
|
134
|
+
* `Clip`: Truncates the cell content when it overflows its area.
|
|
135
|
+
* `Ellipsis`: Displays ellipsis when the cell content overflows its area.
|
|
136
|
+
* `EllipsisWithTooltip`: Displays ellipsis when the cell content overflows its area,
|
|
137
|
+
* also it will display the tooltip while hover on ellipsis is applied.
|
|
138
|
+
*
|
|
139
|
+
* @default Ellipsis
|
|
140
|
+
*/
|
|
141
|
+
clipMode?: ClipMode;
|
|
142
|
+
/**
|
|
143
|
+
* Defines the resizing behavior of the Grid.
|
|
144
|
+
*
|
|
145
|
+
* @default []
|
|
146
|
+
*/
|
|
147
|
+
resizeSettings?: ResizeSettingsModel;
|
|
148
|
+
/**
|
|
149
|
+
* Specifies whether the multi-sorting is enable or not.
|
|
150
|
+
*
|
|
151
|
+
* @default null
|
|
152
|
+
*/
|
|
153
|
+
allowMultiSorting?: boolean;
|
|
154
|
+
/**
|
|
155
|
+
* Specifies the sortSettings for Grid.
|
|
156
|
+
*
|
|
157
|
+
* @default []
|
|
158
|
+
*/
|
|
159
|
+
sortSettings?: SortSettingsModel;
|
|
160
|
+
/**
|
|
161
|
+
* Specifies the infinite scroll settings for Grid.
|
|
162
|
+
*
|
|
163
|
+
* @default []
|
|
164
|
+
*/
|
|
165
|
+
infiniteScrollSettings?: InfiniteScrollSettingsModel;
|
|
166
|
+
/**
|
|
167
|
+
* Specifies whether the Excel exporting is enable or not.
|
|
168
|
+
*
|
|
169
|
+
* @default null
|
|
170
|
+
*/
|
|
171
|
+
allowExcelExport?: boolean;
|
|
172
|
+
/**
|
|
173
|
+
* Specifies whether the Pdf exporting is enable or not.
|
|
174
|
+
*
|
|
175
|
+
* @default null
|
|
176
|
+
*/
|
|
177
|
+
allowPdfExport?: boolean;
|
|
178
|
+
/**
|
|
179
|
+
* Specifies whether the selection is enable or not.
|
|
180
|
+
*
|
|
181
|
+
* @default null
|
|
182
|
+
*/
|
|
183
|
+
allowSelection?: boolean;
|
|
184
|
+
/**
|
|
185
|
+
* It is used to select the row while initializing the grid.
|
|
186
|
+
*
|
|
187
|
+
* @default -1
|
|
188
|
+
*/
|
|
189
|
+
selectedRowIndex?: number;
|
|
190
|
+
/**
|
|
191
|
+
* Specifies the selectionSettings for Grid.
|
|
192
|
+
*
|
|
193
|
+
* @default []
|
|
194
|
+
*/
|
|
195
|
+
selectionSettings?: SelectionSettingsModel;
|
|
196
|
+
/**
|
|
197
|
+
* Specifies whether the reordering is enable or not.
|
|
198
|
+
*
|
|
199
|
+
* @default null
|
|
200
|
+
*/
|
|
201
|
+
allowReordering?: boolean;
|
|
202
|
+
/**
|
|
203
|
+
* If `allowResizing` set to true, then the Grid columns can be resized.
|
|
204
|
+
*
|
|
205
|
+
* @default false
|
|
206
|
+
*/
|
|
207
|
+
allowResizing?: boolean;
|
|
208
|
+
/**
|
|
209
|
+
* Specifies whether the filtering is enable or not.
|
|
210
|
+
*
|
|
211
|
+
* @default null
|
|
212
|
+
*/
|
|
213
|
+
allowFiltering?: boolean;
|
|
214
|
+
/**
|
|
215
|
+
* Specifies the filterSettings for Grid.
|
|
216
|
+
*
|
|
217
|
+
* @default []
|
|
218
|
+
*/
|
|
219
|
+
filterSettings?: FilterSettingsModel;
|
|
220
|
+
/**
|
|
221
|
+
* Specifies whether the grouping is enable or not.
|
|
222
|
+
*
|
|
223
|
+
* @default null
|
|
224
|
+
*/
|
|
225
|
+
allowGrouping?: boolean;
|
|
226
|
+
/**
|
|
227
|
+
* Specifies whether the immutable mode is enable or not.
|
|
228
|
+
*
|
|
229
|
+
* @default null
|
|
230
|
+
*/
|
|
231
|
+
enableImmutableMode?: boolean;
|
|
232
|
+
/**
|
|
233
|
+
* Specifies whether the column menu is show or not.
|
|
234
|
+
*
|
|
235
|
+
* @default null
|
|
236
|
+
*/
|
|
237
|
+
showColumnMenu?: boolean;
|
|
238
|
+
/**
|
|
239
|
+
* Specifies the groupSettings for Grid.
|
|
240
|
+
*
|
|
241
|
+
* @default []
|
|
242
|
+
*/
|
|
243
|
+
groupSettings?: GroupSettingsModel;
|
|
244
|
+
/**
|
|
245
|
+
* if showColumnChooser is true, then column chooser will be enabled in Grid.
|
|
246
|
+
*
|
|
247
|
+
* @default false
|
|
248
|
+
*/
|
|
249
|
+
showColumnChooser?: boolean;
|
|
250
|
+
/**
|
|
251
|
+
* Specifies the 'columnChooserSettings' for Grid.
|
|
252
|
+
*
|
|
253
|
+
* @default []
|
|
254
|
+
*/
|
|
255
|
+
columnChooserSettings?: ColumnChooserSettingsModel;
|
|
256
|
+
/**
|
|
257
|
+
* Specifies the editSettings for Grid.
|
|
258
|
+
*
|
|
259
|
+
* @default []
|
|
260
|
+
*/
|
|
261
|
+
editSettings?: EditSettingsModel;
|
|
262
|
+
/**
|
|
263
|
+
* Specifies the summaryRows for Grid.
|
|
264
|
+
*
|
|
265
|
+
* @default []
|
|
266
|
+
*/
|
|
267
|
+
aggregates?: AggregateRowModel[];
|
|
268
|
+
/**
|
|
269
|
+
* Specifies scrollable height of the grid content.
|
|
270
|
+
*
|
|
271
|
+
* @default 'auto'
|
|
272
|
+
*/
|
|
273
|
+
height?: string | number;
|
|
274
|
+
/**
|
|
275
|
+
* Specifies scrollable width of the grid content.
|
|
276
|
+
*
|
|
277
|
+
* @default 'auto'
|
|
278
|
+
*/
|
|
279
|
+
width?: string | number;
|
|
280
|
+
/**
|
|
281
|
+
* Specifies the searchSettings for Grid.
|
|
282
|
+
*
|
|
283
|
+
* @default []
|
|
284
|
+
*/
|
|
285
|
+
searchSettings?: SearchSettingsModel;
|
|
286
|
+
/**
|
|
287
|
+
* Specifies the rowDropSettings for Grid.
|
|
288
|
+
*
|
|
289
|
+
* @default []
|
|
290
|
+
*/
|
|
291
|
+
rowDropSettings?: RowDropSettingsModel;
|
|
292
|
+
/**
|
|
293
|
+
* Specifies whether the allowRowDragAndDrop is enable or not.
|
|
294
|
+
*
|
|
295
|
+
* @default false
|
|
296
|
+
*/
|
|
297
|
+
allowRowDragAndDrop?: boolean;
|
|
298
|
+
/**
|
|
299
|
+
* Specifies whether the gridLines mode
|
|
300
|
+
*
|
|
301
|
+
* @default null
|
|
302
|
+
*/
|
|
303
|
+
gridLines?: GridLine;
|
|
304
|
+
/**
|
|
305
|
+
* Specifies rowTemplate
|
|
306
|
+
*/
|
|
307
|
+
rowTemplate?: string;
|
|
308
|
+
/**
|
|
309
|
+
* Specifies detailTemplate
|
|
310
|
+
*/
|
|
311
|
+
detailTemplate?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Defines the child Grid to add inside the data rows of the parent Grid with expand/collapse options.
|
|
314
|
+
*/
|
|
315
|
+
childGrid?: GridModel;
|
|
316
|
+
/**
|
|
317
|
+
* Defines the relation between parent and child grid.
|
|
318
|
+
*/
|
|
319
|
+
queryString?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Specifies the printMode
|
|
322
|
+
*/
|
|
323
|
+
printMode?: PrintMode;
|
|
324
|
+
/**
|
|
325
|
+
* Specifies the dataSource for Grid.
|
|
326
|
+
*
|
|
327
|
+
* @default []
|
|
328
|
+
*/
|
|
329
|
+
dataSource?: Object | DataManager;
|
|
330
|
+
/**
|
|
331
|
+
* Defines the row height for Grid rows.
|
|
332
|
+
*
|
|
333
|
+
* @default null
|
|
334
|
+
*/
|
|
335
|
+
rowHeight?: number;
|
|
336
|
+
/**
|
|
337
|
+
* Specifies the query for Grid.
|
|
338
|
+
*
|
|
339
|
+
* @default []
|
|
340
|
+
*/
|
|
341
|
+
query?: Query;
|
|
342
|
+
/**
|
|
343
|
+
* @hidden
|
|
344
|
+
* `columnQueryMode`provides options to retrive data from the datasource.
|
|
345
|
+
* @default All
|
|
346
|
+
*/
|
|
347
|
+
columnQueryMode?: ColumnQueryModeType;
|
|
348
|
+
/**
|
|
349
|
+
* @hidden
|
|
350
|
+
* `vGroupOffsets`provides options to store the whole data objects block heights.
|
|
351
|
+
* @default false
|
|
352
|
+
*/
|
|
353
|
+
isVirtualAdaptive?: boolean;
|
|
354
|
+
/**
|
|
355
|
+
* @hidden
|
|
356
|
+
* `vGroupOffsets`provides options to store the whole data objects block heights.
|
|
357
|
+
* @default {}
|
|
358
|
+
*/
|
|
359
|
+
vGroupOffsets?: {
|
|
360
|
+
[x: number]: number;
|
|
361
|
+
};
|
|
362
|
+
/**
|
|
363
|
+
* @hidden
|
|
364
|
+
* `vRows`provides options to store the whole row objects from the datasource.
|
|
365
|
+
* @default []
|
|
366
|
+
*/
|
|
367
|
+
vRows?: Row<Column>[];
|
|
368
|
+
/**
|
|
369
|
+
* @hidden
|
|
370
|
+
* `vcRows`provides options to store the whole row objects from the datasource.
|
|
371
|
+
* @default []
|
|
372
|
+
*/
|
|
373
|
+
vcRows?: Row<Column>[];
|
|
374
|
+
/**
|
|
375
|
+
* @hidden
|
|
376
|
+
* Specifies the toolbar for Grid.
|
|
377
|
+
* @default null
|
|
378
|
+
*/
|
|
379
|
+
toolbar?: (ToolbarItems | string | ItemModel | ToolbarItem)[];
|
|
380
|
+
/**
|
|
381
|
+
* Specifies the context menu items for Grid.
|
|
382
|
+
*
|
|
383
|
+
* @default null
|
|
384
|
+
*/
|
|
385
|
+
contextMenuItems?: ContextMenuItem[] | ContextMenuItemModel[];
|
|
386
|
+
/**
|
|
387
|
+
* Specifies the column menu items for Grid.
|
|
388
|
+
*
|
|
389
|
+
* @default null
|
|
390
|
+
*/
|
|
391
|
+
columnMenuItems?: string[] | ContextMenuItemModel[];
|
|
392
|
+
/**
|
|
393
|
+
* @hidden
|
|
394
|
+
* It used to render toolbar template
|
|
395
|
+
* @default null
|
|
396
|
+
*/
|
|
397
|
+
toolbarTemplate?: string;
|
|
398
|
+
/**
|
|
399
|
+
* @hidden
|
|
400
|
+
* It used to render pager template
|
|
401
|
+
* @default null
|
|
402
|
+
*/
|
|
403
|
+
pagerTemplate?: string;
|
|
404
|
+
/**
|
|
405
|
+
* @hidden
|
|
406
|
+
* It used to indicate initial loading
|
|
407
|
+
* @default false
|
|
408
|
+
*/
|
|
409
|
+
isInitialLoad?: boolean;
|
|
410
|
+
/**
|
|
411
|
+
* Defines the frozen rows for the grid content
|
|
412
|
+
*
|
|
413
|
+
* @default 0
|
|
414
|
+
*/
|
|
415
|
+
frozenRows?: number;
|
|
416
|
+
/**
|
|
417
|
+
* Defines the grid rows displaying direction.
|
|
418
|
+
*
|
|
419
|
+
* @default 'Horizontal'
|
|
420
|
+
*/
|
|
421
|
+
rowRenderingMode?: RowRenderingDirection;
|
|
422
|
+
/**
|
|
423
|
+
* If `enableAdaptiveUI` set to true the grid dialogs will be displayed at fullscreen.
|
|
424
|
+
*
|
|
425
|
+
* @default false
|
|
426
|
+
*/
|
|
427
|
+
enableAdaptiveUI?: boolean;
|
|
428
|
+
/**
|
|
429
|
+
* Defines the frozen columns for the grid content
|
|
430
|
+
*
|
|
431
|
+
* @default 0
|
|
432
|
+
*/
|
|
433
|
+
frozenColumns?: number;
|
|
434
|
+
/**
|
|
435
|
+
* Specifies whether the Searching for columns is enable or not.
|
|
436
|
+
*
|
|
437
|
+
* @default true
|
|
438
|
+
*/
|
|
439
|
+
allowSearching?: boolean;
|
|
440
|
+
/**
|
|
441
|
+
* Defines the own class for the grid element.
|
|
442
|
+
*
|
|
443
|
+
* @default ''
|
|
444
|
+
*/
|
|
445
|
+
cssClass?: string;
|
|
446
|
+
isEdit?: boolean;
|
|
447
|
+
commonQuery?: Query;
|
|
448
|
+
scrollPosition: ScrollPositionType;
|
|
449
|
+
isLastCellPrimaryKey?: boolean;
|
|
450
|
+
editModule?: Edit;
|
|
451
|
+
selectionModule?: Selection;
|
|
452
|
+
aggregateModule?: Aggregate;
|
|
453
|
+
scrollModule?: Scroll;
|
|
454
|
+
infiniteScrollModule?: InfiniteScroll;
|
|
455
|
+
resizeModule: Resize;
|
|
456
|
+
focusModule?: FocusStrategy;
|
|
457
|
+
mergeCells?: {
|
|
458
|
+
[key: string]: number;
|
|
459
|
+
};
|
|
460
|
+
checkAllRows?: CheckState;
|
|
461
|
+
isCheckBoxSelection?: boolean;
|
|
462
|
+
isPersistSelection?: boolean;
|
|
463
|
+
localeObj?: L10n;
|
|
464
|
+
isManualRefresh?: boolean;
|
|
465
|
+
isAutoFitColumns?: boolean;
|
|
466
|
+
enableDeepCompare?: boolean;
|
|
467
|
+
totalDataRecordsCount?: number;
|
|
468
|
+
disableSelectedRecords?: Object[];
|
|
469
|
+
partialSelectedRecords?: Object[];
|
|
470
|
+
prevPageMoving?: boolean;
|
|
471
|
+
renderModule?: Render;
|
|
472
|
+
headerModule?: IRenderer;
|
|
473
|
+
contentModule?: IRenderer;
|
|
474
|
+
isPreventScrollEvent?: boolean;
|
|
475
|
+
hierarchyPrintMode?: HierarchyGridPrintMode;
|
|
476
|
+
detailRowModule?: DetailRow;
|
|
477
|
+
printModule?: Print;
|
|
478
|
+
filterModule?: Filter;
|
|
479
|
+
requestTypeAction?: string;
|
|
480
|
+
expandedRows?: {
|
|
481
|
+
[index: number]: IExpandedRow;
|
|
482
|
+
};
|
|
483
|
+
registeredTemplate?: Object;
|
|
484
|
+
lockcolPositionCount?: number;
|
|
485
|
+
commandDelIndex?: number;
|
|
486
|
+
isPrinting?: boolean;
|
|
487
|
+
id?: string;
|
|
488
|
+
isSelectedRowIndexUpdating?: boolean;
|
|
489
|
+
pagerModule?: Page;
|
|
490
|
+
invokedFromMedia?: boolean;
|
|
491
|
+
isAutoGen?: boolean;
|
|
492
|
+
pageTemplateChange?: boolean;
|
|
493
|
+
enableHeaderFocus?: boolean;
|
|
494
|
+
renderTemplates?: Function;
|
|
495
|
+
isReact?: boolean;
|
|
496
|
+
tableIndex?: number;
|
|
497
|
+
isVue?: boolean;
|
|
498
|
+
isAngular?: boolean;
|
|
499
|
+
adaptiveDlgTarget?: HTMLElement;
|
|
500
|
+
parentDetails?: ParentDetails;
|
|
501
|
+
/**
|
|
502
|
+
* @hidden
|
|
503
|
+
* It used to render pager template
|
|
504
|
+
* @default null
|
|
505
|
+
*/
|
|
506
|
+
contextMenuModule?: ContextMenu;
|
|
507
|
+
getHeaderContent?(): Element;
|
|
508
|
+
isRowDragable(): boolean;
|
|
509
|
+
setGridHeaderContent?(value: Element): void;
|
|
510
|
+
getContentTable?(): Element;
|
|
511
|
+
setGridContentTable?(value: Element): void;
|
|
512
|
+
getContent?(): Element;
|
|
513
|
+
setGridContent?(value: Element): void;
|
|
514
|
+
getHeaderTable?(): Element;
|
|
515
|
+
setGridHeaderTable?(value: Element): void;
|
|
516
|
+
getFooterContent?(): Element;
|
|
517
|
+
getFooterContentTable?(): Element;
|
|
518
|
+
getPager?(): Element;
|
|
519
|
+
setGridPager?(value: Element): void;
|
|
520
|
+
hoverFrozenRows?(value: MouseEvent): void;
|
|
521
|
+
getRowByIndex?(index: number): Element;
|
|
522
|
+
getMovableRowByIndex?(index: number): Element;
|
|
523
|
+
getFrozenRightRowByIndex?(index: number): Element;
|
|
524
|
+
getFrozenRightRowByIndex?(index: number): Element;
|
|
525
|
+
getFrozenRowByIndex?(index: number): Element;
|
|
526
|
+
showResponsiveCustomFilter?(): void;
|
|
527
|
+
showResponsiveCustomSort?(): void;
|
|
528
|
+
getRowInfo?(target: Element): RowInfo;
|
|
529
|
+
selectRow?(index: number, isToggle?: boolean): void;
|
|
530
|
+
getColumnHeaderByIndex?(index: number): Element;
|
|
531
|
+
getColumnByField?(field: string): Column;
|
|
532
|
+
getColumnIndexByField?(field: string): number;
|
|
533
|
+
getColumnByUid?(uid: string): Column;
|
|
534
|
+
getColumnIndexByUid?(uid: string): number;
|
|
535
|
+
getColumnByIndex?(index: number): Column;
|
|
536
|
+
getUidByColumnField?(field: string): string;
|
|
537
|
+
getNormalizedColumnIndex?(uid: string): number;
|
|
538
|
+
getIndentCount?(): number;
|
|
539
|
+
getColumnIndexesInView(): number[];
|
|
540
|
+
setColumnIndexesInView(indexes?: number[]): void;
|
|
541
|
+
getRows?(): Element[];
|
|
542
|
+
getMovableRows?(): Element[];
|
|
543
|
+
getCellFromIndex?(rowIndex: number, columnIndex: number): Element;
|
|
544
|
+
getMovableCellFromIndex?(rowIndex: number, columnIndex: number): Element;
|
|
545
|
+
getFrozenRightCellFromIndex?(rowIndex: number, columnIndex: number): Element;
|
|
546
|
+
getColumnFieldNames?(): string[];
|
|
547
|
+
getSelectedRows?(): Element[];
|
|
548
|
+
getSelectedRecords?(): Object[];
|
|
549
|
+
getSelectedRowIndexes?(): number[];
|
|
550
|
+
getSelectedRowCellIndexes(): ISelectedCell[];
|
|
551
|
+
getCurrentViewRecords(): Object[];
|
|
552
|
+
selectRows?(indexes: number[]): void;
|
|
553
|
+
clearSelection?(): void;
|
|
554
|
+
updateExternalMessage?(message: string): void;
|
|
555
|
+
getColumns?(isRefresh?: boolean): Column[];
|
|
556
|
+
getStackedHeaderColumnByHeaderText?(stackedHeader: string, col: Column[]): Column;
|
|
557
|
+
getStackedColumns?(column: Column[]): Column[];
|
|
558
|
+
getRowTemplate?(): Function;
|
|
559
|
+
getDetailTemplate?(): Function;
|
|
560
|
+
getEditTemplate?(): Function;
|
|
561
|
+
getEditFooterTemplate?(): Function;
|
|
562
|
+
getEditHeaderTemplate?(): Function;
|
|
563
|
+
getFilterTemplate?(): Function;
|
|
564
|
+
sortColumn?(columnName: string, sortDirection: SortDirection, isMultiSort?: boolean): void;
|
|
565
|
+
clearSorting?(): void;
|
|
566
|
+
removeSortColumn?(field: string): void;
|
|
567
|
+
clearGridActions?(): void;
|
|
568
|
+
getColumnHeaderByUid?(uid: string): Element;
|
|
569
|
+
getColumnHeaderByField?(field: string): Element;
|
|
570
|
+
showColumns?(keys: string | string[], showBy?: string): void;
|
|
571
|
+
hideColumns?(keys: string | string[], hideBy?: string): void;
|
|
572
|
+
showSpinner?(): void;
|
|
573
|
+
hideSpinner?(): void;
|
|
574
|
+
showMaskRow?(axisDirection?: string, dialogElement?: Element): void;
|
|
575
|
+
removeMaskRow?(): void;
|
|
576
|
+
addShimmerEffect?(): void;
|
|
577
|
+
updateDefaultCursor?(): void;
|
|
578
|
+
getVisibleColumns?(): Column[];
|
|
579
|
+
refreshHeader?(): void;
|
|
580
|
+
getDataRows?(): Element[];
|
|
581
|
+
getFrozenRightRows?(): Element[];
|
|
582
|
+
getMovableDataRows?(): Element[];
|
|
583
|
+
getFrozenRightDataRows?(): Element[];
|
|
584
|
+
getFrozenDataRows?(): Element[];
|
|
585
|
+
addMovableRows?(fRows: HTMLElement[], mrows: HTMLElement[]): HTMLElement[];
|
|
586
|
+
getPrimaryKeyFieldNames?(): string[];
|
|
587
|
+
autoFitColumns(fieldNames?: string | string[]): void;
|
|
588
|
+
groupColumn(columnName: string): void;
|
|
589
|
+
ungroupColumn(columnName: string): void;
|
|
590
|
+
ensureModuleInjected(module: Function): boolean;
|
|
591
|
+
isContextMenuOpen(): boolean;
|
|
592
|
+
goToPage(pageNo: number): void;
|
|
593
|
+
updateVisibleExpandCollapseRows?(): void;
|
|
594
|
+
getFrozenColumns(): number;
|
|
595
|
+
getFrozenRightColumnsCount?(): number;
|
|
596
|
+
getFrozenLeftColumnsCount?(): number;
|
|
597
|
+
getFrozenLeftCount?(): number;
|
|
598
|
+
getMovableColumnsCount?(): number;
|
|
599
|
+
isFrozenGrid?(): boolean;
|
|
600
|
+
getFrozenMode?(): freezeMode;
|
|
601
|
+
setTablesCount?(): void;
|
|
602
|
+
getTablesCount?(): number;
|
|
603
|
+
setFrozenCount?(): void;
|
|
604
|
+
getVisibleFrozenLeftCount?(): number;
|
|
605
|
+
getVisibleFrozenRightCount?(): number;
|
|
606
|
+
getVisibleMovableCount?(): number;
|
|
607
|
+
getFrozenRightColumns?(): Column[];
|
|
608
|
+
getFrozenLeftColumns?(): Column[];
|
|
609
|
+
getMovableColumns?(): Column[];
|
|
610
|
+
getFrozenRightRowsObject?(): Row<Column>[];
|
|
611
|
+
getFrozenRightContent?(): Element;
|
|
612
|
+
getFrozenRightHeader?(): Element;
|
|
613
|
+
getMovableHeaderTbody?(): Element;
|
|
614
|
+
getMovableContentTbody?(): Element;
|
|
615
|
+
getFrozenHeaderTbody?(): Element;
|
|
616
|
+
getFrozenLeftContentTbody?(): Element;
|
|
617
|
+
getFrozenRightHeaderTbody?(): Element;
|
|
618
|
+
getFrozenRightContentTbody?(): Element;
|
|
619
|
+
refreshReactColumnTemplateByUid?(columnUid: string): void;
|
|
620
|
+
refreshReactHeaderTemplateByUid?(columnUid: string): void;
|
|
621
|
+
getAllDataRows?(includeBatch: boolean): Element[];
|
|
622
|
+
getAllMovableDataRows?(includeBatch: boolean): Element[];
|
|
623
|
+
getAllFrozenDataRows?(includeBatch: boolean): Element[];
|
|
624
|
+
getAllFrozenRightDataRows?(includeBatch: boolean): Element[];
|
|
625
|
+
getMovableColumnHeaderByIndex?(index: number): Element;
|
|
626
|
+
getFrozenRightColumnHeaderByIndex?(index: number): Element;
|
|
627
|
+
getFrozenLeftColumnHeaderByIndex?(index: number): Element;
|
|
628
|
+
applyBiggerTheme(args: Element): void;
|
|
629
|
+
getVisibleFrozenColumns(): number;
|
|
630
|
+
print(): void;
|
|
631
|
+
excelExport(exportProperties?: any, isMultipleExport?: boolean, workbook?: any): Promise<any>;
|
|
632
|
+
csvExport(exportProperties?: any, isMultipleExport?: boolean, workbook?: any): Promise<any>;
|
|
633
|
+
pdfExport(exportProperties?: any, isMultipleExport?: boolean, pdfDoc?: Object): Promise<Object>;
|
|
634
|
+
search(searchString: string): void;
|
|
635
|
+
deleteRecord?(fieldname?: string, data?: Object): void;
|
|
636
|
+
startEdit?(): void;
|
|
637
|
+
endEdit?(): void;
|
|
638
|
+
closeEdit?(): void;
|
|
639
|
+
addRecord?(data?: Object): void;
|
|
640
|
+
deleteRow?(tr: HTMLTableRowElement): void;
|
|
641
|
+
getRowObjectFromUID?(uid: string, isMovable?: boolean, isFrozenRight?: boolean): Row<Column>;
|
|
642
|
+
addFreezeRows?(fRows: Row<Column>[], mRows?: Row<Column>[]): Row<Column>[];
|
|
643
|
+
getRowsObject?(): Row<Column>[];
|
|
644
|
+
getMovableRowsObject?(): Row<Column>[];
|
|
645
|
+
createColumnchooser(x: number, y: number, target: Element): void;
|
|
646
|
+
getDataModule?(): Data;
|
|
647
|
+
refreshTooltip?(): void;
|
|
648
|
+
copy?(withHeader?: boolean): void;
|
|
649
|
+
getLocaleConstants?(): Object;
|
|
650
|
+
getForeignKeyColumns?(): Column[];
|
|
651
|
+
getRowHeight?(): number;
|
|
652
|
+
setCellValue(key: string | number, field: string, value: string | number | boolean | Date): void;
|
|
653
|
+
setRowData(key: string | number, rowData?: Object): void;
|
|
654
|
+
getState?(): Object;
|
|
655
|
+
destroyTemplate?(templateName: string[], index?: any): void;
|
|
656
|
+
getQuery?(): Query;
|
|
657
|
+
log?(type: string | string[], args?: Object): void;
|
|
658
|
+
isDetail?(): boolean;
|
|
659
|
+
updateMediaColumns?(col: Column): void;
|
|
660
|
+
hideScroll?(): void;
|
|
661
|
+
grabColumnByFieldFromAllCols(field: string): Column;
|
|
662
|
+
grabColumnByUidFromAllCols(uid: string): Column;
|
|
663
|
+
getRowUid(prefix: string): string;
|
|
664
|
+
getMovableVirtualContent?(): Element;
|
|
665
|
+
getFrozenVirtualContent?(): Element;
|
|
666
|
+
getMovableVirtualHeader?(): Element;
|
|
667
|
+
getFrozenVirtualHeader?(): Element;
|
|
668
|
+
getFilteredRecords(): Object[] | Promise<Object>;
|
|
669
|
+
getRowElementByUID?(uid: string): Element;
|
|
670
|
+
getMediaColumns?(): void;
|
|
671
|
+
isCollapseStateEnabled?(): boolean;
|
|
672
|
+
mergePersistGridData?(setData?: Object): void;
|
|
673
|
+
setForeignKeyData?(args: DataResult): void;
|
|
674
|
+
getSelectedColumnsUid?(): string[];
|
|
675
|
+
serverExcelExport?(url: string): void;
|
|
676
|
+
serverPdfExport?(url: string): void;
|
|
677
|
+
getCurrentVisibleColumns?(isColVirtualization?: boolean): Column[];
|
|
678
|
+
dataStateChange?: EmitType<DataStateChangeEventArgs>;
|
|
679
|
+
exportGroupCaption?: EmitType<ExportGroupCaptionEventArgs>;
|
|
680
|
+
columnDataStateChange?: EmitType<ColumnDataStateChangeEventArgs>;
|
|
681
|
+
}
|
|
682
|
+
/** @hidden */
|
|
683
|
+
export interface IExpandedRow {
|
|
684
|
+
index?: number;
|
|
685
|
+
gridModel?: Object;
|
|
686
|
+
isExpand?: boolean;
|
|
687
|
+
}
|
|
688
|
+
/** @hidden */
|
|
689
|
+
export interface IRenderer {
|
|
690
|
+
renderPanel(): void;
|
|
691
|
+
renderTable(): void;
|
|
692
|
+
setPanel(panel: Element): void;
|
|
693
|
+
setTable(table: Element): void;
|
|
694
|
+
getPanel(): Element;
|
|
695
|
+
getTable(): Element;
|
|
696
|
+
getRows?(): Row<{}>[] | HTMLCollectionOf<HTMLTableRowElement>;
|
|
697
|
+
getMovableRows?(): Row<{}>[] | HTMLCollectionOf<HTMLTableRowElement>;
|
|
698
|
+
getFrozenRightRows?(): Row<{}>[] | HTMLCollectionOf<HTMLTableRowElement>;
|
|
699
|
+
refreshUI?(): void;
|
|
700
|
+
setVisible?(column?: Column[]): void;
|
|
701
|
+
addEventListener?(): void;
|
|
702
|
+
removeEventListener?(): void;
|
|
703
|
+
getRowElements?(): Element[];
|
|
704
|
+
getMovableRowElements?(): Element[];
|
|
705
|
+
getFrozenRightRowElements?(): Element[];
|
|
706
|
+
setSelection?(uid: string, set: boolean, clearAll: boolean): void;
|
|
707
|
+
getRowByIndex?(index: number): Element;
|
|
708
|
+
getVirtualRowIndex?(index: number): number;
|
|
709
|
+
getMovableRowByIndex?(index: number): Element;
|
|
710
|
+
getFrozenRightRowByIndex?(index: number): Element;
|
|
711
|
+
getRowInfo?(target: Element): RowInfo;
|
|
712
|
+
getState?(): Object;
|
|
713
|
+
getMovableHeader?(): Element;
|
|
714
|
+
getMovableContent?(): Element;
|
|
715
|
+
getFrozenRightContent?(): Element;
|
|
716
|
+
getFrozenRightHeader?(): Element;
|
|
717
|
+
destroyTemplate?(templateName: string[]): void;
|
|
718
|
+
emptyVcRows?(): void;
|
|
719
|
+
getBlockSize?(): number;
|
|
720
|
+
getGroupedTotalBlocks?(): number;
|
|
721
|
+
isEndBlock?(block: number): boolean;
|
|
722
|
+
}
|
|
723
|
+
/**
|
|
724
|
+
* IAction interface
|
|
725
|
+
*
|
|
726
|
+
* @hidden
|
|
727
|
+
*/
|
|
728
|
+
export interface IAction {
|
|
729
|
+
updateModel?(): void;
|
|
730
|
+
onActionBegin?(args?: Object, type?: string): void;
|
|
731
|
+
onActionComplete?(args?: Object, type?: string): void;
|
|
732
|
+
addEventListener?(): void;
|
|
733
|
+
removeEventListener?(): void;
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* @hidden
|
|
737
|
+
*/
|
|
738
|
+
export interface IDataProcessor {
|
|
739
|
+
generateQuery(): Query;
|
|
740
|
+
getData(args: Object, query: Query): Promise<Object>;
|
|
741
|
+
processData?(): void;
|
|
742
|
+
}
|
|
743
|
+
/**
|
|
744
|
+
* @hidden
|
|
745
|
+
*/
|
|
746
|
+
export interface IValueFormatter {
|
|
747
|
+
fromView(value: string, format: Function, target?: string): string | number | Date;
|
|
748
|
+
toView(value: number | Date, format: Function): string | Object;
|
|
749
|
+
setCulture?(cultureName: string): void;
|
|
750
|
+
getFormatFunction?(format: NumberFormatOptions | DateFormatOptions): Function;
|
|
751
|
+
getParserFunction?(format: NumberFormatOptions | DateFormatOptions): Function;
|
|
752
|
+
}
|
|
753
|
+
/**
|
|
754
|
+
* @hidden
|
|
755
|
+
*/
|
|
756
|
+
export interface ITemplateRender {
|
|
757
|
+
compiled: {
|
|
758
|
+
[x: string]: Function;
|
|
759
|
+
};
|
|
760
|
+
compile(key: string, template: string): Function;
|
|
761
|
+
render(key: string, data: Object, params?: {
|
|
762
|
+
[p: string]: Object;
|
|
763
|
+
}): string;
|
|
764
|
+
}
|
|
765
|
+
/**
|
|
766
|
+
* @hidden
|
|
767
|
+
*/
|
|
768
|
+
export interface IEditCell {
|
|
769
|
+
create?: Element | Function | string;
|
|
770
|
+
read?: Object | Function | string;
|
|
771
|
+
write?: void | Function | string;
|
|
772
|
+
params?: DatePickerModel | NumericTextBoxModel | DropDownListModel | CheckBoxModel | MultiSelectModel | AutoCompleteModel | ComboBoxModel | SwitchModel | TimePickerModel | MaskedTextBoxModel;
|
|
773
|
+
destroy?: Function | string;
|
|
774
|
+
}
|
|
775
|
+
/**
|
|
776
|
+
* @hidden
|
|
777
|
+
*/
|
|
778
|
+
export interface IDialogUI {
|
|
779
|
+
params?: DialogModel;
|
|
780
|
+
}
|
|
781
|
+
/**
|
|
782
|
+
* @hidden
|
|
783
|
+
*/
|
|
784
|
+
export interface IFilterUI {
|
|
785
|
+
create?: Element | Function | string;
|
|
786
|
+
read?: Object | Function | string;
|
|
787
|
+
write?: void | Function | string;
|
|
788
|
+
}
|
|
789
|
+
/**
|
|
790
|
+
* @hidden
|
|
791
|
+
*/
|
|
792
|
+
export interface IFilterMUI {
|
|
793
|
+
create?: void | Function | string;
|
|
794
|
+
read?: Object | Function | string;
|
|
795
|
+
write?: void | Function | string;
|
|
796
|
+
}
|
|
797
|
+
/**
|
|
798
|
+
* @hidden
|
|
799
|
+
*/
|
|
800
|
+
export interface ICustomOptr {
|
|
801
|
+
stringOperator?: {
|
|
802
|
+
[key: string]: Object;
|
|
803
|
+
}[];
|
|
804
|
+
numberOperator?: {
|
|
805
|
+
[key: string]: Object;
|
|
806
|
+
}[];
|
|
807
|
+
dateOperator?: {
|
|
808
|
+
[key: string]: Object;
|
|
809
|
+
}[];
|
|
810
|
+
dateTimeOperator?: {
|
|
811
|
+
[key: string]: Object;
|
|
812
|
+
}[];
|
|
813
|
+
booleanOperator?: {
|
|
814
|
+
[key: string]: Object;
|
|
815
|
+
}[];
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* @hidden
|
|
819
|
+
*/
|
|
820
|
+
export interface ICellRenderer<T> {
|
|
821
|
+
element?: Element;
|
|
822
|
+
getGui?(): string | Element;
|
|
823
|
+
format?(column: T, value: Object, data: Object): string;
|
|
824
|
+
evaluate?(node: Element, column: Cell<T>, data: Object, attributes?: Object): boolean;
|
|
825
|
+
setStyleAndAttributes?(node: Element, attributes: {
|
|
826
|
+
[key: string]: Object;
|
|
827
|
+
}): void;
|
|
828
|
+
render(cell: Cell<T>, data: Object, attributes?: {
|
|
829
|
+
[x: string]: string;
|
|
830
|
+
}, isExpand?: boolean, isEdit?: boolean): Element;
|
|
831
|
+
appendHtml?(node: Element, innerHtml: string | Element): Element;
|
|
832
|
+
refresh?(cell: Cell<T>, node: Element): Element;
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* @hidden
|
|
836
|
+
*/
|
|
837
|
+
export interface IRowRenderer<T> {
|
|
838
|
+
element?: Element;
|
|
839
|
+
render(row: Row<T>, column: Column[], attributes?: {
|
|
840
|
+
[x: string]: string;
|
|
841
|
+
}, rowTemplate?: string): Element;
|
|
842
|
+
}
|
|
843
|
+
/**
|
|
844
|
+
* @hidden
|
|
845
|
+
*/
|
|
846
|
+
export interface ICellFormatter {
|
|
847
|
+
getValue(column: Column, data: Object): Object;
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* @hidden
|
|
851
|
+
*/
|
|
852
|
+
export interface IIndex {
|
|
853
|
+
rowIndex?: number;
|
|
854
|
+
cellIndex?: number;
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* @hidden
|
|
858
|
+
*/
|
|
859
|
+
export interface ISelectedCell {
|
|
860
|
+
rowIndex: number;
|
|
861
|
+
cellIndexes: number[];
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* @hidden
|
|
865
|
+
*/
|
|
866
|
+
export interface IFilterOperator {
|
|
867
|
+
contains: string;
|
|
868
|
+
endsWith: string;
|
|
869
|
+
equal: string;
|
|
870
|
+
greaterThan: string;
|
|
871
|
+
greaterThanOrEqual: string;
|
|
872
|
+
lessThan: string;
|
|
873
|
+
lessThanOrEqual: string;
|
|
874
|
+
notEqual: string;
|
|
875
|
+
startsWith: string;
|
|
876
|
+
}
|
|
877
|
+
export interface NotifyArgs {
|
|
878
|
+
records?: Object[];
|
|
879
|
+
count?: number;
|
|
880
|
+
requestType?: Action;
|
|
881
|
+
module?: string;
|
|
882
|
+
enable?: boolean;
|
|
883
|
+
properties?: Object;
|
|
884
|
+
virtualInfo?: VirtualInfo;
|
|
885
|
+
cancel?: boolean;
|
|
886
|
+
rows?: Row<Column>[];
|
|
887
|
+
isFrozen?: boolean;
|
|
888
|
+
args?: NotifyArgs;
|
|
889
|
+
scrollTop?: Object;
|
|
890
|
+
oldProperties?: string[];
|
|
891
|
+
focusElement?: HTMLElement;
|
|
892
|
+
rowObject?: Row<Column>;
|
|
893
|
+
renderMovableContent?: boolean;
|
|
894
|
+
renderFrozenRightContent?: boolean;
|
|
895
|
+
promise?: Promise<Object>;
|
|
896
|
+
isFrozenRowsRender?: boolean;
|
|
897
|
+
}
|
|
898
|
+
export interface LazyLoadArgs {
|
|
899
|
+
/** Defines expand/collapse caption row details. */
|
|
900
|
+
groupInfo?: Row<Column>;
|
|
901
|
+
/** Defines whether get rows from group cache or make a request. */
|
|
902
|
+
enableCaching?: boolean;
|
|
903
|
+
/** Cancel the expand/collapse action. */
|
|
904
|
+
cancel?: boolean;
|
|
905
|
+
/** Defines the caption row element. */
|
|
906
|
+
captionRowElement?: HTMLTableRowElement;
|
|
907
|
+
}
|
|
908
|
+
export interface LazyLoadGroupArgs extends LazyLoadArgs {
|
|
909
|
+
makeRequest?: boolean;
|
|
910
|
+
skip?: number;
|
|
911
|
+
take?: number;
|
|
912
|
+
fields?: string[];
|
|
913
|
+
keys?: string[];
|
|
914
|
+
isExpand?: boolean;
|
|
915
|
+
isScroll?: boolean;
|
|
916
|
+
scrollUp?: boolean;
|
|
917
|
+
cachedRowIndex?: number;
|
|
918
|
+
rowIndex?: number;
|
|
919
|
+
}
|
|
920
|
+
export interface InfiniteScrollArgs {
|
|
921
|
+
requestType?: Action;
|
|
922
|
+
currentPage?: number;
|
|
923
|
+
prevPage?: number;
|
|
924
|
+
startIndex?: number;
|
|
925
|
+
direction?: string;
|
|
926
|
+
isFrozen?: boolean;
|
|
927
|
+
isCaptionCollapse?: boolean;
|
|
928
|
+
parentUid?: string;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
* @hidden
|
|
932
|
+
*/
|
|
933
|
+
export interface FrozenReorderArgs {
|
|
934
|
+
column?: Column;
|
|
935
|
+
destIndex?: number;
|
|
936
|
+
columns?: Column[];
|
|
937
|
+
parent?: Column;
|
|
938
|
+
cancel?: boolean;
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
* @hidden
|
|
942
|
+
*/
|
|
943
|
+
export interface ICell<T> {
|
|
944
|
+
colSpan?: number;
|
|
945
|
+
rowSpan?: number;
|
|
946
|
+
cellType?: CellType;
|
|
947
|
+
visible?: boolean;
|
|
948
|
+
isTemplate?: boolean;
|
|
949
|
+
isDataCell?: boolean;
|
|
950
|
+
column?: T;
|
|
951
|
+
rowID?: string;
|
|
952
|
+
index?: number;
|
|
953
|
+
colIndex?: number;
|
|
954
|
+
className?: string;
|
|
955
|
+
commands?: CommandModel[];
|
|
956
|
+
isForeignKey?: boolean;
|
|
957
|
+
foreignKeyData?: Object;
|
|
958
|
+
}
|
|
959
|
+
/**
|
|
960
|
+
* @hidden
|
|
961
|
+
*/
|
|
962
|
+
export interface IRow<T> {
|
|
963
|
+
uid?: string;
|
|
964
|
+
parentGid?: number;
|
|
965
|
+
childGid?: number;
|
|
966
|
+
data?: Object;
|
|
967
|
+
gSummary?: number;
|
|
968
|
+
aggregatesCount?: number;
|
|
969
|
+
tIndex?: number;
|
|
970
|
+
collapseRows?: Object[];
|
|
971
|
+
isSelected?: boolean;
|
|
972
|
+
isFreezeRow?: boolean;
|
|
973
|
+
isReadOnly?: boolean;
|
|
974
|
+
isCaptionRow?: boolean;
|
|
975
|
+
isAltRow?: boolean;
|
|
976
|
+
isDataRow?: boolean;
|
|
977
|
+
isExpand?: boolean;
|
|
978
|
+
rowSpan?: number;
|
|
979
|
+
cells?: Cell<T>[];
|
|
980
|
+
index?: number;
|
|
981
|
+
indent?: number;
|
|
982
|
+
subRowDetails?: Object;
|
|
983
|
+
height?: string;
|
|
984
|
+
cssClass?: string;
|
|
985
|
+
foreignKeyData?: Object;
|
|
986
|
+
parentUid?: string;
|
|
987
|
+
isSelectable?: boolean;
|
|
988
|
+
}
|
|
989
|
+
/**
|
|
990
|
+
* @hidden
|
|
991
|
+
*/
|
|
992
|
+
export interface IModelGenerator<T> {
|
|
993
|
+
generateRows(data: Object, args?: Object): Row<T>[];
|
|
994
|
+
refreshRows?(input?: Row<T>[]): Row<T>[];
|
|
995
|
+
}
|
|
996
|
+
export interface RowInfo {
|
|
997
|
+
/** returns particular cell element */
|
|
998
|
+
cell?: Element;
|
|
999
|
+
/** returns particular cell index */
|
|
1000
|
+
cellIndex?: number;
|
|
1001
|
+
/** returns particular row element */
|
|
1002
|
+
row?: Element;
|
|
1003
|
+
/** returns particular rowIndex */
|
|
1004
|
+
rowIndex?: number;
|
|
1005
|
+
/** returns particular row data */
|
|
1006
|
+
rowData?: Object;
|
|
1007
|
+
/** return particular column information */
|
|
1008
|
+
column?: Object;
|
|
1009
|
+
}
|
|
1010
|
+
export interface GridActionEventArgs {
|
|
1011
|
+
/** Defines the current action. */
|
|
1012
|
+
requestType?: Action;
|
|
1013
|
+
/** Defines the type of event. */
|
|
1014
|
+
type?: string;
|
|
1015
|
+
/** Cancel the print action */
|
|
1016
|
+
cancel?: boolean;
|
|
1017
|
+
}
|
|
1018
|
+
export interface FailureEventArgs {
|
|
1019
|
+
/** Defines the error information. */
|
|
1020
|
+
error?: Error;
|
|
1021
|
+
}
|
|
1022
|
+
export interface FilterEventArgs extends GridActionEventArgs {
|
|
1023
|
+
/** Defines the object that is currently filtered. */
|
|
1024
|
+
currentFilterObject?: PredicateModel;
|
|
1025
|
+
/** Defines the column name that is currently filtered. */
|
|
1026
|
+
currentFilteringColumn?: string;
|
|
1027
|
+
/** Defines the collection of filtered columns. */
|
|
1028
|
+
columns?: PredicateModel[];
|
|
1029
|
+
}
|
|
1030
|
+
export interface GroupEventArgs extends GridActionEventArgs {
|
|
1031
|
+
/** Defines the field name of the currently grouped columns. */
|
|
1032
|
+
columnName?: string;
|
|
1033
|
+
}
|
|
1034
|
+
export interface PageEventArgs extends GridActionEventArgs {
|
|
1035
|
+
/** Defines the previous page number. */
|
|
1036
|
+
previousPage?: string;
|
|
1037
|
+
/** Defines the current page number. */
|
|
1038
|
+
currentPage?: string;
|
|
1039
|
+
}
|
|
1040
|
+
export interface SortEventArgs extends GridActionEventArgs {
|
|
1041
|
+
/** Defines the field name of currently sorted column. */
|
|
1042
|
+
columnName?: string;
|
|
1043
|
+
/** Defines the direction of sort column. */
|
|
1044
|
+
direction?: SortDirection;
|
|
1045
|
+
}
|
|
1046
|
+
export interface SearchEventArgs extends GridActionEventArgs {
|
|
1047
|
+
/** Defines the string value to search. */
|
|
1048
|
+
searchString?: string;
|
|
1049
|
+
}
|
|
1050
|
+
export interface PrintEventArgs extends GridActionEventArgs {
|
|
1051
|
+
/** Defines the Grid element. */
|
|
1052
|
+
element?: Element;
|
|
1053
|
+
/** Defines the currently selected rows. */
|
|
1054
|
+
selectedRows?: NodeListOf<Element>;
|
|
1055
|
+
/** Cancel the print action */
|
|
1056
|
+
cancel?: boolean;
|
|
1057
|
+
/** Hierarchy Grid print mode */
|
|
1058
|
+
hierarchyPrintMode?: HierarchyGridPrintMode;
|
|
1059
|
+
}
|
|
1060
|
+
export interface DetailDataBoundEventArgs {
|
|
1061
|
+
/** Defines the details row element. */
|
|
1062
|
+
detailElement?: Element;
|
|
1063
|
+
/** Defines the selected row data.
|
|
1064
|
+
*
|
|
1065
|
+
* @isGenericType true
|
|
1066
|
+
*/
|
|
1067
|
+
data?: Object;
|
|
1068
|
+
/** Defines the child grid of the current row. */
|
|
1069
|
+
childGrid?: IGrid;
|
|
1070
|
+
}
|
|
1071
|
+
export interface ColumnChooserEventArgs {
|
|
1072
|
+
/** Defines the parent element. */
|
|
1073
|
+
element?: Element;
|
|
1074
|
+
/** Defines the display columns of column chooser. */
|
|
1075
|
+
columns?: Column[];
|
|
1076
|
+
/** Specifies the instance of column chooser dialog. */
|
|
1077
|
+
dialogInstance?: Object;
|
|
1078
|
+
/** Defines the operator for column chooser search request */
|
|
1079
|
+
searchOperator?: string;
|
|
1080
|
+
}
|
|
1081
|
+
export interface AdaptiveDialogEventArgs {
|
|
1082
|
+
/** Defines the cancel option value. */
|
|
1083
|
+
cancel?: boolean;
|
|
1084
|
+
/** Defines the instance of adaptive dialog. */
|
|
1085
|
+
dialogObj?: Dialog;
|
|
1086
|
+
/** Defines the current action. */
|
|
1087
|
+
requestType?: string;
|
|
1088
|
+
}
|
|
1089
|
+
export interface RowDeselectEventArgs {
|
|
1090
|
+
/** Defines the current selected/deselected row data.
|
|
1091
|
+
*
|
|
1092
|
+
* @isGenericType true
|
|
1093
|
+
*/
|
|
1094
|
+
data?: Object | Object[];
|
|
1095
|
+
/** Defines the selected/deselected row index. */
|
|
1096
|
+
rowIndex?: number;
|
|
1097
|
+
/** Defines the selected/deselected row indexes. */
|
|
1098
|
+
rowIndexes?: number[];
|
|
1099
|
+
/** Defines the selected/deselected row. */
|
|
1100
|
+
row?: Element | Element[];
|
|
1101
|
+
/** Define the foreignKey row data associated with this column */
|
|
1102
|
+
foreignKeyData?: Object | Object[];
|
|
1103
|
+
/** Defines the cancel option value. */
|
|
1104
|
+
cancel?: boolean;
|
|
1105
|
+
/** Defines the target element for row deselect. */
|
|
1106
|
+
target?: Element;
|
|
1107
|
+
/** Defines whether event is triggered by interaction or not. */
|
|
1108
|
+
isInteracted?: boolean;
|
|
1109
|
+
/** Defines whether header checkbox is clicked or not */
|
|
1110
|
+
isHeaderCheckboxClicked?: boolean;
|
|
1111
|
+
}
|
|
1112
|
+
export interface RowSelectEventArgs extends RowDeselectEventArgs {
|
|
1113
|
+
/** Defines the previously selected row index. */
|
|
1114
|
+
previousRowIndex?: number;
|
|
1115
|
+
/** Defines the previously selected row. */
|
|
1116
|
+
previousRow?: Element;
|
|
1117
|
+
/** Defines the target element for selection. */
|
|
1118
|
+
target?: Element;
|
|
1119
|
+
}
|
|
1120
|
+
export interface RecordDoubleClickEventArgs {
|
|
1121
|
+
/** Defines the target element. */
|
|
1122
|
+
target?: Element;
|
|
1123
|
+
/** Defines the cell element. */
|
|
1124
|
+
cell?: Element;
|
|
1125
|
+
/** Defines the cell index. */
|
|
1126
|
+
cellIndex?: number;
|
|
1127
|
+
/** Defines the column object. */
|
|
1128
|
+
column?: Column;
|
|
1129
|
+
/** Defines the name of the event. */
|
|
1130
|
+
name?: string;
|
|
1131
|
+
/** Defines the row element. */
|
|
1132
|
+
row?: Element;
|
|
1133
|
+
/** Defines the current row data.
|
|
1134
|
+
*
|
|
1135
|
+
* @isGenericType true
|
|
1136
|
+
*/
|
|
1137
|
+
rowData?: Object;
|
|
1138
|
+
/** Defines the row index. */
|
|
1139
|
+
rowIndex?: number;
|
|
1140
|
+
/** Define the foreignKey row data associated with this column */
|
|
1141
|
+
foreignKeyData?: Object;
|
|
1142
|
+
}
|
|
1143
|
+
export interface RecordClickEventArgs {
|
|
1144
|
+
/** Defines the target element. */
|
|
1145
|
+
target?: Element;
|
|
1146
|
+
/** Defines the cell element. */
|
|
1147
|
+
cell?: Element;
|
|
1148
|
+
/** Defines the cell index. */
|
|
1149
|
+
cellIndex?: number;
|
|
1150
|
+
/** Defines the column object. */
|
|
1151
|
+
column?: Column;
|
|
1152
|
+
/** Defines the name of the event. */
|
|
1153
|
+
name?: string;
|
|
1154
|
+
/** Defines the row element. */
|
|
1155
|
+
row?: Element;
|
|
1156
|
+
/** Defines the current row data.
|
|
1157
|
+
*
|
|
1158
|
+
* @isGenericType true
|
|
1159
|
+
*/
|
|
1160
|
+
rowData?: Object;
|
|
1161
|
+
/** Defines the row index. */
|
|
1162
|
+
rowIndex?: number;
|
|
1163
|
+
/** Define the foreignKey row data associated with this column */
|
|
1164
|
+
foreignKeyData?: Object;
|
|
1165
|
+
}
|
|
1166
|
+
export interface RowSelectingEventArgs extends RowSelectEventArgs {
|
|
1167
|
+
/** Defines whether CTRL key is pressed. */
|
|
1168
|
+
isCtrlPressed?: boolean;
|
|
1169
|
+
/** Defines whether SHIFT key is pressed. */
|
|
1170
|
+
isShiftPressed?: boolean;
|
|
1171
|
+
}
|
|
1172
|
+
export interface CellDeselectEventArgs {
|
|
1173
|
+
/** Defines the currently selected/deselected row data.
|
|
1174
|
+
*
|
|
1175
|
+
* @isGenericType true
|
|
1176
|
+
*/
|
|
1177
|
+
data?: Object;
|
|
1178
|
+
/** Defines the indexes of the current selected/deselected cells. */
|
|
1179
|
+
cellIndexes?: ISelectedCell[];
|
|
1180
|
+
/** Defines the currently selected/deselected cells. */
|
|
1181
|
+
cells?: Element[];
|
|
1182
|
+
/** Defines the cancel option value. */
|
|
1183
|
+
cancel?: boolean;
|
|
1184
|
+
}
|
|
1185
|
+
export interface CellSelectEventArgs extends CellDeselectEventArgs {
|
|
1186
|
+
/** Defines the index of the current selected cell. */
|
|
1187
|
+
cellIndex?: IIndex;
|
|
1188
|
+
/** Defines the previously selected cell index. */
|
|
1189
|
+
previousRowCellIndex?: number;
|
|
1190
|
+
/** Defines the element. */
|
|
1191
|
+
currentCell: Element;
|
|
1192
|
+
/** Defines the previously selected cell element. */
|
|
1193
|
+
previousRowCell?: Element;
|
|
1194
|
+
}
|
|
1195
|
+
export interface CellSelectingEventArgs extends CellSelectEventArgs {
|
|
1196
|
+
/** Defines whether the CTRL key is pressed or not. */
|
|
1197
|
+
isCtrlPressed?: boolean;
|
|
1198
|
+
/** Defines whether the SHIFT key is pressed or not. */
|
|
1199
|
+
isShiftPressed?: boolean;
|
|
1200
|
+
}
|
|
1201
|
+
export interface ColumnDragEventArgs {
|
|
1202
|
+
/** Defines the target element from which the drag starts. */
|
|
1203
|
+
target?: Element;
|
|
1204
|
+
/** Defines the type of the element dragged. */
|
|
1205
|
+
draggableType?: string;
|
|
1206
|
+
/** Defines the column object that is dragged. */
|
|
1207
|
+
column?: Column;
|
|
1208
|
+
}
|
|
1209
|
+
export interface RowDataBoundEventArgs {
|
|
1210
|
+
/** Defines the current row data.
|
|
1211
|
+
*
|
|
1212
|
+
* @isGenericType true
|
|
1213
|
+
*/
|
|
1214
|
+
data?: Object;
|
|
1215
|
+
/** Defines the row element.
|
|
1216
|
+
*
|
|
1217
|
+
* @blazorType CellDOM
|
|
1218
|
+
*/
|
|
1219
|
+
row?: Element;
|
|
1220
|
+
/** Defines the row height */
|
|
1221
|
+
rowHeight?: number;
|
|
1222
|
+
/** Defines whether the row should be select or not */
|
|
1223
|
+
isSelectable?: boolean;
|
|
1224
|
+
}
|
|
1225
|
+
export interface HeaderCellInfoEventArgs {
|
|
1226
|
+
/** Defines the cell. */
|
|
1227
|
+
cell?: Cell<Column>;
|
|
1228
|
+
/** Defines the cell element. */
|
|
1229
|
+
node?: Element;
|
|
1230
|
+
}
|
|
1231
|
+
export interface ExportGroupCaptionEventArgs {
|
|
1232
|
+
/** Defines the group caption text. */
|
|
1233
|
+
captionText?: string;
|
|
1234
|
+
/** Defines the export type. */
|
|
1235
|
+
type?: string;
|
|
1236
|
+
/** Defines the grouped data items. */
|
|
1237
|
+
data?: Object;
|
|
1238
|
+
/** Defines the style of the grouped cell. */
|
|
1239
|
+
style?: PdfStyle;
|
|
1240
|
+
}
|
|
1241
|
+
export interface QueryCellInfoEventArgs {
|
|
1242
|
+
/** Defines the row data associated with this cell.
|
|
1243
|
+
*
|
|
1244
|
+
* @isGenericType true
|
|
1245
|
+
*/
|
|
1246
|
+
data?: Object;
|
|
1247
|
+
/** Defines the cell element.
|
|
1248
|
+
*
|
|
1249
|
+
* @blazorType CellDOM
|
|
1250
|
+
*/
|
|
1251
|
+
cell?: Element;
|
|
1252
|
+
/** Defines the column object associated with this cell.
|
|
1253
|
+
*
|
|
1254
|
+
* @blazorType GridColumn
|
|
1255
|
+
*/
|
|
1256
|
+
column?: Column;
|
|
1257
|
+
/** Defines the no. of columns to be spanned */
|
|
1258
|
+
colSpan?: number;
|
|
1259
|
+
/** Defines the no. of rows to be spanned */
|
|
1260
|
+
rowSpan?: number;
|
|
1261
|
+
/** Defines the current action. */
|
|
1262
|
+
requestType?: string;
|
|
1263
|
+
/** Define the foreignKey row data associated with this column */
|
|
1264
|
+
foreignKeyData?: Object;
|
|
1265
|
+
}
|
|
1266
|
+
export interface PdfQueryCellInfoEventArgs {
|
|
1267
|
+
/** Defines the column of the current cell. */
|
|
1268
|
+
column?: Column;
|
|
1269
|
+
/** Defines the style of the current cell. */
|
|
1270
|
+
style?: PdfStyle;
|
|
1271
|
+
/** Defines the value of the current cell. */
|
|
1272
|
+
value?: Date | string | number | boolean | PdfTextWebLink | PdfImage;
|
|
1273
|
+
/** Defines the no. of columns to be spanned */
|
|
1274
|
+
colSpan?: number;
|
|
1275
|
+
/** Defines the data of the cell
|
|
1276
|
+
*
|
|
1277
|
+
* @isGenericType true
|
|
1278
|
+
*/
|
|
1279
|
+
data?: Object;
|
|
1280
|
+
/** Defines the current PDF cell */
|
|
1281
|
+
cell?: PdfGridCell;
|
|
1282
|
+
/** Defines the image details */
|
|
1283
|
+
image?: {
|
|
1284
|
+
base64: string;
|
|
1285
|
+
};
|
|
1286
|
+
/** Defines the hyperlink of the cell */
|
|
1287
|
+
hyperLink?: Hyperlink;
|
|
1288
|
+
}
|
|
1289
|
+
export interface ExportDetailDataBoundEventArgs {
|
|
1290
|
+
/** Defines the child grid of the current row. */
|
|
1291
|
+
childGrid?: IGrid;
|
|
1292
|
+
/** Defines the row object of the current data. */
|
|
1293
|
+
row?: Row<Column>;
|
|
1294
|
+
/** Defines the PDF grid current cell. */
|
|
1295
|
+
cell?: PdfGridCell;
|
|
1296
|
+
/** Defines the export properties */
|
|
1297
|
+
exportProperties?: PdfExportProperties | ExcelExportProperties;
|
|
1298
|
+
}
|
|
1299
|
+
export interface AggregateQueryCellInfoEventArgs {
|
|
1300
|
+
/** Defines the row data associated with this cell. */
|
|
1301
|
+
row?: Object;
|
|
1302
|
+
/** Defines the type of the cell */
|
|
1303
|
+
type?: AggregateTemplateType;
|
|
1304
|
+
/** Defines the data of the current cell */
|
|
1305
|
+
data?: object;
|
|
1306
|
+
/** Defines the style of the current cell. */
|
|
1307
|
+
style?: object;
|
|
1308
|
+
}
|
|
1309
|
+
export interface PdfHeaderQueryCellInfoEventArgs {
|
|
1310
|
+
/** Defines the PDF grid current cell. */
|
|
1311
|
+
cell?: object;
|
|
1312
|
+
/** Defines the style of the current cell. */
|
|
1313
|
+
style?: PdfStyle;
|
|
1314
|
+
/** Defines the current cell with column */
|
|
1315
|
+
gridCell?: object;
|
|
1316
|
+
/** Defines the image details */
|
|
1317
|
+
image?: {
|
|
1318
|
+
base64: string;
|
|
1319
|
+
};
|
|
1320
|
+
/** Defines the hyperlink of the cell */
|
|
1321
|
+
hyperLink?: Hyperlink;
|
|
1322
|
+
}
|
|
1323
|
+
export interface Image {
|
|
1324
|
+
/** Defines the base 64 string for image */
|
|
1325
|
+
base64: string;
|
|
1326
|
+
/** Defines the height for the image */
|
|
1327
|
+
height: number;
|
|
1328
|
+
/** Defines the height for the image */
|
|
1329
|
+
width: number;
|
|
1330
|
+
}
|
|
1331
|
+
export interface ExcelQueryCellInfoEventArgs {
|
|
1332
|
+
/** Defines the row data associated with this cell.
|
|
1333
|
+
*
|
|
1334
|
+
* @isGenericType true
|
|
1335
|
+
*/
|
|
1336
|
+
data?: Object;
|
|
1337
|
+
/** Defines the column of the current cell. */
|
|
1338
|
+
column: Column;
|
|
1339
|
+
/** Defines the value of the current cell. */
|
|
1340
|
+
value?: Date | string | number | boolean;
|
|
1341
|
+
/** Defines the style of the current cell. */
|
|
1342
|
+
style?: ExcelStyle;
|
|
1343
|
+
/** Defines the number of columns to be spanned */
|
|
1344
|
+
colSpan?: number;
|
|
1345
|
+
/** Defines the cell data */
|
|
1346
|
+
cell?: number | ExcelStyle | {
|
|
1347
|
+
name: string;
|
|
1348
|
+
} | ExcelCell;
|
|
1349
|
+
/** Defines the image details */
|
|
1350
|
+
image?: Image;
|
|
1351
|
+
/** Defines the hyperlink */
|
|
1352
|
+
hyperLink?: Hyperlink;
|
|
1353
|
+
}
|
|
1354
|
+
export interface ExcelHeaderQueryCellInfoEventArgs {
|
|
1355
|
+
/** Defines the cell that contains colspan. */
|
|
1356
|
+
cell?: Object;
|
|
1357
|
+
/** Defines the style of the current cell. */
|
|
1358
|
+
style?: ExcelStyle;
|
|
1359
|
+
/** Defines the Grid cell instance */
|
|
1360
|
+
gridCell?: Cell<Column> | ExcelCell;
|
|
1361
|
+
/** Defines the image details */
|
|
1362
|
+
image?: Image;
|
|
1363
|
+
/** Defines the hyperlink */
|
|
1364
|
+
hyperLink?: Hyperlink;
|
|
1365
|
+
}
|
|
1366
|
+
export interface FilterSearchBeginEventArgs {
|
|
1367
|
+
/** Defines the current action. */
|
|
1368
|
+
requestType?: string;
|
|
1369
|
+
/** Defines the filter model. */
|
|
1370
|
+
filterModel?: CheckBoxFilterBase;
|
|
1371
|
+
/** Defines the field name of current column */
|
|
1372
|
+
columnName?: string;
|
|
1373
|
+
/** Defines the current Column objects */
|
|
1374
|
+
column?: Column;
|
|
1375
|
+
/** Defines the operator for filter request */
|
|
1376
|
+
operator?: string;
|
|
1377
|
+
/** Defines the matchCase for filter request */
|
|
1378
|
+
matchCase?: boolean;
|
|
1379
|
+
/** Defines the ignoreAccent for filter request */
|
|
1380
|
+
ignoreAccent?: boolean;
|
|
1381
|
+
/** Defines the custom query in before execute */
|
|
1382
|
+
query: Query;
|
|
1383
|
+
/** Defines take number of data */
|
|
1384
|
+
filterChoiceCount: number;
|
|
1385
|
+
/** Defines the datasource for filter request */
|
|
1386
|
+
dataSource?: Object[];
|
|
1387
|
+
/** Defines the value of the current search */
|
|
1388
|
+
value?: Date | string | number | boolean;
|
|
1389
|
+
}
|
|
1390
|
+
export interface FilterUI {
|
|
1391
|
+
/** Defines the field */
|
|
1392
|
+
field?: string;
|
|
1393
|
+
/** Defines the Operator */
|
|
1394
|
+
operator?: string;
|
|
1395
|
+
/** Defines the first operator for excel filter */
|
|
1396
|
+
firstOperator?: string;
|
|
1397
|
+
/** Defines the second Operator for excel filter */
|
|
1398
|
+
secondOperator?: string;
|
|
1399
|
+
}
|
|
1400
|
+
export interface MultipleExport {
|
|
1401
|
+
/** Indicates whether to append the multiple grid in same sheet or different sheet */
|
|
1402
|
+
type?: MultipleExportType;
|
|
1403
|
+
/** Defines the number of blank rows between the multiple grid data */
|
|
1404
|
+
blankRows?: number;
|
|
1405
|
+
}
|
|
1406
|
+
export interface ExcelRow {
|
|
1407
|
+
/** Defines the index for cells */
|
|
1408
|
+
index?: number;
|
|
1409
|
+
/** Defines the cells in a row */
|
|
1410
|
+
cells?: ExcelCell[];
|
|
1411
|
+
/** Defines the group of rows to expand and collapse */
|
|
1412
|
+
grouping?: Object;
|
|
1413
|
+
}
|
|
1414
|
+
export interface ExcelBorder {
|
|
1415
|
+
/** Defines the color of border */
|
|
1416
|
+
color?: string;
|
|
1417
|
+
/** Defines the line style of border */
|
|
1418
|
+
lineStyle?: ExcelBorderLineStyle;
|
|
1419
|
+
}
|
|
1420
|
+
export interface ExcelStyle {
|
|
1421
|
+
/** Defines the color of font */
|
|
1422
|
+
fontColor?: string;
|
|
1423
|
+
/** Defines the name of font */
|
|
1424
|
+
fontName?: string;
|
|
1425
|
+
/** Defines the size of font */
|
|
1426
|
+
fontSize?: number;
|
|
1427
|
+
/** Defines the horizontal alignment for cell style */
|
|
1428
|
+
hAlign?: ExcelHAlign;
|
|
1429
|
+
/** Defines the vertical alignment for cell style */
|
|
1430
|
+
vAlign?: ExcelVAlign;
|
|
1431
|
+
/** Defines the rotation degree for cell style */
|
|
1432
|
+
rotation?: number;
|
|
1433
|
+
/** Defines the bold style for fonts */
|
|
1434
|
+
bold?: boolean;
|
|
1435
|
+
/** Defines the indent for cell style */
|
|
1436
|
+
indent?: number;
|
|
1437
|
+
/** Defines the italic style for fonts */
|
|
1438
|
+
italic?: boolean;
|
|
1439
|
+
/** Defines the underline style for fonts */
|
|
1440
|
+
underline?: boolean;
|
|
1441
|
+
/** Defines the background color for cell style */
|
|
1442
|
+
backColor?: string;
|
|
1443
|
+
/** Defines the wrapText for cell style */
|
|
1444
|
+
wrapText?: boolean;
|
|
1445
|
+
/** Defines the borders for cell style */
|
|
1446
|
+
borders?: ExcelBorder;
|
|
1447
|
+
/** Defines the format of the cell */
|
|
1448
|
+
numberFormat?: string;
|
|
1449
|
+
/** Defines the type of the cell */
|
|
1450
|
+
type?: string;
|
|
1451
|
+
/** Defines the strike through of the cell */
|
|
1452
|
+
strikeThrough?: boolean;
|
|
1453
|
+
}
|
|
1454
|
+
export interface PdfStyle {
|
|
1455
|
+
/** Defines the horizontal alignment */
|
|
1456
|
+
textAlignment?: PdfHAlign;
|
|
1457
|
+
/** Defines the brush color of font */
|
|
1458
|
+
textBrushColor?: string;
|
|
1459
|
+
/** Defines the pen color of font */
|
|
1460
|
+
textPenColor?: string;
|
|
1461
|
+
/** Defines the font family */
|
|
1462
|
+
fontFamily?: string;
|
|
1463
|
+
/** Defines the font size */
|
|
1464
|
+
fontSize?: number;
|
|
1465
|
+
/** Defines the font bold */
|
|
1466
|
+
bold?: boolean;
|
|
1467
|
+
/** Defines the indent alignment */
|
|
1468
|
+
indent?: PdfHAlign;
|
|
1469
|
+
/** Defines the italic font */
|
|
1470
|
+
italic?: boolean;
|
|
1471
|
+
/** Defines the underlined font */
|
|
1472
|
+
underline?: boolean;
|
|
1473
|
+
/** Defines the strike-out font */
|
|
1474
|
+
strikeout?: boolean;
|
|
1475
|
+
/** Defines the horizontal alignment */
|
|
1476
|
+
verticalAlignment?: PdfVAlign;
|
|
1477
|
+
/** Defines the background color */
|
|
1478
|
+
backgroundColor?: string;
|
|
1479
|
+
/** Defines the grid border */
|
|
1480
|
+
border?: PdfBorder;
|
|
1481
|
+
/** Defines the cell indent */
|
|
1482
|
+
paragraphIndent?: number;
|
|
1483
|
+
cellPadding?: PdfPaddings;
|
|
1484
|
+
}
|
|
1485
|
+
export interface PdfBorder {
|
|
1486
|
+
/** Defines the border color */
|
|
1487
|
+
color?: string;
|
|
1488
|
+
/** Defines the border width */
|
|
1489
|
+
width?: number;
|
|
1490
|
+
/** Defines the border dash style */
|
|
1491
|
+
dashStyle?: PdfDashStyle;
|
|
1492
|
+
/** Defines the line style of border */
|
|
1493
|
+
lineStyle?: BorderLineStyle;
|
|
1494
|
+
}
|
|
1495
|
+
export interface ExcelCell {
|
|
1496
|
+
/** Defines the index for the cell */
|
|
1497
|
+
index?: number;
|
|
1498
|
+
/** Defines the column span for the cell */
|
|
1499
|
+
colSpan?: number;
|
|
1500
|
+
/** Defines the value of the cell */
|
|
1501
|
+
value?: string | boolean | number | Date;
|
|
1502
|
+
/** Defines the hyperlink of the cell */
|
|
1503
|
+
hyperlink?: Hyperlink;
|
|
1504
|
+
/** Defines the style of the cell */
|
|
1505
|
+
style?: ExcelStyle;
|
|
1506
|
+
/** Defines the row span for the cell */
|
|
1507
|
+
rowSpan?: number;
|
|
1508
|
+
}
|
|
1509
|
+
export interface Hyperlink {
|
|
1510
|
+
/** Defines the Url for hyperlink */
|
|
1511
|
+
target?: string;
|
|
1512
|
+
/** Defines the display text for hyperlink */
|
|
1513
|
+
displayText?: string;
|
|
1514
|
+
}
|
|
1515
|
+
export interface ExcelHeader {
|
|
1516
|
+
/** Defines the number of rows between the header and grid data */
|
|
1517
|
+
headerRows?: number;
|
|
1518
|
+
/** Defines the rows in header content */
|
|
1519
|
+
rows?: ExcelRow[];
|
|
1520
|
+
}
|
|
1521
|
+
export interface ExcelFooter {
|
|
1522
|
+
/** Defines the number of rows between the grid data and footer */
|
|
1523
|
+
footerRows?: number;
|
|
1524
|
+
/** Defines the rows in footer content */
|
|
1525
|
+
rows?: ExcelRow[];
|
|
1526
|
+
}
|
|
1527
|
+
export interface ExcelExportProperties {
|
|
1528
|
+
/** Defines the data source dynamically before exporting */
|
|
1529
|
+
dataSource?: Object | DataManager;
|
|
1530
|
+
/** Defined the query dynamically before exporting */
|
|
1531
|
+
query?: Query;
|
|
1532
|
+
/** Exports multiple grid into the excel document */
|
|
1533
|
+
multipleExport?: MultipleExport;
|
|
1534
|
+
/** Defines the header content for exported document */
|
|
1535
|
+
header?: ExcelHeader;
|
|
1536
|
+
/** Defines the footer content for exported document */
|
|
1537
|
+
footer?: ExcelFooter;
|
|
1538
|
+
/** Defines the columns which are to be customized for Export alone.
|
|
1539
|
+
*
|
|
1540
|
+
* @blazorType List<GridColumn>
|
|
1541
|
+
*/
|
|
1542
|
+
columns?: Column[];
|
|
1543
|
+
/** Indicates to export current page or all page */
|
|
1544
|
+
exportType?: ExportType;
|
|
1545
|
+
/** Indicates whether to show the hidden columns in exported excel */
|
|
1546
|
+
includeHiddenColumn?: boolean;
|
|
1547
|
+
/** Defines the theme for exported data */
|
|
1548
|
+
theme?: ExcelTheme;
|
|
1549
|
+
/** Defines the file name for the exported file */
|
|
1550
|
+
fileName?: string;
|
|
1551
|
+
/** Defines the hierarchy export mode for the pdf grid */
|
|
1552
|
+
hierarchyExportMode?: 'Expanded' | 'All' | 'None';
|
|
1553
|
+
/** Defines the delimiter for CSV file export */
|
|
1554
|
+
separator?: string;
|
|
1555
|
+
/** Defines filter icons while exporting */
|
|
1556
|
+
enableFilter?: boolean;
|
|
1557
|
+
}
|
|
1558
|
+
export interface RowDragEventArgs {
|
|
1559
|
+
/** Defines the selected row's element. */
|
|
1560
|
+
rows?: Element[];
|
|
1561
|
+
/** Defines the target element from which drag starts. */
|
|
1562
|
+
target?: Element;
|
|
1563
|
+
/** Defines the type of the element to be dragged.
|
|
1564
|
+
*
|
|
1565
|
+
* @hidden
|
|
1566
|
+
*/
|
|
1567
|
+
draggableType?: string;
|
|
1568
|
+
/** Defines the selected row data.
|
|
1569
|
+
*
|
|
1570
|
+
* @isGenericType true
|
|
1571
|
+
*/
|
|
1572
|
+
data?: Object[];
|
|
1573
|
+
/** Defines the drag element from index. */
|
|
1574
|
+
fromIndex?: number;
|
|
1575
|
+
/** Defines the target element from index. */
|
|
1576
|
+
dropIndex?: number;
|
|
1577
|
+
/** Define the mouse event */
|
|
1578
|
+
originalEvent?: object;
|
|
1579
|
+
cancel?: boolean;
|
|
1580
|
+
}
|
|
1581
|
+
/**
|
|
1582
|
+
* @hidden
|
|
1583
|
+
*/
|
|
1584
|
+
export interface EJ2Intance extends HTMLElement {
|
|
1585
|
+
ej2_instances: Object | Object[];
|
|
1586
|
+
}
|
|
1587
|
+
/**
|
|
1588
|
+
* @hidden
|
|
1589
|
+
*/
|
|
1590
|
+
export interface IPosition {
|
|
1591
|
+
x: number;
|
|
1592
|
+
y: number;
|
|
1593
|
+
}
|
|
1594
|
+
/**
|
|
1595
|
+
* @hidden
|
|
1596
|
+
*/
|
|
1597
|
+
export interface ParentDetails {
|
|
1598
|
+
parentID?: string;
|
|
1599
|
+
parentPrimaryKeys?: string[];
|
|
1600
|
+
parentKeyField?: string;
|
|
1601
|
+
parentKeyFieldValue?: string;
|
|
1602
|
+
parentRowData?: Object;
|
|
1603
|
+
parentInstObj?: IGrid;
|
|
1604
|
+
}
|
|
1605
|
+
/**
|
|
1606
|
+
* @hidden
|
|
1607
|
+
*/
|
|
1608
|
+
export interface ScrollPositionType {
|
|
1609
|
+
top?: number;
|
|
1610
|
+
left?: number;
|
|
1611
|
+
}
|
|
1612
|
+
/**
|
|
1613
|
+
* @hidden
|
|
1614
|
+
*/
|
|
1615
|
+
export interface VirtualInfo {
|
|
1616
|
+
data?: boolean;
|
|
1617
|
+
event?: string;
|
|
1618
|
+
block?: number;
|
|
1619
|
+
page?: number;
|
|
1620
|
+
currentPage?: number;
|
|
1621
|
+
direction?: string;
|
|
1622
|
+
blockIndexes?: number[];
|
|
1623
|
+
columnIndexes?: number[];
|
|
1624
|
+
columnBlocks?: number[];
|
|
1625
|
+
loadSelf?: boolean;
|
|
1626
|
+
loadNext?: boolean;
|
|
1627
|
+
nextInfo?: {
|
|
1628
|
+
page?: number;
|
|
1629
|
+
};
|
|
1630
|
+
sentinelInfo?: SentinelType;
|
|
1631
|
+
offsets?: Offsets;
|
|
1632
|
+
startIndex?: number;
|
|
1633
|
+
endIndex?: number;
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* @hidden
|
|
1637
|
+
*/
|
|
1638
|
+
export interface InterSection {
|
|
1639
|
+
container?: HTMLElement;
|
|
1640
|
+
pageHeight?: number;
|
|
1641
|
+
debounceEvent?: boolean;
|
|
1642
|
+
axes?: string[];
|
|
1643
|
+
scrollbar?: Element;
|
|
1644
|
+
movableContainer?: Element;
|
|
1645
|
+
prevTop?: number;
|
|
1646
|
+
prevLeft?: number;
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* @hidden
|
|
1650
|
+
*/
|
|
1651
|
+
export interface ICancel {
|
|
1652
|
+
/** Defines the cancel option value. */
|
|
1653
|
+
cancel?: boolean;
|
|
1654
|
+
}
|
|
1655
|
+
/**
|
|
1656
|
+
* @hidden
|
|
1657
|
+
*/
|
|
1658
|
+
export interface IPrimaryKey {
|
|
1659
|
+
/** Defines the primaryKey. */
|
|
1660
|
+
primaryKey?: string[];
|
|
1661
|
+
}
|
|
1662
|
+
export interface BeforeBatchAddArgs extends ICancel, IPrimaryKey {
|
|
1663
|
+
/** Defines the default data object.
|
|
1664
|
+
*
|
|
1665
|
+
* @isGenericType true
|
|
1666
|
+
*/
|
|
1667
|
+
defaultData?: Object;
|
|
1668
|
+
}
|
|
1669
|
+
/**
|
|
1670
|
+
* @hidden
|
|
1671
|
+
*/
|
|
1672
|
+
export interface BatchCancelArgs {
|
|
1673
|
+
/** Defines the rows. */
|
|
1674
|
+
rows?: Row<Column>[];
|
|
1675
|
+
/** Defines the request type. */
|
|
1676
|
+
requestType?: string;
|
|
1677
|
+
}
|
|
1678
|
+
/**
|
|
1679
|
+
* @hidden
|
|
1680
|
+
*/
|
|
1681
|
+
export interface BatchDeleteArgs extends IPrimaryKey {
|
|
1682
|
+
/** Defines the deleted data.
|
|
1683
|
+
*
|
|
1684
|
+
* @isGenericType true
|
|
1685
|
+
*/
|
|
1686
|
+
rowData?: Object;
|
|
1687
|
+
/** Defines the row index. */
|
|
1688
|
+
rowIndex?: number;
|
|
1689
|
+
}
|
|
1690
|
+
export interface BeforeBatchDeleteArgs extends BatchDeleteArgs, ICancel {
|
|
1691
|
+
/** Defines the row element. */
|
|
1692
|
+
row?: Element;
|
|
1693
|
+
}
|
|
1694
|
+
export interface BeforeBatchSaveArgs extends ICancel {
|
|
1695
|
+
/** Defines the changed record object. */
|
|
1696
|
+
batchChanges?: Object;
|
|
1697
|
+
}
|
|
1698
|
+
export interface ResizeArgs extends ICancel {
|
|
1699
|
+
/** Event argument of point or touch action.
|
|
1700
|
+
*
|
|
1701
|
+
* @hidden
|
|
1702
|
+
*/
|
|
1703
|
+
e?: MouseEvent | TouchEvent;
|
|
1704
|
+
/** Defines the resizing column details */
|
|
1705
|
+
column?: Column;
|
|
1706
|
+
}
|
|
1707
|
+
/**
|
|
1708
|
+
* @hidden
|
|
1709
|
+
*/
|
|
1710
|
+
export interface BatchAddArgs extends ICancel, IPrimaryKey {
|
|
1711
|
+
/** Defines the added data.
|
|
1712
|
+
*
|
|
1713
|
+
* @isGenericType true
|
|
1714
|
+
*/
|
|
1715
|
+
defaultData?: Object;
|
|
1716
|
+
/** Defines the column index. */
|
|
1717
|
+
columnIndex?: number;
|
|
1718
|
+
/** Defines the row element. */
|
|
1719
|
+
row?: Element | Element[];
|
|
1720
|
+
/** Defines the cell element. */
|
|
1721
|
+
cell?: Element | Element[] | HTMLCollection[];
|
|
1722
|
+
/** Defines the column object. */
|
|
1723
|
+
columnObject?: Column;
|
|
1724
|
+
}
|
|
1725
|
+
export interface BeginEditArgs extends ICancel, IPrimaryKey {
|
|
1726
|
+
/** Defines the edited data.
|
|
1727
|
+
*
|
|
1728
|
+
* @isGenericType true
|
|
1729
|
+
*/
|
|
1730
|
+
rowData?: Object;
|
|
1731
|
+
/** Defines the edited row index. */
|
|
1732
|
+
rowIndex?: number;
|
|
1733
|
+
/** Defines the current edited row. */
|
|
1734
|
+
row?: Element;
|
|
1735
|
+
/** Defines the name of the event. */
|
|
1736
|
+
type?: string;
|
|
1737
|
+
/** Defines the primary key value. */
|
|
1738
|
+
primaryKeyValue?: string[];
|
|
1739
|
+
}
|
|
1740
|
+
export interface DeleteEventArgs {
|
|
1741
|
+
/** Defines the cancel option value. */
|
|
1742
|
+
cancel?: boolean;
|
|
1743
|
+
/** Defines the request type. */
|
|
1744
|
+
requestType?: string;
|
|
1745
|
+
/** Defines the foreign key record object (JSON). @hidden */
|
|
1746
|
+
foreignKeyData?: Object;
|
|
1747
|
+
/** Defines the record objects.
|
|
1748
|
+
*
|
|
1749
|
+
* @isGenericType true
|
|
1750
|
+
*/
|
|
1751
|
+
data?: Object[];
|
|
1752
|
+
/** Defines the selected rows for delete. */
|
|
1753
|
+
tr?: Element[];
|
|
1754
|
+
/** Defines the name of the event. */
|
|
1755
|
+
type?: string;
|
|
1756
|
+
}
|
|
1757
|
+
export interface AddEventArgs {
|
|
1758
|
+
/** If `cancel` is set to true, then the current action will stopped. */
|
|
1759
|
+
cancel?: boolean;
|
|
1760
|
+
/** Defines the request type. */
|
|
1761
|
+
requestType?: string;
|
|
1762
|
+
/** Defines the foreign key record object.
|
|
1763
|
+
*
|
|
1764
|
+
* @hidden
|
|
1765
|
+
*/
|
|
1766
|
+
foreignKeyData?: Object;
|
|
1767
|
+
/** Defines the record objects.
|
|
1768
|
+
*
|
|
1769
|
+
* @isGenericType true
|
|
1770
|
+
*/
|
|
1771
|
+
data?: Object;
|
|
1772
|
+
/** Defines the event name. */
|
|
1773
|
+
type?: string;
|
|
1774
|
+
/** Defines the previous data. */
|
|
1775
|
+
previousData?: Object;
|
|
1776
|
+
/** Defines the added row. */
|
|
1777
|
+
row?: Object;
|
|
1778
|
+
/** Added row index */
|
|
1779
|
+
index?: number;
|
|
1780
|
+
/**
|
|
1781
|
+
* @hidden
|
|
1782
|
+
* Defines the record objects.
|
|
1783
|
+
*/
|
|
1784
|
+
rowData?: Object;
|
|
1785
|
+
/** Defines the target for dialog */
|
|
1786
|
+
target?: HTMLElement;
|
|
1787
|
+
}
|
|
1788
|
+
export interface SaveEventArgs extends AddEventArgs {
|
|
1789
|
+
/** Defines the previous data.
|
|
1790
|
+
*
|
|
1791
|
+
* @isGenericType true
|
|
1792
|
+
*/
|
|
1793
|
+
previousData?: Object;
|
|
1794
|
+
/** Defines the selected row index. */
|
|
1795
|
+
selectedRow?: number;
|
|
1796
|
+
/** Defines the current action. */
|
|
1797
|
+
action?: string;
|
|
1798
|
+
/** Added row index */
|
|
1799
|
+
index?: number;
|
|
1800
|
+
/** Defines the promise. */
|
|
1801
|
+
promise?: Promise<Object>;
|
|
1802
|
+
}
|
|
1803
|
+
export interface EditEventArgs extends BeginEditArgs {
|
|
1804
|
+
/** Defines the request type. */
|
|
1805
|
+
requestType?: string;
|
|
1806
|
+
/** Defines foreign data object. */
|
|
1807
|
+
foreignKeyData?: Object;
|
|
1808
|
+
addRecord?(data?: Object, index?: number): void;
|
|
1809
|
+
/** Define the form element */
|
|
1810
|
+
form?: HTMLFormElement;
|
|
1811
|
+
/** Define the movable table form element */
|
|
1812
|
+
movableForm?: HTMLFormElement;
|
|
1813
|
+
/** Define the target for dialog */
|
|
1814
|
+
target?: HTMLElement;
|
|
1815
|
+
/** Define frozen right table form element */
|
|
1816
|
+
frozenRightForm?: HTMLFormElement;
|
|
1817
|
+
}
|
|
1818
|
+
export interface DialogEditEventArgs extends EditEventArgs {
|
|
1819
|
+
/** Defines the dialog object */
|
|
1820
|
+
dialog?: DialogModel;
|
|
1821
|
+
}
|
|
1822
|
+
/** @hidden */
|
|
1823
|
+
export interface CustomEditEventArgs extends EditEventArgs {
|
|
1824
|
+
/** Defines the virtual scroll action */
|
|
1825
|
+
isScroll?: boolean;
|
|
1826
|
+
/** Defines custom virtualization form validation */
|
|
1827
|
+
isCustomFormValidation?: boolean;
|
|
1828
|
+
}
|
|
1829
|
+
/** @hidden */
|
|
1830
|
+
export interface CustomAddEventArgs extends AddEventArgs {
|
|
1831
|
+
/** Defines the virtual scroll x axis */
|
|
1832
|
+
isScroll?: boolean;
|
|
1833
|
+
}
|
|
1834
|
+
/**
|
|
1835
|
+
* @hidden
|
|
1836
|
+
*/
|
|
1837
|
+
export interface CellEditSameArgs extends ICancel {
|
|
1838
|
+
/** Defines the row data object.
|
|
1839
|
+
*
|
|
1840
|
+
* @isGenericType true
|
|
1841
|
+
*/
|
|
1842
|
+
rowData?: Object;
|
|
1843
|
+
/** Defines the column name. */
|
|
1844
|
+
columnName?: string;
|
|
1845
|
+
/** Defines the cell object. */
|
|
1846
|
+
cell?: Element;
|
|
1847
|
+
/** Defines the column object. */
|
|
1848
|
+
columnObject?: Column;
|
|
1849
|
+
/** Defines the cell value. */
|
|
1850
|
+
value?: string;
|
|
1851
|
+
/** Defines isForeignKey option value. */
|
|
1852
|
+
isForeignKey?: boolean;
|
|
1853
|
+
/** Defines the Column Object */
|
|
1854
|
+
column?: Column;
|
|
1855
|
+
}
|
|
1856
|
+
export interface CellEditArgs extends CellEditSameArgs, IPrimaryKey {
|
|
1857
|
+
/** Defines the current row. */
|
|
1858
|
+
row?: Element;
|
|
1859
|
+
/** Defines the validation rules. */
|
|
1860
|
+
validationRules?: Object;
|
|
1861
|
+
/** Defines the name of the event. */
|
|
1862
|
+
type?: string;
|
|
1863
|
+
/** Defines foreign data object */
|
|
1864
|
+
foreignKeyData?: Object;
|
|
1865
|
+
}
|
|
1866
|
+
export interface CommandClickEventArgs {
|
|
1867
|
+
/** Defines the current target element. */
|
|
1868
|
+
target?: HTMLElement;
|
|
1869
|
+
/** cancel the CRUD action. */
|
|
1870
|
+
cancel?: boolean;
|
|
1871
|
+
/** Defines the current command column . */
|
|
1872
|
+
commandColumn?: CommandModel;
|
|
1873
|
+
/** returns particular row data
|
|
1874
|
+
*
|
|
1875
|
+
* @isGenericType true
|
|
1876
|
+
*/
|
|
1877
|
+
rowData?: Object;
|
|
1878
|
+
}
|
|
1879
|
+
export interface IFilterCreate {
|
|
1880
|
+
column?: Column;
|
|
1881
|
+
target?: HTMLElement;
|
|
1882
|
+
getOptrInstance?: FlMenuOptrUI;
|
|
1883
|
+
localizeText?: L10n;
|
|
1884
|
+
dialogObj?: Dialog;
|
|
1885
|
+
}
|
|
1886
|
+
export interface CellSaveArgs extends CellEditSameArgs {
|
|
1887
|
+
/** Defines the previous value of the cell. */
|
|
1888
|
+
previousValue?: string;
|
|
1889
|
+
}
|
|
1890
|
+
export interface BeforeDataBoundArgs {
|
|
1891
|
+
/** Defines the data.
|
|
1892
|
+
*
|
|
1893
|
+
* @isGenericType true
|
|
1894
|
+
*/
|
|
1895
|
+
result?: Object[];
|
|
1896
|
+
/** Defines the data count. */
|
|
1897
|
+
count?: number;
|
|
1898
|
+
/** Defines the cancel option value. */
|
|
1899
|
+
cancel?: boolean;
|
|
1900
|
+
}
|
|
1901
|
+
/**
|
|
1902
|
+
* @hidden
|
|
1903
|
+
*/
|
|
1904
|
+
export interface IEdit {
|
|
1905
|
+
formObj?: FormValidator;
|
|
1906
|
+
destroy?: Function;
|
|
1907
|
+
closeEdit?(): void;
|
|
1908
|
+
deleteRecord?(fieldname?: string, data?: Object): void;
|
|
1909
|
+
startEdit?(tr?: Element): void;
|
|
1910
|
+
addRecord?(data?: Object, index?: number): void;
|
|
1911
|
+
deleteRow?(tr: HTMLTableRowElement): void;
|
|
1912
|
+
endEdit?(data?: Object): void;
|
|
1913
|
+
batchSave?(): void;
|
|
1914
|
+
getBatchChanges?(): Object;
|
|
1915
|
+
removeRowObjectFromUID?(uid: string): void;
|
|
1916
|
+
addRowObject?(row: Row<Column>): void;
|
|
1917
|
+
editCell?(index: number, field: string, isAdd?: boolean): void;
|
|
1918
|
+
updateCell?(rowIndex: number, field: string, value: string | number | boolean | Date): void;
|
|
1919
|
+
updateRow?(index: number, data: Object): void;
|
|
1920
|
+
saveCell?(isForceSave?: boolean): void;
|
|
1921
|
+
escapeCellEdit?(): void;
|
|
1922
|
+
addCancelWhilePaging?(): void;
|
|
1923
|
+
args?: {
|
|
1924
|
+
requestType?: string;
|
|
1925
|
+
};
|
|
1926
|
+
isAdded?: boolean;
|
|
1927
|
+
previousData?: object;
|
|
1928
|
+
}
|
|
1929
|
+
export interface CheckBoxChangeEventArgs extends ICancel {
|
|
1930
|
+
/** Defines the checked state. */
|
|
1931
|
+
checked?: boolean;
|
|
1932
|
+
/** Defines the selected row indexes. */
|
|
1933
|
+
selectedRowIndexes?: number[];
|
|
1934
|
+
/** Defines the target element for selection. */
|
|
1935
|
+
target?: Element;
|
|
1936
|
+
}
|
|
1937
|
+
/**
|
|
1938
|
+
* @hidden
|
|
1939
|
+
*/
|
|
1940
|
+
export interface BeforeCopyEventArgs extends ICancel {
|
|
1941
|
+
/** Defines the grid copied data. */
|
|
1942
|
+
data?: string;
|
|
1943
|
+
}
|
|
1944
|
+
export interface BeforePasteEventArgs {
|
|
1945
|
+
/** Defines the grid pasted data. */
|
|
1946
|
+
column?: Column;
|
|
1947
|
+
data?: string | number | boolean | Date;
|
|
1948
|
+
cancel?: boolean;
|
|
1949
|
+
rowIndex?: number;
|
|
1950
|
+
}
|
|
1951
|
+
export interface BeforeAutoFillEventArgs {
|
|
1952
|
+
/** Defines the grid autofill data. */
|
|
1953
|
+
column?: Column;
|
|
1954
|
+
value?: string;
|
|
1955
|
+
cancel?: boolean;
|
|
1956
|
+
}
|
|
1957
|
+
/**
|
|
1958
|
+
* Defines options for custom command buttons.
|
|
1959
|
+
*/
|
|
1960
|
+
export interface CommandButtonOptions extends ButtonModel {
|
|
1961
|
+
/**
|
|
1962
|
+
* Defines handler for the click event.
|
|
1963
|
+
*/
|
|
1964
|
+
click?: EmitType<Event>;
|
|
1965
|
+
}
|
|
1966
|
+
/**
|
|
1967
|
+
* Define options for custom command buttons.
|
|
1968
|
+
*/
|
|
1969
|
+
export interface CommandModel {
|
|
1970
|
+
/**
|
|
1971
|
+
* Define the command Button tooltip
|
|
1972
|
+
*/
|
|
1973
|
+
title?: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* Define the command Button type
|
|
1976
|
+
*
|
|
1977
|
+
* @blazorDefaultValue none
|
|
1978
|
+
*/
|
|
1979
|
+
type?: CommandButtonType;
|
|
1980
|
+
/**
|
|
1981
|
+
* Define the button model
|
|
1982
|
+
*/
|
|
1983
|
+
buttonOption?: CommandButtonOptions;
|
|
1984
|
+
}
|
|
1985
|
+
/**
|
|
1986
|
+
* Defines the pending state for Custom Service Data
|
|
1987
|
+
*/
|
|
1988
|
+
export interface PendingState {
|
|
1989
|
+
/**
|
|
1990
|
+
* The function which resolves the current action's promise.
|
|
1991
|
+
*/
|
|
1992
|
+
resolver?: Function;
|
|
1993
|
+
/**
|
|
1994
|
+
* Defines the current state of the action.
|
|
1995
|
+
*/
|
|
1996
|
+
isPending?: boolean;
|
|
1997
|
+
/**
|
|
1998
|
+
* Grouping property for Custom data service
|
|
1999
|
+
*/
|
|
2000
|
+
group?: string[];
|
|
2001
|
+
/**
|
|
2002
|
+
* aggregate support for Custom data service
|
|
2003
|
+
*/
|
|
2004
|
+
aggregates?: Object[];
|
|
2005
|
+
/**
|
|
2006
|
+
* DataSource changed through set model
|
|
2007
|
+
*/
|
|
2008
|
+
isDataChanged?: boolean;
|
|
2009
|
+
}
|
|
2010
|
+
/**
|
|
2011
|
+
* Sorting property for Custom data Service
|
|
2012
|
+
*/
|
|
2013
|
+
export interface Sorts {
|
|
2014
|
+
/** Defines the field to be sorted */
|
|
2015
|
+
name?: string;
|
|
2016
|
+
/** Defines the direction of sorting */
|
|
2017
|
+
direction?: string;
|
|
2018
|
+
}
|
|
2019
|
+
export interface ColumnDataStateChangeEventArgs {
|
|
2020
|
+
/** Defines the filter query */
|
|
2021
|
+
where?: PredicateModel[];
|
|
2022
|
+
/** Defines the search query */
|
|
2023
|
+
search?: PredicateModel[];
|
|
2024
|
+
/** Defines the grid action details performed by paging, grouping, filtering, searching, sorting */
|
|
2025
|
+
action?: PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs;
|
|
2026
|
+
/** Defines the function to be called to refresh column dataSource */
|
|
2027
|
+
setColumnData?: Function;
|
|
2028
|
+
}
|
|
2029
|
+
/** Custom data service event types */
|
|
2030
|
+
export interface DataStateChangeEventArgs {
|
|
2031
|
+
/** Defines the skip count in datasource record */
|
|
2032
|
+
skip?: number;
|
|
2033
|
+
/** Defines the page size */
|
|
2034
|
+
take?: number;
|
|
2035
|
+
/** Defines the filter criteria */
|
|
2036
|
+
where?: Predicate[];
|
|
2037
|
+
/** Defines the sorted field and direction */
|
|
2038
|
+
sorted?: Sorts[];
|
|
2039
|
+
/** Defines the grouped field names */
|
|
2040
|
+
group?: string[];
|
|
2041
|
+
/** Defines the aggregates object */
|
|
2042
|
+
aggregates?: Object[];
|
|
2043
|
+
/** Defines the search criteria */
|
|
2044
|
+
search?: SearchSettingsModel[];
|
|
2045
|
+
/** Defines the grid action details performed by paging, grouping, filtering, searching, sorting */
|
|
2046
|
+
action?: PageEventArgs | GroupEventArgs | FilterEventArgs | SearchEventArgs | SortEventArgs;
|
|
2047
|
+
/** Defines the remote table name */
|
|
2048
|
+
table?: string;
|
|
2049
|
+
/** Defines the selected field names */
|
|
2050
|
+
select?: string[];
|
|
2051
|
+
/** If `count` is set true, then the remote service needs to return records and count */
|
|
2052
|
+
count?: boolean;
|
|
2053
|
+
/** Defines the checkbox filter dataSource */
|
|
2054
|
+
dataSource?: Function;
|
|
2055
|
+
}
|
|
2056
|
+
export interface DataSourceChangedEventArgs {
|
|
2057
|
+
/** Defines the current action type. */
|
|
2058
|
+
requestType?: string;
|
|
2059
|
+
/** Defines the current action. */
|
|
2060
|
+
action?: string;
|
|
2061
|
+
/** Defines the primary column field */
|
|
2062
|
+
key?: string | string[];
|
|
2063
|
+
/** Defines the state of the performed action */
|
|
2064
|
+
state?: DataStateChangeEventArgs;
|
|
2065
|
+
/** Defines the selected row data.
|
|
2066
|
+
*
|
|
2067
|
+
* @isGenericType true
|
|
2068
|
+
*/
|
|
2069
|
+
data?: Object | Object[];
|
|
2070
|
+
/** Defines the primary key value */
|
|
2071
|
+
primaryKeyValues?: Object[];
|
|
2072
|
+
/** Defines the index value */
|
|
2073
|
+
index?: number;
|
|
2074
|
+
/** Defines the end of editing function. */
|
|
2075
|
+
endEdit?: Function;
|
|
2076
|
+
/** Defines the Cancel of editing process */
|
|
2077
|
+
cancelEdit?: Function;
|
|
2078
|
+
/** Defines the changes made in batch editing */
|
|
2079
|
+
changes?: Object;
|
|
2080
|
+
/** Defines the query */
|
|
2081
|
+
query?: Query;
|
|
2082
|
+
}
|
|
2083
|
+
/**
|
|
2084
|
+
* @hidden
|
|
2085
|
+
*/
|
|
2086
|
+
export interface IFocus {
|
|
2087
|
+
matrix: Matrix;
|
|
2088
|
+
onKeyPress?: Function;
|
|
2089
|
+
onClick?: Function;
|
|
2090
|
+
onFocus?: Function;
|
|
2091
|
+
lastIdxCell: boolean;
|
|
2092
|
+
target?: HTMLElement;
|
|
2093
|
+
jump?: (action: string, current: number[]) => SwapInfo;
|
|
2094
|
+
getFocusInfo?: () => FocusInfo;
|
|
2095
|
+
getFocusable?: (element: HTMLElement) => HTMLElement;
|
|
2096
|
+
getTable?: () => HTMLTableElement;
|
|
2097
|
+
selector?: (row: Row<Column>, cell: Cell<Column>) => boolean;
|
|
2098
|
+
generateRows?: (rows: Row<Column>[], optionals?: Object) => void;
|
|
2099
|
+
getInfo?: (e?: BaseKeyboardEventArgs) => FocusedContainer;
|
|
2100
|
+
validator?: () => Function;
|
|
2101
|
+
getNextCurrent?: (previous: number[], swap?: SwapInfo, active?: IFocus, action?: string) => number[];
|
|
2102
|
+
preventDefault?: (e: BaseKeyboardEventArgs, info: FocusInfo) => void;
|
|
2103
|
+
nextRowFocusValidate?: (index: number) => number;
|
|
2104
|
+
previousRowFocusValidate?: (index: number) => number;
|
|
2105
|
+
}
|
|
2106
|
+
/**
|
|
2107
|
+
* @hidden
|
|
2108
|
+
*/
|
|
2109
|
+
export interface FocusInfo {
|
|
2110
|
+
element?: HTMLElement;
|
|
2111
|
+
elementToFocus?: HTMLElement;
|
|
2112
|
+
outline?: boolean;
|
|
2113
|
+
class?: string;
|
|
2114
|
+
skipAction?: boolean;
|
|
2115
|
+
uid?: string;
|
|
2116
|
+
}
|
|
2117
|
+
/**
|
|
2118
|
+
* @hidden
|
|
2119
|
+
*/
|
|
2120
|
+
export interface CellFocusArgs {
|
|
2121
|
+
element?: HTMLElement;
|
|
2122
|
+
parent?: HTMLElement;
|
|
2123
|
+
indexes?: number[];
|
|
2124
|
+
byKey?: boolean;
|
|
2125
|
+
byClick?: boolean;
|
|
2126
|
+
keyArgs?: BaseKeyboardEventArgs;
|
|
2127
|
+
clickArgs?: Event;
|
|
2128
|
+
isJump?: boolean;
|
|
2129
|
+
container?: FocusedContainer;
|
|
2130
|
+
outline?: boolean;
|
|
2131
|
+
cancel?: boolean;
|
|
2132
|
+
}
|
|
2133
|
+
/**
|
|
2134
|
+
* @hidden
|
|
2135
|
+
*/
|
|
2136
|
+
export interface FocusedContainer {
|
|
2137
|
+
isContent?: boolean;
|
|
2138
|
+
isHeader?: boolean;
|
|
2139
|
+
isDataCell?: boolean;
|
|
2140
|
+
isFrozen?: boolean;
|
|
2141
|
+
isStacked?: boolean;
|
|
2142
|
+
isSelectable?: boolean;
|
|
2143
|
+
indexes?: number[];
|
|
2144
|
+
}
|
|
2145
|
+
/**
|
|
2146
|
+
* @hidden
|
|
2147
|
+
*/
|
|
2148
|
+
export interface SwapInfo {
|
|
2149
|
+
swap?: boolean;
|
|
2150
|
+
toHeader?: boolean;
|
|
2151
|
+
toFrozen?: boolean;
|
|
2152
|
+
current?: number[];
|
|
2153
|
+
toFrozenRight?: boolean;
|
|
2154
|
+
}
|
|
2155
|
+
/**
|
|
2156
|
+
* @hidden
|
|
2157
|
+
*/
|
|
2158
|
+
export interface KeyboardEventArgs extends KeyboardEvent {
|
|
2159
|
+
cancel?: boolean;
|
|
2160
|
+
}
|
|
2161
|
+
/**
|
|
2162
|
+
* @hidden
|
|
2163
|
+
*/
|
|
2164
|
+
export interface IFilter {
|
|
2165
|
+
type?: string;
|
|
2166
|
+
dataSource?: Object[] | DataManager;
|
|
2167
|
+
hideSearchbox?: boolean;
|
|
2168
|
+
itemTemplate?: string;
|
|
2169
|
+
ui?: IFilterMUI;
|
|
2170
|
+
operator?: string;
|
|
2171
|
+
params?: DatePickerModel | NumericTextBoxModel | DropDownListModel | AutoCompleteModel | DateTimePickerModel;
|
|
2172
|
+
}
|
|
2173
|
+
/**
|
|
2174
|
+
* @hidden
|
|
2175
|
+
*/
|
|
2176
|
+
export interface IFilterArgs {
|
|
2177
|
+
type?: string;
|
|
2178
|
+
height: number;
|
|
2179
|
+
columns?: ColumnModel[];
|
|
2180
|
+
field?: string;
|
|
2181
|
+
displayName?: string;
|
|
2182
|
+
query?: Query;
|
|
2183
|
+
dataSource?: Object[] | DataManager;
|
|
2184
|
+
dataManager?: DataManager;
|
|
2185
|
+
format?: string;
|
|
2186
|
+
filteredColumns?: Object[];
|
|
2187
|
+
localizedStrings?: Object;
|
|
2188
|
+
localeObj?: L10n;
|
|
2189
|
+
position?: {
|
|
2190
|
+
X: number;
|
|
2191
|
+
Y: number;
|
|
2192
|
+
};
|
|
2193
|
+
formatFn?: Function;
|
|
2194
|
+
parserFn?: Function;
|
|
2195
|
+
hideSearchbox?: boolean;
|
|
2196
|
+
allowCaseSensitive?: boolean;
|
|
2197
|
+
handler?: Function;
|
|
2198
|
+
template?: Function;
|
|
2199
|
+
target?: Element;
|
|
2200
|
+
foreignKeyValue?: string;
|
|
2201
|
+
column?: ColumnModel;
|
|
2202
|
+
actualPredicate?: {
|
|
2203
|
+
[key: string]: PredicateModel[];
|
|
2204
|
+
};
|
|
2205
|
+
uid?: string;
|
|
2206
|
+
isForeignKey?: boolean;
|
|
2207
|
+
ignoreAccent?: boolean;
|
|
2208
|
+
isRemote?: boolean;
|
|
2209
|
+
isResponsiveFilter?: boolean;
|
|
2210
|
+
operator?: string;
|
|
2211
|
+
cancel?: boolean;
|
|
2212
|
+
disableHtmlEncode?: boolean;
|
|
2213
|
+
}
|
|
2214
|
+
export interface PdfExportProperties {
|
|
2215
|
+
/** Defines the Pdf orientation. */
|
|
2216
|
+
pageOrientation?: PageOrientation;
|
|
2217
|
+
/** Defines the Pdf page size. */
|
|
2218
|
+
pageSize?: PdfPageSize;
|
|
2219
|
+
/** Defines the Pdf header. */
|
|
2220
|
+
header?: PdfHeader;
|
|
2221
|
+
/** Defines the columns which are to be customized for Export alone.
|
|
2222
|
+
*
|
|
2223
|
+
* @blazorType List<GridColumn>
|
|
2224
|
+
*/
|
|
2225
|
+
columns?: Column[];
|
|
2226
|
+
/** Defines the Pdf footer. */
|
|
2227
|
+
footer?: PdfFooter;
|
|
2228
|
+
/** Indicates whether to show the hidden columns in exported Pdf */
|
|
2229
|
+
includeHiddenColumn?: boolean;
|
|
2230
|
+
/** Defines the data source dynamically before exporting */
|
|
2231
|
+
dataSource?: Object | DataManager | Object[];
|
|
2232
|
+
/** Indicates to export current page or all page */
|
|
2233
|
+
exportType?: ExportType;
|
|
2234
|
+
/** Defines the theme for exported data */
|
|
2235
|
+
theme?: PdfTheme;
|
|
2236
|
+
/** Defines the file name for the exported file */
|
|
2237
|
+
fileName?: string;
|
|
2238
|
+
/** Defines the hierarchy export mode for the pdf grid */
|
|
2239
|
+
hierarchyExportMode?: 'Expanded' | 'All' | 'None';
|
|
2240
|
+
/** Defines the overflow of columns for the pdf grid */
|
|
2241
|
+
allowHorizontalOverflow?: boolean;
|
|
2242
|
+
}
|
|
2243
|
+
export interface PdfTheme {
|
|
2244
|
+
/** Defines the style of header content. */
|
|
2245
|
+
header?: PdfThemeStyle;
|
|
2246
|
+
/** Defines the theme style of record content. */
|
|
2247
|
+
record?: PdfThemeStyle;
|
|
2248
|
+
/** Defines the theme style of caption content. */
|
|
2249
|
+
caption?: PdfThemeStyle;
|
|
2250
|
+
}
|
|
2251
|
+
export interface ExcelTheme {
|
|
2252
|
+
/** Defines the style of header content. */
|
|
2253
|
+
header?: ExcelStyle;
|
|
2254
|
+
/** Defines the theme style of record content. */
|
|
2255
|
+
record?: ExcelStyle;
|
|
2256
|
+
/** Defines the theme style of caption content. */
|
|
2257
|
+
caption?: ExcelStyle;
|
|
2258
|
+
}
|
|
2259
|
+
export interface PdfThemeStyle {
|
|
2260
|
+
/** Defines the font color of theme style. */
|
|
2261
|
+
fontColor?: string;
|
|
2262
|
+
/** Defines the font name of theme style. */
|
|
2263
|
+
fontName?: string;
|
|
2264
|
+
/** Defines the font size of theme style. */
|
|
2265
|
+
fontSize?: number;
|
|
2266
|
+
/** Defines the bold of theme style. */
|
|
2267
|
+
bold?: boolean;
|
|
2268
|
+
/** Defines the borders of theme style. */
|
|
2269
|
+
border?: PdfBorder;
|
|
2270
|
+
/** Defines the font of the theme.
|
|
2271
|
+
*
|
|
2272
|
+
* @blazorType PdfGridFont
|
|
2273
|
+
*/
|
|
2274
|
+
font?: PdfStandardFont | PdfTrueTypeFont;
|
|
2275
|
+
/** Defines the italic of theme style. */
|
|
2276
|
+
italic?: boolean;
|
|
2277
|
+
/** Defines the underline of theme style. */
|
|
2278
|
+
underline?: boolean;
|
|
2279
|
+
/** Defines the strikeout of theme style. */
|
|
2280
|
+
strikeout?: boolean;
|
|
2281
|
+
}
|
|
2282
|
+
export interface PdfGridFont {
|
|
2283
|
+
/** Defines the fontFamily of font content. */
|
|
2284
|
+
fontFamily?: object;
|
|
2285
|
+
/** Defines the fontSize of font content. */
|
|
2286
|
+
fontSize?: number;
|
|
2287
|
+
/** Defines the trueTypeFont is enabled or not for font content.
|
|
2288
|
+
*
|
|
2289
|
+
* @default false
|
|
2290
|
+
*/
|
|
2291
|
+
isTrueType: boolean;
|
|
2292
|
+
/** Defines the fontStyle of font content. */
|
|
2293
|
+
fontStyle?: object;
|
|
2294
|
+
}
|
|
2295
|
+
export interface PdfHeader {
|
|
2296
|
+
/** Defines the header content distance from top. */
|
|
2297
|
+
fromTop?: number;
|
|
2298
|
+
/** Defines the height of header content. */
|
|
2299
|
+
height?: number;
|
|
2300
|
+
/** Defines the header contents. */
|
|
2301
|
+
contents?: PdfHeaderFooterContent[];
|
|
2302
|
+
}
|
|
2303
|
+
export interface PdfFooter {
|
|
2304
|
+
/** Defines the footer content distance from bottom. */
|
|
2305
|
+
fromBottom?: number;
|
|
2306
|
+
/** Defines the height of footer content. */
|
|
2307
|
+
height?: number;
|
|
2308
|
+
/** Defines the footer contents */
|
|
2309
|
+
contents?: PdfHeaderFooterContent[];
|
|
2310
|
+
}
|
|
2311
|
+
export interface PdfHeaderFooterContent {
|
|
2312
|
+
/** Defines the content type */
|
|
2313
|
+
type: ContentType;
|
|
2314
|
+
/** Defines the page number type */
|
|
2315
|
+
pageNumberType?: PdfPageNumberType;
|
|
2316
|
+
/** Defines the style of content */
|
|
2317
|
+
style?: PdfContentStyle;
|
|
2318
|
+
/** Defines the pdf points for drawing line */
|
|
2319
|
+
points?: PdfPoints;
|
|
2320
|
+
/** Defines the format for customizing page number */
|
|
2321
|
+
format?: string;
|
|
2322
|
+
/** Defines the position of the content */
|
|
2323
|
+
position?: PdfPosition;
|
|
2324
|
+
/** Defines the size of content */
|
|
2325
|
+
size?: PdfSize;
|
|
2326
|
+
/** Defines the base64 string for image content type */
|
|
2327
|
+
src?: string;
|
|
2328
|
+
/** Defines the value for content */
|
|
2329
|
+
value?: any;
|
|
2330
|
+
/** Defines the font for the content */
|
|
2331
|
+
font?: PdfStandardFont | PdfTrueTypeFont;
|
|
2332
|
+
/** Defines the alignment of header */
|
|
2333
|
+
stringFormat?: PdfStringFormat;
|
|
2334
|
+
}
|
|
2335
|
+
export interface PdfPosition {
|
|
2336
|
+
/** Defines the x position */
|
|
2337
|
+
x: number;
|
|
2338
|
+
/** Defines the y position */
|
|
2339
|
+
y: number;
|
|
2340
|
+
}
|
|
2341
|
+
export interface PdfSize {
|
|
2342
|
+
/** Defines the height */
|
|
2343
|
+
height: number;
|
|
2344
|
+
/** Defines the width */
|
|
2345
|
+
width: number;
|
|
2346
|
+
}
|
|
2347
|
+
export interface PdfPoints {
|
|
2348
|
+
/** Defines the x1 position */
|
|
2349
|
+
x1: number;
|
|
2350
|
+
/** Defines the y1 position */
|
|
2351
|
+
y1: number;
|
|
2352
|
+
/** Defines the x2 position */
|
|
2353
|
+
x2: number;
|
|
2354
|
+
/** Defines the y2 position */
|
|
2355
|
+
y2: number;
|
|
2356
|
+
}
|
|
2357
|
+
export interface PdfContentStyle {
|
|
2358
|
+
/** Defines the pen color. */
|
|
2359
|
+
penColor?: string;
|
|
2360
|
+
/** Defines the pen size. */
|
|
2361
|
+
penSize?: number;
|
|
2362
|
+
/** Defines the dash style. */
|
|
2363
|
+
dashStyle?: PdfDashStyle;
|
|
2364
|
+
/** Defines the text brush color. */
|
|
2365
|
+
textBrushColor?: string;
|
|
2366
|
+
/** Defines the text pen color. */
|
|
2367
|
+
textPenColor?: string;
|
|
2368
|
+
/** Defines the font size. */
|
|
2369
|
+
fontSize?: number;
|
|
2370
|
+
/** Defines the horizontal alignment. */
|
|
2371
|
+
hAlign?: PdfHAlign;
|
|
2372
|
+
/** Defines the vertical alignment. */
|
|
2373
|
+
vAlign?: PdfVAlign;
|
|
2374
|
+
}
|
|
2375
|
+
/**
|
|
2376
|
+
* Defines the context menu item model.
|
|
2377
|
+
*/
|
|
2378
|
+
export interface ContextMenuItemModel extends MenuItemModel {
|
|
2379
|
+
/**
|
|
2380
|
+
* Define the target to show the menu item.
|
|
2381
|
+
*/
|
|
2382
|
+
target?: string;
|
|
2383
|
+
}
|
|
2384
|
+
export interface ColumnMenuItemModel extends MenuItemModel {
|
|
2385
|
+
hide?: boolean;
|
|
2386
|
+
}
|
|
2387
|
+
export interface ColumnMenuOpenEventArgs extends BeforeOpenCloseMenuEventArgs {
|
|
2388
|
+
column?: Column;
|
|
2389
|
+
}
|
|
2390
|
+
export interface ColumnMenuClickEventArgs extends MenuEventArgs {
|
|
2391
|
+
column?: Column;
|
|
2392
|
+
}
|
|
2393
|
+
export interface ContextMenuClickEventArgs {
|
|
2394
|
+
column?: Column;
|
|
2395
|
+
rowInfo?: RowInfo;
|
|
2396
|
+
element: HTMLElement;
|
|
2397
|
+
/** Defines the Menu Items.
|
|
2398
|
+
*
|
|
2399
|
+
* @blazorType Syncfusion.Blazor.Navigations.MenuItemModel
|
|
2400
|
+
*/
|
|
2401
|
+
item: MenuItemModel;
|
|
2402
|
+
event?: Event;
|
|
2403
|
+
name?: string;
|
|
2404
|
+
}
|
|
2405
|
+
export interface ContextMenuOpenEventArgs extends BeforeOpenCloseMenuEventArgs {
|
|
2406
|
+
column?: Column;
|
|
2407
|
+
rowInfo?: RowInfo;
|
|
2408
|
+
}
|
|
2409
|
+
export interface ExcelExportCompleteArgs {
|
|
2410
|
+
/** Defines the promise object for blob data. */
|
|
2411
|
+
promise?: Promise<{
|
|
2412
|
+
blobData: Blob;
|
|
2413
|
+
}>;
|
|
2414
|
+
}
|
|
2415
|
+
export interface PdfExportCompleteArgs {
|
|
2416
|
+
/** Defines the promise object for blob data. */
|
|
2417
|
+
promise?: Promise<{
|
|
2418
|
+
blobData: Blob;
|
|
2419
|
+
}>;
|
|
2420
|
+
}
|
|
2421
|
+
export interface SelectionNotifyArgs extends NotifyArgs {
|
|
2422
|
+
row?: HTMLElement;
|
|
2423
|
+
CheckState?: boolean;
|
|
2424
|
+
}
|
|
2425
|
+
/**
|
|
2426
|
+
* @hidden
|
|
2427
|
+
*/
|
|
2428
|
+
export interface DataResult {
|
|
2429
|
+
result: Object[] | Group[];
|
|
2430
|
+
count: number;
|
|
2431
|
+
aggregates?: object;
|
|
2432
|
+
}
|
|
2433
|
+
export interface RowDropEventArgs extends RowDragEventArgs {
|
|
2434
|
+
cancel?: boolean;
|
|
2435
|
+
}
|
|
2436
|
+
export interface AggregateTemplateContext {
|
|
2437
|
+
/** Gets sum aggregate value */
|
|
2438
|
+
sum: string;
|
|
2439
|
+
/** Gets average aggregate value */
|
|
2440
|
+
average: string;
|
|
2441
|
+
/** Gets maximum aggregate value */
|
|
2442
|
+
max: string;
|
|
2443
|
+
/** Gets minimum aggregate value */
|
|
2444
|
+
min: string;
|
|
2445
|
+
/** Gets count aggregate value */
|
|
2446
|
+
count: string;
|
|
2447
|
+
/** Gets true count aggregate value */
|
|
2448
|
+
trueCount: string;
|
|
2449
|
+
/** Specifies false count aggregate value */
|
|
2450
|
+
falseCount: string;
|
|
2451
|
+
/** Gets custom aggregate value */
|
|
2452
|
+
custom: string;
|
|
2453
|
+
/** Gets the current group field name */
|
|
2454
|
+
field?: string;
|
|
2455
|
+
/** Gets header text of the grouped column */
|
|
2456
|
+
headerText?: string;
|
|
2457
|
+
/** Gets grouped data key value */
|
|
2458
|
+
key?: string;
|
|
2459
|
+
/** Gets corresponding grouped foreign key value */
|
|
2460
|
+
foreignKey?: string;
|
|
2461
|
+
}
|
|
2462
|
+
export interface PagerTemplateContext {
|
|
2463
|
+
/** Gets the current page number */
|
|
2464
|
+
currentPage?: number;
|
|
2465
|
+
/** Gets the page size number */
|
|
2466
|
+
pageSize?: number;
|
|
2467
|
+
/** Gets the page count */
|
|
2468
|
+
pageCount?: number;
|
|
2469
|
+
/** Gets the total records count */
|
|
2470
|
+
totalRecordsCount?: number;
|
|
2471
|
+
/** Gets the total number of pages */
|
|
2472
|
+
totalPages?: number;
|
|
2473
|
+
}
|
|
2474
|
+
export interface CaptionTemplateContext {
|
|
2475
|
+
GroupGuid?: string;
|
|
2476
|
+
/** Gets the current group field name */
|
|
2477
|
+
field?: string;
|
|
2478
|
+
/** Gets depth or level in which the group caption is present. */
|
|
2479
|
+
level?: number;
|
|
2480
|
+
/** Gets grouped data key value */
|
|
2481
|
+
key?: string;
|
|
2482
|
+
/** Gets corresponding grouped foreign key value */
|
|
2483
|
+
foreignKey?: string;
|
|
2484
|
+
/** Gets count value which specified the number of records in the group */
|
|
2485
|
+
count?: number;
|
|
2486
|
+
/** Gets header text of the grouped column */
|
|
2487
|
+
headerText?: string;
|
|
2488
|
+
}
|
|
2489
|
+
/**
|
|
2490
|
+
* @hidden
|
|
2491
|
+
*/
|
|
2492
|
+
export interface ActionArgs {
|
|
2493
|
+
/**
|
|
2494
|
+
* @blazorType string
|
|
2495
|
+
*/
|
|
2496
|
+
requestType?: Action | string;
|
|
2497
|
+
type?: string;
|
|
2498
|
+
fromIndex?: number;
|
|
2499
|
+
toIndex?: number;
|
|
2500
|
+
toColumnUid?: string;
|
|
2501
|
+
fromColumnUid?: string[];
|
|
2502
|
+
isMultipleReorder?: boolean;
|
|
2503
|
+
virtualStartIndex?: number;
|
|
2504
|
+
virtualEndIndex?: number;
|
|
2505
|
+
startColumnIndex?: number;
|
|
2506
|
+
endColumnIndex?: number;
|
|
2507
|
+
axis?: string;
|
|
2508
|
+
translateX?: number;
|
|
2509
|
+
rHeight?: number;
|
|
2510
|
+
vTableWidth?: number;
|
|
2511
|
+
}
|
|
2512
|
+
export interface CheckBoxBeforeRenderer {
|
|
2513
|
+
dataSource?: object[];
|
|
2514
|
+
field?: string;
|
|
2515
|
+
executeQuery?: boolean;
|
|
2516
|
+
}
|
|
2517
|
+
export interface ColumnDeselectEventArgs {
|
|
2518
|
+
/** Defines the selected/deselected column index. */
|
|
2519
|
+
columnIndex?: number;
|
|
2520
|
+
/** Defines the selected/deselected column indexes. */
|
|
2521
|
+
columnIndexes?: number[];
|
|
2522
|
+
/** Defines the selected/deselected column. */
|
|
2523
|
+
headerCell?: Element | Element[];
|
|
2524
|
+
/** Defines the selected/deselected column */
|
|
2525
|
+
column?: Column;
|
|
2526
|
+
/** Defines the cancel option value. */
|
|
2527
|
+
cancel?: boolean;
|
|
2528
|
+
/** Defines the target element for column deselect. */
|
|
2529
|
+
target?: Element;
|
|
2530
|
+
/** Defines whether event is triggered by interaction or not. */
|
|
2531
|
+
isInteracted?: boolean;
|
|
2532
|
+
}
|
|
2533
|
+
export interface ColumnSelectEventArgs extends ColumnDeselectEventArgs {
|
|
2534
|
+
/** Defines the previously selected column index. */
|
|
2535
|
+
previousColumnIndex?: number;
|
|
2536
|
+
/** Defines the target element for column selection. */
|
|
2537
|
+
target?: Element;
|
|
2538
|
+
}
|
|
2539
|
+
export interface ColumnSelectingEventArgs extends ColumnSelectEventArgs {
|
|
2540
|
+
/** Defines whether CTRL key is pressed. */
|
|
2541
|
+
isCtrlPressed?: boolean;
|
|
2542
|
+
/** Defines whether SHIFT key is pressed. */
|
|
2543
|
+
isShiftPressed?: boolean;
|
|
2544
|
+
}
|
|
2545
|
+
/**
|
|
2546
|
+
* @hidden
|
|
2547
|
+
*/
|
|
2548
|
+
export interface ResponsiveDialogArgs {
|
|
2549
|
+
primaryKeyValue?: string[];
|
|
2550
|
+
rowData?: Object;
|
|
2551
|
+
dialog?: DialogModel;
|
|
2552
|
+
target?: HTMLElement;
|
|
2553
|
+
col?: Column;
|
|
2554
|
+
action?: ResponsiveDialogAction;
|
|
2555
|
+
}
|
|
2556
|
+
/**
|
|
2557
|
+
* @hidden
|
|
2558
|
+
*/
|
|
2559
|
+
export interface ExportHelperArgs extends PdfQueryCellInfoEventArgs {
|
|
2560
|
+
isForeignKey?: boolean;
|
|
2561
|
+
}
|
|
2562
|
+
/**
|
|
2563
|
+
* @hidden
|
|
2564
|
+
*/
|
|
2565
|
+
export interface ForeignKeyFormat {
|
|
2566
|
+
[key: string]: Object[];
|
|
2567
|
+
}
|