@bryntum/grid-vue-3-thin 7.3.0 → 7.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/lib/chunks/Bc2x_WPR.js.map +1 -1
- package/lib/chunks/Be7ZZzGW.js.map +1 -1
- package/lib/chunks/BpNo5v3W.js.map +1 -1
- package/lib/chunks/{BeyOFZne.js → C87PnYXS.js} +11 -9
- package/lib/chunks/C87PnYXS.js.map +1 -0
- package/lib/chunks/{Ba35uKyP.js → C9RmZYoQ.js} +7 -5
- package/lib/chunks/C9RmZYoQ.js.map +1 -0
- package/lib/chunks/CAlh-Y8B.js.map +1 -1
- package/lib/chunks/CWYhi4DG.js.map +1 -1
- package/lib/chunks/CcfDAcJD.js.map +1 -1
- package/lib/chunks/{BGeNcVH6.js → DZ2V6NNc.js} +12 -10
- package/lib/chunks/DZ2V6NNc.js.map +1 -0
- package/lib/chunks/w2GDktIt.js.map +1 -1
- package/lib/components/BryntumAIFilterField.js +1 -1
- package/lib/components/BryntumChecklistFilterCombo.js +1 -1
- package/lib/components/BryntumTreeCombo.js +1 -1
- package/lib/index.js +3 -3
- package/package.json +1 -1
- package/src/components/BryntumAIFilterField.vue +86 -106
- package/src/components/BryntumAIFilterFieldProps.ts +15 -0
- package/src/components/BryntumChecklistFilterCombo.vue +87 -109
- package/src/components/BryntumChecklistFilterComboProps.ts +15 -0
- package/src/components/BryntumGrid.vue +529 -755
- package/src/components/BryntumGridBase.vue +529 -755
- package/src/components/BryntumGridBaseProps.ts +6 -0
- package/src/components/BryntumGridChartDesigner.vue +49 -69
- package/src/components/BryntumGridChartDesignerProps.ts +6 -0
- package/src/components/BryntumGridFieldFilterPicker.vue +59 -85
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +63 -91
- package/src/components/BryntumGridFieldFilterPickerGroupProps.ts +6 -0
- package/src/components/BryntumGridFieldFilterPickerProps.ts +6 -0
- package/src/components/BryntumGridProps.ts +6 -0
- package/src/components/BryntumGroupBar.vue +74 -102
- package/src/components/BryntumGroupBarProps.ts +9 -1
- package/src/components/BryntumTreeCombo.vue +87 -109
- package/src/components/BryntumTreeComboProps.ts +15 -0
- package/src/components/BryntumTreeGrid.vue +529 -755
- package/src/components/BryntumTreeGridProps.ts +6 -0
- package/lib/chunks/BGeNcVH6.js.map +0 -1
- package/lib/chunks/Ba35uKyP.js.map +0 -1
- package/lib/chunks/BeyOFZne.js.map +0 -1
|
@@ -36,6 +36,8 @@ export declare type BryntumGridBaseProps = {
|
|
|
36
36
|
/**
|
|
37
37
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
38
38
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
39
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
40
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-appendTo)
|
|
39
41
|
*/
|
|
40
42
|
appendTo ? : HTMLElement|string
|
|
41
43
|
/**
|
|
@@ -347,10 +349,14 @@ export declare type BryntumGridBaseProps = {
|
|
|
347
349
|
inputFieldAlign ? : 'start'|'end'
|
|
348
350
|
/**
|
|
349
351
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
352
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
353
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
350
354
|
*/
|
|
351
355
|
insertBefore ? : HTMLElement|string
|
|
352
356
|
/**
|
|
353
357
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
358
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
359
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
354
360
|
*/
|
|
355
361
|
insertFirst ? : HTMLElement|string
|
|
356
362
|
/**
|
|
@@ -43,6 +43,8 @@ defineProps<{
|
|
|
43
43
|
/**
|
|
44
44
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
45
45
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
46
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
47
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
46
48
|
*/
|
|
47
49
|
appendTo ? : HTMLElement|string
|
|
48
50
|
/**
|
|
@@ -220,10 +222,14 @@ defineProps<{
|
|
|
220
222
|
ignoreParentReadOnly ? : Boolean
|
|
221
223
|
/**
|
|
222
224
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
225
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
226
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
223
227
|
*/
|
|
224
228
|
insertBefore ? : HTMLElement|string
|
|
225
229
|
/**
|
|
226
230
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
231
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
232
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
227
233
|
*/
|
|
228
234
|
insertFirst ? : HTMLElement|string
|
|
229
235
|
/**
|
|
@@ -444,30 +450,24 @@ const emit = defineEmits<{
|
|
|
444
450
|
* Fires before an object is destroyed.
|
|
445
451
|
* @param {string} e Event name
|
|
446
452
|
* @param {object} params Event parameters
|
|
447
|
-
* @param {
|
|
448
|
-
* @param {
|
|
449
|
-
* @param {object} params.params.event Event object
|
|
450
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
453
|
+
* @param {object} params.event Event object
|
|
454
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
451
455
|
*/
|
|
452
456
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
453
457
|
/**
|
|
454
458
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
455
459
|
* @param {string} e Event name
|
|
456
460
|
* @param {object} params Event parameters
|
|
457
|
-
* @param {
|
|
458
|
-
* @param {
|
|
459
|
-
* @param {object} params.params.event Event object
|
|
460
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
461
|
+
* @param {object} params.event Event object
|
|
462
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
461
463
|
*/
|
|
462
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
464
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
463
465
|
/**
|
|
464
466
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
465
467
|
* @param {string} e Event name
|
|
466
468
|
* @param {object} params Event parameters
|
|
467
|
-
* @param {
|
|
468
|
-
* @param {
|
|
469
|
-
* @param {object} params.params.event Event object
|
|
470
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
469
|
+
* @param {object} params.event Event object
|
|
470
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
471
471
|
*/
|
|
472
472
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
473
473
|
/**
|
|
@@ -475,46 +475,38 @@ const emit = defineEmits<{
|
|
|
475
475
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#event-catchAll)
|
|
476
476
|
* @param {string} e Event name
|
|
477
477
|
* @param {object} params Event parameters
|
|
478
|
-
* @param {
|
|
479
|
-
* @param {
|
|
480
|
-
* @param {
|
|
481
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
482
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
478
|
+
* @param {object} params.event Event object
|
|
479
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
480
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
483
481
|
*/
|
|
484
482
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
485
483
|
/**
|
|
486
484
|
* Fires when an object is destroyed.
|
|
487
485
|
* @param {string} e Event name
|
|
488
486
|
* @param {object} params Event parameters
|
|
489
|
-
* @param {
|
|
490
|
-
* @param {
|
|
491
|
-
* @param {object} params.params.event Event object
|
|
492
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
487
|
+
* @param {object} params.event Event object
|
|
488
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
493
489
|
*/
|
|
494
490
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
495
491
|
/**
|
|
496
492
|
* Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
|
|
497
493
|
* @param {string} e Event name
|
|
498
494
|
* @param {object} params Event parameters
|
|
499
|
-
* @param {
|
|
500
|
-
* @param {
|
|
501
|
-
* @param {object} params.params.event Event object
|
|
502
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
495
|
+
* @param {object} params.event Event object
|
|
496
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
503
497
|
*/
|
|
504
498
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
505
499
|
/**
|
|
506
500
|
* Fired when focus enters this Widget.
|
|
507
501
|
* @param {string} e Event name
|
|
508
502
|
* @param {object} params Event parameters
|
|
509
|
-
* @param {
|
|
510
|
-
* @param {
|
|
511
|
-
* @param {
|
|
512
|
-
* @param {
|
|
513
|
-
* @param {
|
|
514
|
-
* @param {
|
|
515
|
-
* @param {
|
|
516
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
517
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
503
|
+
* @param {object} params.event Event object
|
|
504
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
505
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
506
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
507
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
508
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
509
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
518
510
|
*/
|
|
519
511
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
520
512
|
/**
|
|
@@ -523,25 +515,21 @@ const emit = defineEmits<{
|
|
|
523
515
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
524
516
|
* @param {string} e Event name
|
|
525
517
|
* @param {object} params Event parameters
|
|
526
|
-
* @param {
|
|
527
|
-
* @param {
|
|
528
|
-
* @param {
|
|
529
|
-
* @param {
|
|
530
|
-
* @param {
|
|
531
|
-
* @param {
|
|
532
|
-
* @param {
|
|
533
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
534
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
518
|
+
* @param {object} params.event Event object
|
|
519
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
520
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
521
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
522
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
523
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
524
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
535
525
|
*/
|
|
536
526
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
537
527
|
/**
|
|
538
528
|
* Triggered after a widget was hidden
|
|
539
529
|
* @param {string} e Event name
|
|
540
530
|
* @param {object} params Event parameters
|
|
541
|
-
* @param {
|
|
542
|
-
* @param {
|
|
543
|
-
* @param {object} params.params.event Event object
|
|
544
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
531
|
+
* @param {object} params.event Event object
|
|
532
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
545
533
|
*/
|
|
546
534
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
547
535
|
/**
|
|
@@ -550,21 +538,17 @@ const emit = defineEmits<{
|
|
|
550
538
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#event-paint)
|
|
551
539
|
* @param {string} e Event name
|
|
552
540
|
* @param {object} params Event parameters
|
|
553
|
-
* @param {
|
|
554
|
-
* @param {
|
|
555
|
-
* @param {
|
|
556
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
557
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
541
|
+
* @param {object} params.event Event object
|
|
542
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
543
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
558
544
|
*/
|
|
559
545
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
560
546
|
/**
|
|
561
547
|
* Fired when a Widget's read only state is toggled
|
|
562
548
|
* @param {string} e Event name
|
|
563
549
|
* @param {object} params Event parameters
|
|
564
|
-
* @param {
|
|
565
|
-
* @param {
|
|
566
|
-
* @param {object} params.params.event Event object
|
|
567
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
550
|
+
* @param {object} params.event Event object
|
|
551
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
568
552
|
*/
|
|
569
553
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
570
554
|
/**
|
|
@@ -576,24 +560,20 @@ const emit = defineEmits<{
|
|
|
576
560
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
577
561
|
* @param {string} e Event name
|
|
578
562
|
* @param {object} params Event parameters
|
|
579
|
-
* @param {
|
|
580
|
-
* @param {
|
|
581
|
-
* @param {
|
|
582
|
-
* @param {
|
|
583
|
-
* @param {number} params.
|
|
584
|
-
* @param {number} params.
|
|
585
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
586
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
563
|
+
* @param {object} params.event Event object
|
|
564
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
565
|
+
* @param {number} params.event.width The new width
|
|
566
|
+
* @param {number} params.event.height The new height
|
|
567
|
+
* @param {number} params.event.oldWidth The old width
|
|
568
|
+
* @param {number} params.event.oldHeight The old height
|
|
587
569
|
*/
|
|
588
570
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
589
571
|
/**
|
|
590
572
|
* Triggered after a widget is shown.
|
|
591
573
|
* @param {string} e Event name
|
|
592
574
|
* @param {object} params Event parameters
|
|
593
|
-
* @param {
|
|
594
|
-
* @param {
|
|
595
|
-
* @param {object} params.params.event Event object
|
|
596
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
575
|
+
* @param {object} params.event Event object
|
|
576
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
597
577
|
*/
|
|
598
578
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
599
579
|
}>();
|
|
@@ -28,6 +28,8 @@ export declare type BryntumGridChartDesignerProps = {
|
|
|
28
28
|
/**
|
|
29
29
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
30
30
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
31
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
32
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
31
33
|
*/
|
|
32
34
|
appendTo ? : HTMLElement|string
|
|
33
35
|
/**
|
|
@@ -205,10 +207,14 @@ export declare type BryntumGridChartDesignerProps = {
|
|
|
205
207
|
ignoreParentReadOnly ? : Boolean
|
|
206
208
|
/**
|
|
207
209
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
210
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
211
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
208
212
|
*/
|
|
209
213
|
insertBefore ? : HTMLElement|string
|
|
210
214
|
/**
|
|
211
215
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
216
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
217
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
212
218
|
*/
|
|
213
219
|
insertFirst ? : HTMLElement|string
|
|
214
220
|
/**
|
|
@@ -50,6 +50,8 @@ defineProps<{
|
|
|
50
50
|
/**
|
|
51
51
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
52
52
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
53
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
54
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
53
55
|
*/
|
|
54
56
|
appendTo ? : HTMLElement|string
|
|
55
57
|
/**
|
|
@@ -286,10 +288,14 @@ defineProps<{
|
|
|
286
288
|
inputFieldAlign ? : 'start'|'end'
|
|
287
289
|
/**
|
|
288
290
|
* Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
291
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
292
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
289
293
|
*/
|
|
290
294
|
insertBefore ? : HTMLElement|string
|
|
291
295
|
/**
|
|
292
296
|
* Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
|
|
297
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
298
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
293
299
|
*/
|
|
294
300
|
insertFirst ? : HTMLElement|string
|
|
295
301
|
/**
|
|
@@ -606,42 +612,34 @@ const emit = defineEmits<{
|
|
|
606
612
|
* Fires before an object is destroyed.
|
|
607
613
|
* @param {string} e Event name
|
|
608
614
|
* @param {object} params Event parameters
|
|
609
|
-
* @param {
|
|
610
|
-
* @param {
|
|
611
|
-
* @param {object} params.params.event Event object
|
|
612
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
615
|
+
* @param {object} params.event Event object
|
|
616
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
613
617
|
*/
|
|
614
618
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
615
619
|
/**
|
|
616
620
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
617
621
|
* @param {string} e Event name
|
|
618
622
|
* @param {object} params Event parameters
|
|
619
|
-
* @param {
|
|
620
|
-
* @param {
|
|
621
|
-
* @param {object} params.params.event Event object
|
|
622
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
623
|
+
* @param {object} params.event Event object
|
|
624
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
623
625
|
*/
|
|
624
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
626
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
625
627
|
/**
|
|
626
628
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
627
629
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
628
630
|
* @param {string} e Event name
|
|
629
631
|
* @param {object} params Event parameters
|
|
630
|
-
* @param {
|
|
631
|
-
* @param {
|
|
632
|
-
* @param {
|
|
633
|
-
* @param {Core.widget.Container} params.params.event.source The container
|
|
634
|
-
* @param {Core.data.Model} params.params.event.record The record
|
|
632
|
+
* @param {object} params.event Event object
|
|
633
|
+
* @param {Core.widget.Container} params.event.source The container
|
|
634
|
+
* @param {Core.data.Model} params.event.record The record
|
|
635
635
|
*/
|
|
636
636
|
(e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
|
|
637
637
|
/**
|
|
638
638
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
639
639
|
* @param {string} e Event name
|
|
640
640
|
* @param {object} params Event parameters
|
|
641
|
-
* @param {
|
|
642
|
-
* @param {
|
|
643
|
-
* @param {object} params.params.event Event object
|
|
644
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
641
|
+
* @param {object} params.event Event object
|
|
642
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
645
643
|
*/
|
|
646
644
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
647
645
|
/**
|
|
@@ -649,69 +647,57 @@ const emit = defineEmits<{
|
|
|
649
647
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#event-catchAll)
|
|
650
648
|
* @param {string} e Event name
|
|
651
649
|
* @param {object} params Event parameters
|
|
652
|
-
* @param {
|
|
653
|
-
* @param {
|
|
654
|
-
* @param {
|
|
655
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
656
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
650
|
+
* @param {object} params.event Event object
|
|
651
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
652
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
657
653
|
*/
|
|
658
654
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
659
655
|
/**
|
|
660
656
|
* Fires when the filter is modified.
|
|
661
657
|
* @param {string} e Event name
|
|
662
658
|
* @param {object} params Event parameters
|
|
663
|
-
* @param {
|
|
664
|
-
* @param {
|
|
665
|
-
* @param {
|
|
666
|
-
* @param {
|
|
667
|
-
* @param {any[]} params.params.event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
668
|
-
* @param {boolean} params.params.event.isValid Whether the current configuration object represents a complete and valid filter
|
|
659
|
+
* @param {object} params.event Event object
|
|
660
|
+
* @param {Core.widget.FieldFilterPicker} params.event.source The FieldFilterPicker instance that fired the event.
|
|
661
|
+
* @param {any[]} params.event.filter The [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration object for the filter represented by this [FieldFilterPicker](https://bryntum.com/products/grid/docs/api/Core/widget/FieldFilterPicker).
|
|
662
|
+
* @param {boolean} params.event.isValid Whether the current configuration object represents a complete and valid filter
|
|
669
663
|
*/
|
|
670
664
|
(e: 'change', params: ((event: { source: FieldFilterPicker, filter: any[], isValid: boolean }) => void)|string): void
|
|
671
665
|
/**
|
|
672
666
|
* Fires when an object is destroyed.
|
|
673
667
|
* @param {string} e Event name
|
|
674
668
|
* @param {object} params Event parameters
|
|
675
|
-
* @param {
|
|
676
|
-
* @param {
|
|
677
|
-
* @param {object} params.params.event Event object
|
|
678
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
669
|
+
* @param {object} params.event Event object
|
|
670
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
679
671
|
*/
|
|
680
672
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
681
673
|
/**
|
|
682
674
|
* Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/grid/docs/api/Core/widget/Container#property-hasChanges) property changes
|
|
683
675
|
* @param {string} e Event name
|
|
684
676
|
* @param {object} params Event parameters
|
|
685
|
-
* @param {
|
|
686
|
-
* @param {
|
|
687
|
-
* @param {
|
|
688
|
-
* @param {Core.widget.Container} params.params.event.source The container.
|
|
689
|
-
* @param {boolean} params.params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
677
|
+
* @param {object} params.event Event object
|
|
678
|
+
* @param {Core.widget.Container} params.event.source The container.
|
|
679
|
+
* @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
690
680
|
*/
|
|
691
681
|
(e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
|
|
692
682
|
/**
|
|
693
683
|
* Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
|
|
694
684
|
* @param {string} e Event name
|
|
695
685
|
* @param {object} params Event parameters
|
|
696
|
-
* @param {
|
|
697
|
-
* @param {
|
|
698
|
-
* @param {object} params.params.event Event object
|
|
699
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
686
|
+
* @param {object} params.event Event object
|
|
687
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
700
688
|
*/
|
|
701
689
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
702
690
|
/**
|
|
703
691
|
* Fired when focus enters this Widget.
|
|
704
692
|
* @param {string} e Event name
|
|
705
693
|
* @param {object} params Event parameters
|
|
706
|
-
* @param {
|
|
707
|
-
* @param {
|
|
708
|
-
* @param {
|
|
709
|
-
* @param {
|
|
710
|
-
* @param {
|
|
711
|
-
* @param {
|
|
712
|
-
* @param {
|
|
713
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
714
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
694
|
+
* @param {object} params.event Event object
|
|
695
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
696
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
697
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
698
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
699
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
700
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
715
701
|
*/
|
|
716
702
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
717
703
|
/**
|
|
@@ -720,25 +706,21 @@ const emit = defineEmits<{
|
|
|
720
706
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
721
707
|
* @param {string} e Event name
|
|
722
708
|
* @param {object} params Event parameters
|
|
723
|
-
* @param {
|
|
724
|
-
* @param {
|
|
725
|
-
* @param {
|
|
726
|
-
* @param {
|
|
727
|
-
* @param {
|
|
728
|
-
* @param {
|
|
729
|
-
* @param {
|
|
730
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
731
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
709
|
+
* @param {object} params.event Event object
|
|
710
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
711
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
712
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
713
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
714
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
715
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
732
716
|
*/
|
|
733
717
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
734
718
|
/**
|
|
735
719
|
* Triggered after a widget was hidden
|
|
736
720
|
* @param {string} e Event name
|
|
737
721
|
* @param {object} params Event parameters
|
|
738
|
-
* @param {
|
|
739
|
-
* @param {
|
|
740
|
-
* @param {object} params.params.event Event object
|
|
741
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
722
|
+
* @param {object} params.event Event object
|
|
723
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
742
724
|
*/
|
|
743
725
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
744
726
|
/**
|
|
@@ -747,21 +729,17 @@ const emit = defineEmits<{
|
|
|
747
729
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#event-paint)
|
|
748
730
|
* @param {string} e Event name
|
|
749
731
|
* @param {object} params Event parameters
|
|
750
|
-
* @param {
|
|
751
|
-
* @param {
|
|
752
|
-
* @param {
|
|
753
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
754
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
732
|
+
* @param {object} params.event Event object
|
|
733
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
734
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
755
735
|
*/
|
|
756
736
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
757
737
|
/**
|
|
758
738
|
* Fired when a Widget's read only state is toggled
|
|
759
739
|
* @param {string} e Event name
|
|
760
740
|
* @param {object} params Event parameters
|
|
761
|
-
* @param {
|
|
762
|
-
* @param {
|
|
763
|
-
* @param {object} params.params.event Event object
|
|
764
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
741
|
+
* @param {object} params.event Event object
|
|
742
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
765
743
|
*/
|
|
766
744
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
767
745
|
/**
|
|
@@ -773,24 +751,20 @@ const emit = defineEmits<{
|
|
|
773
751
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
774
752
|
* @param {string} e Event name
|
|
775
753
|
* @param {object} params Event parameters
|
|
776
|
-
* @param {
|
|
777
|
-
* @param {
|
|
778
|
-
* @param {
|
|
779
|
-
* @param {
|
|
780
|
-
* @param {number} params.
|
|
781
|
-
* @param {number} params.
|
|
782
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
783
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
754
|
+
* @param {object} params.event Event object
|
|
755
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
756
|
+
* @param {number} params.event.width The new width
|
|
757
|
+
* @param {number} params.event.height The new height
|
|
758
|
+
* @param {number} params.event.oldWidth The old width
|
|
759
|
+
* @param {number} params.event.oldHeight The old height
|
|
784
760
|
*/
|
|
785
761
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
786
762
|
/**
|
|
787
763
|
* Triggered after a widget is shown.
|
|
788
764
|
* @param {string} e Event name
|
|
789
765
|
* @param {object} params Event parameters
|
|
790
|
-
* @param {
|
|
791
|
-
* @param {
|
|
792
|
-
* @param {object} params.params.event Event object
|
|
793
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
766
|
+
* @param {object} params.event Event object
|
|
767
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
794
768
|
*/
|
|
795
769
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
796
770
|
}>();
|