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