@bryntum/gantt-react 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.
Files changed (74) hide show
  1. package/README.md +12 -6
  2. package/lib/BryntumAssignmentGrid.d.ts +18 -8
  3. package/lib/BryntumAssignmentGrid.js +2 -0
  4. package/lib/BryntumAssignmentGrid.js.map +1 -1
  5. package/lib/BryntumAssignmentPicker.d.ts +253 -0
  6. package/lib/BryntumAssignmentPicker.js +182 -0
  7. package/lib/BryntumAssignmentPicker.js.map +1 -0
  8. package/lib/BryntumGantt.d.ts +18 -8
  9. package/lib/BryntumGantt.js +2 -0
  10. package/lib/BryntumGantt.js.map +1 -1
  11. package/lib/BryntumGanttBase.d.ts +18 -8
  12. package/lib/BryntumGanttBase.js +2 -0
  13. package/lib/BryntumGanttBase.js.map +1 -1
  14. package/lib/BryntumGrid.d.ts +18 -8
  15. package/lib/BryntumGrid.js +2 -0
  16. package/lib/BryntumGrid.js.map +1 -1
  17. package/lib/BryntumGridBase.d.ts +18 -8
  18. package/lib/BryntumGridBase.js +2 -0
  19. package/lib/BryntumGridBase.js.map +1 -1
  20. package/lib/BryntumResourceGrid.d.ts +18 -8
  21. package/lib/BryntumResourceGrid.js +2 -0
  22. package/lib/BryntumResourceGrid.js.map +1 -1
  23. package/lib/BryntumResourceHistogram.d.ts +18 -8
  24. package/lib/BryntumResourceHistogram.js +2 -0
  25. package/lib/BryntumResourceHistogram.js.map +1 -1
  26. package/lib/BryntumResourceUtilization.d.ts +18 -8
  27. package/lib/BryntumResourceUtilization.js +2 -0
  28. package/lib/BryntumResourceUtilization.js.map +1 -1
  29. package/lib/BryntumScheduler.d.ts +18 -8
  30. package/lib/BryntumScheduler.js +2 -0
  31. package/lib/BryntumScheduler.js.map +1 -1
  32. package/lib/BryntumSchedulerBase.d.ts +18 -8
  33. package/lib/BryntumSchedulerBase.js +2 -0
  34. package/lib/BryntumSchedulerBase.js.map +1 -1
  35. package/lib/BryntumSchedulerPro.d.ts +18 -8
  36. package/lib/BryntumSchedulerPro.js +2 -0
  37. package/lib/BryntumSchedulerPro.js.map +1 -1
  38. package/lib/BryntumSchedulerProBase.d.ts +18 -8
  39. package/lib/BryntumSchedulerProBase.js +2 -0
  40. package/lib/BryntumSchedulerProBase.js.map +1 -1
  41. package/lib/BryntumTimeline.d.ts +18 -8
  42. package/lib/BryntumTimeline.js +2 -0
  43. package/lib/BryntumTimeline.js.map +1 -1
  44. package/lib/BryntumTimelineHistogram.d.ts +18 -8
  45. package/lib/BryntumTimelineHistogram.js +2 -0
  46. package/lib/BryntumTimelineHistogram.js.map +1 -1
  47. package/lib/BryntumTreeGrid.d.ts +18 -8
  48. package/lib/BryntumTreeGrid.js +2 -0
  49. package/lib/BryntumTreeGrid.js.map +1 -1
  50. package/lib/BryntumVersionGrid.d.ts +18 -8
  51. package/lib/BryntumVersionGrid.js +2 -0
  52. package/lib/BryntumVersionGrid.js.map +1 -1
  53. package/lib/index.d.ts +1 -0
  54. package/lib/index.js +1 -0
  55. package/lib/index.js.map +1 -1
  56. package/package.json +1 -1
  57. package/src/BryntumAssignmentGrid.tsx +40 -22
  58. package/src/BryntumAssignmentPicker.tsx +1109 -0
  59. package/src/BryntumGantt.tsx +42 -23
  60. package/src/BryntumGanttBase.tsx +42 -23
  61. package/src/BryntumGrid.tsx +40 -22
  62. package/src/BryntumGridBase.tsx +40 -22
  63. package/src/BryntumResourceGrid.tsx +40 -22
  64. package/src/BryntumResourceHistogram.tsx +40 -22
  65. package/src/BryntumResourceUtilization.tsx +40 -22
  66. package/src/BryntumScheduler.tsx +40 -22
  67. package/src/BryntumSchedulerBase.tsx +40 -22
  68. package/src/BryntumSchedulerPro.tsx +40 -22
  69. package/src/BryntumSchedulerProBase.tsx +40 -22
  70. package/src/BryntumTimeline.tsx +40 -22
  71. package/src/BryntumTimelineHistogram.tsx +40 -22
  72. package/src/BryntumTreeGrid.tsx +40 -22
  73. package/src/BryntumVersionGrid.tsx +40 -22
  74. package/src/index.ts +1 -0
