@progress/kendo-vue-grid 8.0.3-develop.2 → 8.0.3-develop.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (121) hide show
  1. package/BasePDFExport.d.ts +59 -0
  2. package/Grid.d.ts +542 -0
  3. package/GridColumn.d.ts +18 -0
  4. package/GridNav.d.ts +26 -0
  5. package/GridSearchBox.d.ts +42 -0
  6. package/GridState.d.ts +234 -0
  7. package/GridToolbar.d.ts +32 -0
  8. package/RootGrid.d.ts +429 -0
  9. package/ScrollMode.d.ts +8 -0
  10. package/StatusBar.d.ts +21 -0
  11. package/VirtualScroll.d.ts +43 -0
  12. package/cells/GridCell.d.ts +123 -0
  13. package/cells/GridDetailCell.d.ts +38 -0
  14. package/cells/GridDetailHierarchyCell.d.ts +23 -0
  15. package/cells/GridEditCell.d.ts +86 -0
  16. package/cells/GridFilterCell.d.ts +60 -0
  17. package/cells/GridGroupCell.d.ts +68 -0
  18. package/cells/GridHierarchyCell.d.ts +67 -0
  19. package/cells/GridSelectionCell.d.ts +65 -0
  20. package/columnMenu/ColumnMenu.d.ts +191 -0
  21. package/columnMenu/ColumnMenuContent.d.ts +58 -0
  22. package/columnMenu/GridColumnMenuCheckboxFilter.d.ts +102 -0
  23. package/columnMenu/GridColumnMenuFilter.d.ts +129 -0
  24. package/columnMenu/GridColumnMenuFilter.mjs +5 -5
  25. package/columnMenu/GridColumnMenuFilterCell.d.ts +65 -0
  26. package/columnMenu/GridColumnMenuFilterOperators.d.ts +49 -0
  27. package/columnMenu/GridColumnMenuFilterUI.d.ts +59 -0
  28. package/columnMenu/GridColumnMenuItem.d.ts +60 -0
  29. package/columnMenu/GridColumnMenuItemContent.d.ts +26 -0
  30. package/columnMenu/GridColumnMenuItemGroup.d.ts +12 -0
  31. package/columnMenu/GridColumnMenuSort.d.ts +46 -0
  32. package/common.d.ts +184 -0
  33. package/components/GridDragClue.d.ts +11 -0
  34. package/components/GridDropClue.d.ts +11 -0
  35. package/components/GridLoader.d.ts +32 -0
  36. package/components/PagerContainer.d.ts +11 -0
  37. package/components/VirtualScrollHeightContainer.d.ts +11 -0
  38. package/components/colGroup/GridColGroup.d.ts +11 -0
  39. package/components/noRecords/GridNoRecords.d.ts +15 -0
  40. package/components/noRecords/GridNoRecordsContainer.d.ts +15 -0
  41. package/components/utils.d.ts +21 -0
  42. package/dist/cdn/js/kendo-vue-grid.js +1 -1
  43. package/drag/ColumnDraggable.d.ts +34 -0
  44. package/drag/ColumnResize.d.ts +46 -0
  45. package/drag/ColumnResizer.d.ts +27 -0
  46. package/drag/CommonDragLogic.d.ts +43 -0
  47. package/drag/DragClue.d.ts +18 -0
  48. package/drag/DropClue.d.ts +17 -0
  49. package/drag/GroupingIndicator.d.ts +50 -0
  50. package/filterCommon.d.ts +86 -0
  51. package/footer/Footer.d.ts +57 -0
  52. package/footer/FooterRow.d.ts +35 -0
  53. package/header/FilterRow.d.ts +65 -0
  54. package/header/GridHeaderCell.d.ts +34 -0
  55. package/header/GridHeaderSelectionCell.d.ts +25 -0
  56. package/header/GroupPanel.d.ts +52 -0
  57. package/header/Header.d.ts +70 -0
  58. package/header/HeaderRow.d.ts +140 -0
  59. package/index.d.mts +42 -3319
  60. package/index.d.ts +42 -3319
  61. package/interfaces/ColumnType.d.ts +13 -0
  62. package/interfaces/CompositeHighlightDescriptor.d.ts +29 -0
  63. package/interfaces/ExtendedColumnProps.d.ts +33 -0
  64. package/interfaces/GridCellProps.d.ts +176 -0
  65. package/interfaces/GridCellRenderModel.d.ts +15 -0
  66. package/interfaces/GridColSpanProps.d.ts +21 -0
  67. package/interfaces/GridColumnChildrenProps.d.ts +12 -0
  68. package/interfaces/GridColumnMenuBaseProps.d.ts +21 -0
  69. package/interfaces/GridColumnMenuColumnProps.d.ts +20 -0
  70. package/interfaces/GridColumnMenuColumnsChooserBaseProps.d.ts +22 -0
  71. package/interfaces/GridColumnMenuExtendedFilterProps.d.ts +49 -0
  72. package/interfaces/GridColumnMenuFilterBaseProps.d.ts +56 -0
  73. package/interfaces/GridColumnMenuFilterProps.d.ts +34 -0
  74. package/interfaces/GridColumnMenuFilterUIProps.d.ts +62 -0
  75. package/interfaces/GridColumnMenuGroupBaseProps.d.ts +26 -0
  76. package/interfaces/GridColumnMenuProps.d.ts +48 -0
  77. package/interfaces/GridColumnMenuSortBaseProps.d.ts +35 -0
  78. package/interfaces/GridColumnProps.d.ts +207 -0
  79. package/interfaces/GridColumnState.d.ts +44 -0
  80. package/interfaces/GridDataType.d.ts +12 -0
  81. package/interfaces/GridDetailExpandableSettings.d.ts +11 -0
  82. package/interfaces/GridDetailRowProps.d.ts +16 -0
  83. package/interfaces/GridEditableSettings.d.ts +16 -0
  84. package/interfaces/GridFilterCellProps.d.ts +86 -0
  85. package/interfaces/GridFilterOperator.d.ts +14 -0
  86. package/interfaces/GridFilterOperators.d.ts +56 -0
  87. package/interfaces/GridFooterCellProps.d.ts +14 -0
  88. package/interfaces/GridGroupExpandableSettings.d.ts +22 -0
  89. package/interfaces/GridGroupableSettings.d.ts +27 -0
  90. package/interfaces/GridHeaderCellProps.d.ts +44 -0
  91. package/interfaces/GridHeaderSelectionCellProps.d.ts +24 -0
  92. package/interfaces/GridHighlightDescriptor.d.ts +10 -0
  93. package/interfaces/GridNoRecordsProps.d.ts +16 -0
  94. package/interfaces/GridProps.d.ts +543 -0
  95. package/interfaces/GridReorderDropDir.d.ts +11 -0
  96. package/interfaces/GridRowProps.d.ts +70 -0
  97. package/interfaces/GridRowReorderSettings.d.ts +25 -0
  98. package/interfaces/GridRowSpannableSettings.d.ts +21 -0
  99. package/interfaces/GridRowType.d.ts +16 -0
  100. package/interfaces/GridRowsSettings.d.ts +15 -0
  101. package/interfaces/GridSelectableSettings.d.ts +25 -0
  102. package/interfaces/GridSortSettings.d.ts +33 -0
  103. package/interfaces/GridToolbarProps.d.ts +22 -0
  104. package/interfaces/VirtualScrollInterface.d.ts +28 -0
  105. package/interfaces/events.d.ts +311 -0
  106. package/key.d.ts +8 -0
  107. package/messages/main.d.ts +430 -0
  108. package/messages/messagesMap.d.ts +14 -0
  109. package/package-metadata.d.ts +12 -0
  110. package/package-metadata.js +1 -1
  111. package/package-metadata.mjs +2 -2
  112. package/package.json +20 -14
  113. package/paging/GridPagerSettings.d.ts +21 -0
  114. package/paging/Page.d.ts +11 -0
  115. package/rows/GridDetailRow.d.ts +12 -0
  116. package/rows/GridRow.d.ts +72 -0
  117. package/utils/browser-support.service.d.ts +14 -0
  118. package/utils/main.d.ts +143 -0
  119. package/utils/main.js +1 -1
  120. package/utils/main.mjs +1 -1
  121. package/utils/virtualColumns.d.ts +31 -0
package/index.d.ts CHANGED
@@ -5,3322 +5,45 @@
5
5
  * Licensed under commercial license. See LICENSE.md in the package root for more information
6
6
  *-------------------------------------------------------------------------------------------
7
7
  */
