@bryntum/grid-vue-3-thin 7.3.0 → 7.3.1
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 +80 -106
- package/src/components/BryntumAIFilterFieldProps.ts +9 -0
- package/src/components/BryntumChecklistFilterCombo.vue +81 -109
- package/src/components/BryntumChecklistFilterComboProps.ts +9 -0
- package/src/components/BryntumGrid.vue +523 -755
- package/src/components/BryntumGridBase.vue +523 -755
- package/src/components/BryntumGridChartDesigner.vue +43 -69
- package/src/components/BryntumGridFieldFilterPicker.vue +53 -85
- package/src/components/BryntumGridFieldFilterPickerGroup.vue +57 -91
- package/src/components/BryntumGroupBar.vue +65 -101
- package/src/components/BryntumTreeCombo.vue +81 -109
- package/src/components/BryntumTreeComboProps.ts +9 -0
- package/src/components/BryntumTreeGrid.vue +523 -755
- package/lib/chunks/BGeNcVH6.js.map +0 -1
- package/lib/chunks/Ba35uKyP.js.map +0 -1
- package/lib/chunks/BeyOFZne.js.map +0 -1
|
@@ -613,53 +613,43 @@ const emit = defineEmits<{
|
|
|
613
613
|
* Return `false` from the event handler to prevent the filter being added.
|
|
614
614
|
* @param {string} e Event name
|
|
615
615
|
* @param {object} params Event parameters
|
|
616
|
-
* @param {
|
|
617
|
-
* @param {
|
|
618
|
-
* @param {
|
|
619
|
-
* @param {Core.widget.FieldFilterPicker} params.params.event.source The FieldFilterPicker instance that fired the event.
|
|
620
|
-
* @param {CollectionFilterConfig} 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).
|
|
616
|
+
* @param {object} params.event Event object
|
|
617
|
+
* @param {Core.widget.FieldFilterPicker} params.event.source The FieldFilterPicker instance that fired the event.
|
|
618
|
+
* @param {CollectionFilterConfig} 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).
|
|
621
619
|
*/
|
|
622
|
-
(e: 'beforeAddFilter', params: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
620
|
+
(e: 'beforeAddFilter', params: ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string): boolean|void
|
|
623
621
|
/**
|
|
624
622
|
* Fires before an object is destroyed.
|
|
625
623
|
* @param {string} e Event name
|
|
626
624
|
* @param {object} params Event parameters
|
|
627
|
-
* @param {
|
|
628
|
-
* @param {
|
|
629
|
-
* @param {object} params.params.event Event object
|
|
630
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
625
|
+
* @param {object} params.event Event object
|
|
626
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
631
627
|
*/
|
|
632
628
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
633
629
|
/**
|
|
634
630
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
635
631
|
* @param {string} e Event name
|
|
636
632
|
* @param {object} params Event parameters
|
|
637
|
-
* @param {
|
|
638
|
-
* @param {
|
|
639
|
-
* @param {object} params.params.event Event object
|
|
640
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
633
|
+
* @param {object} params.event Event object
|
|
634
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
641
635
|
*/
|
|
642
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
636
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
643
637
|
/**
|
|
644
638
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
645
639
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
646
640
|
* @param {string} e Event name
|
|
647
641
|
* @param {object} params Event parameters
|
|
648
|
-
* @param {
|
|
649
|
-
* @param {
|
|
650
|
-
* @param {
|
|
651
|
-
* @param {Core.widget.Container} params.params.event.source The container
|
|
652
|
-
* @param {Core.data.Model} params.params.event.record The record
|
|
642
|
+
* @param {object} params.event Event object
|
|
643
|
+
* @param {Core.widget.Container} params.event.source The container
|
|
644
|
+
* @param {Core.data.Model} params.event.record The record
|
|
653
645
|
*/
|
|
654
646
|
(e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
|
|
655
647
|
/**
|
|
656
648
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
657
649
|
* @param {string} e Event name
|
|
658
650
|
* @param {object} params Event parameters
|
|
659
|
-
* @param {
|
|
660
|
-
* @param {
|
|
661
|
-
* @param {object} params.params.event Event object
|
|
662
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
651
|
+
* @param {object} params.event Event object
|
|
652
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
663
653
|
*/
|
|
664
654
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
665
655
|
/**
|
|
@@ -667,69 +657,57 @@ const emit = defineEmits<{
|
|
|
667
657
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#event-catchAll)
|
|
668
658
|
* @param {string} e Event name
|
|
669
659
|
* @param {object} params Event parameters
|
|
670
|
-
* @param {
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {
|
|
673
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
674
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
660
|
+
* @param {object} params.event Event object
|
|
661
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
662
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
675
663
|
*/
|
|
676
664
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
677
665
|
/**
|
|
678
666
|
* Fires when any filter in the group is added, removed, or modified.
|
|
679
667
|
* @param {string} e Event name
|
|
680
668
|
* @param {object} params Event parameters
|
|
681
|
-
* @param {
|
|
682
|
-
* @param {
|
|
683
|
-
* @param {
|
|
684
|
-
* @param {
|
|
685
|
-
* @param {CollectionFilterConfig[]} params.params.event.filters The array of [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration objects currently represented by the FieldFilterPickerGroup. <strong>IMPORTANT:</strong> Note that this includes all filters currently present in the UI, including partially completed ones that may not be ready to apply to a Store. To retrieve only valid filters, use the `validFilters` parameter on this event, or filter out incomplete filters in your own code.
|
|
686
|
-
* @param {CollectionFilterConfig[]} params.params.event.validFilters The subset of [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration objects in the `filters` parameter on this event that are complete and valid for application to a Store.
|
|
669
|
+
* @param {object} params.event Event object
|
|
670
|
+
* @param {Core.widget.FieldFilterPickerGroup} params.event.source The FieldFilterPickerGroup instance that fired the event.
|
|
671
|
+
* @param {CollectionFilterConfig[]} params.event.filters The array of [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration objects currently represented by the FieldFilterPickerGroup. <strong>IMPORTANT:</strong> Note that this includes all filters currently present in the UI, including partially completed ones that may not be ready to apply to a Store. To retrieve only valid filters, use the `validFilters` parameter on this event, or filter out incomplete filters in your own code.
|
|
672
|
+
* @param {CollectionFilterConfig[]} params.event.validFilters The subset of [CollectionFilter](https://bryntum.com/products/grid/docs/api/Core/util/CollectionFilter) configuration objects in the `filters` parameter on this event that are complete and valid for application to a Store.
|
|
687
673
|
*/
|
|
688
674
|
(e: 'change', params: ((event: { source: FieldFilterPickerGroup, filters: CollectionFilterConfig[], validFilters: CollectionFilterConfig[] }) => void)|string): void
|
|
689
675
|
/**
|
|
690
676
|
* Fires when an object is destroyed.
|
|
691
677
|
* @param {string} e Event name
|
|
692
678
|
* @param {object} params Event parameters
|
|
693
|
-
* @param {
|
|
694
|
-
* @param {
|
|
695
|
-
* @param {object} params.params.event Event object
|
|
696
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
679
|
+
* @param {object} params.event Event object
|
|
680
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
697
681
|
*/
|
|
698
682
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
699
683
|
/**
|
|
700
684
|
* 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
|
|
701
685
|
* @param {string} e Event name
|
|
702
686
|
* @param {object} params Event parameters
|
|
703
|
-
* @param {
|
|
704
|
-
* @param {
|
|
705
|
-
* @param {
|
|
706
|
-
* @param {Core.widget.Container} params.params.event.source The container.
|
|
707
|
-
* @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.
|
|
687
|
+
* @param {object} params.event Event object
|
|
688
|
+
* @param {Core.widget.Container} params.event.source The container.
|
|
689
|
+
* @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
|
|
708
690
|
*/
|
|
709
691
|
(e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
|
|
710
692
|
/**
|
|
711
693
|
* Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
|
|
712
694
|
* @param {string} e Event name
|
|
713
695
|
* @param {object} params Event parameters
|
|
714
|
-
* @param {
|
|
715
|
-
* @param {
|
|
716
|
-
* @param {object} params.params.event Event object
|
|
717
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
696
|
+
* @param {object} params.event Event object
|
|
697
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
718
698
|
*/
|
|
719
699
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
720
700
|
/**
|
|
721
701
|
* Fired when focus enters this Widget.
|
|
722
702
|
* @param {string} e Event name
|
|
723
703
|
* @param {object} params Event parameters
|
|
724
|
-
* @param {
|
|
725
|
-
* @param {
|
|
726
|
-
* @param {
|
|
727
|
-
* @param {
|
|
728
|
-
* @param {
|
|
729
|
-
* @param {
|
|
730
|
-
* @param {
|
|
731
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
732
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
704
|
+
* @param {object} params.event Event object
|
|
705
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
706
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
707
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
708
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
709
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
710
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
733
711
|
*/
|
|
734
712
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
735
713
|
/**
|
|
@@ -738,25 +716,21 @@ const emit = defineEmits<{
|
|
|
738
716
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
739
717
|
* @param {string} e Event name
|
|
740
718
|
* @param {object} params Event parameters
|
|
741
|
-
* @param {
|
|
742
|
-
* @param {
|
|
743
|
-
* @param {
|
|
744
|
-
* @param {
|
|
745
|
-
* @param {
|
|
746
|
-
* @param {
|
|
747
|
-
* @param {
|
|
748
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
749
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
719
|
+
* @param {object} params.event Event object
|
|
720
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
721
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
722
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
723
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
724
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
725
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
750
726
|
*/
|
|
751
727
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
752
728
|
/**
|
|
753
729
|
* Triggered after a widget was hidden
|
|
754
730
|
* @param {string} e Event name
|
|
755
731
|
* @param {object} params Event parameters
|
|
756
|
-
* @param {
|
|
757
|
-
* @param {
|
|
758
|
-
* @param {object} params.params.event Event object
|
|
759
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
732
|
+
* @param {object} params.event Event object
|
|
733
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
760
734
|
*/
|
|
761
735
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
762
736
|
/**
|
|
@@ -765,21 +739,17 @@ const emit = defineEmits<{
|
|
|
765
739
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#event-paint)
|
|
766
740
|
* @param {string} e Event name
|
|
767
741
|
* @param {object} params Event parameters
|
|
768
|
-
* @param {
|
|
769
|
-
* @param {
|
|
770
|
-
* @param {
|
|
771
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
772
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
742
|
+
* @param {object} params.event Event object
|
|
743
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
744
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
773
745
|
*/
|
|
774
746
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
775
747
|
/**
|
|
776
748
|
* Fired when a Widget's read only state is toggled
|
|
777
749
|
* @param {string} e Event name
|
|
778
750
|
* @param {object} params Event parameters
|
|
779
|
-
* @param {
|
|
780
|
-
* @param {
|
|
781
|
-
* @param {object} params.params.event Event object
|
|
782
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
751
|
+
* @param {object} params.event Event object
|
|
752
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
783
753
|
*/
|
|
784
754
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
785
755
|
/**
|
|
@@ -791,24 +761,20 @@ const emit = defineEmits<{
|
|
|
791
761
|
* 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`*.
|
|
792
762
|
* @param {string} e Event name
|
|
793
763
|
* @param {object} params Event parameters
|
|
794
|
-
* @param {
|
|
795
|
-
* @param {
|
|
796
|
-
* @param {
|
|
797
|
-
* @param {
|
|
798
|
-
* @param {number} params.
|
|
799
|
-
* @param {number} params.
|
|
800
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
801
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
764
|
+
* @param {object} params.event Event object
|
|
765
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
766
|
+
* @param {number} params.event.width The new width
|
|
767
|
+
* @param {number} params.event.height The new height
|
|
768
|
+
* @param {number} params.event.oldWidth The old width
|
|
769
|
+
* @param {number} params.event.oldHeight The old height
|
|
802
770
|
*/
|
|
803
771
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
804
772
|
/**
|
|
805
773
|
* Triggered after a widget is shown.
|
|
806
774
|
* @param {string} e Event name
|
|
807
775
|
* @param {object} params Event parameters
|
|
808
|
-
* @param {
|
|
809
|
-
* @param {
|
|
810
|
-
* @param {object} params.params.event Event object
|
|
811
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
776
|
+
* @param {object} params.event Event object
|
|
777
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
812
778
|
*/
|
|
813
779
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
814
780
|
}>();
|
|
@@ -557,46 +557,38 @@ const emit = defineEmits<{
|
|
|
557
557
|
* Fires before an object is destroyed.
|
|
558
558
|
* @param {string} e Event name
|
|
559
559
|
* @param {object} params Event parameters
|
|
560
|
-
* @param {
|
|
561
|
-
* @param {
|
|
562
|
-
* @param {object} params.params.event Event object
|
|
563
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
560
|
+
* @param {object} params.event Event object
|
|
561
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
564
562
|
*/
|
|
565
563
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
566
564
|
/**
|
|
567
565
|
* Triggered before a widget is hidden. Return `false` to prevent the action.
|
|
568
566
|
* @param {string} e Event name
|
|
569
567
|
* @param {object} params Event parameters
|
|
570
|
-
* @param {
|
|
571
|
-
* @param {
|
|
572
|
-
* @param {object} params.params.event Event object
|
|
573
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being hidden.
|
|
568
|
+
* @param {object} params.event Event object
|
|
569
|
+
* @param {Core.widget.Widget} params.event.source The widget being hidden.
|
|
574
570
|
*/
|
|
575
|
-
(e: 'beforeHide', params: ((event: { source: Widget }) =>
|
|
571
|
+
(e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
|
|
576
572
|
/**
|
|
577
573
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
578
574
|
* The active record, list item index, and the triggering event are passed.
|
|
579
575
|
* It is preventable by returning `false`
|
|
580
576
|
* @param {string} e Event name
|
|
581
577
|
* @param {object} params Event parameters
|
|
582
|
-
* @param {
|
|
583
|
-
* @param {
|
|
584
|
-
* @param {
|
|
585
|
-
* @param {Core.
|
|
586
|
-
* @param {
|
|
587
|
-
* @param {
|
|
588
|
-
* @param {number} params.params.event.index List item index
|
|
589
|
-
* @param {Event} params.params.event.event Triggering event
|
|
578
|
+
* @param {object} params.event Event object
|
|
579
|
+
* @param {Core.widget.List} params.event.source The List instance
|
|
580
|
+
* @param {HTMLElement} params.event.item The clicked list element
|
|
581
|
+
* @param {Core.data.Model} params.event.record Activated record
|
|
582
|
+
* @param {number} params.event.index List item index
|
|
583
|
+
* @param {Event} params.event.event Triggering event
|
|
590
584
|
*/
|
|
591
|
-
(e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
585
|
+
(e: 'beforeItem', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string): boolean|void
|
|
592
586
|
/**
|
|
593
587
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
594
588
|
* @param {string} e Event name
|
|
595
589
|
* @param {object} params Event parameters
|
|
596
|
-
* @param {
|
|
597
|
-
* @param {
|
|
598
|
-
* @param {object} params.params.event Event object
|
|
599
|
-
* @param {Core.widget.Widget,any} params.params.event.source The widget being shown
|
|
590
|
+
* @param {object} params.event Event object
|
|
591
|
+
* @param {Core.widget.Widget,any} params.event.source The widget being shown
|
|
600
592
|
*/
|
|
601
593
|
(e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
602
594
|
/**
|
|
@@ -604,46 +596,38 @@ const emit = defineEmits<{
|
|
|
604
596
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-catchAll)
|
|
605
597
|
* @param {string} e Event name
|
|
606
598
|
* @param {object} params Event parameters
|
|
607
|
-
* @param {
|
|
608
|
-
* @param {
|
|
609
|
-
* @param {
|
|
610
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
611
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
599
|
+
* @param {object} params.event Event object
|
|
600
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
601
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
612
602
|
*/
|
|
613
603
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
614
604
|
/**
|
|
615
605
|
* Fires when an object is destroyed.
|
|
616
606
|
* @param {string} e Event name
|
|
617
607
|
* @param {object} params Event parameters
|
|
618
|
-
* @param {
|
|
619
|
-
* @param {
|
|
620
|
-
* @param {object} params.params.event Event object
|
|
621
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
608
|
+
* @param {object} params.event Event object
|
|
609
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
622
610
|
*/
|
|
623
611
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
624
612
|
/**
|
|
625
613
|
* Triggered when a widget's [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element) is available.
|
|
626
614
|
* @param {string} e Event name
|
|
627
615
|
* @param {object} params Event parameters
|
|
628
|
-
* @param {
|
|
629
|
-
* @param {
|
|
630
|
-
* @param {object} params.params.event Event object
|
|
631
|
-
* @param {HTMLElement} params.params.event.element The Widget's element.
|
|
616
|
+
* @param {object} params.event Event object
|
|
617
|
+
* @param {HTMLElement} params.event.element The Widget's element.
|
|
632
618
|
*/
|
|
633
619
|
(e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
|
|
634
620
|
/**
|
|
635
621
|
* Fired when focus enters this Widget.
|
|
636
622
|
* @param {string} e Event name
|
|
637
623
|
* @param {object} params Event parameters
|
|
638
|
-
* @param {
|
|
639
|
-
* @param {
|
|
640
|
-
* @param {
|
|
641
|
-
* @param {
|
|
642
|
-
* @param {
|
|
643
|
-
* @param {
|
|
644
|
-
* @param {
|
|
645
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
646
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
624
|
+
* @param {object} params.event Event object
|
|
625
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
626
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
627
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
628
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
629
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
630
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
647
631
|
*/
|
|
648
632
|
(e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
649
633
|
/**
|
|
@@ -652,25 +636,21 @@ const emit = defineEmits<{
|
|
|
652
636
|
* will not trigger this event. This is when focus exits this widget completely.
|
|
653
637
|
* @param {string} e Event name
|
|
654
638
|
* @param {object} params Event parameters
|
|
655
|
-
* @param {
|
|
656
|
-
* @param {
|
|
657
|
-
* @param {
|
|
658
|
-
* @param {
|
|
659
|
-
* @param {
|
|
660
|
-
* @param {
|
|
661
|
-
* @param {
|
|
662
|
-
* @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
|
|
663
|
-
* @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
639
|
+
* @param {object} params.event Event object
|
|
640
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
641
|
+
* @param {HTMLElement} params.event.fromElement The element which lost focus.
|
|
642
|
+
* @param {HTMLElement} params.event.toElement The element which gained focus.
|
|
643
|
+
* @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
|
|
644
|
+
* @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
|
|
645
|
+
* @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
|
|
664
646
|
*/
|
|
665
647
|
(e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
|
|
666
648
|
/**
|
|
667
649
|
* Triggered after a widget was hidden
|
|
668
650
|
* @param {string} e Event name
|
|
669
651
|
* @param {object} params Event parameters
|
|
670
|
-
* @param {
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {object} params.params.event Event object
|
|
673
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
652
|
+
* @param {object} params.event Event object
|
|
653
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
674
654
|
*/
|
|
675
655
|
(e: 'hide', params: ((event: { source: Widget }) => void)|string): void
|
|
676
656
|
/**
|
|
@@ -678,14 +658,12 @@ const emit = defineEmits<{
|
|
|
678
658
|
* The active record, list item index, and the triggering event are passed.
|
|
679
659
|
* @param {string} e Event name
|
|
680
660
|
* @param {object} params Event parameters
|
|
681
|
-
* @param {
|
|
682
|
-
* @param {
|
|
683
|
-
* @param {
|
|
684
|
-
* @param {Core.
|
|
685
|
-
* @param {
|
|
686
|
-
* @param {
|
|
687
|
-
* @param {number} params.params.event.index List item index
|
|
688
|
-
* @param {Event} params.params.event.event Triggering event
|
|
661
|
+
* @param {object} params.event Event object
|
|
662
|
+
* @param {Core.widget.List} params.event.source The List instance
|
|
663
|
+
* @param {HTMLElement} params.event.item The clicked list element
|
|
664
|
+
* @param {Core.data.Model} params.event.record Activated record
|
|
665
|
+
* @param {number} params.event.index List item index
|
|
666
|
+
* @param {Event} params.event.event Triggering event
|
|
689
667
|
*/
|
|
690
668
|
(e: 'item', params: ((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => void)|string): void
|
|
691
669
|
/**
|
|
@@ -694,21 +672,17 @@ const emit = defineEmits<{
|
|
|
694
672
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#event-paint)
|
|
695
673
|
* @param {string} e Event name
|
|
696
674
|
* @param {object} params Event parameters
|
|
697
|
-
* @param {
|
|
698
|
-
* @param {
|
|
699
|
-
* @param {
|
|
700
|
-
* @param {Core.widget.Widget} params.params.event.source The widget being painted.
|
|
701
|
-
* @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
|
|
675
|
+
* @param {object} params.event Event object
|
|
676
|
+
* @param {Core.widget.Widget} params.event.source The widget being painted.
|
|
677
|
+
* @param {boolean} params.event.firstPaint `true` if this is the first paint.
|
|
702
678
|
*/
|
|
703
679
|
(e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
|
|
704
680
|
/**
|
|
705
681
|
* Fired when a Widget's read only state is toggled
|
|
706
682
|
* @param {string} e Event name
|
|
707
683
|
* @param {object} params Event parameters
|
|
708
|
-
* @param {
|
|
709
|
-
* @param {
|
|
710
|
-
* @param {object} params.params.event Event object
|
|
711
|
-
* @param {boolean} params.params.event.readOnly Read only or not
|
|
684
|
+
* @param {object} params.event Event object
|
|
685
|
+
* @param {boolean} params.event.readOnly Read only or not
|
|
712
686
|
*/
|
|
713
687
|
(e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
|
|
714
688
|
/**
|
|
@@ -720,57 +694,47 @@ const emit = defineEmits<{
|
|
|
720
694
|
* 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`*.
|
|
721
695
|
* @param {string} e Event name
|
|
722
696
|
* @param {object} params Event parameters
|
|
723
|
-
* @param {
|
|
724
|
-
* @param {
|
|
725
|
-
* @param {
|
|
726
|
-
* @param {
|
|
727
|
-
* @param {number} params.
|
|
728
|
-
* @param {number} params.
|
|
729
|
-
* @param {number} params.params.event.oldWidth The old width
|
|
730
|
-
* @param {number} params.params.event.oldHeight The old height
|
|
697
|
+
* @param {object} params.event Event object
|
|
698
|
+
* @param {Core.widget.Widget} params.event.source This Widget
|
|
699
|
+
* @param {number} params.event.width The new width
|
|
700
|
+
* @param {number} params.event.height The new height
|
|
701
|
+
* @param {number} params.event.oldWidth The old width
|
|
702
|
+
* @param {number} params.event.oldHeight The old height
|
|
731
703
|
*/
|
|
732
704
|
(e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
|
|
733
705
|
/**
|
|
734
706
|
* Fired when selection changes
|
|
735
707
|
* @param {string} e Event name
|
|
736
708
|
* @param {object} params Event parameters
|
|
737
|
-
* @param {
|
|
738
|
-
* @param {
|
|
739
|
-
* @param {
|
|
740
|
-
* @param {Core.widget.List} params.params.event.source The List instance
|
|
741
|
-
* @param {Core.data.Model[]} params.params.event.selected An array of the currently selected records
|
|
709
|
+
* @param {object} params.event Event object
|
|
710
|
+
* @param {Core.widget.List} params.event.source The List instance
|
|
711
|
+
* @param {Core.data.Model[]} params.event.selected An array of the currently selected records
|
|
742
712
|
*/
|
|
743
713
|
(e: 'selectionChange', params: ((event: { source: List, selected: Model[] }) => void)|string): void
|
|
744
714
|
/**
|
|
745
715
|
* Triggered after a widget is shown.
|
|
746
716
|
* @param {string} e Event name
|
|
747
717
|
* @param {object} params Event parameters
|
|
748
|
-
* @param {
|
|
749
|
-
* @param {
|
|
750
|
-
* @param {object} params.params.event Event object
|
|
751
|
-
* @param {Core.widget.Widget} params.params.event.source The widget
|
|
718
|
+
* @param {object} params.event Event object
|
|
719
|
+
* @param {Core.widget.Widget} params.event.source The widget
|
|
752
720
|
*/
|
|
753
721
|
(e: 'show', params: ((event: { source: Widget }) => void)|string): void
|
|
754
722
|
/**
|
|
755
723
|
* Group item expanded or collapsed
|
|
756
724
|
* @param {string} e Event name
|
|
757
725
|
* @param {object} params Event parameters
|
|
758
|
-
* @param {
|
|
759
|
-
* @param {
|
|
760
|
-
* @param {
|
|
761
|
-
* @param {Core.data.Model} params.params.event.groupRecord Group record
|
|
762
|
-
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
726
|
+
* @param {object} params.event Event object
|
|
727
|
+
* @param {Core.data.Model} params.event.groupRecord Group record
|
|
728
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
763
729
|
*/
|
|
764
730
|
(e: 'toggleGroup', params: ((event: { groupRecord: Model, collapse: boolean }) => void)|string): void
|
|
765
731
|
/**
|
|
766
732
|
* Tree parent node expanded or collapsed
|
|
767
733
|
* @param {string} e Event name
|
|
768
734
|
* @param {object} params Event parameters
|
|
769
|
-
* @param {
|
|
770
|
-
* @param {
|
|
771
|
-
* @param {
|
|
772
|
-
* @param {Core.data.Model} params.params.event.record The parent record which has been toggled
|
|
773
|
-
* @param {boolean} params.params.event.collapse Collapsed (true) or expanded (false)
|
|
735
|
+
* @param {object} params.event Event object
|
|
736
|
+
* @param {Core.data.Model} params.event.record The parent record which has been toggled
|
|
737
|
+
* @param {boolean} params.event.collapse Collapsed (true) or expanded (false)
|
|
774
738
|
*/
|
|
775
739
|
(e: 'toggleNode', params: ((event: { record: Model, collapse: boolean }) => void)|string): void
|
|
776
740
|
}>();
|