@bryntum/grid-angular 7.1.2 → 7.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -6
- package/bundles/bryntum-grid-angular.umd.js +111 -45
- package/bundles/bryntum-grid-angular.umd.js.map +1 -1
- package/esm2015/lib/bryntum-grid-base.component.js +38 -16
- package/esm2015/lib/bryntum-grid.component.js +38 -16
- package/esm2015/lib/bryntum-tree-grid.component.js +38 -16
- package/fesm2015/bryntum-grid-angular.js +111 -45
- package/fesm2015/bryntum-grid-angular.js.map +1 -1
- package/lib/bryntum-grid-base.component.d.ts +31 -15
- package/lib/bryntum-grid.component.d.ts +31 -15
- package/lib/bryntum-tree-grid.component.d.ts +31 -15
- package/package.json +1 -1
- package/src/lib/bryntum-grid-base.component.ts +40 -22
- package/src/lib/bryntum-grid.component.ts +40 -22
- package/src/lib/bryntum-tree-grid.component.ts +40 -22
|
@@ -1052,6 +1052,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1052
1052
|
'onBeforeCellEditStart',
|
|
1053
1053
|
'onBeforeCellRangeDelete',
|
|
1054
1054
|
'onBeforeCellRangeEdit',
|
|
1055
|
+
'onBeforeColumnCollapseToggle',
|
|
1055
1056
|
'onBeforeColumnDragStart',
|
|
1056
1057
|
'onBeforeColumnDropFinalize',
|
|
1057
1058
|
'onBeforeColumnResize',
|
|
@@ -1092,6 +1093,7 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1092
1093
|
'onCellMouseOver',
|
|
1093
1094
|
'onCollapse',
|
|
1094
1095
|
'onCollapseNode',
|
|
1096
|
+
'onColumnCollapseToggle',
|
|
1095
1097
|
'onColumnDrag',
|
|
1096
1098
|
'onColumnDragStart',
|
|
1097
1099
|
'onColumnDrop',
|
|
@@ -1732,6 +1734,14 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1732
1734
|
* @param {any} event.value The value being set
|
|
1733
1735
|
*/
|
|
1734
1736
|
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string>();
|
|
1737
|
+
/**
|
|
1738
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
1739
|
+
* @param {object} event Event object
|
|
1740
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
1741
|
+
* @param {Grid.column.Column} event.column The column
|
|
1742
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1743
|
+
*/
|
|
1744
|
+
@Output() onBeforeColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
1735
1745
|
/**
|
|
1736
1746
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
1737
1747
|
* @param {object} event Event object
|
|
@@ -1842,18 +1852,18 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
1842
1852
|
/**
|
|
1843
1853
|
* Fires before a row is rendered.
|
|
1844
1854
|
* @param {object} event Event object
|
|
1845
|
-
* @param {Grid.view.
|
|
1846
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1847
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
1848
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
1855
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
1856
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1857
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
1858
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
1849
1859
|
*/
|
|
1850
|
-
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source:
|
|
1860
|
+
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
1851
1861
|
/**
|
|
1852
1862
|
* Grid rows are about to be rendered
|
|
1853
1863
|
* @param {object} event Event object
|
|
1854
|
-
* @param {Grid.view.
|
|
1864
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1855
1865
|
*/
|
|
1856
|
-
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source:
|
|
1866
|
+
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
1857
1867
|
/**
|
|
1858
1868
|
* This event fires before row collapse is started.
|
|
1859
1869
|
* ...
|
|
@@ -2084,6 +2094,14 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2084
2094
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
2085
2095
|
*/
|
|
2086
2096
|
@Output() onCollapseNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
|
|
2097
|
+
/**
|
|
2098
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
2099
|
+
* @param {object} event Event object
|
|
2100
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
2101
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
2102
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
2103
|
+
*/
|
|
2104
|
+
@Output() onColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
2087
2105
|
/**
|
|
2088
2106
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
2089
2107
|
* to indicate whether the drop position is valid or not.
|
|
@@ -2165,14 +2183,14 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2165
2183
|
* ...
|
|
2166
2184
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/GridBase#event-dataChange)
|
|
2167
2185
|
* @param {object} event Event object
|
|
2168
|
-
* @param {Grid.view.
|
|
2186
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
2169
2187
|
* @param {Core.data.Store} event.store The originating store
|
|
2170
2188
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
2171
2189
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
2172
2190
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
2173
2191
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
2174
2192
|
*/
|
|
2175
|
-
@Output() onDataChange: any = new EventEmitter<((event: { source:
|
|
2193
|
+
@Output() onDataChange: any = new EventEmitter<((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
|
|
2176
2194
|
/**
|
|
2177
2195
|
* Fires when an object is destroyed.
|
|
2178
2196
|
* @param {object} event Event object
|
|
@@ -2480,18 +2498,18 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2480
2498
|
/**
|
|
2481
2499
|
* Fires after a row is rendered.
|
|
2482
2500
|
* @param {object} event Event object
|
|
2483
|
-
* @param {Grid.view.
|
|
2484
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2485
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
2486
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
2501
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2502
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2503
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
2504
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
2487
2505
|
*/
|
|
2488
|
-
@Output() onRenderRow: any = new EventEmitter<((event: { source:
|
|
2506
|
+
@Output() onRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
2489
2507
|
/**
|
|
2490
2508
|
* Grid rows have been rendered
|
|
2491
2509
|
* @param {object} event Event object
|
|
2492
|
-
* @param {Grid.view.
|
|
2510
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
2493
2511
|
*/
|
|
2494
|
-
@Output() onRenderRows: any = new EventEmitter<((event: { source:
|
|
2512
|
+
@Output() onRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
2495
2513
|
/**
|
|
2496
2514
|
* 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`*.
|
|
2497
2515
|
* @param {object} event Event object
|
|
@@ -2551,10 +2569,10 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2551
2569
|
/**
|
|
2552
2570
|
* Grid has scrolled vertically
|
|
2553
2571
|
* @param {object} event Event object
|
|
2554
|
-
* @param {Grid.view.
|
|
2572
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
2555
2573
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
2556
2574
|
*/
|
|
2557
|
-
@Output() onScroll: any = new EventEmitter<((event: { source:
|
|
2575
|
+
@Output() onScroll: any = new EventEmitter<((event: { source: GridBase, scrollTop: number }) => void)|string>();
|
|
2558
2576
|
/**
|
|
2559
2577
|
* The selection has been changed.
|
|
2560
2578
|
* @param {object} event Event object
|
|
@@ -2642,17 +2660,17 @@ export class BryntumGridBaseComponent implements OnInit, OnDestroy {
|
|
|
2642
2660
|
/**
|
|
2643
2661
|
* Fires after a sub grid is collapsed.
|
|
2644
2662
|
* @param {object} event Event object
|
|
2645
|
-
* @param {Grid.view.
|
|
2663
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2646
2664
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2647
2665
|
*/
|
|
2648
|
-
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source:
|
|
2666
|
+
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2649
2667
|
/**
|
|
2650
2668
|
* Fires after a sub grid is expanded.
|
|
2651
2669
|
* @param {object} event Event object
|
|
2652
|
-
* @param {Grid.view.
|
|
2670
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2653
2671
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2654
2672
|
*/
|
|
2655
|
-
@Output() onSubGridExpand: any = new EventEmitter<((event: { source:
|
|
2673
|
+
@Output() onSubGridExpand: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2656
2674
|
/**
|
|
2657
2675
|
* Fired when one or more groups are expanded or collapsed
|
|
2658
2676
|
* @param {object} event Event object
|
|
@@ -1053,6 +1053,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1053
1053
|
'onBeforeCellEditStart',
|
|
1054
1054
|
'onBeforeCellRangeDelete',
|
|
1055
1055
|
'onBeforeCellRangeEdit',
|
|
1056
|
+
'onBeforeColumnCollapseToggle',
|
|
1056
1057
|
'onBeforeColumnDragStart',
|
|
1057
1058
|
'onBeforeColumnDropFinalize',
|
|
1058
1059
|
'onBeforeColumnResize',
|
|
@@ -1093,6 +1094,7 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1093
1094
|
'onCellMouseOver',
|
|
1094
1095
|
'onCollapse',
|
|
1095
1096
|
'onCollapseNode',
|
|
1097
|
+
'onColumnCollapseToggle',
|
|
1096
1098
|
'onColumnDrag',
|
|
1097
1099
|
'onColumnDragStart',
|
|
1098
1100
|
'onColumnDrop',
|
|
@@ -1736,6 +1738,14 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1736
1738
|
* @param {any} event.value The value being set
|
|
1737
1739
|
*/
|
|
1738
1740
|
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string>();
|
|
1741
|
+
/**
|
|
1742
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
1743
|
+
* @param {object} event Event object
|
|
1744
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
1745
|
+
* @param {Grid.column.Column} event.column The column
|
|
1746
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1747
|
+
*/
|
|
1748
|
+
@Output() onBeforeColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
1739
1749
|
/**
|
|
1740
1750
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
1741
1751
|
* @param {object} event Event object
|
|
@@ -1846,18 +1856,18 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
1846
1856
|
/**
|
|
1847
1857
|
* Fires before a row is rendered.
|
|
1848
1858
|
* @param {object} event Event object
|
|
1849
|
-
* @param {Grid.view.
|
|
1850
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1851
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
1852
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
1859
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
1860
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1861
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
1862
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
1853
1863
|
*/
|
|
1854
|
-
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source:
|
|
1864
|
+
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
1855
1865
|
/**
|
|
1856
1866
|
* Grid rows are about to be rendered
|
|
1857
1867
|
* @param {object} event Event object
|
|
1858
|
-
* @param {Grid.view.
|
|
1868
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1859
1869
|
*/
|
|
1860
|
-
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source:
|
|
1870
|
+
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
1861
1871
|
/**
|
|
1862
1872
|
* This event fires before row collapse is started.
|
|
1863
1873
|
* ...
|
|
@@ -2088,6 +2098,14 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2088
2098
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
2089
2099
|
*/
|
|
2090
2100
|
@Output() onCollapseNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
|
|
2101
|
+
/**
|
|
2102
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
2103
|
+
* @param {object} event Event object
|
|
2104
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
2105
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
2106
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
2107
|
+
*/
|
|
2108
|
+
@Output() onColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
2091
2109
|
/**
|
|
2092
2110
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
2093
2111
|
* to indicate whether the drop position is valid or not.
|
|
@@ -2169,14 +2187,14 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2169
2187
|
* ...
|
|
2170
2188
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/Grid#event-dataChange)
|
|
2171
2189
|
* @param {object} event Event object
|
|
2172
|
-
* @param {Grid.view.
|
|
2190
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
2173
2191
|
* @param {Core.data.Store} event.store The originating store
|
|
2174
2192
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
2175
2193
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
2176
2194
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
2177
2195
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
2178
2196
|
*/
|
|
2179
|
-
@Output() onDataChange: any = new EventEmitter<((event: { source:
|
|
2197
|
+
@Output() onDataChange: any = new EventEmitter<((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
|
|
2180
2198
|
/**
|
|
2181
2199
|
* Fires when an object is destroyed.
|
|
2182
2200
|
* @param {object} event Event object
|
|
@@ -2484,18 +2502,18 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2484
2502
|
/**
|
|
2485
2503
|
* Fires after a row is rendered.
|
|
2486
2504
|
* @param {object} event Event object
|
|
2487
|
-
* @param {Grid.view.
|
|
2488
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2489
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
2490
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
2505
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2506
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2507
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
2508
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
2491
2509
|
*/
|
|
2492
|
-
@Output() onRenderRow: any = new EventEmitter<((event: { source:
|
|
2510
|
+
@Output() onRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
2493
2511
|
/**
|
|
2494
2512
|
* Grid rows have been rendered
|
|
2495
2513
|
* @param {object} event Event object
|
|
2496
|
-
* @param {Grid.view.
|
|
2514
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
2497
2515
|
*/
|
|
2498
|
-
@Output() onRenderRows: any = new EventEmitter<((event: { source:
|
|
2516
|
+
@Output() onRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
2499
2517
|
/**
|
|
2500
2518
|
* 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`*.
|
|
2501
2519
|
* @param {object} event Event object
|
|
@@ -2555,10 +2573,10 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2555
2573
|
/**
|
|
2556
2574
|
* Grid has scrolled vertically
|
|
2557
2575
|
* @param {object} event Event object
|
|
2558
|
-
* @param {Grid.view.
|
|
2576
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
2559
2577
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
2560
2578
|
*/
|
|
2561
|
-
@Output() onScroll: any = new EventEmitter<((event: { source:
|
|
2579
|
+
@Output() onScroll: any = new EventEmitter<((event: { source: GridBase, scrollTop: number }) => void)|string>();
|
|
2562
2580
|
/**
|
|
2563
2581
|
* The selection has been changed.
|
|
2564
2582
|
* @param {object} event Event object
|
|
@@ -2646,17 +2664,17 @@ export class BryntumGridComponent implements OnInit, OnDestroy {
|
|
|
2646
2664
|
/**
|
|
2647
2665
|
* Fires after a sub grid is collapsed.
|
|
2648
2666
|
* @param {object} event Event object
|
|
2649
|
-
* @param {Grid.view.
|
|
2667
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2650
2668
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2651
2669
|
*/
|
|
2652
|
-
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source:
|
|
2670
|
+
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2653
2671
|
/**
|
|
2654
2672
|
* Fires after a sub grid is expanded.
|
|
2655
2673
|
* @param {object} event Event object
|
|
2656
|
-
* @param {Grid.view.
|
|
2674
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2657
2675
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2658
2676
|
*/
|
|
2659
|
-
@Output() onSubGridExpand: any = new EventEmitter<((event: { source:
|
|
2677
|
+
@Output() onSubGridExpand: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2660
2678
|
/**
|
|
2661
2679
|
* Fired when one or more groups are expanded or collapsed
|
|
2662
2680
|
* @param {object} event Event object
|
|
@@ -1053,6 +1053,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1053
1053
|
'onBeforeCellEditStart',
|
|
1054
1054
|
'onBeforeCellRangeDelete',
|
|
1055
1055
|
'onBeforeCellRangeEdit',
|
|
1056
|
+
'onBeforeColumnCollapseToggle',
|
|
1056
1057
|
'onBeforeColumnDragStart',
|
|
1057
1058
|
'onBeforeColumnDropFinalize',
|
|
1058
1059
|
'onBeforeColumnResize',
|
|
@@ -1093,6 +1094,7 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1093
1094
|
'onCellMouseOver',
|
|
1094
1095
|
'onCollapse',
|
|
1095
1096
|
'onCollapseNode',
|
|
1097
|
+
'onColumnCollapseToggle',
|
|
1096
1098
|
'onColumnDrag',
|
|
1097
1099
|
'onColumnDragStart',
|
|
1098
1100
|
'onColumnDrop',
|
|
@@ -1736,6 +1738,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1736
1738
|
* @param {any} event.value The value being set
|
|
1737
1739
|
*/
|
|
1738
1740
|
@Output() onBeforeCellRangeEdit: any = new EventEmitter<((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string>();
|
|
1741
|
+
/**
|
|
1742
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
1743
|
+
* @param {object} event Event object
|
|
1744
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
1745
|
+
* @param {Grid.column.Column} event.column The column
|
|
1746
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
1747
|
+
*/
|
|
1748
|
+
@Output() onBeforeColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
1739
1749
|
/**
|
|
1740
1750
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
1741
1751
|
* @param {object} event Event object
|
|
@@ -1846,18 +1856,18 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
1846
1856
|
/**
|
|
1847
1857
|
* Fires before a row is rendered.
|
|
1848
1858
|
* @param {object} event Event object
|
|
1849
|
-
* @param {Grid.view.
|
|
1850
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1851
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
1852
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
1859
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
1860
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
1861
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
1862
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
1853
1863
|
*/
|
|
1854
|
-
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source:
|
|
1864
|
+
@Output() onBeforeRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
1855
1865
|
/**
|
|
1856
1866
|
* Grid rows are about to be rendered
|
|
1857
1867
|
* @param {object} event Event object
|
|
1858
|
-
* @param {Grid.view.
|
|
1868
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1859
1869
|
*/
|
|
1860
|
-
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source:
|
|
1870
|
+
@Output() onBeforeRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
1861
1871
|
/**
|
|
1862
1872
|
* This event fires before row collapse is started.
|
|
1863
1873
|
* ...
|
|
@@ -2088,6 +2098,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2088
2098
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
2089
2099
|
*/
|
|
2090
2100
|
@Output() onCollapseNode: any = new EventEmitter<((event: { source: Grid, record: Model }) => void)|string>();
|
|
2101
|
+
/**
|
|
2102
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
2103
|
+
* @param {object} event Event object
|
|
2104
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
2105
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
2106
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
2107
|
+
*/
|
|
2108
|
+
@Output() onColumnCollapseToggle: any = new EventEmitter<((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string>();
|
|
2091
2109
|
/**
|
|
2092
2110
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
2093
2111
|
* to indicate whether the drop position is valid or not.
|
|
@@ -2169,14 +2187,14 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2169
2187
|
* ...
|
|
2170
2188
|
* [View online docs...](https://bryntum.com/products/grid/docs/api/Grid/view/TreeGrid#event-dataChange)
|
|
2171
2189
|
* @param {object} event Event object
|
|
2172
|
-
* @param {Grid.view.
|
|
2190
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
2173
2191
|
* @param {Core.data.Store} event.store The originating store
|
|
2174
2192
|
* @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
|
|
2175
2193
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
2176
2194
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
2177
2195
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
2178
2196
|
*/
|
|
2179
|
-
@Output() onDataChange: any = new EventEmitter<((event: { source:
|
|
2197
|
+
@Output() onDataChange: any = new EventEmitter<((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string>();
|
|
2180
2198
|
/**
|
|
2181
2199
|
* Fires when an object is destroyed.
|
|
2182
2200
|
* @param {object} event Event object
|
|
@@ -2484,18 +2502,18 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2484
2502
|
/**
|
|
2485
2503
|
* Fires after a row is rendered.
|
|
2486
2504
|
* @param {object} event Event object
|
|
2487
|
-
* @param {Grid.view.
|
|
2488
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2489
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
2490
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
2505
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2506
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2507
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
2508
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
2491
2509
|
*/
|
|
2492
|
-
@Output() onRenderRow: any = new EventEmitter<((event: { source:
|
|
2510
|
+
@Output() onRenderRow: any = new EventEmitter<((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string>();
|
|
2493
2511
|
/**
|
|
2494
2512
|
* Grid rows have been rendered
|
|
2495
2513
|
* @param {object} event Event object
|
|
2496
|
-
* @param {Grid.view.
|
|
2514
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
2497
2515
|
*/
|
|
2498
|
-
@Output() onRenderRows: any = new EventEmitter<((event: { source:
|
|
2516
|
+
@Output() onRenderRows: any = new EventEmitter<((event: { source: GridBase }) => void)|string>();
|
|
2499
2517
|
/**
|
|
2500
2518
|
* 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`*.
|
|
2501
2519
|
* @param {object} event Event object
|
|
@@ -2555,10 +2573,10 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2555
2573
|
/**
|
|
2556
2574
|
* Grid has scrolled vertically
|
|
2557
2575
|
* @param {object} event Event object
|
|
2558
|
-
* @param {Grid.view.
|
|
2576
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
2559
2577
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
2560
2578
|
*/
|
|
2561
|
-
@Output() onScroll: any = new EventEmitter<((event: { source:
|
|
2579
|
+
@Output() onScroll: any = new EventEmitter<((event: { source: GridBase, scrollTop: number }) => void)|string>();
|
|
2562
2580
|
/**
|
|
2563
2581
|
* The selection has been changed.
|
|
2564
2582
|
* @param {object} event Event object
|
|
@@ -2646,17 +2664,17 @@ export class BryntumTreeGridComponent implements OnInit, OnDestroy {
|
|
|
2646
2664
|
/**
|
|
2647
2665
|
* Fires after a sub grid is collapsed.
|
|
2648
2666
|
* @param {object} event Event object
|
|
2649
|
-
* @param {Grid.view.
|
|
2667
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2650
2668
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2651
2669
|
*/
|
|
2652
|
-
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source:
|
|
2670
|
+
@Output() onSubGridCollapse: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2653
2671
|
/**
|
|
2654
2672
|
* Fires after a sub grid is expanded.
|
|
2655
2673
|
* @param {object} event Event object
|
|
2656
|
-
* @param {Grid.view.
|
|
2674
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
2657
2675
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
2658
2676
|
*/
|
|
2659
|
-
@Output() onSubGridExpand: any = new EventEmitter<((event: { source:
|
|
2677
|
+
@Output() onSubGridExpand: any = new EventEmitter<((event: { source: GridBase, subGrid: SubGrid }) => void)|string>();
|
|
2660
2678
|
/**
|
|
2661
2679
|
* Fired when one or more groups are expanded or collapsed
|
|
2662
2680
|
* @param {object} event Event object
|