@@ -1714,6 +1714,14 @@ export type BryntumSchedulerBaseProps = {
1714
1714
  * @param {any} event.value The value being set
1715
1715
  */
1716
1716
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1717
+ /**
1718
+ * This event is triggered before a parent column is collapsed or expanded.
1719
+ * @param {object} event Event object
1720
+ * @param {Grid.view.GridBase} event.source The grid instance
1721
+ * @param {Grid.column.Column} event.column The column
1722
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1723
+ */
1724
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1717
1725
  /**
1718
1726
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1719
1727
  * @param {object} event Event object
@@ -2087,18 +2095,18 @@ export type BryntumSchedulerBaseProps = {
2087
2095
  /**
2088
2096
  * Fires before a row is rendered.
2089
2097
  * @param {object} event Event object
2090
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2091
- * @param {Grid.row.Row} event.row The row about to be rendered.
2092
- * @param {Core.data.Model} event.record The record for the row.
2093
- * @param {number} event.recordIndex The zero-based index of the record.
2098
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2099
+ * @param {Grid.row.Row} event.row The row about to be rendered
2100
+ * @param {Core.data.Model} event.record The record for the row
2101
+ * @param {number} event.recordIndex The zero-based index of the record
2094
2102
  */
2095
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2103
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2096
2104
  /**
2097
2105
  * Grid rows are about to be rendered
2098
2106
  * @param {object} event Event object
2099
- * @param {Grid.view.Grid} event.source This grid.
2107
+ * @param {Grid.view.GridBase} event.source This grid.
2100
2108
  */
2101
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
2109
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
2102
2110
  /**
2103
2111
  * This event fires before row collapse is started.
2104
2112
  * ...
@@ -2347,6 +2355,14 @@ export type BryntumSchedulerBaseProps = {
2347
2355
  * @param {Core.data.Model} event.record The record which has been collapsed.
2348
2356
  */
2349
2357
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2358
+ /**
2359
+ * This event is triggered after a parent column has been collapsed or expanded.
2360
+ * @param {object} event Event object
2361
+ * @param {Grid.view.GridBase} event.source The Grid instance
2362
+ * @param {Grid.column.Column} event.column The column being toggled
2363
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2364
+ */
2365
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2350
2366
  /**
2351
2367
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2352
2368
  * to indicate whether the drop position is valid or not.
@@ -2435,14 +2451,14 @@ export type BryntumSchedulerBaseProps = {
2435
2451
  * ...
2436
2452
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Scheduler/view/SchedulerBase#event-dataChange)
2437
2453
  * @param {object} event Event object
2438
- * @param {Grid.view.Grid} event.source Owning grid
2454
+ * @param {Grid.view.GridBase} event.source Owning grid
2439
2455
  * @param {Core.data.Store} event.store The originating store
2440
2456
  * @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'`
2441
2457
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2442
2458
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2443
2459
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2444
2460
  */
2445
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2461
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2446
2462
  /**
2447
2463
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2448
2464
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -3301,18 +3317,18 @@ export type BryntumSchedulerBaseProps = {
3301
3317
  /**
3302
3318
  * Fires after a row is rendered.
3303
3319
  * @param {object} event Event object
3304
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3305
- * @param {Grid.row.Row} event.row The row that has been rendered.
3306
- * @param {Core.data.Model} event.record The record for the row.
3307
- * @param {number} event.recordIndex The zero-based index of the record.
3320
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3321
+ * @param {Grid.row.Row} event.row The row that has been rendered
3322
+ * @param {Core.data.Model} event.record The record for the row
3323
+ * @param {number} event.recordIndex The zero-based index of the record
3308
3324
  */
3309
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
3325
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
3310
3326
  /**
3311
3327
  * Grid rows have been rendered
3312
3328
  * @param {object} event Event object
3313
- * @param {Grid.view.Grid} event.source This grid.
3329
+ * @param {Grid.view.GridBase} event.source This grid.
3314
3330
  */
3315
- onRenderRows? : ((event: { source: Grid }) => void)|string
3331
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
3316
3332
  /**
3317
3333
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
3318
3334
  * @param {object} event Event object
@@ -3654,10 +3670,10 @@ export type BryntumSchedulerBaseProps = {
3654
3670
  /**
3655
3671
  * Grid has scrolled vertically
3656
3672
  * @param {object} event Event object
3657
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3673
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
3658
3674
  * @param {number} event.scrollTop The vertical scroll position.
3659
3675
  */
3660
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
3676
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
3661
3677
  /**
3662
3678
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
3663
3679
  * @param {object} event Event object
@@ -3761,17 +3777,17 @@ export type BryntumSchedulerBaseProps = {
3761
3777
  /**
3762
3778
  * Fires after a sub grid is collapsed.
3763
3779
  * @param {object} event Event object
3764
- * @param {Grid.view.Grid} event.source The firing Grid instance
3780
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3765
3781
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3766
3782
  */
3767
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3783
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3768
3784
  /**
3769
3785
  * Fires after a sub grid is expanded.
3770
3786
  * @param {object} event Event object
3771
- * @param {Grid.view.Grid} event.source The firing Grid instance
3787
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3772
3788
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3773
3789
  */
3774
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3790
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3775
3791
  /**
3776
3792
  * Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
3777
3793
  * `[enableMouseEvents](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
@@ -4835,6 +4851,7 @@ export class BryntumSchedulerBase extends React.Component<BryntumSchedulerBasePr
4835
4851
  'onBeforeCellEditStart',
4836
4852
  'onBeforeCellRangeDelete',
4837
4853
  'onBeforeCellRangeEdit',
4854
+ 'onBeforeColumnCollapseToggle',
4838
4855
  'onBeforeColumnDragStart',
4839
4856
  'onBeforeColumnDropFinalize',
4840
4857
  'onBeforeColumnResize',
@@ -4900,6 +4917,7 @@ export class BryntumSchedulerBase extends React.Component<BryntumSchedulerBasePr
4900
4917
  'onCellMouseOver',
4901
4918
  'onCollapse',
4902
4919
  'onCollapseNode',
4920
+ 'onColumnCollapseToggle',
4903
4921
  'onColumnDrag',
4904
4922
  'onColumnDragStart',
4905
4923
  'onColumnDrop',
@@ -1777,6 +1777,14 @@ export type BryntumSchedulerProProps = {
1777
1777
  * @param {any} event.value The value being set
1778
1778
  */
1779
1779
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1780
+ /**
1781
+ * This event is triggered before a parent column is collapsed or expanded.
1782
+ * @param {object} event Event object
1783
+ * @param {Grid.view.GridBase} event.source The grid instance
1784
+ * @param {Grid.column.Column} event.column The column
1785
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1786
+ */
1787
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1780
1788
  /**
1781
1789
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1782
1790
  * @param {object} event Event object
@@ -2203,18 +2211,18 @@ export type BryntumSchedulerProProps = {
2203
2211
  /**
2204
2212
  * Fires before a row is rendered.
2205
2213
  * @param {object} event Event object
2206
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2207
- * @param {Grid.row.Row} event.row The row about to be rendered.
2208
- * @param {Core.data.Model} event.record The record for the row.
2209
- * @param {number} event.recordIndex The zero-based index of the record.
2214
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2215
+ * @param {Grid.row.Row} event.row The row about to be rendered
2216
+ * @param {Core.data.Model} event.record The record for the row
2217
+ * @param {number} event.recordIndex The zero-based index of the record
2210
2218
  */
2211
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2219
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2212
2220
  /**
2213
2221
  * Grid rows are about to be rendered
2214
2222
  * @param {object} event Event object
2215
- * @param {Grid.view.Grid} event.source This grid.
2223
+ * @param {Grid.view.GridBase} event.source This grid.
2216
2224
  */
2217
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
2225
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
2218
2226
  /**
2219
2227
  * Fires on the owning grid before a resource editing starts.
2220
2228
  * This may be listened for to allow an application to take over event editing duties.
@@ -2517,6 +2525,14 @@ export type BryntumSchedulerProProps = {
2517
2525
  * @param {Core.data.Model} event.record The record which has been collapsed.
2518
2526
  */
2519
2527
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2528
+ /**
2529
+ * This event is triggered after a parent column has been collapsed or expanded.
2530
+ * @param {object} event Event object
2531
+ * @param {Grid.view.GridBase} event.source The Grid instance
2532
+ * @param {Grid.column.Column} event.column The column being toggled
2533
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2534
+ */
2535
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2520
2536
  /**
2521
2537
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2522
2538
  * to indicate whether the drop position is valid or not.
@@ -2605,14 +2621,14 @@ export type BryntumSchedulerProProps = {
2605
2621
  * ...
2606
2622
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/view/SchedulerPro#event-dataChange)
2607
2623
  * @param {object} event Event object
2608
- * @param {Grid.view.Grid} event.source Owning grid
2624
+ * @param {Grid.view.GridBase} event.source Owning grid
2609
2625
  * @param {Core.data.Store} event.store The originating store
2610
2626
  * @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'`
2611
2627
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2612
2628
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2613
2629
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2614
2630
  */
2615
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2631
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2616
2632
  /**
2617
2633
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2618
2634
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -3570,18 +3586,18 @@ export type BryntumSchedulerProProps = {
3570
3586
  /**
3571
3587
  * Fires after a row is rendered.
3572
3588
  * @param {object} event Event object
3573
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3574
- * @param {Grid.row.Row} event.row The row that has been rendered.
3575
- * @param {Core.data.Model} event.record The record for the row.
3576
- * @param {number} event.recordIndex The zero-based index of the record.
3589
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3590
+ * @param {Grid.row.Row} event.row The row that has been rendered
3591
+ * @param {Core.data.Model} event.record The record for the row
3592
+ * @param {number} event.recordIndex The zero-based index of the record
3577
3593
  */
3578
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
3594
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
3579
3595
  /**
3580
3596
  * Grid rows have been rendered
3581
3597
  * @param {object} event Event object
3582
- * @param {Grid.view.Grid} event.source This grid.
3598
+ * @param {Grid.view.GridBase} event.source This grid.
3583
3599
  */
3584
- onRenderRows? : ((event: { source: Grid }) => void)|string
3600
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
3585
3601
  /**
3586
3602
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
3587
3603
  * @param {object} event Event object
@@ -4029,10 +4045,10 @@ export type BryntumSchedulerProProps = {
4029
4045
  /**
4030
4046
  * Grid has scrolled vertically
4031
4047
  * @param {object} event Event object
4032
- * @param {Grid.view.Grid} event.source The firing Grid instance.
4048
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
4033
4049
  * @param {number} event.scrollTop The vertical scroll position.
4034
4050
  */
4035
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
4051
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
4036
4052
  /**
4037
4053
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
4038
4054
  * @param {object} event Event object
@@ -4136,17 +4152,17 @@ export type BryntumSchedulerProProps = {
4136
4152
  /**
4137
4153
  * Fires after a sub grid is collapsed.
4138
4154
  * @param {object} event Event object
4139
- * @param {Grid.view.Grid} event.source The firing Grid instance
4155
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
4140
4156
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
4141
4157
  */
4142
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
4158
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
4143
4159
  /**
4144
4160
  * Fires after a sub grid is expanded.
4145
4161
  * @param {object} event Event object
4146
- * @param {Grid.view.Grid} event.source The firing Grid instance
4162
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
4147
4163
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
4148
4164
  */
4149
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
4165
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
4150
4166
  /**
4151
4167
  * Fires on the owning Scheduler or Gantt widget when the editor for an event is canceled.
4152
4168
  * @param {object} event Event object
@@ -5330,6 +5346,7 @@ export class BryntumSchedulerPro extends React.Component<BryntumSchedulerProProp
5330
5346
  'onBeforeCellEditStart',
5331
5347
  'onBeforeCellRangeDelete',
5332
5348
  'onBeforeCellRangeEdit',
5349
+ 'onBeforeColumnCollapseToggle',
5333
5350
  'onBeforeColumnDragStart',
5334
5351
  'onBeforeColumnDropFinalize',
5335
5352
  'onBeforeColumnResize',
@@ -5405,6 +5422,7 @@ export class BryntumSchedulerPro extends React.Component<BryntumSchedulerProProp
5405
5422
  'onCellMouseOver',
5406
5423
  'onCollapse',
5407
5424
  'onCollapseNode',
5425
+ 'onColumnCollapseToggle',
5408
5426
  'onColumnDrag',
5409
5427
  'onColumnDragStart',
5410
5428
  'onColumnDrop',
@@ -1776,6 +1776,14 @@ export type BryntumSchedulerProBaseProps = {
1776
1776
  * @param {any} event.value The value being set
1777
1777
  */
1778
1778
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1779
+ /**
1780
+ * This event is triggered before a parent column is collapsed or expanded.
1781
+ * @param {object} event Event object
1782
+ * @param {Grid.view.GridBase} event.source The grid instance
1783
+ * @param {Grid.column.Column} event.column The column
1784
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1785
+ */
1786
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1779
1787
  /**
1780
1788
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1781
1789
  * @param {object} event Event object
@@ -2202,18 +2210,18 @@ export type BryntumSchedulerProBaseProps = {
2202
2210
  /**
2203
2211
  * Fires before a row is rendered.
2204
2212
  * @param {object} event Event object
2205
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2206
- * @param {Grid.row.Row} event.row The row about to be rendered.
2207
- * @param {Core.data.Model} event.record The record for the row.
2208
- * @param {number} event.recordIndex The zero-based index of the record.
2213
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2214
+ * @param {Grid.row.Row} event.row The row about to be rendered
2215
+ * @param {Core.data.Model} event.record The record for the row
2216
+ * @param {number} event.recordIndex The zero-based index of the record
2209
2217
  */
2210
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2218
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2211
2219
  /**
2212
2220
  * Grid rows are about to be rendered
2213
2221
  * @param {object} event Event object
2214
- * @param {Grid.view.Grid} event.source This grid.
2222
+ * @param {Grid.view.GridBase} event.source This grid.
2215
2223
  */
2216
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
2224
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
2217
2225
  /**
2218
2226
  * Fires on the owning grid before a resource editing starts.
2219
2227
  * This may be listened for to allow an application to take over event editing duties.
@@ -2516,6 +2524,14 @@ export type BryntumSchedulerProBaseProps = {
2516
2524
  * @param {Core.data.Model} event.record The record which has been collapsed.
2517
2525
  */
2518
2526
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2527
+ /**
2528
+ * This event is triggered after a parent column has been collapsed or expanded.
2529
+ * @param {object} event Event object
2530
+ * @param {Grid.view.GridBase} event.source The Grid instance
2531
+ * @param {Grid.column.Column} event.column The column being toggled
2532
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2533
+ */
2534
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2519
2535
  /**
2520
2536
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2521
2537
  * to indicate whether the drop position is valid or not.
@@ -2604,14 +2620,14 @@ export type BryntumSchedulerProBaseProps = {
2604
2620
  * ...
2605
2621
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/view/SchedulerProBase#event-dataChange)
2606
2622
  * @param {object} event Event object
2607
- * @param {Grid.view.Grid} event.source Owning grid
2623
+ * @param {Grid.view.GridBase} event.source Owning grid
2608
2624
  * @param {Core.data.Store} event.store The originating store
2609
2625
  * @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'`
2610
2626
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2611
2627
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2612
2628
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2613
2629
  */
2614
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2630
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2615
2631
  /**
2616
2632
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2617
2633
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -3569,18 +3585,18 @@ export type BryntumSchedulerProBaseProps = {
3569
3585
  /**
3570
3586
  * Fires after a row is rendered.
3571
3587
  * @param {object} event Event object
3572
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3573
- * @param {Grid.row.Row} event.row The row that has been rendered.
3574
- * @param {Core.data.Model} event.record The record for the row.
3575
- * @param {number} event.recordIndex The zero-based index of the record.
3588
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3589
+ * @param {Grid.row.Row} event.row The row that has been rendered
3590
+ * @param {Core.data.Model} event.record The record for the row
3591
+ * @param {number} event.recordIndex The zero-based index of the record
3576
3592
  */
3577
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
3593
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
3578
3594
  /**
3579
3595
  * Grid rows have been rendered
3580
3596
  * @param {object} event Event object
3581
- * @param {Grid.view.Grid} event.source This grid.
3597
+ * @param {Grid.view.GridBase} event.source This grid.
3582
3598
  */
3583
- onRenderRows? : ((event: { source: Grid }) => void)|string
3599
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
3584
3600
  /**
3585
3601
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
3586
3602
  * @param {object} event Event object
@@ -4028,10 +4044,10 @@ export type BryntumSchedulerProBaseProps = {
4028
4044
  /**
4029
4045
  * Grid has scrolled vertically
4030
4046
  * @param {object} event Event object
4031
- * @param {Grid.view.Grid} event.source The firing Grid instance.
4047
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
4032
4048
  * @param {number} event.scrollTop The vertical scroll position.
4033
4049
  */
4034
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
4050
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
4035
4051
  /**
4036
4052
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
4037
4053
  * @param {object} event Event object
@@ -4135,17 +4151,17 @@ export type BryntumSchedulerProBaseProps = {
4135
4151
  /**
4136
4152
  * Fires after a sub grid is collapsed.
4137
4153
  * @param {object} event Event object
4138
- * @param {Grid.view.Grid} event.source The firing Grid instance
4154
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
4139
4155
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
4140
4156
  */
4141
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
4157
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
4142
4158
  /**
4143
4159
  * Fires after a sub grid is expanded.
4144
4160
  * @param {object} event Event object
4145
- * @param {Grid.view.Grid} event.source The firing Grid instance
4161
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
4146
4162
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
4147
4163
  */
4148
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
4164
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
4149
4165
  /**
4150
4166
  * Fires on the owning Scheduler or Gantt widget when the editor for an event is canceled.
4151
4167
  * @param {object} event Event object
@@ -5328,6 +5344,7 @@ export class BryntumSchedulerProBase extends React.Component<BryntumSchedulerPro
5328
5344
  'onBeforeCellEditStart',
5329
5345
  'onBeforeCellRangeDelete',
5330
5346
  'onBeforeCellRangeEdit',
5347
+ 'onBeforeColumnCollapseToggle',
5331
5348
  'onBeforeColumnDragStart',
5332
5349
  'onBeforeColumnDropFinalize',
5333
5350
  'onBeforeColumnResize',
@@ -5403,6 +5420,7 @@ export class BryntumSchedulerProBase extends React.Component<BryntumSchedulerPro
5403
5420
  'onCellMouseOver',
5404
5421
  'onCollapse',
5405
5422
  'onCollapseNode',
5423
+ 'onColumnCollapseToggle',
5406
5424
  'onColumnDrag',
5407
5425
  'onColumnDragStart',
5408
5426
  'onColumnDrop',
@@ -1703,6 +1703,14 @@ export type BryntumTimelineProps = {
1703
1703
  * @param {any} event.value The value being set
1704
1704
  */
1705
1705
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1706
+ /**
1707
+ * This event is triggered before a parent column is collapsed or expanded.
1708
+ * @param {object} event Event object
1709
+ * @param {Grid.view.GridBase} event.source The grid instance
1710
+ * @param {Grid.column.Column} event.column The column
1711
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1712
+ */
1713
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1706
1714
  /**
1707
1715
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1708
1716
  * @param {object} event Event object
@@ -2076,18 +2084,18 @@ export type BryntumTimelineProps = {
2076
2084
  /**
2077
2085
  * Fires before a row is rendered.
2078
2086
  * @param {object} event Event object
2079
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2080
- * @param {Grid.row.Row} event.row The row about to be rendered.
2081
- * @param {Core.data.Model} event.record The record for the row.
2082
- * @param {number} event.recordIndex The zero-based index of the record.
2087
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2088
+ * @param {Grid.row.Row} event.row The row about to be rendered
2089
+ * @param {Core.data.Model} event.record The record for the row
2090
+ * @param {number} event.recordIndex The zero-based index of the record
2083
2091
  */
2084
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2092
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2085
2093
  /**
2086
2094
  * Grid rows are about to be rendered
2087
2095
  * @param {object} event Event object
2088
- * @param {Grid.view.Grid} event.source This grid.
2096
+ * @param {Grid.view.GridBase} event.source This grid.
2089
2097
  */
2090
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
2098
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
2091
2099
  /**
2092
2100
  * This event fires before row collapse is started.
2093
2101
  * ...
@@ -2336,6 +2344,14 @@ export type BryntumTimelineProps = {
2336
2344
  * @param {Core.data.Model} event.record The record which has been collapsed.
2337
2345
  */
2338
2346
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2347
+ /**
2348
+ * This event is triggered after a parent column has been collapsed or expanded.
2349
+ * @param {object} event Event object
2350
+ * @param {Grid.view.GridBase} event.source The Grid instance
2351
+ * @param {Grid.column.Column} event.column The column being toggled
2352
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2353
+ */
2354
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2339
2355
  /**
2340
2356
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2341
2357
  * to indicate whether the drop position is valid or not.
@@ -2424,14 +2440,14 @@ export type BryntumTimelineProps = {
2424
2440
  * ...
2425
2441
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/SchedulerPro/widget/Timeline#event-dataChange)
2426
2442
  * @param {object} event Event object
2427
- * @param {Grid.view.Grid} event.source Owning grid
2443
+ * @param {Grid.view.GridBase} event.source Owning grid
2428
2444
  * @param {Core.data.Store} event.store The originating store
2429
2445
  * @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'`
2430
2446
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2431
2447
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2432
2448
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2433
2449
  */
2434
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2450
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2435
2451
  /**
2436
2452
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2437
2453
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -3290,18 +3306,18 @@ export type BryntumTimelineProps = {
3290
3306
  /**
3291
3307
  * Fires after a row is rendered.
3292
3308
  * @param {object} event Event object
3293
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3294
- * @param {Grid.row.Row} event.row The row that has been rendered.
3295
- * @param {Core.data.Model} event.record The record for the row.
3296
- * @param {number} event.recordIndex The zero-based index of the record.
3309
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3310
+ * @param {Grid.row.Row} event.row The row that has been rendered
3311
+ * @param {Core.data.Model} event.record The record for the row
3312
+ * @param {number} event.recordIndex The zero-based index of the record
3297
3313
  */
3298
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
3314
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
3299
3315
  /**
3300
3316
  * Grid rows have been rendered
3301
3317
  * @param {object} event Event object
3302
- * @param {Grid.view.Grid} event.source This grid.
3318
+ * @param {Grid.view.GridBase} event.source This grid.
3303
3319
  */
3304
- onRenderRows? : ((event: { source: Grid }) => void)|string
3320
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
3305
3321
  /**
3306
3322
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/gantt/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
3307
3323
  * @param {object} event Event object
@@ -3643,10 +3659,10 @@ export type BryntumTimelineProps = {
3643
3659
  /**
3644
3660
  * Grid has scrolled vertically
3645
3661
  * @param {object} event Event object
3646
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3662
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
3647
3663
  * @param {number} event.scrollTop The vertical scroll position.
3648
3664
  */
3649
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
3665
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
3650
3666
  /**
3651
3667
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
3652
3668
  * @param {object} event Event object
@@ -3750,17 +3766,17 @@ export type BryntumTimelineProps = {
3750
3766
  /**
3751
3767
  * Fires after a sub grid is collapsed.
3752
3768
  * @param {object} event Event object
3753
- * @param {Grid.view.Grid} event.source The firing Grid instance
3769
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3754
3770
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3755
3771
  */
3756
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3772
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3757
3773
  /**
3758
3774
  * Fires after a sub grid is expanded.
3759
3775
  * @param {object} event Event object
3760
- * @param {Grid.view.Grid} event.source The firing Grid instance
3776
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3761
3777
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3762
3778
  */
3763
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3779
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3764
3780
  /**
3765
3781
  * Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
3766
3782
  * `[enableMouseEvents](https://bryntum.com/products/gantt/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
@@ -4723,6 +4739,7 @@ export class BryntumTimeline extends React.Component<BryntumTimelineProps> {
4723
4739
  'onBeforeCellEditStart',
4724
4740
  'onBeforeCellRangeDelete',
4725
4741
  'onBeforeCellRangeEdit',
4742
+ 'onBeforeColumnCollapseToggle',
4726
4743
  'onBeforeColumnDragStart',
4727
4744
  'onBeforeColumnDropFinalize',
4728
4745
  'onBeforeColumnResize',
@@ -4788,6 +4805,7 @@ export class BryntumTimeline extends React.Component<BryntumTimelineProps> {
4788
4805
  'onCellMouseOver',
4789
4806
  'onCollapse',
4790
4807
  'onCollapseNode',
4808
+ 'onColumnCollapseToggle',
4791
4809
  'onColumnDrag',
4792
4810
  'onColumnDragStart',
4793
4811
  'onColumnDrop',