@bryntum/grid-angular-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/bundles/bryntum-grid-angular-thin.umd.js +15 -3
- package/bundles/bryntum-grid-angular-thin.umd.js.map +1 -1
- package/esm2015/lib/bryntum-a-i-filter-field.component.js +6 -2
- package/esm2015/lib/bryntum-checklist-filter-combo.component.js +6 -2
- package/esm2015/lib/bryntum-grid-base.component.js +1 -1
- package/esm2015/lib/bryntum-grid-chart-designer.component.js +1 -1
- package/esm2015/lib/bryntum-grid-field-filter-picker-group.component.js +1 -1
- package/esm2015/lib/bryntum-grid-field-filter-picker.component.js +1 -1
- package/esm2015/lib/bryntum-grid.component.js +1 -1
- package/esm2015/lib/bryntum-group-bar.component.js +1 -1
- package/esm2015/lib/bryntum-tree-combo.component.js +6 -2
- package/esm2015/lib/bryntum-tree-grid.component.js +1 -1
- package/fesm2015/bryntum-grid-angular-thin.js +15 -3
- package/fesm2015/bryntum-grid-angular-thin.js.map +1 -1
- package/lib/bryntum-a-i-filter-field.component.d.ts +17 -1
- package/lib/bryntum-checklist-filter-combo.component.d.ts +17 -1
- package/lib/bryntum-grid-base.component.d.ts +6 -0
- package/lib/bryntum-grid-chart-designer.component.d.ts +6 -0
- package/lib/bryntum-grid-field-filter-picker-group.component.d.ts +6 -0
- package/lib/bryntum-grid-field-filter-picker.component.d.ts +6 -0
- package/lib/bryntum-grid.component.d.ts +6 -0
- package/lib/bryntum-group-bar.component.d.ts +10 -2
- package/lib/bryntum-tree-combo.component.d.ts +17 -1
- package/lib/bryntum-tree-grid.component.d.ts +6 -0
- package/package.json +1 -1
- package/src/lib/bryntum-a-i-filter-field.component.ts +19 -1
- package/src/lib/bryntum-checklist-filter-combo.component.ts +19 -1
- package/src/lib/bryntum-grid-base.component.ts +31 -25
- package/src/lib/bryntum-grid-chart-designer.component.ts +7 -1
- package/src/lib/bryntum-grid-field-filter-picker-group.component.ts +8 -2
- package/src/lib/bryntum-grid-field-filter-picker.component.ts +7 -1
- package/src/lib/bryntum-grid.component.ts +31 -25
- package/src/lib/bryntum-group-bar.component.ts +12 -4
- package/src/lib/bryntum-theme-combo.component.ts +0 -1
- package/src/lib/bryntum-tree-combo.component.ts +19 -1
- package/src/lib/bryntum-tree-grid.component.ts +31 -25
|
@@ -50,6 +50,8 @@ export type BryntumGroupBarProps = {
|
|
|
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/GroupBar#config-appendTo)
|
|
53
55
|
*/
|
|
54
56
|
appendTo ? : HTMLElement|string
|
|
55
57
|
/**
|
|
@@ -99,9 +101,11 @@ export type BryntumGroupBarProps = {
|
|
|
99
101
|
/**
|
|
100
102
|
* If [closable](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView#config-closable) is `true`, this is the name of a callback function to handle what the "close"
|
|
101
103
|
* action means. If not provided, the record representing the chip is removed from the store.
|
|
104
|
+
* @param {Core.data.Model[]} records Records to be closed
|
|
105
|
+
* @param {object} options Close options
|
|
102
106
|
* @returns {void}
|
|
103
107
|
*/
|
|
104
|
-
closeHandler ? : string|(() => void)
|
|
108
|
+
closeHandler ? : string|((records: Model[], options: object) => void)
|
|
105
109
|
/**
|
|
106
110
|
* Custom CSS classes to add to element.
|
|
107
111
|
* May be specified as a space separated string, or as an object in which property names
|
|
@@ -278,10 +282,14 @@ export type BryntumGroupBarProps = {
|
|
|
278
282
|
ignoreParentReadOnly ? : boolean
|
|
279
283
|
/**
|
|
280
284
|
* 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.
|
|
285
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
286
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/GroupBar#config-insertBefore)
|
|
281
287
|
*/
|
|
282
288
|
insertBefore ? : HTMLElement|string
|
|
283
289
|
/**
|
|
284
290
|
* 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.
|
|
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/GroupBar#config-insertFirst)
|
|
285
293
|
*/
|
|
286
294
|
insertFirst ? : HTMLElement|string
|
|
287
295
|
/**
|
|
@@ -817,7 +825,7 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
|
|
|
817
825
|
@Input() bubbleEvents ! : object;
|
|
818
826
|
@Input() centered ! : boolean;
|
|
819
827
|
@Input() closable ! : boolean;
|
|
820
|
-
@Input() closeHandler ! : string|(() => void);
|
|
828
|
+
@Input() closeHandler ! : string|((records: Model[], options: object) => void);
|
|
821
829
|
@Input() color ! : Color;
|
|
822
830
|
@Input() config ! : object;
|
|
823
831
|
@Input() constrainTo ! : HTMLElement|Widget|Rectangle;
|
|
@@ -924,7 +932,7 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
|
|
|
924
932
|
* @param {object} event Event object
|
|
925
933
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
926
934
|
*/
|
|
927
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
935
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
928
936
|
/**
|
|
929
937
|
* User going to activate an item in the list either by pointer or keyboard.
|
|
930
938
|
* The active record, list item index, and the triggering event are passed.
|
|
@@ -936,7 +944,7 @@ export class BryntumGroupBarComponent implements OnInit, OnDestroy {
|
|
|
936
944
|
* @param {number} event.index List item index
|
|
937
945
|
* @param {Event} event.event Triggering event
|
|
938
946
|
*/
|
|
939
|
-
@Output() onBeforeItem: any = new EventEmitter<((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) =>
|
|
947
|
+
@Output() onBeforeItem: any = new EventEmitter<((event: { source: List, item: HTMLElement, record: Model, index: number, event: Event }) => boolean|void)|string>();
|
|
940
948
|
/**
|
|
941
949
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
942
950
|
* @param {object} event Event object
|
|
@@ -89,7 +89,6 @@ export class BryntumThemeComboComponent implements OnInit, OnChanges, OnDestroy
|
|
|
89
89
|
this.combo.value = theme;
|
|
90
90
|
}
|
|
91
91
|
|
|
92
|
-
console.log(`Set: .b-theme-${this.combo.value as string}`);
|
|
93
92
|
// Always set the initial body class — even when theme detection falls back to the
|
|
94
93
|
// combo's default value (CSS vars may be unreadable in shadow DOM contexts)
|
|
95
94
|
document.body.classList.add(`b-theme-${this.combo.value as string}`);
|
|
@@ -40,6 +40,8 @@ export type BryntumTreeComboProps = {
|
|
|
40
40
|
/**
|
|
41
41
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
42
42
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
43
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
44
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-appendTo)
|
|
43
45
|
*/
|
|
44
46
|
appendTo ? : HTMLElement|string
|
|
45
47
|
/**
|
|
@@ -102,6 +104,15 @@ export type BryntumTreeComboProps = {
|
|
|
102
104
|
* Set to `true` to centre the Widget in browser viewport space.
|
|
103
105
|
*/
|
|
104
106
|
centered ? : boolean
|
|
107
|
+
/**
|
|
108
|
+
* A function (or the name of a function in the ownership hierarchy) called during field validation
|
|
109
|
+
* to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/grid/docs/api/Core/widget/Field#property-isValid)
|
|
110
|
+
* evaluation, after the built-in [required](https://bryntum.com/products/grid/docs/api/Core/widget/Field#config-required) check.
|
|
111
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-checkValidity)
|
|
112
|
+
* @param {Core.widget.Field} field The field being validated
|
|
113
|
+
* @returns {void}
|
|
114
|
+
*/
|
|
115
|
+
checkValidity ? : ((field: Field) => void)|string
|
|
105
116
|
/**
|
|
106
117
|
* A config object to configure the [ChipView](https://bryntum.com/products/grid/docs/api/Core/widget/ChipView) to display the
|
|
107
118
|
* selected value set when [multiSelect](https://bryntum.com/products/grid/docs/api/Core/widget/Combo#config-multiSelect) is `true`.
|
|
@@ -395,10 +406,14 @@ export type BryntumTreeComboProps = {
|
|
|
395
406
|
inputWidth ? : string|number
|
|
396
407
|
/**
|
|
397
408
|
* 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.
|
|
409
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
410
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertBefore)
|
|
398
411
|
*/
|
|
399
412
|
insertBefore ? : HTMLElement|string
|
|
400
413
|
/**
|
|
401
414
|
* 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.
|
|
415
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
416
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/widget/TreeCombo#config-insertFirst)
|
|
402
417
|
*/
|
|
403
418
|
insertFirst ? : HTMLElement|string
|
|
404
419
|
/**
|
|
@@ -840,6 +855,7 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
840
855
|
'caseSensitive',
|
|
841
856
|
'catchEventHandlerExceptions',
|
|
842
857
|
'centered',
|
|
858
|
+
'checkValidity',
|
|
843
859
|
'chipView',
|
|
844
860
|
'clearable',
|
|
845
861
|
'clearTextOnPickerHide',
|
|
@@ -980,6 +996,7 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
980
996
|
'cacheLastResult',
|
|
981
997
|
'caseSensitive',
|
|
982
998
|
'centered',
|
|
999
|
+
'checkValidity',
|
|
983
1000
|
'chipView',
|
|
984
1001
|
'clearable',
|
|
985
1002
|
'clearTextOnPickerHide',
|
|
@@ -1150,6 +1167,7 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1150
1167
|
@Input() cacheLastResult ! : number|string|Duration|DurationConfig;
|
|
1151
1168
|
@Input() caseSensitive ! : boolean;
|
|
1152
1169
|
@Input() centered ! : boolean;
|
|
1170
|
+
@Input() checkValidity ! : ((field: Field) => void)|string;
|
|
1153
1171
|
@Input() chipView ! : ChipViewConfig;
|
|
1154
1172
|
@Input() clearable ! : boolean|FieldTriggerConfig;
|
|
1155
1173
|
@Input() clearTextOnPickerHide ! : boolean;
|
|
@@ -1313,7 +1331,7 @@ export class BryntumTreeComboComponent implements OnInit, OnDestroy {
|
|
|
1313
1331
|
* @param {object} event Event object
|
|
1314
1332
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1315
1333
|
*/
|
|
1316
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1334
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1317
1335
|
/**
|
|
1318
1336
|
* Triggered before a widget is shown. Return `false` to prevent the action.
|
|
1319
1337
|
* @param {object} event Event object
|
|
@@ -48,6 +48,8 @@ export type BryntumTreeGridProps = {
|
|
|
48
48
|
/**
|
|
49
49
|
* Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
|
|
50
50
|
* runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/grid/docs/api/Core/widget/Widget#property-element).
|
|
51
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
52
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-appendTo)
|
|
51
53
|
*/
|
|
52
54
|
appendTo ? : HTMLElement|string
|
|
53
55
|
/**
|
|
@@ -359,10 +361,14 @@ export type BryntumTreeGridProps = {
|
|
|
359
361
|
inputFieldAlign ? : 'start'|'end'
|
|
360
362
|
/**
|
|
361
363
|
* 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.
|
|
364
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
365
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertBefore)
|
|
362
366
|
*/
|
|
363
367
|
insertBefore ? : HTMLElement|string
|
|
364
368
|
/**
|
|
365
369
|
* 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.
|
|
370
|
+
* <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
|
|
371
|
+
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#config-insertFirst)
|
|
366
372
|
*/
|
|
367
373
|
insertFirst ? : HTMLElement|string
|
|
368
374
|
/**
|
|
@@ -1624,7 +1630,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1624
1630
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1625
1631
|
* @param {Grid.util.GridLocation} event.editorContext Editing context
|
|
1626
1632
|
*/
|
|
1627
|
-
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) =>
|
|
1633
|
+
@Output() onBeforeCancelCellEdit: any = new EventEmitter<((event: { source: Grid, editorContext: GridLocation }) => boolean|void)|string>();
|
|
1628
1634
|
/**
|
|
1629
1635
|
* 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.
|
|
1630
1636
|
* [More...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-beforeCancelRowEdit)
|
|
@@ -1639,7 +1645,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1639
1645
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1640
1646
|
* @param {CellEditorContext} event.editorContext Editing context
|
|
1641
1647
|
*/
|
|
1642
|
-
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) =>
|
|
1648
|
+
@Output() onBeforeCellEditStart: any = new EventEmitter<((event: { source: Grid, editorContext: CellEditorContext }) => boolean|void)|string>();
|
|
1643
1649
|
/**
|
|
1644
1650
|
* Fires on the owning Grid before deleting a range of selected cell values by pressing <kbd>Backspace</kbd> or <kbd>Delete</kbd>
|
|
1645
1651
|
* buttons while [autoEdit](https://bryntum.com/products/grid/docs/api/Grid/feature/CellEdit#config-autoEdit) is set to `true`. Return `false` to prevent editing.
|
|
@@ -1647,7 +1653,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1647
1653
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1648
1654
|
* @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).
|
|
1649
1655
|
*/
|
|
1650
|
-
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) =>
|
|
1656
|
+
@Output() onBeforeCellRangeDelete: any = new EventEmitter<((event: { source: Grid, gridSelection: (GridLocation|Model)[] }) => boolean|void)|string>();
|
|
1651
1657
|
/**
|
|
1652
1658
|
* Fires for each selected record on the owning Grid before editing a range of selected cell values
|
|
1653
1659
|
* @param {object} event Event object
|
|
@@ -1655,7 +1661,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1655
1661
|
* @param {string} event.field The field being changed
|
|
1656
1662
|
* @param {any} event.value The value being set
|
|
1657
1663
|
*/
|
|
1658
|
-
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) =>
|
|
1664
|
+
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => boolean|void)|string>();
|
|
1659
1665
|
/**
|
|
1660
1666
|
* This event is triggered before a parent column is collapsed or expanded.
|
|
1661
1667
|
* @param {object} event Event object
|
|
@@ -1671,7 +1677,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1671
1677
|
* @param {Grid.column.Column} event.column The dragged column.
|
|
1672
1678
|
* @param {Event} event.event The browser event.
|
|
1673
1679
|
*/
|
|
1674
|
-
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) =>
|
|
1680
|
+
@Output() onBeforeColumnDragStart: any = new EventEmitter<((event: { source: Grid, column: Column, event: Event }) => boolean|void)|string>();
|
|
1675
1681
|
/**
|
|
1676
1682
|
* This event is fired when a column is dropped, and you can return false from a listener to abort the operation.
|
|
1677
1683
|
* @param {object} event Event object
|
|
@@ -1682,7 +1688,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1682
1688
|
* @param {Event} event.event The browser event.
|
|
1683
1689
|
* @param {string} event.region The region where the column was dropped.
|
|
1684
1690
|
*/
|
|
1685
|
-
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) =>
|
|
1691
|
+
@Output() onBeforeColumnDropFinalize: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, event: Event, region: string }) => boolean|void)|string>();
|
|
1686
1692
|
/**
|
|
1687
1693
|
* This event is fired prior to starting a column resize gesture. The resize is canceled if a listener returns
|
|
1688
1694
|
* `false`.
|
|
@@ -1691,7 +1697,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1691
1697
|
* @param {Grid.column.Column} event.column The column
|
|
1692
1698
|
* @param {Event} event.domEvent The browser event
|
|
1693
1699
|
*/
|
|
1694
|
-
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) =>
|
|
1700
|
+
@Output() onBeforeColumnResize: any = new EventEmitter<((event: { source: Grid, column: Column, domEvent: Event }) => boolean|void)|string>();
|
|
1695
1701
|
/**
|
|
1696
1702
|
* Fires on the owning Grid before a copy action is performed, return `false` to prevent the action
|
|
1697
1703
|
* @param {object} event Event object
|
|
@@ -1711,7 +1717,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1711
1717
|
* @param {string} event.lineDelimiter The CSV delimiter to separate lines
|
|
1712
1718
|
* @param {string} event.columnDelimiter The CSV delimiter to separate values on one line
|
|
1713
1719
|
*/
|
|
1714
|
-
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) =>
|
|
1720
|
+
@Output() onBeforeCSVExport: any = new EventEmitter<((event: { config: ExportConfig, columns: Column[], rows: Model[], lineDelimiter: string, columnDelimiter: string }) => boolean|void)|string>();
|
|
1715
1721
|
/**
|
|
1716
1722
|
* Fires before an object is destroyed.
|
|
1717
1723
|
* @param {object} event Event object
|
|
@@ -1725,14 +1731,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1725
1731
|
* @param {XLSColumn[]} event.columns An array of columns to export
|
|
1726
1732
|
* @param {any[][]} event.rows An array of records to export
|
|
1727
1733
|
*/
|
|
1728
|
-
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) =>
|
|
1734
|
+
@Output() onBeforeExcelExport: any = new EventEmitter<((event: { config: ExportConfig, columns: XLSColumn[], rows: any[] }) => boolean|void)|string>();
|
|
1729
1735
|
/**
|
|
1730
1736
|
* Fired before dragging of the FillHandle starts, return `false` to prevent the drag operation.
|
|
1731
1737
|
* @param {object} event Event object
|
|
1732
1738
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
1733
1739
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
1734
1740
|
*/
|
|
1735
|
-
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
1741
|
+
@Output() onBeforeFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
1736
1742
|
/**
|
|
1737
1743
|
* 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.
|
|
1738
1744
|
* @param {object} event Event object
|
|
@@ -1753,7 +1759,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1753
1759
|
* @param {object} event Event object
|
|
1754
1760
|
* @param {Core.widget.Widget} event.source The widget being hidden.
|
|
1755
1761
|
*/
|
|
1756
|
-
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) =>
|
|
1762
|
+
@Output() onBeforeHide: any = new EventEmitter<((event: { source: Widget }) => boolean|void)|string>();
|
|
1757
1763
|
/**
|
|
1758
1764
|
* Fires on the owning Grid before a paste action is performed, return `false` to prevent the action
|
|
1759
1765
|
* @param {object} event Event object
|
|
@@ -1769,7 +1775,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1769
1775
|
* @param {object} event Event object
|
|
1770
1776
|
* @param {PdfExportConfig} event.config Export config
|
|
1771
1777
|
*/
|
|
1772
|
-
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) =>
|
|
1778
|
+
@Output() onBeforePdfExport: any = new EventEmitter<((event: { config: PdfExportConfig }) => boolean|void)|string>();
|
|
1773
1779
|
/**
|
|
1774
1780
|
* Fires before a row is rendered.
|
|
1775
1781
|
* @param {object} event Event object
|
|
@@ -1812,7 +1818,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1812
1818
|
* @param {Grid.util.GridLocation[]} event.selectedCells The cells to be selected in this operation.
|
|
1813
1819
|
* @param {Grid.util.GridLocation[]} event.cellSelection The cells in the current selection, before applying `selectedCells` and `deselectedCells`
|
|
1814
1820
|
*/
|
|
1815
|
-
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) =>
|
|
1821
|
+
@Output() onBeforeSelectionChange: any = new EventEmitter<((event: { action: string, mode: 'row'|'cell', source: Grid, deselected: Model[], selected: Model[], selection: Model[], deselectedCells: GridLocation[], selectedCells: GridLocation[], cellSelection: GridLocation[] }) => boolean|void)|string>();
|
|
1816
1822
|
/**
|
|
1817
1823
|
* Fired before this container will load record values into its child fields. This is useful if you
|
|
1818
1824
|
* want to modify the UI before data is loaded (e.g. set some input field to be readonly)
|
|
@@ -1833,19 +1839,19 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1833
1839
|
* @param {Grid.view.Grid} event.source Owner grid
|
|
1834
1840
|
* @param {RowEditorContext} event.editorContext Editing context
|
|
1835
1841
|
*/
|
|
1836
|
-
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) =>
|
|
1842
|
+
@Output() onBeforeStartRowEdit: any = new EventEmitter<((event: { source: Grid, editorContext: RowEditorContext }) => boolean|void)|string>();
|
|
1837
1843
|
/**
|
|
1838
1844
|
* Fired before state is applied to the source. Allows editing the state object or preventing the operation.
|
|
1839
1845
|
* @param {object} event Event object
|
|
1840
1846
|
* @param {GridStateInfo} event.state State object config
|
|
1841
1847
|
*/
|
|
1842
|
-
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1848
|
+
@Output() onBeforeStateApply: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1843
1849
|
/**
|
|
1844
1850
|
* Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
|
|
1845
1851
|
* @param {object} event Event object
|
|
1846
1852
|
* @param {GridStateInfo} event.state State object config
|
|
1847
1853
|
*/
|
|
1848
|
-
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) =>
|
|
1854
|
+
@Output() onBeforeStateSave: any = new EventEmitter<((event: { state: GridStateInfo }) => boolean|void)|string>();
|
|
1849
1855
|
/**
|
|
1850
1856
|
* Fired when a group is going to be expanded or collapsed using the UI.
|
|
1851
1857
|
* Returning `false` from a listener prevents the operation
|
|
@@ -1855,7 +1861,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1855
1861
|
* @param {boolean} event.collapse Collapsed (true) or expanded (false)
|
|
1856
1862
|
* @param {Event} event.domEvent The user interaction event (eg a `click` event) if the toggle request was instigated by user interaction.
|
|
1857
1863
|
*/
|
|
1858
|
-
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) =>
|
|
1864
|
+
@Output() onBeforeToggleGroup: any = new EventEmitter<((event: { groupRecord: Model, groupRecords: Model[], collapse: boolean, domEvent: Event }) => boolean|void)|string>();
|
|
1859
1865
|
/**
|
|
1860
1866
|
* Fired before a parent node record toggles its collapsed state.
|
|
1861
1867
|
* @param {object} event Event object
|
|
@@ -1924,7 +1930,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1924
1930
|
* @param {Grid.column.Column} event.column Column
|
|
1925
1931
|
* @param {Core.data.Model} event.record Record
|
|
1926
1932
|
*/
|
|
1927
|
-
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) =>
|
|
1933
|
+
@Output() onCellMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column, record: Model }) => boolean|void)|string>();
|
|
1928
1934
|
/**
|
|
1929
1935
|
* This event fires on the owning grid when an item is selected in the cell context menu.
|
|
1930
1936
|
* @param {object} event Event object
|
|
@@ -2051,7 +2057,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2051
2057
|
* @param {Event} event.event The browser event.
|
|
2052
2058
|
* @param {string} event.region The region where the column was dropped.
|
|
2053
2059
|
*/
|
|
2054
|
-
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) =>
|
|
2060
|
+
@Output() onColumnDrop: any = new EventEmitter<((event: { source: Grid, column: Column, insertBefore: Column, newParent: Column, valid: boolean, event: Event, region: string }) => boolean|void)|string>();
|
|
2055
2061
|
/**
|
|
2056
2062
|
* This event is fired after a resize gesture is completed.
|
|
2057
2063
|
* @param {object} event Event object
|
|
@@ -2191,7 +2197,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2191
2197
|
* @param {Grid.util.GridLocation} event.cell Information about the column / record
|
|
2192
2198
|
* @param {MouseEvent} event.domEvent The raw DOM event
|
|
2193
2199
|
*/
|
|
2194
|
-
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) =>
|
|
2200
|
+
@Output() onFillHandleDragStart: any = new EventEmitter<((event: { cell: GridLocation, domEvent: MouseEvent }) => boolean|void)|string>();
|
|
2195
2201
|
/**
|
|
2196
2202
|
* Fires on the owning Grid when cell editing is finished
|
|
2197
2203
|
* @param {object} event Event object
|
|
@@ -2239,7 +2245,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2239
2245
|
* @param {Core.data.Model[]} event.context.records The dragged row records
|
|
2240
2246
|
* @param {MouseEvent,TouchEvent} event.event
|
|
2241
2247
|
*/
|
|
2242
|
-
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) =>
|
|
2248
|
+
@Output() onGridRowBeforeDragStart: any = new EventEmitter<((event: { source: GridBase, context: { records: Model[] }, event: MouseEvent|TouchEvent }) => boolean|void)|string>();
|
|
2243
2249
|
/**
|
|
2244
2250
|
* Fired before the row drop operation is finalized. You can return false to abort the drop operation, or a
|
|
2245
2251
|
* Promise yielding `true` / `false` which allows for asynchronous abort (e.g. first show user a confirmation dialog).
|
|
@@ -2306,7 +2312,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2306
2312
|
* @param {Event} event.domEvent The triggering DOM event.
|
|
2307
2313
|
* @param {Grid.column.Column} event.column The column clicked on.
|
|
2308
2314
|
*/
|
|
2309
|
-
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) =>
|
|
2315
|
+
@Output() onHeaderClick: any = new EventEmitter<((event: { domEvent: Event, column: Column }) => boolean|void)|string>();
|
|
2310
2316
|
/**
|
|
2311
2317
|
* This event fires on the owning Grid before the context menu is shown for a header.
|
|
2312
2318
|
* 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).
|
|
@@ -2317,7 +2323,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2317
2323
|
* @param {Record<string, MenuItemEntry>} event.items Menu item configs
|
|
2318
2324
|
* @param {Grid.column.Column} event.column Column
|
|
2319
2325
|
*/
|
|
2320
|
-
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) =>
|
|
2326
|
+
@Output() onHeaderMenuBeforeShow: any = new EventEmitter<((event: { source: Grid, menu: Menu, items: Record<string, MenuItemEntry>, column: Column }) => boolean|void)|string>();
|
|
2321
2327
|
/**
|
|
2322
2328
|
* This event fires on the owning Grid when an item is selected in the header context menu.
|
|
2323
2329
|
* @param {object} event Event object
|
|
@@ -2528,7 +2534,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2528
2534
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2529
2535
|
* @param {Event} event.domEvent The native DOM event
|
|
2530
2536
|
*/
|
|
2531
|
-
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2537
|
+
@Output() onSplitterCollapseClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2532
2538
|
/**
|
|
2533
2539
|
* Fired by the Grid after a sub-grid has been resized using the splitter
|
|
2534
2540
|
* @param {object} event Event object
|
|
@@ -2553,7 +2559,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2553
2559
|
* @param {Grid.view.SubGrid} event.subGrid The subgrid
|
|
2554
2560
|
* @param {Event} event.domEvent The native DOM event
|
|
2555
2561
|
*/
|
|
2556
|
-
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) =>
|
|
2562
|
+
@Output() onSplitterExpandClick: any = new EventEmitter<((event: { source: Grid, subGrid: SubGrid, domEvent: Event }) => boolean|void)|string>();
|
|
2557
2563
|
/**
|
|
2558
2564
|
* Fires on the owning Grid when editing starts
|
|
2559
2565
|
* @param {object} event Event object
|