8
- import { ColumnBaseProps } from '@progress/kendo-vue-data-tools';
9
- import { ComponentOptionsMixin } from 'vue';
10
- import { ComponentProvideOptions } from 'vue';
11
- import { CompositeFilterDescriptor } from '@progress/kendo-data-query';
12
- import { ComputedRef } from 'vue';
13
- import { DataResult } from '@progress/kendo-data-query';
14
- import { DefineComponent } from 'vue';
15
- import { DetailExpandDescriptor } from '@progress/kendo-vue-data-tools';
16
- import { ExtractPropTypes } from 'vue';
17
- import { GridCellProps as GridCellProps_2 } from '.';
18
- import { GridColumnMenuColumnProps } from '../interfaces/GridColumnMenuColumnProps';
19
- import { GridColumnState as GridColumnState_2 } from '.';
20
- import { GridDataStateChangeEvent as GridDataStateChangeEvent_2 } from '.';
21
- import { GridDetailExpandChangeEvent as GridDetailExpandChangeEvent_2 } from '.';
22
- import { GridExpandChangeEvent as GridExpandChangeEvent_2 } from '.';
23
- import { GridFilterCellProps as GridFilterCellProps_2 } from '..';
24
- import { GridFilterChangeEvent as GridFilterChangeEvent_2 } from '.';
25
- import { GridFilterOperator as GridFilterOperator_2 } from '../interfaces/GridFilterOperator';
26
- import { GridFilterOperators as GridFilterOperators_2 } from './interfaces/GridFilterOperators';
27
- import { GridFilterOperators as GridFilterOperators_3 } from '../interfaces/GridFilterOperators';
28
- import { GridGroupableSettings as GridGroupableSettings_2 } from '.';
29
- import { GridGroupChangeEvent as GridGroupChangeEvent_2 } from '.';
30
- import { GridGroupExpandChangeEvent as GridGroupExpandChangeEvent_2 } from '.';
31
- import { GridItemChangeEvent as GridItemChangeEvent_2 } from '.';
32
- import { GridPageChangeEvent as GridPageChangeEvent_2 } from '.';
33
- import { GridPagerSettings } from '@progress/kendo-vue-data-tools';
34
- import { GridRowSpannableSettings as GridRowSpannableSettings_2 } from './interfaces/GridRowSpannableSettings';
35
- import { GridSearchChangeEvent as GridSearchChangeEvent_2 } from '.';
36
- import { GridSortChangeEvent as GridSortChangeEvent_2 } from '.';
37
- import { GridSortSettings as GridSortSettings_2 } from '.';
38
- import { GridSortSettings as GridSortSettings_3 } from '..';
39
- import { GridSortSettings as GridSortSettings_4 } from '../interfaces/GridSortSettings';
40
- import { GroupDescriptor } from '@progress/kendo-data-query';
41
- import { GroupExpandDescriptor } from '@progress/kendo-vue-data-tools';
42
- import { GroupState } from '@progress/kendo-vue-data-tools';
43
- import { IntlService } from '@progress/kendo-vue-intl';
44
- import { JSX } from 'vue/jsx-runtime';
45
- import { PopupAnimation } from '@progress/kendo-vue-popup';
46
- import { PropType } from 'vue';
47
- import { PublicProps } from 'vue';
48
- import { Ref } from 'vue';
49
- import { SearchField } from '@progress/kendo-vue-data-tools';
50
- import { SortDescriptor } from '@progress/kendo-data-query';
51
- import { State } from '@progress/kendo-data-query';
52
- import { SVGIcon } from '@progress/kendo-vue-common';
53
- import { SVGIcon as SVGIcon_2 } from '@progress/kendo-svg-icons';
54
- import { SvgIconAll } from '@progress/kendo-vue-common';
55
- import { TableExpandableSettings } from '@progress/kendo-vue-data-tools';
56
- import { TableGroupExpandableSettings } from '@progress/kendo-vue-data-tools';
57
- import { TextBoxChangeEvent } from '@progress/kendo-vue-inputs';
58
- import { TextBoxProps } from '@progress/kendo-vue-inputs';
59
-
60
- /**
61
- * @hidden
62
- */
63
- export declare function applyExpandedState(sdata: DataResult, collapsed: any[], uniqueField: string): DataResult;
64
-
65
- /**
66
- * @hidden
67
- */
68
- export declare function autoGenerateColumns(data: any[] | DataResult | null | undefined, group: GroupDescriptor[] | undefined, expandable: GridDetailExpandableSettings, idInfo: {
69
- prevId: number;
70
- idPrefix: string;
71
- }): ExtendedColumnProps[];
72
-
73
- /** @hidden */
74
- export declare const calcRowHeight: (tableBody: HTMLTableSectionElement | null) => number;
75
-
76
- /**
77
- * @hidden
78
- */
79
- export declare function checkPropCompatibility(props: GridProps): void;
80
-
81
- /**
82
- * @hidden
83
- */
84
- export declare interface DataItemWrapper {
85
- dataItem: any;
86
- rowType: GridRowType;
87
- level: number;
88
- expanded: boolean;
89
- dataIndex: number;
90
- group?: GroupState;
91
- }
92
-
93
- /**
94
- * @hidden
95
- */
96
- declare interface ExtendedColumnProps extends GridColumnProps {
97
- declarationIndex: number;
98
- parentIndex: number;
99
- rowSpan: number;
100
- depth: number;
101
- colSpan: number;
102
- kFirst?: boolean;
103
- index: number;
104
- headerColSpan: number;
105
- children: ExtendedColumnProps[];
106
- left: number;
107
- right: number;
108
- rightBorder: boolean;
109
- ariaColumnIndex: number;
110
- isAccessible: boolean;
111
- /** @hidden _internal usage only */
112
- _type?: 'edit' | 'expand';
113
- rowSpannable?: Required<GridRowSpannableSettings>;
114
- defaultCell?: any;
115
- defaultHeaderCell?: any;
116
- }
117
-
118
- /**
119
- * Can be used to check if filtering is applied to a specific field ([see example]({% slug column_menu_grid %}#toc-styling-the-column-menu-icon)). Useful for creating active filter indicators.
120
- */
121
- export declare const filterGroupByField: (field: string, filter: CompositeFilterDescriptor | undefined) => CompositeFilterDescriptor | null;
122
-
123
- /**
124
- * @hidden
125
- */
126
- export declare const firefox: boolean;
127
-
128
- /**
129
- * @hidden
130
- */
131
- export declare const firefoxMaxHeight = 17895697;
132
-
133
- /**
134
- * @hidden
135
- */
136
- export declare function flatData(output: Array<DataItemWrapper>, input: Array<any>, footer: 'always' | 'visible' | 'none', dataIndex: {
137
- index: number;
138
- }, groupDefined: boolean, expand?: DetailExpandDescriptor, groupExpand?: GroupExpandDescriptor[], defaultGroupExpand?: boolean, dataItemKey?: string, field?: string, level?: number, parentGroup?: GroupState | undefined): number;
139
-
140
- /**
141
- * @hidden
142
- */
143
- export declare const Footer: DefineComponent<ExtractPropTypes< {
144
- staticHeaders: BooleanConstructor;
145
- row: ObjectConstructor;
146
- columnResize: ObjectConstructor;
147
- cols: ArrayConstructor;
148
- size: StringConstructor;
149
- }>, {
150
- colGroupHeaderRef: Ref<any, any>;
151
- footerWrapRef: Ref<any, any>;
152
- }, {
153
- scrollbarWidth: number;
154
- rtl: boolean;
155
- tableWidth: any;
156
- }, {
157
- tableClass(): {
158
- [x: string]: any;
159
- 'k-table': boolean;
160
- 'k-grid-footer-table': boolean;
161
- };
162
- tableStyle(): {
163
- width: any;
164
- };
165
- }, {
166
- setScrollLeft(scrollLeft: number): void;
167
- setWidth(width: number): void;
168
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
169
- staticHeaders: BooleanConstructor;
170
- row: ObjectConstructor;
171
- columnResize: ObjectConstructor;
172
- cols: ArrayConstructor;
173
- size: StringConstructor;
174
- }>> & Readonly<{}>, {
175
- staticHeaders: boolean;
176
- }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
177
-
178
- /**
179
- * @hidden
180
- */
181
- export declare const footerColumns: (columns: ExtendedColumnProps[]) => ExtendedColumnProps[];
182
-
183
- /**
184
- * @hidden
185
- */
186
- export declare const FooterRow: DefineComponent<ExtractPropTypes< {
187
- isRtl: PropType<boolean>;
188
- columns: PropType<ExtendedColumnProps[]>;
189
- rowIndex: PropType<number>;
190
- }>, {}, {}, {}, {
191
- columnStyles(column: ExtendedColumnProps): {
192
- left: string;
193
- right: string;
194
- };
195
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
196
- isRtl: PropType<boolean>;
197
- columns: PropType<ExtendedColumnProps[]>;
198
- rowIndex: PropType<number>;
199
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
200
-
201
- /**
202
- * @hidden
203
- */
204
- export declare const getColSpan: (column: GridColumnProps, dataItem: any) => number;
205
-
206
- /**
207
- * @hidden
208
- */
209
- export declare const getColumnWidth: (column: ExtendedColumnProps) => string | undefined;
210
-
211
- /**
212
- * @hidden
213
- */
214
- export declare const getDataAsArray: (data: any[] | DataResult | null | undefined) => any[];
215
-
216
- /**
217
- * @hidden
218
- */
219
- export declare const getFlatColumnsState: (state: GridColumnState[]) => GridColumnState[];
220
-
221
- /**
222
- * @hidden
223
- */
224
- export declare function getIndex(event: any, parent: HTMLElement | null): number;
225
-
226
- /**
227
- * @hidden
228
- */
229
- export declare function getNestedValue(fieldName: string, dataItem: any): any;
230
-
231
- /**
232
- * @hidden
233
- */
234
- export declare const getRowSpanOptions: (rowSpannable?: boolean | GridRowSpannableSettings) => Required<GridRowSpannableSettings>;
235
-
236
- /**
237
- * Represents the [KendoVue Grid component]({% slug overview_grid %}).
238
- *
239
- * @remarks
240
- * Supported children components are: {@link GridColumn}, {@link GridToolbar}, {@link GridNoRecords}, {@link StatusBar}.
241
- *
242
- *
243
- * export default App;
244
- * ```
245
- */
246
- export declare const Grid: DefineComponent<ExtractPropTypes< {
247
- id: PropType<string>;
248
- autoProcessData: PropType<boolean | {
249
- filter?: boolean;
250
- search?: boolean;
251
- sort?: boolean;
252
- group?: boolean;
253
- page?: boolean;
254
- }>;
255
- topCacheCount: {
256
- type: PropType<number>; /**
257
- * Represent the `ref` of the Grid component.
258
- */
259
- default: number;
260
- };
261
- collapsedGroups: {
262
- type: PropType<any[][]>;
263
- default: () => any[];
264
- };
265
- uniqueField: PropType<string>;
266
- totalGroupedHeight: PropType<number>;
267
- allGroupedItems: PropType<DataResult>;
268
- alternatePerGroup: PropType<boolean>;
269
- columns: PropType<GridColumnProps[]>;
270
- columnsState: {
271
- type: PropType<GridColumnState_2[]>;
272
- default: () => any;
273
- };
274
- defaultColumnsState: {
275
- type: PropType<GridColumnState_2[]>; /**
276
- * Method to allow the scroll to be set to a specific row index when the Grid is scrollable. It is zero based.
277
- *
278
- * @param options - Object, containing the rowIndex to which is going to be scrolled.
279
- */
280
- default: () => any;
281
- };
282
- columnVirtualization: PropType<boolean>;
283
- dataItems: PropType<any[] | DataResult>;
284
- sortable: PropType<GridSortSettings_2>;
285
- defaultSort: PropType<SortDescriptor[]>;
286
- sort: PropType<SortDescriptor[]>;
287
- filterable: PropType<boolean>;
288
- filterOperators: PropType<GridFilterOperators_2>;
289
- filterCellRender: PropType<any>;
290
- headerCellRender: PropType<any>;
291
- showLoader: {
292
- type: PropType<boolean>;
293
- default: any;
294
- };
295
- loader: PropType<string | Object | Function>;
296
- defaultFilter: PropType<CompositeFilterDescriptor>;
297
- filter: PropType<CompositeFilterDescriptor>;
298
- defaultSearch: PropType<CompositeFilterDescriptor>;
299
- search: PropType<CompositeFilterDescriptor>;
300
- searchFields: PropType<(string | SearchField)[]>;
301
- highlight: PropType< {
302
- [id: string]: boolean | {
303
- [id: string]: boolean;
304
- };
305
- }>;
306
- pageable: PropType<any>;
307
- pageSize: PropType<number>;
308
- total: PropType<number>;
309
- fixedScroll: PropType<boolean>;
310
- skip: PropType<number>;
311
- defaultSkip: PropType<number>;
312
- take: PropType<number>;
313
- defaultTake: PropType<number>;
314
- expandField: PropType<string>;
315
- expandColumn: PropType<GridColumnProps>;
316
- selectedField: PropType<string>;
317
- cellRender: PropType<string | boolean | ((h: any, defaultRendering: any, props: GridCellProps_2, listeners: any) => any)>;
318
- rowRender: PropType<string | boolean | ((h: any, defaultRendering: any, defaultSlots: any, props: any, listeners: any) => any)>;
319
- rowSpannable: PropType<boolean | GridRowSpannableSettings_2>;
320
- resizable: PropType<boolean>;
321
- reorderable: PropType<boolean>;
322
- group: PropType<GroupDescriptor[]>;
323
- defaultGroup: PropType<GroupDescriptor[]>;
324
- groupable: PropType<boolean | GridGroupableSettings_2>;
325
- groupExpand: PropType<GroupExpandDescriptor[]>;
326
- defaultGroupExpand: PropType<GroupExpandDescriptor[]>;
327
- detailExpand: PropType<DetailExpandDescriptor>;
328
- defaultDetailExpand: PropType<DetailExpandDescriptor>;
329
- editField: PropType<string>;
330
- rowClass: PropType<Function>;
331
- scrollable: {
332
- type: PropType<string>;
333
- default: string;
334
- };
335
- size: {
336
- type: PropType<string>;
337
- default: string;
338
- validator: (value: string) => any;
339
- };
340
- pager: PropType<string | boolean | Object | Function>;
341
- rowHeight: PropType<number>;
342
- detailRowHeight: PropType<number>;
343
- detail: PropType<any>;
344
- columnMenu: PropType<any>;
345
- columnMenuAnimate: {
346
- type: PropType<boolean | PopupAnimation>;
347
- default: () => boolean;
348
- };
349
- columnMenuIcon: DefineComponent<ExtractPropTypes< {
350
- name: StringConstructor;
351
- icon: ObjectConstructor;
352
- themeColor: {
353
- type: StringConstructor;
354
- };
355
- size: {
356
- type: StringConstructor;
357
- };
358
- flip: {
359
- type: StringConstructor;
360
- };
361
- id: StringConstructor;
362
- ariaLabel: StringConstructor;
363
- title: StringConstructor;
364
- viewBox: {
365
- type: StringConstructor;
366
- default: string;
367
- };
368
- tabIndex: NumberConstructor;
369
- svgClassName: StringConstructor;
370
- svgStyle: ObjectConstructor;
371
- }>, {}, {}, {
372
- wrapperClass(this: SvgIconAll): {
373
- [x: string]: any;
374
- [x: number]: any;
375
- 'k-icon': boolean;
376
- 'k-svg-icon': boolean;
377
- 'k-flip-h': boolean;
378
- 'k-flip-v': boolean;
379
- };
380
- }, {
381
- handleClick(e: any): void;
382
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
383
- click: any;
384
- }, string, PublicProps, Readonly<ExtractPropTypes< {
385
- name: StringConstructor;
386
- icon: ObjectConstructor;
387
- themeColor: {
388
- type: StringConstructor;
389
- };
390
- size: {
391
- type: StringConstructor;
392
- };
393
- flip: {
394
- type: StringConstructor;
395
- };
396
- id: StringConstructor;
397
- ariaLabel: StringConstructor;
398
- title: StringConstructor;
399
- viewBox: {
400
- type: StringConstructor;
401
- default: string;
402
- };
403
- tabIndex: NumberConstructor;
404
- svgClassName: StringConstructor;
405
- svgStyle: ObjectConstructor;
406
- }>> & Readonly<{
407
- onClick?: (...args: any[] | unknown[]) => any;
408
- }>, {
409
- viewBox: string;
410
- }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
411
- dataItemKey: StringConstructor;
412
- navigatable: {
413
- type: PropType<boolean>;
414
- default: boolean;
415
- };
416
- onItemchange: PropType<(event: GridItemChangeEvent_2) => void>;
417
- onExpandchange: PropType<(event: GridExpandChangeEvent_2) => void>;
418
- onDatastatechange: PropType<(event: GridDataStateChangeEvent_2) => void>;
419
- onPagechange: PropType<(event: GridPageChangeEvent_2) => void>;
420
- onSortchange: PropType<(event: GridSortChangeEvent_2) => void>;
421
- onFilterchange: PropType<(event: GridFilterChangeEvent_2) => void>;
422
- onGroupchange: PropType<(event: GridGroupChangeEvent_2) => void>;
423
- onSearchchange: PropType<(event: GridSearchChangeEvent_2) => void>;
424
- onGroupexpandchange: PropType<(event: GridGroupExpandChangeEvent_2) => void>;
425
- onDetailexpandchange: PropType<(event: GridDetailExpandChangeEvent_2) => void>;
426
- }>, void, {}, {
427
- columnsWithTemplates(): any[];
428
- }, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
429
- id: PropType<string>;
430
- autoProcessData: PropType<boolean | {
431
- filter?: boolean;
432
- search?: boolean;
433
- sort?: boolean;
434
- group?: boolean;
435
- page?: boolean;
436
- }>;
437
- topCacheCount: {
438
- type: PropType<number>; /**
439
- * Represent the `ref` of the Grid component.
440
- */
441
- default: number;
442
- };
443
- collapsedGroups: {
444
- type: PropType<any[][]>;
445
- default: () => any[];
446
- };
447
- uniqueField: PropType<string>;
448
- totalGroupedHeight: PropType<number>;
449
- allGroupedItems: PropType<DataResult>;
450
- alternatePerGroup: PropType<boolean>;
451
- columns: PropType<GridColumnProps[]>;
452
- columnsState: {
453
- type: PropType<GridColumnState_2[]>;
454
- default: () => any;
455
- };
456
- defaultColumnsState: {
457
- type: PropType<GridColumnState_2[]>; /**
458
- * Method to allow the scroll to be set to a specific row index when the Grid is scrollable. It is zero based.
459
- *
460
- * @param options - Object, containing the rowIndex to which is going to be scrolled.
461
- */
462
- default: () => any;
463
- };
464
- columnVirtualization: PropType<boolean>;
465
- dataItems: PropType<any[] | DataResult>;
466
- sortable: PropType<GridSortSettings_2>;
467
- defaultSort: PropType<SortDescriptor[]>;
468
- sort: PropType<SortDescriptor[]>;
469
- filterable: PropType<boolean>;
470
- filterOperators: PropType<GridFilterOperators_2>;
471
- filterCellRender: PropType<any>;
472
- headerCellRender: PropType<any>;
473
- showLoader: {
474
- type: PropType<boolean>;
475
- default: any;
476
- };
477
- loader: PropType<string | Object | Function>;
478
- defaultFilter: PropType<CompositeFilterDescriptor>;
479
- filter: PropType<CompositeFilterDescriptor>;
480
- defaultSearch: PropType<CompositeFilterDescriptor>;
481
- search: PropType<CompositeFilterDescriptor>;
482
- searchFields: PropType<(string | SearchField)[]>;
483
- highlight: PropType< {
484
- [id: string]: boolean | {
485
- [id: string]: boolean;
486
- };
487
- }>;
488
- pageable: PropType<any>;
489
- pageSize: PropType<number>;
490
- total: PropType<number>;
491
- fixedScroll: PropType<boolean>;
492
- skip: PropType<number>;
493
- defaultSkip: PropType<number>;
494
- take: PropType<number>;
495
- defaultTake: PropType<number>;
496
- expandField: PropType<string>;
497
- expandColumn: PropType<GridColumnProps>;
498
- selectedField: PropType<string>;
499
- cellRender: PropType<string | boolean | ((h: any, defaultRendering: any, props: GridCellProps_2, listeners: any) => any)>;
500
- rowRender: PropType<string | boolean | ((h: any, defaultRendering: any, defaultSlots: any, props: any, listeners: any) => any)>;
501
- rowSpannable: PropType<boolean | GridRowSpannableSettings_2>;
502
- resizable: PropType<boolean>;
503
- reorderable: PropType<boolean>;
504
- group: PropType<GroupDescriptor[]>;
505
- defaultGroup: PropType<GroupDescriptor[]>;
506
- groupable: PropType<boolean | GridGroupableSettings_2>;
507
- groupExpand: PropType<GroupExpandDescriptor[]>;
508
- defaultGroupExpand: PropType<GroupExpandDescriptor[]>;
509
- detailExpand: PropType<DetailExpandDescriptor>;
510
- defaultDetailExpand: PropType<DetailExpandDescriptor>;
511
- editField: PropType<string>;
512
- rowClass: PropType<Function>;
513
- scrollable: {
514
- type: PropType<string>;
515
- default: string;
516
- };
517
- size: {
518
- type: PropType<string>;
519
- default: string;
520
- validator: (value: string) => any;
521
- };
522
- pager: PropType<string | boolean | Object | Function>;
523
- rowHeight: PropType<number>;
524
- detailRowHeight: PropType<number>;
525
- detail: PropType<any>;
526
- columnMenu: PropType<any>;
527
- columnMenuAnimate: {
528
- type: PropType<boolean | PopupAnimation>;
529
- default: () => boolean;
530
- };
531
- columnMenuIcon: DefineComponent<ExtractPropTypes< {
532
- name: StringConstructor;
533
- icon: ObjectConstructor;
534
- themeColor: {
535
- type: StringConstructor;
536
- };
537
- size: {
538
- type: StringConstructor;
539
- };
540
- flip: {
541
- type: StringConstructor;
542
- };
543
- id: StringConstructor;
544
- ariaLabel: StringConstructor;
545
- title: StringConstructor;
546
- viewBox: {
547
- type: StringConstructor;
548
- default: string;
549
- };
550
- tabIndex: NumberConstructor;
551
- svgClassName: StringConstructor;
552
- svgStyle: ObjectConstructor;
553
- }>, {}, {}, {
554
- wrapperClass(this: SvgIconAll): {
555
- [x: string]: any;
556
- [x: number]: any;
557
- 'k-icon': boolean;
558
- 'k-svg-icon': boolean;
559
- 'k-flip-h': boolean;
560
- 'k-flip-v': boolean;
561
- };
562
- }, {
563
- handleClick(e: any): void;
564
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
565
- click: any;
566
- }, string, PublicProps, Readonly<ExtractPropTypes< {
567
- name: StringConstructor;
568
- icon: ObjectConstructor;
569
- themeColor: {
570
- type: StringConstructor;
571
- };
572
- size: {
573
- type: StringConstructor;
574
- };
575
- flip: {
576
- type: StringConstructor;
577
- };
578
- id: StringConstructor;
579
- ariaLabel: StringConstructor;
580
- title: StringConstructor;
581
- viewBox: {
582
- type: StringConstructor;
583
- default: string;
584
- };
585
- tabIndex: NumberConstructor;
586
- svgClassName: StringConstructor;
587
- svgStyle: ObjectConstructor;
588
- }>> & Readonly<{
589
- onClick?: (...args: any[] | unknown[]) => any;
590
- }>, {
591
- viewBox: string;
592
- }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
593
- dataItemKey: StringConstructor;
594
- navigatable: {
595
- type: PropType<boolean>;
596
- default: boolean;
597
- };
598
- onItemchange: PropType<(event: GridItemChangeEvent_2) => void>;
599
- onExpandchange: PropType<(event: GridExpandChangeEvent_2) => void>;
600
- onDatastatechange: PropType<(event: GridDataStateChangeEvent_2) => void>;
601
- onPagechange: PropType<(event: GridPageChangeEvent_2) => void>;
602
- onSortchange: PropType<(event: GridSortChangeEvent_2) => void>;
603
- onFilterchange: PropType<(event: GridFilterChangeEvent_2) => void>;
604
- onGroupchange: PropType<(event: GridGroupChangeEvent_2) => void>;
605
- onSearchchange: PropType<(event: GridSearchChangeEvent_2) => void>;
606
- onGroupexpandchange: PropType<(event: GridGroupExpandChangeEvent_2) => void>;
607
- onDetailexpandchange: PropType<(event: GridDetailExpandChangeEvent_2) => void>;
608
- }>> & Readonly<{}>, {
609
- size: string;
610
- scrollable: string;
611
- navigatable: boolean;
612
- columnMenuAnimate: boolean;
613
- topCacheCount: number;
614
- collapsedGroups: any[][];
615
- columnsState: GridColumnState_2[];
616
- defaultColumnsState: GridColumnState_2[];
617
- showLoader: boolean;
618
- }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
619
-
620
- /**
621
- * Represents the object of the `cancel` event.
622
- */
623
- export declare interface GridCancelEvent {
624
- /**
625
- * The item from the `data` property of the Grid that corresponds to the item that is canceled by the user.
626
- */
627
- dataItem: any;
628
- }
629
-
630
- /**
631
- * @hidden
632
- */
633
- export declare const GridCell: DefineComponent<ExtractPropTypes< {
634
- id: PropType<string>;
635
- field: PropType<string>;
636
- dataItem: PropType<any>;
637
- format: PropType<string>;
638
- readFormat: PropType<string>;
639
- className: PropType<string>;
640
- colSpan: PropType<number>;
641
- columnIndex: PropType<number>;
642
- columnsCount: PropType<number>;
643
- dataIndex: PropType<number>;
644
- rowType: PropType<string>;
645
- level: PropType<number>;
646
- expanded: PropType<boolean>;
647
- type: PropType<string>;
648
- editor: PropType<string>;
649
- rowSpan: PropType<{
650
- count: number;
651
- value: any;
652
- }>;
653
- isSelected: PropType<boolean>;
654
- isHighlighted: PropType<boolean>;
655
- ariaColumnIndex: PropType<number>;
656
- render: PropType<any>;
657
- isRtl: PropType<boolean>;
658
- onEdit: PropType<(event: {
659
- dataItem: any;
660
- }) => void>;
661
- onSave: PropType<(event: {
662
- dataItem: any;
663
- }) => void>;
664
- onRemove: PropType<(event: {
665
- dataItem: any;
666
- }) => void>;
667
- onCancel: PropType<(event: {
668
- dataItem: any;
669
- }) => void>;
670
- onChange: PropType<(event: {
671
- dataItem: any;
672
- event: any;
673
- field?: string;
674
- value?: any;
675
- }) => void>;
676
- onSelectionchange: PropType<(event: any, dataItem: any) => void>;
677
- }>, {
678
- kendoIntlService: {};
679
- }, {}, {
680
- tdClass(): {
681
- [x: number]: any;
682
- 'k-table-td': boolean;
683
- 'k-highlighted': any;
684
- };
685
- }, {
686
- triggerClick(): void;
687
- triggerKeydown(e: any): void;
688
- triggerEdit(dataItem: any): void;
689
- triggerAdd(dataItem: any): void;
690
- triggerCancel(dataItem: any): void;
691
- triggerSave(dataItem: any): void;
692
- triggerRemove(dataItem: any): void;
693
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
694
- cellclick: any;
695
- cellkeydown: any;
696
- }, string, PublicProps, Readonly<ExtractPropTypes< {
697
- id: PropType<string>;
698
- field: PropType<string>;
699
- dataItem: PropType<any>;
700
- format: PropType<string>;
701
- readFormat: PropType<string>;
702
- className: PropType<string>;
703
- colSpan: PropType<number>;
704
- columnIndex: PropType<number>;
705
- columnsCount: PropType<number>;
706
- dataIndex: PropType<number>;
707
- rowType: PropType<string>;
708
- level: PropType<number>;
709
- expanded: PropType<boolean>;
710
- type: PropType<string>;
711
- editor: PropType<string>;
712
- rowSpan: PropType<{
713
- count: number;
714
- value: any;
715
- }>;
716
- isSelected: PropType<boolean>;
717
- isHighlighted: PropType<boolean>;
718
- ariaColumnIndex: PropType<number>;
719
- render: PropType<any>;
720
- isRtl: PropType<boolean>;
721
- onEdit: PropType<(event: {
722
- dataItem: any;
723
- }) => void>;
724
- onSave: PropType<(event: {
725
- dataItem: any;
726
- }) => void>;
727
- onRemove: PropType<(event: {
728
- dataItem: any;
729
- }) => void>;
730
- onCancel: PropType<(event: {
731
- dataItem: any;
732
- }) => void>;
733
- onChange: PropType<(event: {
734
- dataItem: any;
735
- event: any;
736
- field?: string;
737
- value?: any;
738
- }) => void>;
739
- onSelectionchange: PropType<(event: any, dataItem: any) => void>;
740
- }>> & Readonly<{
741
- onCellkeydown?: (...args: any[] | unknown[]) => any;
742
- onCellclick?: (...args: any[] | unknown[]) => any;
743
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
744
-
745
- /**
746
- * @hidden
747
- */
748
- export declare interface GridCellProps {
749
- /**
750
- * @hidden
751
- */
752
- id: string;
753
- /**
754
- * The field to which the cell is bound ([see example]({% slug sorting_grid %})).
755
- */
756
- key?: number;
757
- /**
758
- * The field to which the cell is bound ([see example]({% slug sorting_grid %})).
759
- */
760
- field: string;
761
- /**
762
- * The data object that represents the current row.
763
- */
764
- dataItem: any;
765
- /**
766
- *
767
- */
768
- dataIndex?: number;
769
- /**
770
- * The format that is applied to the value before the value is displayed. Takes the `{0:format}`
771
- * form where `format` is any of the following:
772
- * * A standard number format
773
- * * A custom number format
774
- * * A standard date format
775
- * * A custom date format
776
- *
777
- * For more information on the supported date and number formats,
778
- * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
779
- */
780
- format?: string;
781
- /**
782
- * The data Item read format.
783
- */
784
- readFormat?: string;
785
- /**
786
- * The custom CSS classes of the cells.
787
- */
788
- className?: string;
789
- /**
790
- * The index to be applied to the `aria-colindex` attribute.
791
- */
792
- ariaColumnIndex: number;
793
- /**
794
- * The index of all rendered columns.
795
- */
796
- columnIndex?: number;
797
- /**
798
- * The number of rendered columns in the Grid.
799
- */
800
- columnsCount?: number;
801
- /**
802
- * The type of the row.
803
- */
804
- rowType?: string;
805
- /**
806
- * @hidden
807
- */
808
- level?: number;
809
- /**
810
- * The expanded value of the cell when hierarchy or grouping are used.
811
- */
812
- expanded?: boolean;
813
- /**
814
- * The event that is fired when the cell is selected.
815
- */
816
- selectionchange?: (event: any, dataItem: any) => void;
817
- /**
818
- * @hidden
819
- */
820
- style?: any;
821
- /**
822
- * The column span of the cell.
823
- */
824
- colSpan?: number;
825
- /**
826
- * Indicates if the cell is selected.
827
- */
828
- isSelected: boolean;
829
- /**
830
- * Indicates if the cell is highlighted.
831
- */
832
- isHighlighted: boolean;
833
- /**
834
- * Indicates if the cell is in rtl direction.
835
- */
836
- isRtl: boolean;
837
- /**
838
- * The event that is fired when the cell value is changed.
839
- */
840
- onChange?: (event: {
841
- dataItem: any;
842
- event: any;
843
- field?: string;
844
- value?: any;
845
- }) => void;
846
- /**
847
- * The event that is fired when the keydown event of the cell is triggered.
848
- */
849
- onCellkeydown?: (event: {
850
- event: any;
851
- dataItem: any;
852
- field: string;
853
- }) => void;
854
- /**
855
- * The event that is fired when the cell is clicked.
856
- */
857
- onCellclick?: (event: {
858
- dataItem: any;
859
- field: string;
860
- }) => void;
861
- /**
862
- * The event that is fired when the cell is about to be added.
863
- */
864
- onAdd?: (event: {
865
- dataItem: any;
866
- }) => void;
867
- /**
868
- * The event that is fired when the cell is about to be edited.
869
- */
870
- onEdit?: (event: {
871
- dataItem: any;
872
- }) => void;
873
- /**
874
- * The event that is fired when the cell is about to be saved.
875
- */
876
- save?: (event: {
877
- dataItem: any;
878
- }) => void;
879
- /**
880
- * The event that is fired when the cell is about to be removed.
881
- */
882
- remove?: (event: {
883
- dataItem: any;
884
- }) => void;
885
- /**
886
- * The event that is fired when the cell is about to be canceled.
887
- */
888
- onCancel?: (event: {
889
- dataItem: any;
890
- }) => void;
891
- /**
892
- * The type of the data which will be used when formatting the cell data.
893
- * Could be one of the following values 'text' | 'numeric' | 'boolean' | 'date'.
894
- */
895
- type?: string;
896
- /**
897
- * The type of the editor which will be used when the cell is in edit mode.
898
- * Could be one of the following values 'text' | 'numeric' | 'boolean' | 'date'.
899
- */
900
- editor?: string;
901
- /**
902
- * The method for rendering the cell.
903
- */
904
- render?: any;
905
- /** @hidden */
906
- group?: GroupState;
907
- /** @hidden */
908
- rowSpan?: {
909
- count: number | null;
910
- value: any;
911
- };
912
- }
913
-
914
- /**
915
- * Represents the properties of the callback used when spanning a column.
916
- */
917
- export declare type GridColSpanProps = {
918
- /**
919
- * Represents the properties of the spanned column.
920
- */
921
- column: GridColumnProps;
922
- /**
923
- * Represents the current row data item.
924
- */
925
- dataItem: any;
926
- };
927
-
928
- /**
929
- * @hidden
930
- */
931
- export declare const GridColumnMenuCheckboxFilter: {
932
- name: string;
933
- props: {
934
- column: PropType<GridColumnMenuColumnProps>;
935
- filter: PropType<CompositeFilterDescriptor>;
936
- filterable: PropType<boolean>;
937
- filterOperators: PropType<GridFilterOperators_3>;
938
- checkAllItem: PropType<string | boolean | object | Function>;
939
- item: PropType<string | boolean | object | Function>;
940
- expanded: {
941
- type: PropType<boolean>;
942
- default: any;
943
- };
944
- dataItems: PropType<(string | object)[]>;
945
- searchBox: {
946
- type: PropType<any>;
947
- default: boolean;
948
- };
949
- uniqueData: {
950
- type: PropType<boolean>;
951
- default: boolean;
952
- };
953
- };
954
- data(): {
955
- currentExpanded: boolean;
956
- currentValue: string;
957
- currentData: any;
958
- dataFromProps: any;
959
- currentFilter: any;
960
- };
961
- created(): void;
962
- updated(): void;
963
- inject: {
964
- kendoLocalizationService: {
965
- default: any;
966
- };
967
- };
968
- setup(): {
969
- kendoLocalizationService: {};
970
- };
971
- render(): JSX.Element;
972
- methods: {
973
- defaultFilter(): any;
974
- parseData(originalData: any, isUnique: any): any;
975
- getFilterIndex(): any;
976
- onFilterExpand(): void;
977
- handleSearchChange(e: any): void;
978
- clear(e: any): void;
979
- submit(e: any): void;
980
- handleCheckBoxChange(e: any, value: any): void;
981
- isAllSelected(): boolean;
982
- };
983
- };
984
-
985
- /**
986
- * The props of the GridColumnMenuFilter component.
987
- */
988
- export declare interface GridColumnMenuCheckboxFilterProps extends GridColumnMenuFilterBaseProps {
989
- /**
990
- * Controls the expand state of the filter component.
991
- */
992
- expanded?: boolean;
993
- /**
994
- * Sets the items collection that will be rendered by the GridColumnMenuCheckboxFilter component.
995
- */
996
- dataItems: Array<string | object>;
997
- /**
998
- * Triggered on each subsequent expand state of the filter component.
999
- */
1000
- expandchange?: (nextExpandState: boolean) => void;
1001
- /**
1002
- * Defines the component that will be rendered as a search box.
1003
- */
1004
- searchBox?: any;
1005
- /**
1006
- * Determines if the data in the component will be unique. By default the property is set to true.
1007
- */
1008
- uniqueData?: boolean;
1009
- }
1010
-
1011
- /**
1012
- * The column props passed by the ColumnMenu.
1013
- */
1014
- declare interface GridColumnMenuColumnProps_2 {
1015
- /**
1016
- * The field to which the column is bound.
1017
- */
1018
- field?: string;
1019
- /**
1020
- * Defines the filter type that is displayed inside the filter row. Defaults to `text`.
1021
- */
1022
- filter?: 'text' | 'numeric' | 'boolean' | 'date';
1023
- }
1024
-
1025
- /**
1026
- * Represents the GridColumnMenuFilter component.
1027
- *
1028
- * @hidden
1029
- */
1030
- export declare const GridColumnMenuFilter: DefineComponent<ExtractPropTypes< {
1031
- column: PropType<GridColumnMenuColumnProps>;
1032
- filter: PropType<CompositeFilterDescriptor>;
1033
- expanded: {
1034
- type: PropType<boolean>;
1035
- default: any;
1036
- };
1037
- filterable: PropType<boolean>;
1038
- filterOperators: {
1039
- type: PropType<GridFilterOperators_3>;
1040
- default: () => GridFilterOperators_3;
1041
- };
1042
- hideSecondFilter: {
1043
- type: PropType<boolean>;
1044
- default: () => any;
1045
- };
1046
- filterUI: PropType<any>;
1047
- onFilterfocus: PropType<(e: any) => void>;
1048
- onFilterchange: PropType<(filter: CompositeFilterDescriptor, syntheticEvent: any) => any>;
1049
- onExpandchange: PropType<(nextExpandState: boolean) => void>;
1050
- onClosemenu: PropType<Function>;
1051
- }>, {
1052
- kendoLocalizationService: {};
1053
- }, {
1054
- currentExpanded: boolean;
1055
- filterGroup: any;
1056
- }, {}, {
1057
- removeGroup(group: CompositeFilterDescriptor, rootFilter: CompositeFilterDescriptor): CompositeFilterDescriptor;
1058
- insertGroup(group: CompositeFilterDescriptor, rootFilter: CompositeFilterDescriptor): CompositeFilterDescriptor;
1059
- isControlled(): boolean;
1060
- onFilterExpand(): void;
1061
- filterChangeHandler(e: any, filterIndex?: number): void;
1062
- firstFilterChange(e: any): void;
1063
- secondFilterChange(e: any): void;
1064
- filterChange(filterIndex: number, e: {
1065
- value: number;
1066
- operator: string;
1067
- }): void;
1068
- logicChange(e: any): void;
1069
- clear(e: any): void;
1070
- currentFilterGroup(): CompositeFilterDescriptor;
1071
- submit(e: any): void;
1072
- handleFocus(e: any): void;
1073
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
1074
- column: PropType<GridColumnMenuColumnProps>;
1075
- filter: PropType<CompositeFilterDescriptor>;
1076
- expanded: {
1077
- type: PropType<boolean>;
1078
- default: any;
1079
- };
1080
- filterable: PropType<boolean>;
1081
- filterOperators: {
1082
- type: PropType<GridFilterOperators_3>;
1083
- default: () => GridFilterOperators_3;
1084
- };
1085
- hideSecondFilter: {
1086
- type: PropType<boolean>;
1087
- default: () => any;
1088
- };
1089
- filterUI: PropType<any>;
1090
- onFilterfocus: PropType<(e: any) => void>;
1091
- onFilterchange: PropType<(filter: CompositeFilterDescriptor, syntheticEvent: any) => any>;
1092
- onExpandchange: PropType<(nextExpandState: boolean) => void>;
1093
- onClosemenu: PropType<Function>;
1094
- }>> & Readonly<{}>, {
1095
- expanded: boolean;
1096
- filterOperators: GridFilterOperators_3;
1097
- hideSecondFilter: boolean;
1098
- }, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1099
-
1100
- /**
1101
- * The props passed to the ColumnMenu filter component.
1102
- */
1103
- declare interface GridColumnMenuFilterBaseProps {
1104
- /**
1105
- * Controls the ColumnMenu animation. By default, the opening and closing animations are enabled.
1106
- */
1107
- animate?: boolean | PopupAnimation;
1108
- /**
1109
- * The current column options.
1110
- */
1111
- column: GridColumnMenuColumnProps_2;
1112
- /**
1113
- * The method that will be called to close the column menu.
1114
- */
1115
- onClosemenu?: Function;
1116
- /**
1117
- * The current filter state of the Grid.
1118
- */
1119
- filter?: CompositeFilterDescriptor;
1120
- /**
1121
- * The filterable option of the column.
1122
- */
1123
- filterable?: boolean | undefined;
1124
- /**
1125
- * The filter operators for the Grid filters.
1126
- */
1127
- filterOperators: GridFilterOperators;
1128
- /**
1129
- * The template that can customize the check all checkbox item.
1130
- */
1131
- checkAllItem?: string | object | Function | boolean;
1132
- /**
1133
- * The template that can customize the checkbox item.
1134
- */
1135
- item?: string | object | Function | boolean;
1136
- /**
1137
- * The trigger focus event.
1138
- */
1139
- onFocus?: (e: any) => void;
1140
- /**
1141
- * The method that will be called to notify the parent Grid about a filter change.
1142
- */
1143
- onFilterchange?: (filter: CompositeFilterDescriptor | null, syntheticEvent: any) => any;
1144
- }
1145
-
1146
- /**
1147
- * @hidden
1148
- */
1149
- export declare const GridColumnMenuFilterCell: DefineComponent<ExtractPropTypes< {
1150
- field: PropType<string>;
1151
- filterType: PropType<string>;
1152
- value: PropType<any>;
1153
- operator: PropType<string>;
1154
- operators: PropType<{
1155
- text: string;
1156
- operator: any;
1157
- }[]>;
1158
- booleanValues: PropType<GridFilterOperator[]>;
1159
- }>, {}, {}, {}, {
1160
- handleFocus(e: any): void;
1161
- triggerChange(filter: any): void;
1162
- inputChange(value: any, e: any): void;
1163
- boolDropdownChange(value: any, e: any): void;
1164
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
1165
- change: any;
1166
- filtercellfocus: any;
1167
- }, string, PublicProps, Readonly<ExtractPropTypes< {
1168
- field: PropType<string>;
1169
- filterType: PropType<string>;
1170
- value: PropType<any>;
1171
- operator: PropType<string>;
1172
- operators: PropType<{
1173
- text: string;
1174
- operator: any;
1175
- }[]>;
1176
- booleanValues: PropType<GridFilterOperator[]>;
1177
- }>> & Readonly<{
1178
- onChange?: (...args: any[] | unknown[]) => any;
1179
- onFiltercellfocus?: (...args: any[] | unknown[]) => any;
1180
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1181
-
1182
- /**
1183
- * @hidden
1184
- */
1185
- export declare const GridColumnMenuFilterUI: DefineComponent<ExtractPropTypes< {
1186
- firstFilterProps: PropType<GridFilterCellProps_2>;
1187
- secondFilterProps: PropType<GridFilterCellProps_2>;
1188
- logicValue: PropType<{
1189
- text: string;
1190
- operator: any;
1191
- }>;
1192
- logicData: PropType<{
1193
- text: string;
1194
- operator: any;
1195
- }[]>;
1196
- hideSecondFilter: PropType<boolean>;
1197
- operators: PropType<{
1198
- text: string;
1199
- operator: any;
1200
- }[]>;
1201
- render: PropType<any>;
1202
- }>, {}, {}, {}, {
1203
- handleFocus(e: any): void;
1204
- changeHandler(e: any, filterIndex: number): void;
1205
- logicChange(e: any): void;
1206
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
1207
- change: any;
1208
- filteruifocus: any;
1209
- logicChange: any;
1210
- }, string, PublicProps, Readonly<ExtractPropTypes< {
1211
- firstFilterProps: PropType<GridFilterCellProps_2>;
1212
- secondFilterProps: PropType<GridFilterCellProps_2>;
1213
- logicValue: PropType<{
1214
- text: string;
1215
- operator: any;
1216
- }>;
1217
- logicData: PropType<{
1218
- text: string;
1219
- operator: any;
1220
- }[]>;
1221
- hideSecondFilter: PropType<boolean>;
1222
- operators: PropType<{
1223
- text: string;
1224
- operator: any;
1225
- }[]>;
1226
- render: PropType<any>;
1227
- }>> & Readonly<{
1228
- onChange?: (...args: any[] | unknown[]) => any;
1229
- onLogicChange?: (...args: any[] | unknown[]) => any;
1230
- onFilteruifocus?: (...args: any[] | unknown[]) => any;
1231
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1232
-
1233
- /**
1234
- * @hidden
1235
- */
1236
- export declare const GridColumnMenuItem: DefineComponent<ExtractPropTypes< {
1237
- title: PropType<string>;
1238
- iconClass: PropType<string>;
1239
- icon: PropType<string>;
1240
- svgIcon: PropType<SVGIcon_2>;
1241
- selected: PropType<boolean>;
1242
- onMenuitemclick: PropType<Function>;
1243
- }>, {}, {}, {}, {
1244
- onClick(e: any): void;
1245
- onKeyDown(event: any): void;
1246
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
1247
- title: PropType<string>;
1248
- iconClass: PropType<string>;
1249
- icon: PropType<string>;
1250
- svgIcon: PropType<SVGIcon_2>;
1251
- selected: PropType<boolean>;
1252
- onMenuitemclick: PropType<Function>;
1253
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1254
-
1255
- /**
1256
- * @hidden
1257
- */
1258
- export declare const GridColumnMenuItemContent: DefineComponent<ExtractPropTypes< {
1259
- show: PropType<boolean>;
1260
- }>, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
1261
- show: PropType<boolean>;
1262
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1263
-
1264
- /**
1265
- * @hidden
1266
- */
1267
- export declare const GridColumnMenuItemGroup: DefineComponent< {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1268
-
1269
- /**
1270
- * The props which the ColumnMenu passes to its children.
1271
- */
1272
- export declare interface GridColumnMenuProps extends GridColumnMenuFilterBaseProps, GridColumnMenuSortBaseProps {
1273
- /**
1274
- * The key of the column menu.
1275
- */
1276
- key?: any;
1277
- /**
1278
- * The method for rendering the column menu.
1279
- */
1280
- render?: any;
1281
- /**
1282
- * The opened column menu.
1283
- */
1284
- opened?: boolean;
1285
- /**
1286
- * The icon that overrides the default(three vertical dots) icon displayed in the column menu of each column.
1287
- */
1288
- columnMenuIcon?: SVGIcon;
1289
- /**
1290
- * The event that is fired when the column menu is focused.
1291
- */
1292
- onContentfocus?: (event: any) => void;
1293
- /**
1294
- * The event that is fired when the column menu is expanded or collapsed.
1295
- */
1296
- onExpandchange?: (event: any) => void;
1297
- /**
1298
- * The event that is fired when the column menu is closed.
1299
- */
1300
- onClose?: (event: any) => void;
1301
- /**
1302
- * The event that is fired when the column menu is about to be sorted.
1303
- */
1304
- onSortchange?: (event: any, sort: SortDescriptor[]) => void;
1305
- }
1306
-
1307
- /**
1308
- * @hidden
1309
- */
1310
- export declare const GridColumnMenuSort: DefineComponent<ExtractPropTypes< {
1311
- sortable: PropType<GridSortSettings_4>;
1312
- sort: {
1313
- type: PropType<SortDescriptor[]>;
1314
- };
1315
- column: PropType<GridColumnMenuColumnProps>;
1316
- onSortchange: PropType<(descriptors: SortDescriptor[], e: any) => void>;
1317
- onClosemenu: PropType<Function>;
1318
- }>, {
1319
- kendoLocalizationService: {};
1320
- }, {}, {}, {
1321
- onAscClick(e: any): void;
1322
- onDescClick(e: any): void;
1323
- onSort(e: any, selectedDir: 'asc' | 'desc'): void;
1324
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
1325
- sortable: PropType<GridSortSettings_4>;
1326
- sort: {
1327
- type: PropType<SortDescriptor[]>;
1328
- };
1329
- column: PropType<GridColumnMenuColumnProps>;
1330
- onSortchange: PropType<(descriptors: SortDescriptor[], e: any) => void>;
1331
- onClosemenu: PropType<Function>;
1332
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1333
-
1334
- /**
1335
- * The props passed to the ColumnMenu sort component.
1336
- */
1337
- declare interface GridColumnMenuSortBaseProps {
1338
- /**
1339
- * The current column options.
1340
- */
1341
- column: GridColumnMenuColumnProps_2;
1342
- /**
1343
- * The method that will be called to close the column menu.
1344
- */
1345
- onClosemenu?: Function;
1346
- /**
1347
- * The sortable option of the column.
1348
- */
1349
- sortable?: GridSortSettings;
1350
- /**
1351
- * The current sort state of the Grid.
1352
- */
1353
- sort?: SortDescriptor[];
1354
- /**
1355
- * The method that will be called to notify the parent Grid about a sort change.
1356
- */
1357
- onSortchange?: (descriptors: SortDescriptor[], e: any) => void;
1358
- }
1359
-
1360
- /**
1361
- * The props that can be assigned to the Grid column.
1362
- */
1363
- export declare interface GridColumnProps extends Omit<ColumnBaseProps, 'cell'> {
1364
- /**
1365
- * The field to which the column is bound.
1366
- */
1367
- field?: string;
1368
- /**
1369
- * The title of the column.
1370
- */
1371
- title?: string;
1372
- /**
1373
- * Defines whether the column is editable
1374
- * ([more information and examples]({% slug editing_inline_grid %})).
1375
- */
1376
- editable?: boolean;
1377
- /**
1378
- * Allows the column headers to be clicked and the `sortChange` event emitted.
1379
- * You have to handle the `sortChange` event yourself and sort the data.
1380
- *
1381
- * @default true
1382
- */
1383
- sortable?: GridColumnSortSettings;
1384
- /**
1385
- * Defines the custom rendering of the cell. Accepts a Vue component, a `render` function, or a slot name.
1386
- * If not set, a `GridCell` will be rendered by default.
1387
- */
1388
- cell?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
1389
- /**
1390
- * @hidden
1391
- */
1392
- internalCell?: any;
1393
- /**
1394
- * @hidden
1395
- */
1396
- internalHeaderCell?: any;
1397
- /**
1398
- * Defines the custom rendering of the filter cell. Accepts a Vue component, a `render` function, or a slot name.
1399
- * If not set, a `GridFilterCell` will be rendered by default.
1400
- */
1401
- filterCell?: ((h: any, defaultRendering: any | null, props: GridFilterCellProps, listeners: any) => any) | string | any;
1402
- /**
1403
- * Defines if a filter UI will be rendered for this column.
1404
- *
1405
- * @default true
1406
- */
1407
- filterable?: boolean;
1408
- /**
1409
- * Defines the title which will be set to the input element in the filter cell.
1410
- *
1411
- */
1412
- filterTitle?: string;
1413
- /**
1414
- * Defines the filter type that will be rendered inside the filter row.
1415
- *
1416
- * @default 'text'
1417
- */
1418
- filter?: GridDataType;
1419
- /**
1420
- * Defines the editor type. Used when the column enters the edit mode ([more information and examples]({% slug editing_inline_grid %})).
1421
- *
1422
- * @default 'text'
1423
- */
1424
- editor?: GridDataType;
1425
- /**
1426
- * Overrides the default(three vertical dots) column menu icon or the icon set through the ([`columnMenuIcon`]({% slug api_grid_gridprops %}#toc-columnmenuicon)) property.
1427
- */
1428
- menuIcon?: SVGIcon;
1429
- /**
1430
- * The width of the column (in pixels).
1431
- */
1432
- width?: string | number;
1433
- /**
1434
- * The width of the column (in pixels) below which the user is not able to resize the column through the UI.
1435
- * Defaults to `10`. It is responsible only for the minimal width that is observed after the manual drag and it is
1436
- * not responsible for the width of the columns when the browser is resized
1437
- */
1438
- minResizableWidth?: number;
1439
- /**
1440
- * Defines the custom rendering of the header cell. Accepts a Vue component, a `render` function, or a slot name.
1441
- * If not set, a `GridHeaderCell` will be rendered by default.
1442
- */
1443
- headerCell?: ((h: any, defaultRendering: any | null, props: GridHeaderCellProps, listeners: any) => any) | string | any;
1444
- /**
1445
- * Defines the custom rendering of the footer cell.
1446
- * The footer cell have to render an `HTMLTableCellElement` (TD element) and
1447
- * apply its `style` and `colspan` values from the footer component `props`.
1448
- * Accepts a Vue component, a `render` function, or a slot name.
1449
- */
1450
- footerCell?: ((h: any, defaultRendering: any | null, props: GridFooterCellProps, listeners: any) => any) | string | any;
1451
- /**
1452
- * Sets the custom CSS classes to the column footer cell if there is footer.
1453
- */
1454
- footerClassName?: string;
1455
- /**
1456
- * Defines if the header selection checkbox is checked.
1457
- */
1458
- headerSelectionValue?: boolean;
1459
- /**
1460
- * The format that is applied to the value before it is displayed. Takes the `{0:format}`
1461
- * form where `format` is any of the following:
1462
- * * A standard number format
1463
- * * A custom number format
1464
- * * A standard date format
1465
- * * A custom date format
1466
- *
1467
- * For more information on the supported date and number formats,
1468
- * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
1469
- */
1470
- format?: string;
1471
- /**
1472
- * Sets the colSpan of the column which will make the row content span over multiple cells.
1473
- * As arguments, it takes either a number or a function that returns a number.
1474
- *
1475
- * @default 1
1476
- */
1477
- colSpan?: number | ((colSpanProps: GridColSpanProps) => number);
1478
- /**
1479
- * Controls the visibility of the Grid's column.
1480
- *
1481
- * @default false
1482
- */
1483
- hidden?: boolean;
1484
- /**
1485
- * Sets the screen size condition that needs to be satisfied for a column to remain visible. If you set the hidden property, the behavior of media is overridden.
1486
- *
1487
- */
1488
- media?: string;
1489
- /**
1490
- * Sets the custom CSS classes to the column header cell.
1491
- */
1492
- headerClassName?: string;
1493
- /**
1494
- * Sets the custom CSS classes to the column cells.
1495
- */
1496
- className?: string;
1497
- /**
1498
- * Indicates whether the column is reorderable.
1499
- */
1500
- reorderable?: boolean;
1501
- /**
1502
- * Indicates whether the column is resizable.
1503
- */
1504
- resizable?: boolean;
1505
- /**
1506
- * Determinates the position of the column. Columns with smaller `orderIndex` will appear
1507
- * before columns with bigger `orderIndex`. Defaults to `0`.
1508
- */
1509
- orderIndex?: number;
1510
- /**
1511
- * Determines if the column can be dragged to the group panel. Defaults to `true`.
1512
- */
1513
- groupable?: boolean;
1514
- /**
1515
- * A collection of child columns.
1516
- */
1517
- children?: (GridColumnProps)[] | (any)[];
1518
- /**
1519
- * Defines if the column menu will be shown for the column.
1520
- * Accepts Boolean, a Vue component, a `render` function, or a slot name
1521
- */
1522
- columnMenu?: boolean | any;
1523
- /**
1524
- * Defines if the column menu is opened.
1525
- */
1526
- columnMenuOpened?: boolean;
1527
- /**
1528
- *
1529
- */
1530
- locked?: boolean;
1531
- /**
1532
- * The type of the data which will be used when formatting the cell data.
1533
- * Could be one of the following values 'string' | 'number' | 'boolean' | 'date'.
1534
- * Defaults to `string`.
1535
- */
1536
- type?: 'string' | 'number' | 'boolean' | 'date';
1537
- /**
1538
- * Sets the type of the column and renders a dedicated column for interaction.
1539
- *
1540
- * @default "data"
1541
- */
1542
- columnType?: GridColumnType;
1543
- /**
1544
- * Defines if the cells of the column should be spanned when their values are the same.
1545
- *
1546
- */
1547
- rowSpannable?: boolean | GridRowSpannableSettings;
1548
- }
1549
-
1550
- /**
1551
- * Represents the object of the `onColumnReorder` event.
1552
- */
1553
- export declare interface GridColumnReorderEvent {
1554
- /**
1555
- * An event target.
1556
- */
1557
- target: GridHandle;
1558
- /**
1559
- * A native DOM event.
1560
- */
1561
- event: any;
1562
- /**
1563
- * A previous column index.
1564
- */
1565
- prev: number;
1566
- /**
1567
- * A next column index.
1568
- */
1569
- next: number;
1570
- /**
1571
- * The current column collection.
1572
- */
1573
- columns: GridColumnProps[];
1574
- }
1575
-
1576
- /**
1577
- * Represents the object of the `onColumnResize` event.
1578
- */
1579
- export declare interface GridColumnResizeEvent {
1580
- /**
1581
- * An event target.
1582
- */
1583
- target: any;
1584
- /**
1585
- * A native DOM event.
1586
- */
1587
- event: any;
1588
- /**
1589
- * The current column collection.
1590
- */
1591
- columns: GridColumnProps[];
1592
- /**
1593
- * The index of the column.
1594
- */
1595
- index: number;
1596
- /**
1597
- * The new width of the column.
1598
- */
1599
- newWidth: number;
1600
- /**
1601
- * The actual width of the column prior to resizing.
1602
- */
1603
- oldWidth: number;
1604
- /**
1605
- * Indicates that resizing is complete and
1606
- * the user has dropped the resize handler.
1607
- */
1608
- end: boolean;
1609
- }
1610
-
1611
- /**
1612
- * The settings for sorting the Grid columns.
1613
- */
1614
- declare type GridColumnSortSettings = boolean | {
1615
- /**
1616
- * Enables the removal of the column sorting functionality.
1617
- */
1618
- allowUnsort?: boolean;
1619
- };
1620
-
1621
- /**
1622
- * Represents the object of the `onColumnsStateChange` Grid event.
1623
- */
1624
- export declare interface GridColumnsStateChangeEvent {
1625
- /**
1626
- * An event target.
1627
- */
1628
- target: GridHandle;
1629
- /**
1630
- * The columns state collection.
1631
- */
1632
- columnsState: GridColumnState[];
1633
- }
1634
-
1635
- /**
1636
- * The state of the GridColumn
1637
- */
1638
- export declare interface GridColumnState {
1639
- /**
1640
- * The id of the column.
1641
- */
1642
- id: string;
1643
- /**
1644
- * The field of the column.
1645
- */
1646
- field?: string;
1647
- /**
1648
- * The title of the column.
1649
- */
1650
- title?: string;
1651
- /**
1652
- * The value indicating whether a column is visible or not.
1653
- */
1654
- hidden?: boolean;
1655
- /**
1656
- * The width of the column (in pixels).
1657
- */
1658
- width?: string | number;
1659
- /**
1660
- * The position of the column.
1661
- */
1662
- orderIndex?: number;
1663
- /**
1664
- * A collection of child states.
1665
- */
1666
- children?: GridColumnState[];
1667
- /**
1668
- * Determines if the column is locked to the left or right side of the grid.
1669
- */
1670
- locked?: boolean;
1671
- }
1672
-
1673
- /**
1674
- * Sets the column type.
1675
- *
1676
- * @default "data"
1677
- */
1678
- declare type GridColumnType = 'data' | 'reorder' | 'checkbox';
1679
-
1680
- /**
1681
- * The returned type of the `onDataStateChange` event.
1682
- */
1683
- export declare interface GridDataStateChangeEvent extends GridEvent {
1684
- /**
1685
- * The state of the Grid based on the user action.
1686
- */
1687
- data: State;
1688
- /**
1689
- * The state of the Grid based on the user action.
1690
- */
1691
- dataState: GridState;
1692
- }
1693
-
1694
- /**
1695
- * Exposes the data types available when setting the [filter](slug:api_grid_gridcolumnprops#toc-filter) or
1696
- * [editor](slug:api_grid_gridcolumnprops#toc-editor) property of the Grid columns.
1697
- */
1698
- declare type GridDataType = 'text' | 'numeric' | 'boolean' | 'date';
1699
-
1700
- /** @hidden */
1701
- declare interface GridDetailExpandableSettings extends TableExpandableSettings {
1702
- }
1703
-
1704
- /**
1705
- * Represents the object of the `onDetailExpandChange` Grid event.
1706
- */
1707
- export declare interface GridDetailExpandChangeEvent extends GridEvent {
1708
- /**
1709
- * The descriptor defining which detail rows are expanded.
1710
- */
1711
- detailExpand: DetailExpandDescriptor;
1712
- }
1713
-
1714
- /**
1715
- * @hidden
1716
- */
1717
- export declare const GridDetailRow: DefineComponent< {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1718
-
1719
- /**
1720
- * @hidden
1721
- */
1722
- export declare interface GridDetailRowProps {
1723
- /**
1724
- * The data object that represents the current row.
1725
- */
1726
- dataItem: any;
1727
- }
1728
-
1729
- /**
1730
- * @hidden
1731
- */
1732
- export declare const GridEditCell: DefineComponent<ExtractPropTypes< {
1733
- id: PropType<string>;
1734
- field: PropType<string>;
1735
- dataItem: PropType<any>;
1736
- format: PropType<string>;
1737
- type: PropType<string>;
1738
- className: PropType<string>;
1739
- colSpan: PropType<number>;
1740
- columnIndex: PropType<number>;
1741
- columnsCount: PropType<number>;
1742
- rowType: PropType<string>;
1743
- level: PropType<number>;
1744
- expanded: PropType<boolean>;
1745
- editor: PropType<string>;
1746
- isSelected: PropType<boolean>;
1747
- ariaColumnIndex: PropType<number>;
1748
- render: PropType<any>;
1749
- isRtl: PropType<boolean>;
1750
- readFormat: PropType<string>;
1751
- dataIndex: PropType<number>;
1752
- }>, {
1753
- kendoIntlService: {};
1754
- }, {
1755
- inputId: any;
1756
- }, {
1757
- tdClass(): {
1758
- [x: number]: any;
1759
- 'k-table-td': boolean;
1760
- };
1761
- }, {
1762
- triggerKeydown(e: any): void;
1763
- triggerEdit(dataItem: any): void;
1764
- triggerAdd(dataItem: any): void;
1765
- triggerCancel(dataItem: any): void;
1766
- triggerSave(dataItem: any): void;
1767
- triggerRemove(dataItem: any): void;
1768
- changeHandler(event: any, value: any): void;
1769
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
1770
- change: any;
1771
- cellkeydown: any;
1772
- edit: any;
1773
- add: any;
1774
- cancel: any;
1775
- save: any;
1776
- remove: any;
1777
- }, string, PublicProps, Readonly<ExtractPropTypes< {
1778
- id: PropType<string>;
1779
- field: PropType<string>;
1780
- dataItem: PropType<any>;
1781
- format: PropType<string>;
1782
- type: PropType<string>;
1783
- className: PropType<string>;
1784
- colSpan: PropType<number>;
1785
- columnIndex: PropType<number>;
1786
- columnsCount: PropType<number>;
1787
- rowType: PropType<string>;
1788
- level: PropType<number>;
1789
- expanded: PropType<boolean>;
1790
- editor: PropType<string>;
1791
- isSelected: PropType<boolean>;
1792
- ariaColumnIndex: PropType<number>;
1793
- render: PropType<any>;
1794
- isRtl: PropType<boolean>;
1795
- readFormat: PropType<string>;
1796
- dataIndex: PropType<number>;
1797
- }>> & Readonly<{
1798
- onCancel?: (...args: any[] | unknown[]) => any;
1799
- onChange?: (...args: any[] | unknown[]) => any;
1800
- onAdd?: (...args: any[] | unknown[]) => any;
1801
- onEdit?: (...args: any[] | unknown[]) => any;
1802
- onRemove?: (...args: any[] | unknown[]) => any;
1803
- onCellkeydown?: (...args: any[] | unknown[]) => any;
1804
- onSave?: (...args: any[] | unknown[]) => any;
1805
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1806
-
1807
- /**
1808
- * Represents the object of the `edit` event.
1809
- */
1810
- export declare interface GridEditEvent {
1811
- /**
1812
- * The item from the `data` property of the Grid that corresponds to the item that is edited by the user.
1813
- */
1814
- dataItem: any;
1815
- }
1816
-
1817
- /**
1818
- * Represents the base event object of the Grid.
1819
- */
1820
- /**
1821
- * @hidden
1822
- */
1823
- export declare interface GridEvent {
1824
- /**
1825
- * An event target.
1826
- */
1827
- target?: any;
1828
- /**
1829
- * A specific native DOM event which is fetched by Vue.
1830
- */
1831
- event?: any;
1832
- }
1833
-
1834
- /**
1835
- * Represents the object of the `onExpandChange` event.
1836
- */
1837
- export declare interface GridExpandChangeEvent extends GridEvent {
1838
- /**
1839
- * The array with collapsed groups.
1840
- */
1841
- collapsedGroups?: any[][];
1842
- /**
1843
- * The data item that is expanded or collapsed.
1844
- */
1845
- dataItem: any;
1846
- /**
1847
- * The available values are:
1848
- * - `true`&mdash;If the data item is expanded.
1849
- * - `false`&mdash;If the data item is collapsed.
1850
- */
1851
- value: boolean;
1852
- }
1853
-
1854
- /**
1855
- * @hidden
1856
- */
1857
- export declare const GridFilterCell: DefineComponent<ExtractPropTypes< {
1858
- id: PropType<string>;
1859
- grid: PropType<any>;
1860
- field: PropType<string>;
1861
- filterType: PropType<string>;
1862
- colSpan: PropType<number>;
1863
- title: PropType<string>;
1864
- value: PropType<any>;
1865
- operator: PropType<string>;
1866
- operators: PropType<GridFilterOperators_3[]>;
1867
- booleanValues: PropType<GridFilterOperator_2[]>;
1868
- onChange: PropType<(event: {
1869
- value: any;
1870
- operator: string | Function;
1871
- event: any;
1872
- }) => void>;
1873
- render: PropType<any>;
1874
- ariaLabel: PropType<string>;
1875
- size: PropType<"small" | "medium" | "large">;
1876
- }>, {
1877
- kendoIntlService: {};
1878
- kendoLocalizationService: {};
1879
- }, {}, {}, {
1880
- inputChange(value: any, e: any): void;
1881
- operatorChange(operatorValue: any, e: any): void;
1882
- boolDropdownChange(value: any, e: any): void;
1883
- clear(e: any): void;
1884
- triggerChange(filter: any): void;
1885
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
1886
- id: PropType<string>;
1887
- grid: PropType<any>;
1888
- field: PropType<string>;
1889
- filterType: PropType<string>;
1890
- colSpan: PropType<number>;
1891
- title: PropType<string>;
1892
- value: PropType<any>;
1893
- operator: PropType<string>;
1894
- operators: PropType<GridFilterOperators_3[]>;
1895
- booleanValues: PropType<GridFilterOperator_2[]>;
1896
- onChange: PropType<(event: {
1897
- value: any;
1898
- operator: string | Function;
1899
- event: any;
1900
- }) => void>;
1901
- render: PropType<any>;
1902
- ariaLabel: PropType<string>;
1903
- size: PropType<"small" | "medium" | "large">;
1904
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
1905
-
1906
- /**
1907
- * The props of the GridFilterCell component
1908
- * ([more information and examples]({% slug filtering_grid %})).
1909
- */
1910
- /**
1911
- * @hidden
1912
- */
1913
- export declare interface GridFilterCellProps {
1914
- /**
1915
- * @hidden
1916
- */
1917
- id: string;
1918
- /**
1919
- * The instance of the Grid component.
1920
- */
1921
- grid?: any;
1922
- /**
1923
- * The title of the filter editor.
1924
- */
1925
- title?: string;
1926
- /**
1927
- * The column span of the cell.
1928
- */
1929
- colSpan?: number;
1930
- /**
1931
- * The column field in which the cell is located.
1932
- */
1933
- field?: string;
1934
- /**
1935
- * The type of the filter. Determines which editor will be rendered for filtering.
1936
- * The supported values are the following 0 'text' | 'numeric' | 'boolean' | 'date;
1937
- */
1938
- filterType: string;
1939
- /**
1940
- * The value of the cell.
1941
- */
1942
- value: any;
1943
- /**
1944
- * The operator that will be used for the cell filtering.
1945
- */
1946
- operator: string;
1947
- /**
1948
- * The list of the default operators for the current filter type.
1949
- */
1950
- operators: GridFilterOperators[];
1951
- /**
1952
- * The list of values for the Boolean filter.
1953
- */
1954
- booleanValues: GridFilterOperator[];
1955
- /**
1956
- * The method that will be called if the cell needs to inform its parent Grid about a change.
1957
- */
1958
- onChange?: (event: {
1959
- value: any;
1960
- operator: string | Function;
1961
- event: any;
1962
- }) => void;
1963
- /**
1964
- * The method for rendering the filter cell.
1965
- */
1966
- render?: any;
1967
- /**
1968
- * The ariaLabel of the filter editor.
1969
- */
1970
- ariaLabel?: string;
1971
- /**
1972
- * Configures the `size` of the cell.
1973
- *
1974
- * The available options are:
1975
- * - small
1976
- * - medium
1977
- * - large
1978
- *
1979
- * @default `undefined`
1980
- */
1981
- size?: 'small' | 'medium' | 'large';
1982
- }
1983
-
1984
- /**
1985
- * Represents the object of the `onFilterChange` event.
1986
- */
1987
- export declare interface GridFilterChangeEvent extends GridEvent {
1988
- /**
1989
- * The new `CompositeFilterDescriptor` based on the user action.
1990
- */
1991
- filter: CompositeFilterDescriptor;
1992
- }
1993
-
1994
- /**
1995
- * The filter operator for the Grid filters.
1996
- */
1997
- declare interface GridFilterOperator {
1998
- text: string;
1999
- operator: any;
2000
- }
2001
-
2002
- /**
2003
- * The filter operators for the Grid filters.
2004
- *
2005
- * @example
2006
- * ```jsx-no-run
2007
- * // Default Grid filter operators:
2008
- * const filterOperators: {
2009
- * 'text': [
2010
- * { text: 'grid.filterContainsOperator', operator: 'contains' },
2011
- * { text: 'grid.filterNotContainsOperator', operator: 'doesnotcontain' },
2012
- * { text: 'grid.filterEqOperator', operator: 'eq' },
2013
- * { text: 'grid.filterNotEqOperator', operator: 'neq' },
2014
- * { text: 'grid.filterStartsWithOperator', operator: 'startswith' },
2015
- * { text: 'grid.filterEndsWithOperator', operator: 'endswith' },
2016
- * { text: 'grid.filterIsNullOperator', operator: 'isnull' },
2017
- * { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' },
2018
- * { text: 'grid.filterIsEmptyOperator', operator: 'isempty' },
2019
- * { text: 'grid.filterIsNotEmptyOperator', operator: 'isnotempty' }
2020
- * ],
2021
- * 'numeric': [
2022
- * { text: 'grid.filterEqOperator', operator: 'eq' },
2023
- * { text: 'grid.filterNotEqOperator', operator: 'neq' },
2024
- * { text: 'grid.filterGteOperator', operator: 'gte' },
2025
- * { text: 'grid.filterGtOperator', operator: 'gt' },
2026
- * { text: 'grid.filterLteOperator', operator: 'lte' },
2027
- * { text: 'grid.filterLtOperator', operator: 'lt' },
2028
- * { text: 'grid.filterIsNullOperator', operator: 'isnull' },
2029
- * { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' }
2030
- * ],
2031
- * 'date': [
2032
- * { text: 'grid.filterEqOperator', operator: 'eq' },
2033
- * { text: 'grid.filterNotEqOperator', operator: 'neq' },
2034
- * { text: 'grid.filterAfterOrEqualOperator', operator: 'gte' },
2035
- * { text: 'grid.filterAfterOperator', operator: 'gt' },
2036
- * { text: 'grid.filterBeforeOperator', operator: 'lt' },
2037
- * { text: 'grid.filterBeforeOrEqualOperator', operator: 'lte' },
2038
- * { text: 'grid.filterIsNullOperator', operator: 'isnull' },
2039
- * { text: 'grid.filterIsNotNullOperator', operator: 'isnotnull' }
2040
- * ],
2041
- * 'boolean': [
2042
- * { text: 'grid.filterEqOperator', operator: 'eq' }
2043
- * ]
2044
- * }
2045
- * ```
2046
- */
2047
- declare interface GridFilterOperators {
2048
- [type: string]: GridFilterOperator[];
2049
- }
2050
-
2051
- export declare interface GridFooterCellProps {
2052
- /**
2053
- * The field to which the footer cell is bound.
2054
- */
2055
- field?: string;
2056
- colSpan?: number;
2057
- }
2058
-
2059
- /**
2060
- * The settings for grouping the data of the Grid
2061
- * ([see example]({% slug groupingaggregates_grid %})).
2062
- */
2063
- export declare interface GridGroupableSettings {
2064
- /**
2065
- * Determines if grouping by dragging and dropping the column headers is allowed
2066
- * and if the group header is visible.
2067
- */
2068
- enabled?: boolean;
2069
- /**
2070
- * Determines if the group footer row is visible when the group is collapsed. Defaults to `false`.
2071
- */
2072
- footer?: 'always' | 'visible' | 'none';
2073
- /**
2074
- * The group expandable settings.
2075
- */
2076
- expandable?: boolean | GridGroupExpandableSettings;
2077
- }
2078
-
2079
- /**
2080
- * @hidden
2081
- */
2082
- export declare const GridGroupCell: DefineComponent<ExtractPropTypes< {
2083
- id: PropType<string>;
2084
- field: PropType<string>;
2085
- dataItem: PropType<any>;
2086
- format: PropType<string>;
2087
- type: PropType<string>;
2088
- colSpan: PropType<number>;
2089
- className: PropType<string>;
2090
- columnIndex: PropType<number>;
2091
- columnsCount: PropType<number>;
2092
- rowType: PropType<string>;
2093
- level: PropType<number>;
2094
- expanded: PropType<boolean>;
2095
- editor: PropType<string>;
2096
- dataIndex: PropType<number>;
2097
- isSelected: PropType<boolean>;
2098
- isRtl: PropType<boolean>;
2099
- ariaColumnIndex: PropType<number>;
2100
- group: PropType<GroupState>;
2101
- render: PropType<any>;
2102
- }>, {}, {}, {
2103
- tdClass(): {
2104
- [x: number]: any;
2105
- 'k-table-td': boolean;
2106
- };
2107
- }, {
2108
- triggerStateChange(): void;
2109
- triggerKeydown(event: any, expanded: boolean | undefined): void;
2110
- clickHandler(e: any, dataItem: any, expanded: boolean | undefined): void;
2111
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
2112
- change: any;
2113
- cellkeydown: any;
2114
- }, string, PublicProps, Readonly<ExtractPropTypes< {
2115
- id: PropType<string>;
2116
- field: PropType<string>;
2117
- dataItem: PropType<any>;
2118
- format: PropType<string>;
2119
- type: PropType<string>;
2120
- colSpan: PropType<number>;
2121
- className: PropType<string>;
2122
- columnIndex: PropType<number>;
2123
- columnsCount: PropType<number>;
2124
- rowType: PropType<string>;
2125
- level: PropType<number>;
2126
- expanded: PropType<boolean>;
2127
- editor: PropType<string>;
2128
- dataIndex: PropType<number>;
2129
- isSelected: PropType<boolean>;
2130
- isRtl: PropType<boolean>;
2131
- ariaColumnIndex: PropType<number>;
2132
- group: PropType<GroupState>;
2133
- render: PropType<any>;
2134
- }>> & Readonly<{
2135
- onChange?: (...args: any[] | unknown[]) => any;
2136
- onCellkeydown?: (...args: any[] | unknown[]) => any;
2137
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
2138
-
2139
- /**
2140
- * Represents the object of the `onGroupChange` event.
2141
- */
2142
- export declare interface GridGroupChangeEvent extends GridEvent {
2143
- /**
2144
- * An array of `GroupDescriptor` based on the user action.
2145
- */
2146
- group: GroupDescriptor[];
2147
- }
2148
-
2149
- /**
2150
- * Represents the Grid group expandable settings.
2151
- */
2152
- declare interface GridGroupExpandableSettings extends TableGroupExpandableSettings {
2153
- /**
2154
- * Determines the default expand state for groups.
2155
- * When set to `true`, all groups are expanded by default.
2156
- */
2157
- defaultExpand?: boolean;
2158
- /**
2159
- * Determines if group expanding functionality is enabled.
2160
- */
2161
- enabled?: boolean;
2162
- }
2163
-
2164
- /**
2165
- * Represents the object of the `onGroupExpandChange` Grid event.
2166
- */
2167
- export declare interface GridGroupExpandChangeEvent extends GridEvent {
2168
- /**
2169
- * The descriptors defining which groups are expanded.
2170
- */
2171
- groupExpand: GroupExpandDescriptor[];
2172
- }
2173
-
2174
- /**
2175
- * Represent the `ref` of the Grid component.
2176
- */
2177
- declare interface GridHandle {
2178
- /**
2179
- * Returns the HTML element of the Grid component.
2180
- */
2181
- element: HTMLDivElement | null;
2182
- /**
2183
- * The props values of the Grid.
2184
- */
2185
- props: GridProps;
2186
- /**
2187
- * A getter of the current columns. Gets the current column width or current columns, or any other [`GridColumnProps`]({% slug api_grid_gridcolumnprops %}) for each defined column. Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the `ref` callback. The following example demonstrates how to reorder the columns by dragging their handlers and check the properties afterwards. You can check the result in the browser console.
2188
- *
2189
- */
2190
- columns: GridColumnProps[];
2191
- /**
2192
- * Method to allow the scroll to be set to a specific row index when the Grid is scrollable. It is zero based.
2193
- *
2194
- * @param options - Object, containing the rowIndex to which is going to be scrolled.
2195
- */
2196
- scrollIntoView: (options: {
2197
- rowIndex: number;
2198
- }) => void;
2199
- /**
2200
- * Method to fit columns according to their content.
2201
- *
2202
- * @param columnIds - Array of column ids to be fitted.
2203
- */
2204
- fitColumns: (columnIds: string[]) => void;
2205
- /**
2206
- * Method to trigger a PDF export of the Grid.
2207
- * The 'pdf' prop of the Grid should be set to true or object of setting that will be applied the exported Grid.
2208
- */
2209
- exportAsPdf: () => void;
2210
- }
2211
-
2212
- /**
2213
- * @hidden
2214
- */
2215
- export declare const GridHeaderCell: DefineComponent<ExtractPropTypes< {
2216
- field: PropType<string>;
2217
- title: PropType<string>;
2218
- sortable: PropType<GridSortSettings_3>;
2219
- render: PropType<any>;
2220
- selectionValue: PropType<any>;
2221
- onHeadercellclick: PropType<any>;
2222
- }>, {}, {}, {
2223
- linkClass(): {
2224
- 'k-link': boolean;
2225
- '!k-cursor-default': boolean;
2226
- };
2227
- }, {
2228
- clickHandler(event: any): void;
2229
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
2230
- field: PropType<string>;
2231
- title: PropType<string>;
2232
- sortable: PropType<GridSortSettings_3>;
2233
- render: PropType<any>;
2234
- selectionValue: PropType<any>;
2235
- onHeadercellclick: PropType<any>;
2236
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
2237
-
2238
- /**
2239
- * The props of the GridHeaderCellProps component.
2240
- */
2241
- /**
2242
- * @hidden
2243
- */
2244
- export declare interface GridHeaderCellProps {
2245
- /**
2246
- * The key in which the cell is located.
2247
- */
2248
- key?: any;
2249
- /**
2250
- * The column field in which the cell is located.
2251
- */
2252
- field?: string;
2253
- /**
2254
- * The title of the column in which the cell is located.
2255
- */
2256
- title?: string;
2257
- /**
2258
- * The `click` event handler of the cell.
2259
- */
2260
- onClick?: any;
2261
- /**
2262
- * @hidden
2263
- */
2264
- selectionValue?: any;
2265
- /**
2266
- * The method for rendering the header cell.
2267
- */
2268
- sortable?: GridSortSettings;
2269
- /**
2270
- * The method for rendering the cell.
2271
- */
2272
- render?: any;
2273
- }
2274
-
2275
- /**
2276
- * Represents the object of the `onHeaderSelectionChange` event.
2277
- */
2278
- export declare interface GridHeaderSelectionChangeEvent extends GridEvent {
2279
- /**
2280
- * The field of the column in which the cell is located.
2281
- */
2282
- field?: string;
2283
- }
2284
-
2285
- /**
2286
- * @hidden
2287
- */
2288
- export declare const GridHierarchyCell: DefineComponent<ExtractPropTypes< {
2289
- id: PropType<string>;
2290
- field: PropType<string>;
2291
- dataItem: PropType<any>;
2292
- format: PropType<string>;
2293
- type: PropType<string>;
2294
- className: PropType<string>;
2295
- colSpan: PropType<number>;
2296
- columnIndex: PropType<number>;
2297
- columnsCount: PropType<number>;
2298
- rowType: PropType<string>;
2299
- level: PropType<number>;
2300
- expanded: PropType<boolean>;
2301
- editor: PropType<string>;
2302
- isSelected: PropType<boolean>;
2303
- dataIndex: PropType<number>;
2304
- ariaColumnIndex: PropType<number>;
2305
- render: PropType<any>;
2306
- isRtl: PropType<boolean>;
2307
- }>, {}, {}, {
2308
- wrapperClass(): {
2309
- [x: number]: any;
2310
- 'k-table-td': boolean;
2311
- 'k-hierarchy-cell': boolean;
2312
- };
2313
- }, {
2314
- triggerStateChange(): void;
2315
- triggerKeydown(event: any, expanded: boolean | undefined): void;
2316
- clickHandler(e: any, dataItem: any, expanded: boolean | undefined): void;
2317
- }, ComponentOptionsMixin, ComponentOptionsMixin, {
2318
- change: any;
2319
- cellkeydown: any;
2320
- }, string, PublicProps, Readonly<ExtractPropTypes< {
2321
- id: PropType<string>;
2322
- field: PropType<string>;
2323
- dataItem: PropType<any>;
2324
- format: PropType<string>;
2325
- type: PropType<string>;
2326
- className: PropType<string>;
2327
- colSpan: PropType<number>;
2328
- columnIndex: PropType<number>;
2329
- columnsCount: PropType<number>;
2330
- rowType: PropType<string>;
2331
- level: PropType<number>;
2332
- expanded: PropType<boolean>;
2333
- editor: PropType<string>;
2334
- isSelected: PropType<boolean>;
2335
- dataIndex: PropType<number>;
2336
- ariaColumnIndex: PropType<number>;
2337
- render: PropType<any>;
2338
- isRtl: PropType<boolean>;
2339
- }>> & Readonly<{
2340
- onChange?: (...args: any[] | unknown[]) => any;
2341
- onCellkeydown?: (...args: any[] | unknown[]) => any;
2342
- }>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
2343
-
2344
- /**
2345
- * Represents the object of the `onItemChange` event.
2346
- */
2347
- export declare interface GridItemChangeEvent extends GridEvent {
2348
- /**
2349
- * The data object that represents the current row.
2350
- */
2351
- dataItem: any;
2352
- /**
2353
- * The field to which the row is bound.
2354
- */
2355
- field?: string;
2356
- /**
2357
- * The value of the item.
2358
- */
2359
- value: any;
2360
- }
2361
-
2362
- /**
2363
- * Represents the object of the `GridKeyDownEvent` Grid event.
2364
- */
2365
- export declare interface GridKeyDownEvent extends GridEvent {
2366
- /**
2367
- * The current Grid leaf data items.
2368
- */
2369
- dataItems: any[];
2370
- /**
2371
- * Grid selection mode.
2372
- */
2373
- mode: 'single' | 'multiple';
2374
- /**
2375
- * Indicates if cell selection mode is enabled.
2376
- */
2377
- cell: boolean;
2378
- /**
2379
- * The `selectedField` prop of the Grid.
2380
- */
2381
- selectedField: string;
2382
- /**
2383
- * The component unique identifier.
2384
- */
2385
- componentId: string;
2386
- }
2387
-
2388
- /**
2389
- * Represents the object of the `GridNavigationActionEvent` Grid event.
2390
- */
2391
- export declare interface GridNavigationActionEvent extends GridEvent {
2392
- /**
2393
- * The focused element.
2394
- */
2395
- focusElement: any;
2396
- }
2397
-
2398
- /**
2399
- * Represents the GridNoRecords component which is rendered
2400
- * when the `data` property of the Grid is empty or `null`.
2401
- */
2402
- export declare const GridNoRecords: DefineComponent< {}, {
2403
- kendoLocalizationService: {};
2404
- }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
2405
-
2406
- /**
2407
- * The props of the GridNoRecords component.
2408
- */
2409
- export declare interface GridNoRecordsProps {
2410
- /**
2411
- * The Vue slots that will be rendered inside the Grid when no records are available.
2412
- */
2413
- children?: any;
2414
- }
2415
-
2416
- /**
2417
- * Represents the object of the `onPageChange` event.
2418
- */
2419
- export declare interface GridPageChangeEvent extends GridEvent {
2420
- page: any;
2421
- /**
2422
- * A specific native DOM event which is fetched by Vue.
2423
- */
2424
- event: any;
2425
- }
2426
-
2427
- export { GridPagerSettings }
2428
-
2429
- /**
2430
- * Represents the props of the [native Vue Grid component by Kendo UI]({% slug overview_grid %}).
2431
- */
2432
- export declare interface GridProps {
2433
- /**
2434
- * Sets the `id` property of the top div element of the component.
2435
- *
2436
- * @example
2437
- * ```jsx
2438
- * <Grid :id="'custom-grid-id' />
2439
- * ```
2440
- */
2441
- id?: string;
2442
- /**
2443
- * Enables data-processing inside the GridComponent based on its state.
2444
- * Provides an easy, built-in way to handle data operations like sorting, filtering, grouping, and paging.
2445
- *
2446
- * @default false
2447
- *
2448
- * @example
2449
- * ```jsx
2450
- * <Grid
2451
- * :autoProcessData="{
2452
- * filter: true,
2453
- * search: true,
2454
- * sort: true,
2455
- * group: true,
2456
- * page: true
2457
- * }}"
2458
- * />
2459
- * ```
2460
- */
2461
- autoProcessData?: boolean | {
2462
- filter?: boolean;
2463
- search?: boolean;
2464
- sort?: boolean;
2465
- group?: boolean;
2466
- page?: boolean;
2467
- };
2468
- /**
2469
- * Sets the Grid row key prop to the value of this field in the dataItem.
2470
- * If not set, the dataItem index will be used for the row key, which
2471
- * might lead to row not updated during paging or scrolling.
2472
- */
2473
- dataItemKey?: string;
2474
- /**
2475
- * When set to `true` it sets the alternating of the rows per groups so each group could start
2476
- * with the same color row. There is a known limitation when virtual scrolling with groups and
2477
- * alternatePerGroup set to `true`- there may be a slight flicker of the alternating rows in
2478
- * groups with larger amount of items - in this case we would rather recommend
2479
- * using rowTemplates and set the row alternating based on the data or dataItems.
2480
- */
2481
- alternatePerGroup?: boolean;
2482
- /**
2483
- * Sets the properties of the columns that are used by the Grid.
2484
- */
2485
- columns?: GridColumnProps[] | null;
2486
- /**
2487
- * Sets the data of the Grid ([see example]({% slug paging_grid %})). If you use paging,
2488
- * the `data` option has to contain only the items for the current page.
2489
- */
2490
- dataItems?: any[] | DataResult | null;
2491
- /**
2492
- * Enables the sorting for the columns with their `field` option set
2493
- * ([see example]({% slug sorting_grid %})).
2494
- */
2495
- sortable?: GridSortSettings;
2496
- /**
2497
- * Fires when the sorting of the Grid is changed ([see example]({% slug sorting_grid %})).
2498
- * You have to handle the event yourself and sort the data.
2499
- */
2500
- onSortchange?: (event: GridSortChangeEvent) => void;
2501
- /**
2502
- * The descriptors by which the data is sorted.
2503
- * Applies the sorting styles and buttons to the affected columns.
2504
- */
2505
- defaultSort?: SortDescriptor[];
2506
- /**
2507
- * The descriptors by which the data is sorted.
2508
- * Applies the sorting styles and buttons to the affected columns.
2509
- */
2510
- sort?: SortDescriptor[];
2511
- /**
2512
- * Enables the filtering of the columns with their `field` option set
2513
- * ([more information and examples]({% slug filtering_grid %})).
2514
- */
2515
- filterable?: boolean;
2516
- /**
2517
- * The descriptor by which the data is searched. Its first FilterDescriptor populates the GridSearchBox.
2518
- *
2519
- * @example
2520
- * ```vue
2521
- * <Grid :search="{ logic: 'and', filters: [{ field: 'name', operator: 'contains', value: 'test' }] }" />
2522
- * ```
2523
- */
2524
- search?: CompositeFilterDescriptor;
2525
- /**
2526
- * The descriptor by which the data is searched by default. Its first FilterDescriptor populates the GridSearchBox.
2527
- *
2528
- * @example
2529
- * ```vue
2530
- * <Grid :default-search="{ logic: 'or', filters: [{ field: 'category', operator: 'eq', value: 'electronics' }] }" />
2531
- * ```
2532
- */
2533
- defaultSearch?: CompositeFilterDescriptor;
2534
- /**
2535
- * Defines the fields of the data that are filtered by the GridSearchBox.
2536
- *
2537
- * @example
2538
- * ```vue
2539
- * <Grid :search-fields="['name', 'category']" />
2540
- * ```
2541
- */
2542
- searchFields?: (string | SearchField)[];
2543
- /**
2544
- * Fires when the search descriptor of the Grid is changed.
2545
- * You have to handle the event yourself and search the data.
2546
- */
2547
- onSearchchange?: (event: GridSearchChangeEvent) => void;
2548
- /**
2549
- * The default descriptor by which the data is filtered
2550
- * ([more information and examples]({% slug filtering_grid %})).
2551
- */
2552
- defaultFilter?: CompositeFilterDescriptor;
2553
- /**
2554
- * The descriptor by which the data is filtered
2555
- * ([more information and examples]({% slug filtering_grid %})).
2556
- * Affects the values and buttons in the `FilterRow` of the Grid.
2557
- */
2558
- filter?: CompositeFilterDescriptor;
2559
- /**
2560
- * The filter operators for the Grid filters.
2561
- */
2562
- filterOperators?: GridFilterOperators;
2563
- /**
2564
- * Fires when the Grid filter is modified through the UI
2565
- * ([more information and examples]({% slug filtering_grid %})).
2566
- * You have to handle the event yourself and filter the data.
2567
- */
2568
- onFilterchange?: (event: GridFilterChangeEvent) => void;
2569
- /**
2570
- * The collection of column states of the grid.
2571
- */
2572
- columnsState?: GridColumnState[];
2573
- /**
2574
- * The default collection of column states of the grid.
2575
- */
2576
- defaultColumnsState?: GridColumnState[];
2577
- /**
2578
- * Defines if the column menu will be shown for the column.
2579
- * Accepts Boolean, a Vue component, a `render` function, or a slot name
2580
- */
2581
- columnMenu?: boolean | any;
2582
- /**
2583
- * Globally overrides the default(three vertical dots) column menu icon for the whole Grid. If set, the prop can be overridden on column level using the ([menuIcon]({% slug api_grid_gridcolumnprops %}#toc-menuicon)) property.
2584
- */
2585
- columnMenuIcon?: SVGIcon;
2586
- /**
2587
- * Controls the ColumnMenu animation. By default, the opening and closing animations are enabled.
2588
- */
2589
- columnMenuAnimate?: boolean | PopupAnimation;
2590
- /**
2591
- * The descriptor by which the group is expanded.
2592
- *
2593
- * @example
2594
- * ```jsx
2595
- * <Grid :group-expand="[{ field: 'CategoryName', expanded: true }]" />
2596
- * ```
2597
- */
2598
- groupExpand?: GroupExpandDescriptor[];
2599
- /**
2600
- * The default `groupExpand` state applied to the Grid when using uncontrolled mode.
2601
- *
2602
- * @example
2603
- * ```jsx
2604
- * <Grid :default-group-expand="[{ field: 'CategoryName', expanded: true }]" />
2605
- * ```
2606
- */
2607
- defaultGroupExpand?: GroupExpandDescriptor[];
2608
- /**
2609
- * Fires when the user expands or collapses a group.
2610
- */
2611
- onGroupexpandchange?: (event: GridGroupExpandChangeEvent) => void;
2612
- /**
2613
- * The descriptor by which the detail rows are expanded.
2614
- *
2615
- * @example
2616
- * ```jsx
2617
- * <Grid :detail-expand="{ 1: true, 3: true }" />
2618
- * ```
2619
- */
2620
- detailExpand?: DetailExpandDescriptor;
2621
- /**
2622
- * The default `detailExpand` state applied to the Grid when using uncontrolled mode.
2623
- *
2624
- * @example
2625
- * ```jsx
2626
- * <Grid :default-detail-expand="{ 2: true, 4: true }" />
2627
- * ```
2628
- */
2629
- defaultDetailExpand?: DetailExpandDescriptor;
2630
- /**
2631
- * Fires when the user expands or collapses a detail row.
2632
- */
2633
- onDetailexpandchange?: (event: GridDetailExpandChangeEvent) => void;
2634
- /**
2635
- * The descriptors by which the data will be grouped
2636
- * ([more information and examples]({% slug groupingbasics_grid %})).
2637
- */
2638
- group?: GroupDescriptor[];
2639
- /**
2640
- * The default `group` state applied to the Grid when using uncontrolled mode.
2641
- *
2642
- * @example
2643
- * ```jsx
2644
- * <Grid defaultGroup={[{ field: 'CategoryName' }]} />
2645
- * ```
2646
- */
2647
- defaultGroup?: GroupDescriptor[];
2648
- /**
2649
- * Fires when the grouping of the Grid is changed. You have to handle the event yourself and group the data
2650
- * ([more information and examples]({% slug groupingbasics_grid %})).
2651
- */
2652
- onGroupchange?: (event: GridGroupChangeEvent) => void;
2653
- /**
2654
- * Configures the pager of the Grid ([see example]({% slug paging_grid %})).
2655
- *
2656
- * The available options are:
2657
- * - `buttonCount: Number`&mdash;Sets the maximum numeric buttons count before the buttons are collapsed.
2658
- * - `info: Boolean`&mdash;Toggles the information about the current page and the total number of records.
2659
- * - `type: PagerType`&mdash;Accepts the `numeric` (buttons with numbers)
2660
- * and `input` (input for typing the page number) values.
2661
- * - `pageSizes: Boolean` or `Array<number>`&mdash;Shows a menu for selecting the page size.
2662
- * - `previousNext: Boolean`&mdash;Toggles the **Previous** and **Next** buttons.
2663
- */
2664
- pageable?: GridPagerSettings | any;
2665
- /**
2666
- * Defines the page size that is used by the Grid pager
2667
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
2668
- */
2669
- pageSize?: number;
2670
- /**
2671
- * Alias of the `pageSize` property. If `take` is set, `pageSize` will be ignored.
2672
- */
2673
- take?: number;
2674
- /**
2675
- * The default `take` state applied to the Grid when using uncontrolled mode.
2676
- *
2677
- * @example
2678
- * ```jsx
2679
- * <Grid :default-take="20" />
2680
- * ```
2681
- */
2682
- defaultTake?: number;
2683
- /**
2684
- * Fires when the page of the Grid is changed ([see example]({% slug paging_grid %})).
2685
- * You have to handle the event yourself and page the data.
2686
- */
2687
- onPagechange?: (event: GridPageChangeEvent) => void;
2688
- /**
2689
- * Defines the total number of data items in all pages
2690
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
2691
- */
2692
- total?: number;
2693
- /**
2694
- * Defines the number of records that will be skipped by the pager
2695
- * ([see example]({% slug paging_grid %})). Required by the paging functionality.
2696
- */
2697
- skip?: number;
2698
- /**
2699
- * The default `skip` state applied to the Grid when using uncontrolled mode.
2700
- *
2701
- * @example
2702
- * ```vue
2703
- * <Grid :default-skip="10" />
2704
- * ```
2705
- */
2706
- defaultSkip?: number;
2707
- /**
2708
- * Deprecated. Use 'onDetailexpandchange' or 'onGroupexpandchange' instead.
2709
- */
2710
- onExpandchange?: (event: GridExpandChangeEvent) => void;
2711
- /**
2712
- * Determines if the scroll position will be updated after a data change.
2713
- * If set to `true`, the scroll will remain in the same position.
2714
- */
2715
- fixedScroll?: boolean;
2716
- /**
2717
- *
2718
- * `obsolete` Will be removed in the next major release. Set `dataItemKey` property instead.
2719
- *
2720
- * Specifies the name of the field which will provide a Boolean representation
2721
- * of the expanded state of the item ([see example]({% slug detailrow_grid %}).
2722
- */
2723
- expandField?: string;
2724
- /**
2725
- * Specifies the name of the field which will provide a Boolean representation
2726
- * of the selected state of the item ([see example]({% slug selection_grid %})).
2727
- */
2728
- selectedField?: string;
2729
- /**
2730
- * Fires when the user tries to select or deselect a row
2731
- * ([see example]({% slug selection_grid %})).
2732
- */
2733
- onSelectionchange?: (event: GridSelectionChangeEvent) => void;
2734
- /**
2735
- * The descriptor by which the highlight state of an item is defined.
2736
- * Passing a boolean value will highlight the whole row, while passing an object will highlight individual cells by their field.
2737
- *
2738
- */
2739
- highlight?: {
2740
- [id: string]: boolean | {
2741
- [id: string]: boolean;
2742
- };
2743
- };
2744
- /**
2745
- * Fires when the user clicks the checkbox of a column header whose `field` matches `selectedField`.
2746
- * ([see example]({% slug selection_grid %})).
2747
- */
2748
- onHeaderselectionchange?: (event: GridHeaderSelectionChangeEvent) => void;
2749
- /**
2750
- * Fires when the user clicks a row.
2751
- */
2752
- onRowclick?: (event: GridRowClickEvent) => void;
2753
- /**
2754
- * Fires when the user double clicks a row.
2755
- */
2756
- onRowdblclick?: (event: GridRowClickEvent) => void;
2757
- /**
2758
- * Fires when the user clicks a cell.
2759
- */
2760
- onCellclick?: (event: any) => void;
2761
- /**
2762
- * Fires when Grid is scrolled.
2763
- */
2764
- onScroll?: (event: any) => void;
2765
- /**
2766
- * Fires when the user triggers an edit operation from a cell.
2767
- */
2768
- onEdit?: (event: GridEditEvent) => void;
2769
- /**
2770
- * Fires when the user triggers a removal operation from a cell.
2771
- */
2772
- onRemove?: (event: GridRemoveEvent) => void;
2773
- /**
2774
- * Fires when the user triggers a saving operation from a cell.
2775
- */
2776
- onSave?: (event: GridSaveEvent) => void;
2777
- /**
2778
- * Fires when the user triggers a canceling operation from a cell.
2779
- */
2780
- onCancel?: (event: GridCancelEvent) => void;
2781
- /**
2782
- * Fires when the user changes the values of the item.
2783
- * The event is not debounced and fires on every `onChange` event of the input in the current `EditCell`.
2784
- * ([more information and examples]({% slug editing_inline_grid %})).
2785
- */
2786
- onItemchange?: (event: GridItemChangeEvent) => void;
2787
- /**
2788
- * Specifies the name of the field which will provide a Boolean representation of the edit state of the current
2789
- * item ([more information and examples]({% slug editing_inline_grid %})).
2790
- */
2791
- editField?: string;
2792
- /**
2793
- * Enables the built-in row span feature of the Grid.
2794
- *
2795
- * @example
2796
- * ```jsx
2797
- * <Grid rowSpannable={true} />
2798
- * ```
2799
- */
2800
- rowSpannable?: boolean | GridRowSpannableSettings;
2801
- /**
2802
- * A function that returns a custom class applied to the row.
2803
- *
2804
- * @param item - the item for the row.
2805
- */
2806
- rowClass?: Function;
2807
- /**
2808
- * Defines the scroll mode that is used by the Grid ([see example]({% slug scrollmmodes_grid %}).
2809
- *
2810
- * The available options are:
2811
- * - `none`&mdash;Renders no scrollbar.
2812
- * - `scrollable`&mdash;This is the default scroll mode. It requires the setting of the `height` option.
2813
- * - `virtual`&mdash;Displays no pager and renders a portion of the data (optimized rendering)
2814
- * while the user is scrolling the content.
2815
- */
2816
- scrollable?: string;
2817
- /**
2818
- * Configures the `size` of the Grid.
2819
- *
2820
- * The available options are:
2821
- * - small
2822
- * - medium
2823
- *
2824
- * @default `undefined`
2825
- */
2826
- size?: 'small' | 'medium' | string;
2827
- /**
2828
- * Defines the row height and forces an equal height to all rows
2829
- * ([see example]({% slug scrollmmodes_grid %})).
2830
- */
2831
- rowHeight?: number;
2832
- /**
2833
- * Defines the height of the detail row and forces an equal height to all detail rows
2834
- */
2835
- detailRowHeight?: number;
2836
- /**
2837
- * Specifies a custom rendering that will be cloned and rendered inside the detail rows
2838
- * of the currently expanded items ([see example]({% slug master_detail_grid %}).
2839
- * Accepts a Vue component, a `render` function, or a slot name.
2840
- * The expand will be active if the `dataItemKey` is set.
2841
- */
2842
- detail?: null | any;
2843
- /**
2844
- * Defines the GridColumnProps of the expand column.
2845
- */
2846
- expandColumn?: GridColumnProps;
2847
- /**
2848
- * Represents the `style` HTML attribute.
2849
- */
2850
- style?: any;
2851
- /**
2852
- * Fires when the data state of the Grid is changed.
2853
- */
2854
- onDatastatechange?: (event: GridDataStateChangeEvent) => void;
2855
- /**
2856
- * If set to `true`, the user can resize columns by dragging the edges (resize handles) of their
2857
- * header cells ([see example]({% slug resizing_columns_grid %}).
2858
- */
2859
- resizable?: boolean;
2860
- /**
2861
- * If set to `true`, the user can reorder columns by dragging their
2862
- * header cells ([see example]({% slug reordering_columns_grid %}).
2863
- */
2864
- reorderable?: boolean;
2865
- /**
2866
- * Determines if grouping by dragging and dropping the column headers is allowed
2867
- * ([more information and examples]({% slug groupingbasics_grid %})).
2868
- */
2869
- groupable?: GridGroupableSettings | boolean;
2870
- /**
2871
- * Fires when a column is resized
2872
- */
2873
- onColumnresize?: (event: GridColumnResizeEvent) => void;
2874
- /**
2875
- * Fires when columns are reordered.
2876
- */
2877
- onColumnreorder?: (event: GridColumnReorderEvent) => void;
2878
- /**
2879
- * Defines the custom rendering of the row. Accepts a Vue component, a `render` function, or a slot name.
2880
- */
2881
- rowRender?: string | boolean | ((h: any, defaultRendering: any | null, defaultSlots: any, props: any, listeners: any) => any);
2882
- /**
2883
- * Defines the custom rendering of the cell. Accepts a Vue component, a `render` function, or a slot name.
2884
- * ([see example]({% slug groupingaggregates_grid %})).
2885
- */
2886
- cellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | null | boolean;
2887
- /**
2888
- * Defines the custom rendering of the filter cell. Accepts a Vue component, a `render` function, or a slot name.
2889
- */
2890
- filterCellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
2891
- /**
2892
- * Defines the custom rendering of the header cell. Accepts a Vue component, a `render` function, or a slot name.
2893
- */
2894
- headerCellRender?: ((h: any, defaultRendering: any | null, props: GridCellProps, listeners: any) => any) | string | any;
2895
- /**
2896
- * Specifies whether the loader of the Grid will be displayed.
2897
- * Defaults to `false`.
2898
- */
2899
- showLoader?: boolean;
2900
- /**
2901
- *
2902
- * The boolean option is `Deprecated`. Use 'showLoader' instead.
2903
- *
2904
- * Defines if the loader will be shown. Accepts a slot name, a `render` function, or a Vue component.
2905
- */
2906
- loader?: Object | Function | string;
2907
- /**
2908
- * Defines the custom rendering of the pager. Accepts a slot name, a `render` function, or a Vue component.
2909
- */
2910
- pager?: Object | Function | string | boolean;
2911
- /**
2912
- * Enables virtualization of the columns. If virtualization is
2913
- * enabled, the columns outside the view are not rendered.
2914
- */
2915
- columnVirtualization?: boolean;
2916
- /**
2917
- * If set to `true`, the user can use dedicated shortcuts to interact with the Grid.
2918
- * By default, navigation is disabled and the Grid content is accessible in the normal tab sequence.
2919
- */
2920
- navigatable?: boolean;
2921
- /**
2922
- * Deprecated. Not needed any more.
2923
- */
2924
- topCacheCount?: number;
2925
- /**
2926
- * Deprecated. Not needed any more.
2927
- */
2928
- totalGroupedHeight?: number;
2929
- /**
2930
- * Deprecated. Not needed any more.
2931
- */
2932
- allGroupedItems?: DataResult | null;
2933
- /**
2934
- *
2935
- *`Deprecated` Use 'groupExpand' instead.
2936
- *
2937
- * Passes the collection of all collapsed groups for every grouped level.
2938
- */
2939
- collapsedGroups?: any[][];
2940
- /**
2941
- * Deprecated. Not needed any more. Use 'dataItemKey' instead.
2942
- */
2943
- uniqueField?: string;
2944
- /**
2945
- * Fires when Grid keyboard navigation position is changed.
2946
- */
2947
- onNavigationaction?: (event: GridNavigationActionEvent) => void;
2948
- /**
2949
- * Fires when the user press keyboard key.
2950
- */
2951
- onKeydown?: (event: GridKeyDownEvent) => void;
2952
- }
2953
-
2954
- /**
2955
- * Represents the object of the `remove` event.
2956
- */
2957
- export declare interface GridRemoveEvent {
2958
- /**
2959
- * The item from the `data` property of the Grid that corresponds to the item that is removed by the user.
2960
- */
2961
- dataItem: any;
2962
- }
2963
-
2964
- /**
2965
- * @hidden
2966
- */
2967
- export declare const GridRow: DefineComponent<ExtractPropTypes< {
2968
- rowType: PropType<string>;
2969
- item: PropType<any>;
2970
- isAltRow: PropType<boolean>;
2971
- isHidden: PropType<boolean>;
2972
- isHighlighted: PropType<boolean>;
2973
- onClick: PropType<any>;
2974
- isInEdit: PropType<boolean>;
2975
- isSelected: PropType<boolean>;
2976
- selectedField: PropType<string>;
2977
- rowHeight: PropType<number>;
2978
- ariaRowIndex: PropType<number>;
2979
- absoluteRowIndex: PropType<number>;
2980
- dataIndex: PropType<number>;
2981
- render: PropType<any>;
2982
- onRowclick: PropType<any>;
2983
- onRowdblclick: PropType<Function>;
2984
- }>, {}, {}, {
2985
- trClass(): {
2986
- 'k-table-row': boolean;
2987
- 'k-selected': any;
2988
- 'k-highlighted': any;
2989
- 'k-table-group-row': boolean;
2990
- 'k-grouping-row': boolean;
2991
- 'k-group-footer': boolean;
2992
- 'k-master-row': boolean;
2993
- 'k-table-alt-row': any;
2994
- 'k-edit-row': any;
2995
- };
2996
- }, {
2997
- handleClick(e: any): void;
2998
- handleDoubleClick(e: any): void;
2999
- }, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
3000
- rowType: PropType<string>;
3001
- item: PropType<any>;
3002
- isAltRow: PropType<boolean>;
3003
- isHidden: PropType<boolean>;
3004
- isHighlighted: PropType<boolean>;
3005
- onClick: PropType<any>;
3006
- isInEdit: PropType<boolean>;
3007
- isSelected: PropType<boolean>;
3008
- selectedField: PropType<string>;
3009
- rowHeight: PropType<number>;
3010
- ariaRowIndex: PropType<number>;
3011
- absoluteRowIndex: PropType<number>;
3012
- dataIndex: PropType<number>;
3013
- render: PropType<any>;
3014
- onRowclick: PropType<any>;
3015
- onRowdblclick: PropType<Function>;
3016
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
3017
-
3018
- /**
3019
- * Represents the object of the `onRowClick` event.
3020
- */
3021
- export declare interface GridRowClickEvent extends GridEvent {
3022
- /**
3023
- * The item from the `data` property of the Grid which corresponds to the row that is clicked by the user.
3024
- */
3025
- dataItem: any;
3026
- }
3027
-
3028
- /**
3029
- * The props that the Grid passes to the GridRow component when creating it.
3030
- * Accessible during the `rowRender` callback of the Grid.
3031
- */
3032
- /**
3033
- * @hidden
3034
- */
3035
- export declare interface GridRowProps {
3036
- /**
3037
- * The 'key' prop that may be applied to the row.
3038
- */
3039
- key?: number;
3040
- /**
3041
- * The `data` object that represents the current row.
3042
- */
3043
- item: any;
3044
- /**
3045
- * Indicates whether the row is an alternating row.
3046
- */
3047
- isAltRow: boolean;
3048
- /**
3049
- * Indicates if the row is hidden. The hidden row is rendered above the
3050
- * visible area of the Grid. Occurs when the Grid uses virtualization and
3051
- * the row is on the current page. When `rowHeight` is set, `isHidden` is always `true`.
3052
- */
3053
- isHidden: boolean;
3054
- /**
3055
- * @hidden
3056
- */
3057
- isHighlighted?: boolean;
3058
- /**
3059
- * The event that is fired when the row is clicked.
3060
- */
3061
- onClick: any;
3062
- /**
3063
- * The name of the field which will provide a Boolean representation of the selected state of the item.
3064
- */
3065
- selectedField?: string;
3066
- /**
3067
- * The row height. Configuring `rowHeight` sets the height to the height of the current Grid row.
3068
- */
3069
- rowHeight?: number;
3070
- /**
3071
- * The type of the row.
3072
- */
3073
- rowType: string;
3074
- /**
3075
- * The method for rendering the cell.
3076
- */
3077
- render?: any;
3078
- /**
3079
- * @hidden
3080
- */
3081
- ariaRowIndex?: number;
3082
- /**
3083
- * @hidden
3084
- */
3085
- absoluteRowIndex?: number;
3086
- /**
3087
- * @hidden
3088
- */
3089
- dataIndex?: number;
3090
- }
3091
-
3092
- /**
3093
- * Represents the settings for the row-spanning functionality of the Grid.
3094
- */
3095
- declare type GridRowSpannableSettings = {
3096
- /**
3097
- * Determines if the row-spanning functionality is enabled or disabled
3098
- */
3099
- enabled?: boolean;
3100
- /**
3101
- * A function that returns the value of the cell that should span the row.
3102
- * The value could be combined from multiple fields of the dataItem to create a unique identifier and prevent the cell from being row-spanned.
3103
- */
3104
- valueGetter?: (dataItem: any, field: string) => any;
3105
- };
3106
-
3107
- /**
3108
- * The type of the GridRow component.
3109
- *
3110
- * The available values are:
3111
- * - `groupHeader`&mdash;The row is a group header.
3112
- * - `groupFooter`&mdash;The row is a group footer.
3113
- * - `data`&mdash;The row corresponds to an item from the `data` collection which is passed to the Grid.
3114
- */
3115
- declare type GridRowType = 'groupFooter' | 'groupHeader' | 'data';
3116
-
3117
- /**
3118
- * Represents the object of the `save` event.
3119
- */
3120
- export declare interface GridSaveEvent {
3121
- /**
3122
- * The item from the `data` property of the Grid that corresponds to the item that is saved by the user.
3123
- */
3124
- dataItem: any;
3125
- }
3126
-
3127
- /**
3128
- * Represents the properties of the KendoVue GridSearchBox component.
3129
- */
3130
- export declare const GridSearchBox: DefineComponent<ExtractPropTypes< {
3131
- onChange: FunctionConstructor;
3132
- className: StringConstructor;
3133
- placeholder: StringConstructor;
3134
- }>, {
3135
- handleChange: (event: TextBoxChangeEvent) => void;
3136
- value: ComputedRef<string>;
3137
- rootClassName: ComputedRef< {
3138
- 'k-grid-search': boolean;
3139
- 'k-searchbox': boolean;
3140
- }>;
3141
- placeholder: ComputedRef<any>;
3142
- }, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
3143
- onChange: FunctionConstructor;
3144
- className: StringConstructor;
3145
- placeholder: StringConstructor;
3146
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
3147
-
3148
- /**
3149
- * Represents the event object of the GridSearchBox `onChange` event.
3150
- */
3151
- declare interface GridSearchBoxChangeEvent extends TextBoxChangeEvent {
3152
- }
3153
-
3154
- /**
3155
- * Represents the props of the GridSearchBox component.
3156
- */
3157
- export declare interface GridSearchBoxProps extends TextBoxProps {
3158
- /**
3159
- * Fires when the value of the search box is changed.
3160
- */
3161
- onChange?: (event: GridSearchBoxChangeEvent) => void;
3162
- }
3163
-
3164
- /**
3165
- * Represents the object of the `onSearchChange` Grid event.
3166
- */
3167
- export declare interface GridSearchChangeEvent extends GridEvent {
3168
- /**
3169
- * The new search based on the user action.
3170
- */
3171
- search: CompositeFilterDescriptor;
3172
- }
3173
-
3174
- /**
3175
- * Represents the object of the `onSelectionChange` event.
3176
- */
3177
- export declare interface GridSelectionChangeEvent extends GridEvent {
3178
- /**
3179
- * The data item which was selected or deselected by the user.
3180
- */
3181
- dataItem: any;
3182
- }
3183
-
3184
- /**
3185
- * Represents the object of the `onSortChange` event.
3186
- */
3187
- export declare interface GridSortChangeEvent extends GridEvent {
3188
- /**
3189
- * The new `SortDescriptor` based on the user action.
3190
- */
3191
- sort: SortDescriptor[];
3192
- }
3193
-
3194
- /**
3195
- * The settings for sorting the Grid data.
3196
- */
3197
- export declare type GridSortSettings = boolean | GridColumnSortSettings & {
3198
- /**
3199
- * The sort mode of the Grid.
3200
- *
3201
- * The available modes are:
3202
- * - `single`
3203
- * - `multiple`
3204
- */
3205
- mode?: 'single' | 'multiple';
3206
- };
3207
-
3208
- /** @hidden */
3209
- declare type GridState = {
3210
- filter?: GridProps['filter'];
3211
- highlight?: GridProps['highlight'];
3212
- search?: GridProps['search'];
3213
- sort?: GridProps['sort'];
3214
- skip?: GridProps['skip'];
3215
- take?: GridProps['take'];
3216
- group?: GridProps['group'];
3217
- detailExpand?: GridProps['detailExpand'];
3218
- groupExpand?: GridProps['groupExpand'];
3219
- columnsState?: GridProps['columnsState'];
3220
- };
3221
-
3222
- /**
3223
- * Represents the GridToolbar component.
3224
- *
3225
- * @hidden
3226
- */
3227
- export declare const GridToolbar: DefineComponent<ExtractPropTypes< {
3228
- size: {
3229
- type: PropType<string>;
3230
- validator: (value: string) => boolean;
3231
- };
3232
- }>, {}, {}, {
3233
- wrapperClass(): {
3234
- [x: string]: any;
3235
- 'k-toolbar': boolean;
3236
- 'k-grid-toolbar': boolean;
3237
- 'k-toolbar-solid': boolean;
3238
- };
3239
- }, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes< {
3240
- size: {
3241
- type: PropType<string>;
3242
- validator: (value: string) => boolean;
3243
- };
3244
- }>> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
3245
-
3246
- /**
3247
- * The props of the GridToolbarProps component.
3248
- */
3249
- export declare interface GridToolbarProps {
3250
- /**
3251
- * Configures the `size` of the Grid.
3252
- *
3253
- * The available options are:
3254
- * - small
3255
- * - medium
3256
- *
3257
- * @default `medium`
3258
- */
3259
- size?: 'small' | 'medium' | string;
3260
- }
3261
-
3262
- /**
3263
- * @hidden
3264
- */
3265
- export declare function groupedFirstItemValue(item: any, field: string): any;
3266
-
3267
- /**
3268
- * @hidden
3269
- */
3270
- export declare function isRtl(element: Element | null): boolean;
3271
-
3272
- /**
3273
- * @hidden
3274
- */
3275
- export declare const isSorted: (field: string | undefined, sort?: SortDescriptor[]) => boolean;
3276
-
3277
- /**
3278
- * @hidden
3279
- */
3280
- export declare function mapColumns(columns: Array<{
3281
- parentIndex: number;
3282
- rowSpan: number;
3283
- depth: number;
3284
- kFirst?: boolean;
3285
- children: any[];
3286
- headerColSpan: number;
3287
- width?: string | number;
3288
- locked?: boolean;
3289
- index: number;
3290
- left: number;
3291
- right: number;
3292
- rightBorder: boolean;
3293
- ariaColumnIndex: number;
3294
- virtualColumnOffset?: number;
3295
- }>, changedColumnLength?: boolean): number[][];
3296
-
3297
- /**
3298
- * @hidden
3299
- */
3300
- export declare const parsers: {
3301
- number: (value: any, intl: IntlService, format?: string) => number;
3302
- date: (value: any, intl: IntlService, format?: string) => Date;
3303
- boolean: (value: any) => any;
3304
- string: (value: any) => any;
3305
- default: (value: any) => any;
3306
- };
3307
-
3308
- /**
3309
- * @hidden
3310
- */
3311
- export declare function readColumns(elements: (GridColumnProps)[], columnsState: GridColumnState[], idInfo: {
3312
- prevId: number;
3313
- idPrefix: string;
3314
- }, depth?: number, parentHidden?: boolean): ExtendedColumnProps[];
3315
-
3316
- /**
3317
- * @hidden
3318
- */
3319
- export declare const sanitizeColumns: (columns: ExtendedColumnProps[]) => GridColumnProps[];
3320
-
3321
- /**
3322
- * Can be used to check if sorting is applied to a specific field ([see example]({% slug column_menu_grid %}#toc-styling-the-column-menu-icon)). Useful for creating active sort indicators.
3323
- */
3324
- export declare const sortGroupByField: (field: string, sort?: SortDescriptor[]) => boolean;
3325
-
3326
- export { }
8
+ import { RootGrid as Grid } from './RootGrid';
9
+ import { GridProps } from './interfaces/GridProps';
10
+ import { GridColumnProps } from './interfaces/GridColumnProps';
11
+ import { GridColumnMenuProps } from './interfaces/GridColumnMenuProps';
12
+ import { GridColumnState } from './interfaces/GridColumnState';
13
+ import { GridColumnMenuSort, sortGroupByField } from './columnMenu/GridColumnMenuSort';
14
+ import { GridColumnMenuFilter, filterGroupByField } from './columnMenu/GridColumnMenuFilter';
15
+ import { GridColumnMenuFilterUI } from './columnMenu/GridColumnMenuFilterUI';
16
+ import { GridColumnMenuFilterCell } from './columnMenu/GridColumnMenuFilterCell';
17
+ import { GridColumnMenuCheckboxFilter, GridColumnMenuCheckboxFilterProps } from './columnMenu/GridColumnMenuCheckboxFilter';
18
+ import { GridCellProps } from './interfaces/GridCellProps';
19
+ import { GridCell } from './cells/GridCell';
20
+ import { GridEditCell } from './cells/GridEditCell';
21
+ import { GridGroupCell } from './cells/GridGroupCell';
22
+ import { GridHierarchyCell } from './cells/GridHierarchyCell';
23
+ import { GridFilterCell } from './cells/GridFilterCell';
24
+ import { GridFilterCellProps } from './interfaces/GridFilterCellProps';
25
+ import { GridHeaderCell } from './header/GridHeaderCell';
26
+ import { GridHeaderCellProps } from './interfaces/GridHeaderCellProps';
27
+ import { Footer } from './footer/Footer';
28
+ import { FooterRow } from './footer/FooterRow';
29
+ import { GridFooterCellProps } from './interfaces/GridFooterCellProps';
30
+ import { GridDetailRow } from './rows/GridDetailRow';
31
+ import { GridDetailRowProps } from './interfaces/GridDetailRowProps';
32
+ import { GridRow } from './rows/GridRow';
33
+ import { GridRowProps } from './interfaces/GridRowProps';
34
+ import { GridToolbar } from './GridToolbar';
35
+ import { GridToolbarProps } from './interfaces/GridToolbarProps';
36
+ import { GridNoRecords } from './components/noRecords/GridNoRecords';
37
+ import { GridNoRecordsProps } from './interfaces/GridNoRecordsProps';
38
+ import { GridColSpanProps } from './interfaces/GridColSpanProps';
39
+ import { GridSortSettings } from './interfaces/GridSortSettings';
40
+ import { GridPagerSettings } from '@progress/kendo-vue-data-tools';
41
+ import { GridGroupableSettings } from './interfaces/GridGroupableSettings';
42
+ import { GridColumnMenuItem } from './columnMenu/GridColumnMenuItem';
43
+ import { GridColumnMenuItemContent } from './columnMenu/GridColumnMenuItemContent';
44
+ import { GridColumnMenuItemGroup } from './columnMenu/GridColumnMenuItemGroup';
45
+ import { GridSearchBox, GridSearchBoxProps } from './GridSearchBox';
46
+ export * from './utils/main';
47
+ export * from './interfaces/events';
48
+ export { Grid, GridCell, GridEditCell, GridGroupCell, GridHierarchyCell, GridDetailRow, GridRow, GridFilterCell, GridHeaderCell, Footer, FooterRow, GridColumnMenuSort, sortGroupByField, GridColumnMenuFilter, filterGroupByField, GridColumnMenuItem, GridColumnMenuItemContent, GridColumnMenuItemGroup, GridColumnMenuFilterUI, GridColumnMenuFilterCell, GridColumnMenuCheckboxFilter, GridToolbar, GridNoRecords, GridSearchBox, };
49
+ export type { GridProps, GridColumnProps, GridCellProps, GridDetailRowProps, GridRowProps, GridFilterCellProps, GridHeaderCellProps, GridFooterCellProps, GridColumnMenuProps, GridColumnMenuCheckboxFilterProps, GridToolbarProps, GridNoRecordsProps, GridSortSettings, GridPagerSettings, GridGroupableSettings, GridSearchBoxProps, GridColumnState, GridColSpanProps, };