@bryntum/grid-react-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 +5 -5
- package/lib/BryntumAIFilterField.d.ts +2 -1
- package/lib/BryntumAIFilterField.js +1 -0
- package/lib/BryntumAIFilterField.js.map +1 -1
- package/lib/BryntumChecklistFilterCombo.d.ts +2 -1
- package/lib/BryntumChecklistFilterCombo.js +1 -0
- package/lib/BryntumChecklistFilterCombo.js.map +1 -1
- package/lib/BryntumGrid.d.ts +25 -25
- package/lib/BryntumGrid.js.map +1 -1
- package/lib/BryntumGridBase.d.ts +25 -25
- package/lib/BryntumGridBase.js.map +1 -1
- package/lib/BryntumGridChartDesigner.d.ts +1 -1
- package/lib/BryntumGridChartDesigner.js.map +1 -1
- package/lib/BryntumGridFieldFilterPicker.d.ts +1 -1
- package/lib/BryntumGridFieldFilterPicker.js.map +1 -1
- package/lib/BryntumGridFieldFilterPickerGroup.d.ts +2 -2
- package/lib/BryntumGridFieldFilterPickerGroup.js.map +1 -1
- package/lib/BryntumGroupBar.d.ts +3 -3
- package/lib/BryntumGroupBar.js.map +1 -1
- package/lib/BryntumTreeCombo.d.ts +2 -1
- package/lib/BryntumTreeCombo.js +1 -0
- package/lib/BryntumTreeCombo.js.map +1 -1
- package/lib/BryntumTreeGrid.d.ts +25 -25
- package/lib/BryntumTreeGrid.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumAIFilterField.tsx +17 -1
- package/src/BryntumChecklistFilterCombo.tsx +17 -1
- package/src/BryntumGrid.tsx +31 -25
- package/src/BryntumGridBase.tsx +31 -25
- package/src/BryntumGridChartDesigner.tsx +7 -1
- package/src/BryntumGridFieldFilterPicker.tsx +7 -1
- package/src/BryntumGridFieldFilterPickerGroup.tsx +8 -2
- package/src/BryntumGroupBar.tsx +11 -3
- package/src/BryntumTreeCombo.tsx +17 -1
- package/src/BryntumTreeGrid.tsx +31 -25
package/src/BryntumGrid.tsx
CHANGED
|
@@ -43,6 +43,8 @@ export type BryntumGridProps = {
|
|
|
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/view/Grid#config-appendTo)
|
|
46
48
|
*/
|
|
47
49
|
appendTo? : HTMLElement|string
|
|
48
50
|
/**
|
|
@@ -354,10 +356,14 @@ export type BryntumGridProps = {
|
|
|
354
356
|
inputFieldAlign? : 'start'|'end'
|
|
355
357
|
/**
|
|
356
358
|
* 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.
|
|
359
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
360
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertBefore)
|
|
357
361
|
*/
|
|
358
362
|
insertBefore? : HTMLElement|string
|
|
359
363
|
/**
|
|
360
364
|
* 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.
|
|
365
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
366
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#config-insertFirst)
|
|
361
367
|
*/
|
|
362
368
|
insertFirst? : HTMLElement|string
|
|
363
369
|
/**
|
|
@@ -710,7 +716,7 @@ export type BryntumGridProps = {
|
|
|
710
716
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
711
717
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
712
718
|
*/
|
|
713
|
-
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
719
|
+
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
714
720
|
/**
|
|
715
721
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
716
722
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-beforeCancelRowEdit)
|
|
@@ -725,7 +731,7 @@ export type BryntumGridProps = {
|
|
|
725
731
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
726
732
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
727
733
|
*/
|
|
728
|
-
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
734
|
+
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
729
735
|
/**
|
|
730
736
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
731
737
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -733,7 +739,7 @@ export type BryntumGridProps = {
|
|
|
733
739
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
734
740
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
735
741
|
*/
|
|
736
|
-
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
742
|
+
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
737
743
|
/**
|
|
738
744
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
739
745
|
* @param {object} event Event object
|
|
@@ -741,7 +747,7 @@ export type BryntumGridProps = {
|
|
|
741
747
|
* @param {string} event.field The field being changed
|
|
742
748
|
* @param {any} event.value The value being set
|
|
743
749
|
*/
|
|
744
|
-
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) =>
|
|
750
|
+
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
745
751
|
/**
|
|
746
752
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
747
753
|
* @param {object} event Event object
|
|
@@ -757,7 +763,7 @@ export type BryntumGridProps = {
|
|
|
757
763
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
758
764
|
* @param {Event} event.event The browser event.
|
|
759
765
|
*/
|
|
760
|
-
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) =>
|
|
766
|
+
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
761
767
|
/**
|
|
762
768
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
763
769
|
* @param {object} event Event object
|
|
@@ -768,7 +774,7 @@ export type BryntumGridProps = {
|
|
|
768
774
|
* @param {Event} event.event The browser event.
|
|
769
775
|
* @param {string} event.region The region where the column was dropped.
|
|
770
776
|
*/
|
|
771
|
-
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
777
|
+
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
772
778
|
/**
|
|
773
779
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
774
780
|
* `false`.
|
|
@@ -777,7 +783,7 @@ export type BryntumGridProps = {
|
|
|
777
783
|
* @param {Grid.column.Column} event.column The column
|
|
778
784
|
* @param {Event} event.domEvent The browser event
|
|
779
785
|
*/
|
|
780
|
-
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
786
|
+
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
781
787
|
/**
|
|
782
788
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
783
789
|
* @param {object} event Event object
|
|
@@ -797,7 +803,7 @@ export type BryntumGridProps = {
|
|
|
797
803
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
798
804
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
799
805
|
*/
|
|
800
|
-
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
806
|
+
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
801
807
|
/**
|
|
802
808
|
* Fires before an object is destroyed.
|
|
803
809
|
* @param {object} event Event object
|
|
@@ -811,14 +817,14 @@ export type BryntumGridProps = {
|
|
|
811
817
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
812
818
|
* @param {any[][]} event.rows An array of records to export
|
|
813
819
|
*/
|
|
814
|
-
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
820
|
+
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
815
821
|
/**
|
|
816
822
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
817
823
|
* @param {object} event Event object
|
|
818
824
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
819
825
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
820
826
|
*/
|
|
821
|
-
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
827
|
+
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
822
828
|
/**
|
|
823
829
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
824
830
|
* @param {object} event Event object
|
|
@@ -839,7 +845,7 @@ export type BryntumGridProps = {
|
|
|
839
845
|
* @param {object} event Event object
|
|
840
846
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
841
847
|
*/
|
|
842
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
848
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
843
849
|
/**
|
|
844
850
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
845
851
|
* @param {object} event Event object
|
|
@@ -855,7 +861,7 @@ export type BryntumGridProps = {
|
|
|
855
861
|
* @param {object} event Event object
|
|
856
862
|
* @param {PdfExportConfig} event.config Export config
|
|
857
863
|
*/
|
|
858
|
-
onBeforePdfExport? : ((event: { config: PdfExportConfig }) =>
|
|
864
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
859
865
|
/**
|
|
860
866
|
* Fires before a row is rendered.
|
|
861
867
|
* @param {object} event Event object
|
|
@@ -898,7 +904,7 @@ export type BryntumGridProps = {
|
|
|
898
904
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
899
905
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
900
906
|
*/
|
|
901
|
-
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
907
|
+
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
902
908
|
/**
|
|
903
909
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
904
910
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -919,19 +925,19 @@ export type BryntumGridProps = {
|
|
|
919
925
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
920
926
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
921
927
|
*/
|
|
922
|
-
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
928
|
+
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
923
929
|
/**
|
|
924
930
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
925
931
|
* @param {object} event Event object
|
|
926
932
|
* @param {GridStateInfo} event.state State object config
|
|
927
933
|
*/
|
|
928
|
-
onBeforeStateApply? : ((event: { state: GridStateInfo }) =>
|
|
934
|
+
onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
929
935
|
/**
|
|
930
936
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
931
937
|
* @param {object} event Event object
|
|
932
938
|
* @param {GridStateInfo} event.state State object config
|
|
933
939
|
*/
|
|
934
|
-
onBeforeStateSave? : ((event: { state: GridStateInfo }) =>
|
|
940
|
+
onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
935
941
|
/**
|
|
936
942
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
937
943
|
* Returning `false` from a listener prevents the operation
|
|
@@ -941,7 +947,7 @@ export type BryntumGridProps = {
|
|
|
941
947
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
942
948
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
943
949
|
*/
|
|
944
|
-
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
950
|
+
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
945
951
|
/**
|
|
946
952
|
* Fired before a parent node record toggles its collapsed state.
|
|
947
953
|
* @param {object} event Event object
|
|
@@ -1010,7 +1016,7 @@ export type BryntumGridProps = {
|
|
|
1010
1016
|
* @param {Grid.column.Column} event.column Column
|
|
1011
1017
|
* @param {Core.data.Model} event.record Record
|
|
1012
1018
|
*/
|
|
1013
|
-
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1019
|
+
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
1014
1020
|
/**
|
|
1015
1021
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1016
1022
|
* @param {object} event Event object
|
|
@@ -1137,7 +1143,7 @@ export type BryntumGridProps = {
|
|
|
1137
1143
|
* @param {Event} event.event The browser event.
|
|
1138
1144
|
* @param {string} event.region The region where the column was dropped.
|
|
1139
1145
|
*/
|
|
1140
|
-
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
1146
|
+
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
1141
1147
|
/**
|
|
1142
1148
|
* This event is fired after a resize gesture is completed.
|
|
1143
1149
|
* @param {object} event Event object
|
|
@@ -1277,7 +1283,7 @@ export type BryntumGridProps = {
|
|
|
1277
1283
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1278
1284
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1279
1285
|
*/
|
|
1280
|
-
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1286
|
+
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
1281
1287
|
/**
|
|
1282
1288
|
* Fires on the owning Grid when cell editing is finished
|
|
1283
1289
|
* @param {object} event Event object
|
|
@@ -1325,7 +1331,7 @@ export type BryntumGridProps = {
|
|
|
1325
1331
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1326
1332
|
* @param {MouseEvent,TouchEvent} event.event
|
|
1327
1333
|
*/
|
|
1328
|
-
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
1334
|
+
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
1329
1335
|
/**
|
|
1330
1336
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1331
1337
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -1392,7 +1398,7 @@ export type BryntumGridProps = {
|
|
|
1392
1398
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
1393
1399
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
1394
1400
|
*/
|
|
1395
|
-
onHeaderClick? : ((event: { domEvent: Event, column: Column }) =>
|
|
1401
|
+
onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
1396
1402
|
/**
|
|
1397
1403
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
1398
1404
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -1403,7 +1409,7 @@ export type BryntumGridProps = {
|
|
|
1403
1409
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1404
1410
|
* @param {Grid.column.Column} event.column Column
|
|
1405
1411
|
*/
|
|
1406
|
-
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
1412
|
+
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
1407
1413
|
/**
|
|
1408
1414
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
1409
1415
|
* @param {object} event Event object
|
|
@@ -1614,7 +1620,7 @@ export type BryntumGridProps = {
|
|
|
1614
1620
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1615
1621
|
* @param {Event} event.domEvent The native DOM event
|
|
1616
1622
|
*/
|
|
1617
|
-
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1623
|
+
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1618
1624
|
/**
|
|
1619
1625
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
1620
1626
|
* @param {object} event Event object
|
|
@@ -1639,7 +1645,7 @@ export type BryntumGridProps = {
|
|
|
1639
1645
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1640
1646
|
* @param {Event} event.domEvent The native DOM event
|
|
1641
1647
|
*/
|
|
1642
|
-
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1648
|
+
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1643
1649
|
/**
|
|
1644
1650
|
* Fires on the owning Grid when editing starts
|
|
1645
1651
|
* @param {object} event Event object
|
package/src/BryntumGridBase.tsx
CHANGED
|
@@ -43,6 +43,8 @@ export type BryntumGridBaseProps = {
|
|
|
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/view/GridBase#config-appendTo)
|
|
46
48
|
*/
|
|
47
49
|
appendTo? : HTMLElement|string
|
|
48
50
|
/**
|
|
@@ -354,10 +356,14 @@ export type BryntumGridBaseProps = {
|
|
|
354
356
|
inputFieldAlign? : 'start'|'end'
|
|
355
357
|
/**
|
|
356
358
|
* 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.
|
|
359
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
360
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertBefore)
|
|
357
361
|
*/
|
|
358
362
|
insertBefore? : HTMLElement|string
|
|
359
363
|
/**
|
|
360
364
|
* 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.
|
|
365
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
366
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#config-insertFirst)
|
|
361
367
|
*/
|
|
362
368
|
insertFirst? : HTMLElement|string
|
|
363
369
|
/**
|
|
@@ -709,7 +715,7 @@ export type BryntumGridBaseProps = {
|
|
|
709
715
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
710
716
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
711
717
|
*/
|
|
712
|
-
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) =>
|
|
718
|
+
onBeforeCancelCellEdit? : ((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string
|
|
713
719
|
/**
|
|
714
720
|
* Fires on the owning Grid before the row editing is canceled, return false to signal that the value is invalid and editing should not be finalized.
|
|
715
721
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-beforeCancelRowEdit)
|
|
@@ -724,7 +730,7 @@ export type BryntumGridBaseProps = {
|
|
|
724
730
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
725
731
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
726
732
|
*/
|
|
727
|
-
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
733
|
+
onBeforeCellEditStart? : ((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string
|
|
728
734
|
/**
|
|
729
735
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
730
736
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -732,7 +738,7 @@ export type BryntumGridBaseProps = {
|
|
|
732
738
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
733
739
|
* @param {(Grid.util.GridLocation|Core.data.Model)[]} event.gridSelection An array of cell selectors or records that will have their values deleted (the records themselves will not get deleted, only visible column values).
|
|
734
740
|
*/
|
|
735
|
-
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
741
|
+
onBeforeCellRangeDelete? : ((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string
|
|
736
742
|
/**
|
|
737
743
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
738
744
|
* @param {object} event Event object
|
|
@@ -740,7 +746,7 @@ export type BryntumGridBaseProps = {
|
|
|
740
746
|
* @param {string} event.field The field being changed
|
|
741
747
|
* @param {any} event.value The value being set
|
|
742
748
|
*/
|
|
743
|
-
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) =>
|
|
749
|
+
onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => boolean|void)|string
|
|
744
750
|
/**
|
|
745
751
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
746
752
|
* @param {object} event Event object
|
|
@@ -756,7 +762,7 @@ export type BryntumGridBaseProps = {
|
|
|
756
762
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
757
763
|
* @param {Event} event.event The browser event.
|
|
758
764
|
*/
|
|
759
|
-
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) =>
|
|
765
|
+
onBeforeColumnDragStart? : ((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string
|
|
760
766
|
/**
|
|
761
767
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
762
768
|
* @param {object} event Event object
|
|
@@ -767,7 +773,7 @@ export type BryntumGridBaseProps = {
|
|
|
767
773
|
* @param {Event} event.event The browser event.
|
|
768
774
|
* @param {string} event.region The region where the column was dropped.
|
|
769
775
|
*/
|
|
770
|
-
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
776
|
+
onBeforeColumnDropFinalize? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string
|
|
771
777
|
/**
|
|
772
778
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
773
779
|
* `false`.
|
|
@@ -776,7 +782,7 @@ export type BryntumGridBaseProps = {
|
|
|
776
782
|
* @param {Grid.column.Column} event.column The column
|
|
777
783
|
* @param {Event} event.domEvent The browser event
|
|
778
784
|
*/
|
|
779
|
-
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
785
|
+
onBeforeColumnResize? : ((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string
|
|
780
786
|
/**
|
|
781
787
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
782
788
|
* @param {object} event Event object
|
|
@@ -796,7 +802,7 @@ export type BryntumGridBaseProps = {
|
|
|
796
802
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
797
803
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
798
804
|
*/
|
|
799
|
-
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
805
|
+
onBeforeCSVExport? : ((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string
|
|
800
806
|
/**
|
|
801
807
|
* Fires before an object is destroyed.
|
|
802
808
|
* @param {object} event Event object
|
|
@@ -810,14 +816,14 @@ export type BryntumGridBaseProps = {
|
|
|
810
816
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
811
817
|
* @param {any[][]} event.rows An array of records to export
|
|
812
818
|
*/
|
|
813
|
-
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
819
|
+
onBeforeExcelExport? : ((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string
|
|
814
820
|
/**
|
|
815
821
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
816
822
|
* @param {object} event Event object
|
|
817
823
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
818
824
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
819
825
|
*/
|
|
820
|
-
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
826
|
+
onBeforeFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
821
827
|
/**
|
|
822
828
|
* Fires on the owning Grid before the cell editing is finished, return false to signal that the value is invalid and editing should not be finalized.
|
|
823
829
|
* @param {object} event Event object
|
|
@@ -838,7 +844,7 @@ export type BryntumGridBaseProps = {
|
|
|
838
844
|
* @param {object} event Event object
|
|
839
845
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
840
846
|
*/
|
|
841
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
847
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
842
848
|
/**
|
|
843
849
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
844
850
|
* @param {object} event Event object
|
|
@@ -854,7 +860,7 @@ export type BryntumGridBaseProps = {
|
|
|
854
860
|
* @param {object} event Event object
|
|
855
861
|
* @param {PdfExportConfig} event.config Export config
|
|
856
862
|
*/
|
|
857
|
-
onBeforePdfExport? : ((event: { config: PdfExportConfig }) =>
|
|
863
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => boolean|void)|string
|
|
858
864
|
/**
|
|
859
865
|
* Fires before a row is rendered.
|
|
860
866
|
* @param {object} event Event object
|
|
@@ -897,7 +903,7 @@ export type BryntumGridBaseProps = {
|
|
|
897
903
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
898
904
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
899
905
|
*/
|
|
900
|
-
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
906
|
+
onBeforeSelectionChange? : ((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string
|
|
901
907
|
/**
|
|
902
908
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
903
909
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -918,19 +924,19 @@ export type BryntumGridBaseProps = {
|
|
|
918
924
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
919
925
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
920
926
|
*/
|
|
921
|
-
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
927
|
+
onBeforeStartRowEdit? : ((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string
|
|
922
928
|
/**
|
|
923
929
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
924
930
|
* @param {object} event Event object
|
|
925
931
|
* @param {GridStateInfo} event.state State object config
|
|
926
932
|
*/
|
|
927
|
-
onBeforeStateApply? : ((event: { state: GridStateInfo }) =>
|
|
933
|
+
onBeforeStateApply? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
928
934
|
/**
|
|
929
935
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
930
936
|
* @param {object} event Event object
|
|
931
937
|
* @param {GridStateInfo} event.state State object config
|
|
932
938
|
*/
|
|
933
|
-
onBeforeStateSave? : ((event: { state: GridStateInfo }) =>
|
|
939
|
+
onBeforeStateSave? : ((event: { state: GridStateInfo }) => boolean|void)|string
|
|
934
940
|
/**
|
|
935
941
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
936
942
|
* Returning `false` from a listener prevents the operation
|
|
@@ -940,7 +946,7 @@ export type BryntumGridBaseProps = {
|
|
|
940
946
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
941
947
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
942
948
|
*/
|
|
943
|
-
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
949
|
+
onBeforeToggleGroup? : ((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string
|
|
944
950
|
/**
|
|
945
951
|
* Fired before a parent node record toggles its collapsed state.
|
|
946
952
|
* @param {object} event Event object
|
|
@@ -1009,7 +1015,7 @@ export type BryntumGridBaseProps = {
|
|
|
1009
1015
|
* @param {Grid.column.Column} event.column Column
|
|
1010
1016
|
* @param {Core.data.Model} event.record Record
|
|
1011
1017
|
*/
|
|
1012
|
-
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1018
|
+
onCellMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string
|
|
1013
1019
|
/**
|
|
1014
1020
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1015
1021
|
* @param {object} event Event object
|
|
@@ -1136,7 +1142,7 @@ export type BryntumGridBaseProps = {
|
|
|
1136
1142
|
* @param {Event} event.event The browser event.
|
|
1137
1143
|
* @param {string} event.region The region where the column was dropped.
|
|
1138
1144
|
*/
|
|
1139
|
-
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
1145
|
+
onColumnDrop? : ((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string
|
|
1140
1146
|
/**
|
|
1141
1147
|
* This event is fired after a resize gesture is completed.
|
|
1142
1148
|
* @param {object} event Event object
|
|
@@ -1276,7 +1282,7 @@ export type BryntumGridBaseProps = {
|
|
|
1276
1282
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1277
1283
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1278
1284
|
*/
|
|
1279
|
-
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1285
|
+
onFillHandleDragStart? : ((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string
|
|
1280
1286
|
/**
|
|
1281
1287
|
* Fires on the owning Grid when cell editing is finished
|
|
1282
1288
|
* @param {object} event Event object
|
|
@@ -1324,7 +1330,7 @@ export type BryntumGridBaseProps = {
|
|
|
1324
1330
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
1325
1331
|
* @param {MouseEvent,TouchEvent} event.event
|
|
1326
1332
|
*/
|
|
1327
|
-
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
1333
|
+
onGridRowBeforeDragStart? : ((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string
|
|
1328
1334
|
/**
|
|
1329
1335
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
1330
1336
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -1391,7 +1397,7 @@ export type BryntumGridBaseProps = {
|
|
|
1391
1397
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
1392
1398
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
1393
1399
|
*/
|
|
1394
|
-
onHeaderClick? : ((event: { domEvent: Event, column: Column }) =>
|
|
1400
|
+
onHeaderClick? : ((event: { domEvent: Event, column: Column }) => boolean|void)|string
|
|
1395
1401
|
/**
|
|
1396
1402
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
1397
1403
|
* Allows manipulation of the items to show in the same way as in the [processItems](https://bryntum.com/products/grid/docs/api/Grid/feature/HeaderMenu#config-processItems).
|
|
@@ -1402,7 +1408,7 @@ export type BryntumGridBaseProps = {
|
|
|
1402
1408
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
1403
1409
|
* @param {Grid.column.Column} event.column Column
|
|
1404
1410
|
*/
|
|
1405
|
-
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
1411
|
+
onHeaderMenuBeforeShow? : ((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string
|
|
1406
1412
|
/**
|
|
1407
1413
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
1408
1414
|
* @param {object} event Event object
|
|
@@ -1613,7 +1619,7 @@ export type BryntumGridBaseProps = {
|
|
|
1613
1619
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1614
1620
|
* @param {Event} event.domEvent The native DOM event
|
|
1615
1621
|
*/
|
|
1616
|
-
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1622
|
+
onSplitterCollapseClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1617
1623
|
/**
|
|
1618
1624
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
1619
1625
|
* @param {object} event Event object
|
|
@@ -1638,7 +1644,7 @@ export type BryntumGridBaseProps = {
|
|
|
1638
1644
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
1639
1645
|
* @param {Event} event.domEvent The native DOM event
|
|
1640
1646
|
*/
|
|
1641
|
-
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
1647
|
+
onSplitterExpandClick? : ((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string
|
|
1642
1648
|
/**
|
|
1643
1649
|
* Fires on the owning Grid when editing starts
|
|
1644
1650
|
* @param {object} event Event object
|
|
@@ -35,6 +35,8 @@ export type BryntumGridChartDesignerProps = {
|
|
|
35
35
|
/**
|
|
36
36
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
37
37
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
38
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
39
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-appendTo)
|
|
38
40
|
*/
|
|
39
41
|
appendTo? : HTMLElement|string
|
|
40
42
|
/**
|
|
@@ -212,10 +214,14 @@ export type BryntumGridChartDesignerProps = {
|
|
|
212
214
|
ignoreParentReadOnly? : boolean
|
|
213
215
|
/**
|
|
214
216
|
* 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.
|
|
217
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
218
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertBefore)
|
|
215
219
|
*/
|
|
216
220
|
insertBefore? : HTMLElement|string
|
|
217
221
|
/**
|
|
218
222
|
* 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.
|
|
223
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
224
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridChartDesigner#config-insertFirst)
|
|
219
225
|
*/
|
|
220
226
|
insertFirst? : HTMLElement|string
|
|
221
227
|
/**
|
|
@@ -441,7 +447,7 @@ export type BryntumGridChartDesignerProps = {
|
|
|
441
447
|
* @param {object} event Event object
|
|
442
448
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
443
449
|
*/
|
|
444
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
450
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
445
451
|
/**
|
|
446
452
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
447
453
|
* @param {object} event Event object
|
|
@@ -42,6 +42,8 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
42
42
|
/**
|
|
43
43
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
44
44
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
45
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
46
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-appendTo)
|
|
45
47
|
*/
|
|
46
48
|
appendTo? : HTMLElement|string
|
|
47
49
|
/**
|
|
@@ -278,10 +280,14 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
278
280
|
inputFieldAlign? : 'start'|'end'
|
|
279
281
|
/**
|
|
280
282
|
* 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.
|
|
283
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
284
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertBefore)
|
|
281
285
|
*/
|
|
282
286
|
insertBefore? : HTMLElement|string
|
|
283
287
|
/**
|
|
284
288
|
* 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.
|
|
289
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
290
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPicker#config-insertFirst)
|
|
285
291
|
*/
|
|
286
292
|
insertFirst? : HTMLElement|string
|
|
287
293
|
/**
|
|
@@ -603,7 +609,7 @@ export type BryntumGridFieldFilterPickerProps = {
|
|
|
603
609
|
* @param {object} event Event object
|
|
604
610
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
605
611
|
*/
|
|
606
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
612
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
607
613
|
/**
|
|
608
614
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
609
615
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -45,6 +45,8 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
45
45
|
/**
|
|
46
46
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
47
47
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
48
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
49
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-appendTo)
|
|
48
50
|
*/
|
|
49
51
|
appendTo? : HTMLElement|string
|
|
50
52
|
/**
|
|
@@ -293,10 +295,14 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
293
295
|
inputFieldAlign? : 'start'|'end'
|
|
294
296
|
/**
|
|
295
297
|
* 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.
|
|
298
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
299
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertBefore)
|
|
296
300
|
*/
|
|
297
301
|
insertBefore? : HTMLElement|string
|
|
298
302
|
/**
|
|
299
303
|
* 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.
|
|
304
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
305
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GridFieldFilterPickerGroup#config-insertFirst)
|
|
300
306
|
*/
|
|
301
307
|
insertFirst? : HTMLElement|string
|
|
302
308
|
/**
|
|
@@ -605,7 +611,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
605
611
|
* @param {Core.widget.FieldFilterPicker} event.source The FieldFilterPicker instance that fired the event.
|
|
606
612
|
* @param {CollectionFilterConfig} 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).
|
|
607
613
|
*/
|
|
608
|
-
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) =>
|
|
614
|
+
onBeforeAddFilter? : ((event: { source: FieldFilterPicker, filter: CollectionFilterConfig }) => boolean|void)|string
|
|
609
615
|
/**
|
|
610
616
|
* Fires before an object is destroyed.
|
|
611
617
|
* @param {object} event Event object
|
|
@@ -617,7 +623,7 @@ export type BryntumGridFieldFilterPickerGroupProps = {
|
|
|
617
623
|
* @param {object} event Event object
|
|
618
624
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
619
625
|
*/
|
|
620
|
-
onBeforeHide? : ((event: { source: Widget }) =>
|
|
626
|
+
onBeforeHide? : ((event: { source: Widget }) => boolean|void)|string
|
|
621
627
|
/**
|
|
622
628
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
623
629
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|