@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
@@ -1415,6 +1415,14 @@ export type BryntumGanttProps = {
1415
1415
  * @param {any} event.value The value being set
1416
1416
  */
1417
1417
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1418
+ /**
1419
+ * This event is triggered before a parent column is collapsed or expanded.
1420
+ * @param {object} event Event object
1421
+ * @param {Grid.view.GridBase} event.source The grid instance
1422
+ * @param {Grid.column.Column} event.column The column
1423
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1424
+ */
1425
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1418
1426
  /**
1419
1427
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1420
1428
  * @param {object} event Event object
@@ -1760,18 +1768,18 @@ export type BryntumGanttProps = {
1760
1768
  /**
1761
1769
  * Fires before a row is rendered.
1762
1770
  * @param {object} event Event object
1763
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1764
- * @param {Grid.row.Row} event.row The row about to be rendered.
1765
- * @param {Core.data.Model} event.record The record for the row.
1766
- * @param {number} event.recordIndex The zero-based index of the record.
1771
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1772
+ * @param {Grid.row.Row} event.row The row about to be rendered
1773
+ * @param {Core.data.Model} event.record The record for the row
1774
+ * @param {number} event.recordIndex The zero-based index of the record
1767
1775
  */
1768
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1776
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
1769
1777
  /**
1770
1778
  * Grid rows are about to be rendered
1771
1779
  * @param {object} event Event object
1772
- * @param {Grid.view.Grid} event.source This grid.
1780
+ * @param {Grid.view.GridBase} event.source This grid.
1773
1781
  */
1774
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1782
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
1775
1783
  /**
1776
1784
  * This event fires before row collapse is started.
1777
1785
  * ...
@@ -2149,6 +2157,14 @@ export type BryntumGanttProps = {
2149
2157
  * @param {Core.data.Model} event.record The record which has been collapsed.
2150
2158
  */
2151
2159
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2160
+ /**
2161
+ * This event is triggered after a parent column has been collapsed or expanded.
2162
+ * @param {object} event Event object
2163
+ * @param {Grid.view.GridBase} event.source The Grid instance
2164
+ * @param {Grid.column.Column} event.column The column being toggled
2165
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2166
+ */
2167
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2152
2168
  /**
2153
2169
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2154
2170
  * to indicate whether the drop position is valid or not.
@@ -2249,14 +2265,14 @@ export type BryntumGanttProps = {
2249
2265
  * ...
2250
2266
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/Gantt#event-dataChange)
2251
2267
  * @param {object} event Event object
2252
- * @param {Grid.view.Grid} event.source Owning grid
2268
+ * @param {Grid.view.GridBase} event.source Owning grid
2253
2269
  * @param {Core.data.Store} event.store The originating store
2254
2270
  * @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'`
2255
2271
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2256
2272
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2257
2273
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2258
2274
  */
2259
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2275
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2260
2276
  /**
2261
2277
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2262
2278
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -2860,18 +2876,18 @@ export type BryntumGanttProps = {
2860
2876
  /**
2861
2877
  * Fires after a row is rendered.
2862
2878
  * @param {object} event Event object
2863
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2864
- * @param {Grid.row.Row} event.row The row that has been rendered.
2865
- * @param {Core.data.Model} event.record The record for the row.
2866
- * @param {number} event.recordIndex The zero-based index of the record.
2879
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2880
+ * @param {Grid.row.Row} event.row The row that has been rendered
2881
+ * @param {Core.data.Model} event.record The record for the row
2882
+ * @param {number} event.recordIndex The zero-based index of the record
2867
2883
  */
2868
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2884
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2869
2885
  /**
2870
2886
  * Grid rows have been rendered
2871
2887
  * @param {object} event Event object
2872
- * @param {Grid.view.Grid} event.source This grid.
2888
+ * @param {Grid.view.GridBase} event.source This grid.
2873
2889
  */
2874
- onRenderRows? : ((event: { source: Grid }) => void)|string
2890
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
2875
2891
  /**
2876
2892
  * Task is rendered, its element is available in DOM.
2877
2893
  * @param {object} event Event object
@@ -2983,10 +2999,10 @@ export type BryntumGanttProps = {
2983
2999
  /**
2984
3000
  * Grid has scrolled vertically
2985
3001
  * @param {object} event Event object
2986
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3002
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
2987
3003
  * @param {number} event.scrollTop The vertical scroll position.
2988
3004
  */
2989
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
3005
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
2990
3006
  /**
2991
3007
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
2992
3008
  * @param {object} event Event object
@@ -3081,17 +3097,17 @@ export type BryntumGanttProps = {
3081
3097
  /**
3082
3098
  * Fires after a sub grid is collapsed.
3083
3099
  * @param {object} event Event object
3084
- * @param {Grid.view.Grid} event.source The firing Grid instance
3100
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3085
3101
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3086
3102
  */
3087
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3103
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3088
3104
  /**
3089
3105
  * Fires after a sub grid is expanded.
3090
3106
  * @param {object} event Event object
3091
- * @param {Grid.view.Grid} event.source The firing Grid instance
3107
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3092
3108
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3093
3109
  */
3094
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3110
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3095
3111
  /**
3096
3112
  * Triggered after a click on a task bar.
3097
3113
  * @param {object} event Event object
@@ -3539,7 +3555,8 @@ export type BryntumGanttProps = {
3539
3555
  */
3540
3556
  cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
3541
3557
  /**
3542
- * Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by <b>default</b>
3558
+ * Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by
3559
+ * <b>default</b>
3543
3560
  * ...
3544
3561
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
3545
3562
  */
@@ -4360,6 +4377,7 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
4360
4377
  'onBeforeCellEditStart',
4361
4378
  'onBeforeCellRangeDelete',
4362
4379
  'onBeforeCellRangeEdit',
4380
+ 'onBeforeColumnCollapseToggle',
4363
4381
  'onBeforeColumnDragStart',
4364
4382
  'onBeforeColumnDropFinalize',
4365
4383
  'onBeforeColumnResize',
@@ -4437,6 +4455,7 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
4437
4455
  'onCellMouseOver',
4438
4456
  'onCollapse',
4439
4457
  'onCollapseNode',
4458
+ 'onColumnCollapseToggle',
4440
4459
  'onColumnDrag',
4441
4460
  'onColumnDragStart',
4442
4461
  'onColumnDrop',
@@ -1414,6 +1414,14 @@ export type BryntumGanttBaseProps = {
1414
1414
  * @param {any} event.value The value being set
1415
1415
  */
1416
1416
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
1417
+ /**
1418
+ * This event is triggered before a parent column is collapsed or expanded.
1419
+ * @param {object} event Event object
1420
+ * @param {Grid.view.GridBase} event.source The grid instance
1421
+ * @param {Grid.column.Column} event.column The column
1422
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
1423
+ */
1424
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1417
1425
  /**
1418
1426
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
1419
1427
  * @param {object} event Event object
@@ -1759,18 +1767,18 @@ export type BryntumGanttBaseProps = {
1759
1767
  /**
1760
1768
  * Fires before a row is rendered.
1761
1769
  * @param {object} event Event object
1762
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1763
- * @param {Grid.row.Row} event.row The row about to be rendered.
1764
- * @param {Core.data.Model} event.record The record for the row.
1765
- * @param {number} event.recordIndex The zero-based index of the record.
1770
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1771
+ * @param {Grid.row.Row} event.row The row about to be rendered
1772
+ * @param {Core.data.Model} event.record The record for the row
1773
+ * @param {number} event.recordIndex The zero-based index of the record
1766
1774
  */
1767
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1775
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
1768
1776
  /**
1769
1777
  * Grid rows are about to be rendered
1770
1778
  * @param {object} event Event object
1771
- * @param {Grid.view.Grid} event.source This grid.
1779
+ * @param {Grid.view.GridBase} event.source This grid.
1772
1780
  */
1773
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
1781
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
1774
1782
  /**
1775
1783
  * This event fires before row collapse is started.
1776
1784
  * ...
@@ -2148,6 +2156,14 @@ export type BryntumGanttBaseProps = {
2148
2156
  * @param {Core.data.Model} event.record The record which has been collapsed.
2149
2157
  */
2150
2158
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
2159
+ /**
2160
+ * This event is triggered after a parent column has been collapsed or expanded.
2161
+ * @param {object} event Event object
2162
+ * @param {Grid.view.GridBase} event.source The Grid instance
2163
+ * @param {Grid.column.Column} event.column The column being toggled
2164
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
2165
+ */
2166
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
2151
2167
  /**
2152
2168
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
2153
2169
  * to indicate whether the drop position is valid or not.
@@ -2248,14 +2264,14 @@ export type BryntumGanttBaseProps = {
2248
2264
  * ...
2249
2265
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/view/GanttBase#event-dataChange)
2250
2266
  * @param {object} event Event object
2251
- * @param {Grid.view.Grid} event.source Owning grid
2267
+ * @param {Grid.view.GridBase} event.source Owning grid
2252
2268
  * @param {Core.data.Store} event.store The originating store
2253
2269
  * @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'`
2254
2270
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
2255
2271
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
2256
2272
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
2257
2273
  */
2258
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2274
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
2259
2275
  /**
2260
2276
  * Fired when the range of dates encapsulated by the UI changes. This will be when
2261
2277
  * moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/gantt/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
@@ -2859,18 +2875,18 @@ export type BryntumGanttBaseProps = {
2859
2875
  /**
2860
2876
  * Fires after a row is rendered.
2861
2877
  * @param {object} event Event object
2862
- * @param {Grid.view.Grid} event.source The firing Grid instance.
2863
- * @param {Grid.row.Row} event.row The row that has been rendered.
2864
- * @param {Core.data.Model} event.record The record for the row.
2865
- * @param {number} event.recordIndex The zero-based index of the record.
2878
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
2879
+ * @param {Grid.row.Row} event.row The row that has been rendered
2880
+ * @param {Core.data.Model} event.record The record for the row
2881
+ * @param {number} event.recordIndex The zero-based index of the record
2866
2882
  */
2867
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
2883
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
2868
2884
  /**
2869
2885
  * Grid rows have been rendered
2870
2886
  * @param {object} event Event object
2871
- * @param {Grid.view.Grid} event.source This grid.
2887
+ * @param {Grid.view.GridBase} event.source This grid.
2872
2888
  */
2873
- onRenderRows? : ((event: { source: Grid }) => void)|string
2889
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
2874
2890
  /**
2875
2891
  * Task is rendered, its element is available in DOM.
2876
2892
  * @param {object} event Event object
@@ -2982,10 +2998,10 @@ export type BryntumGanttBaseProps = {
2982
2998
  /**
2983
2999
  * Grid has scrolled vertically
2984
3000
  * @param {object} event Event object
2985
- * @param {Grid.view.Grid} event.source The firing Grid instance.
3001
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
2986
3002
  * @param {number} event.scrollTop The vertical scroll position.
2987
3003
  */
2988
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
3004
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
2989
3005
  /**
2990
3006
  * Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
2991
3007
  * @param {object} event Event object
@@ -3080,17 +3096,17 @@ export type BryntumGanttBaseProps = {
3080
3096
  /**
3081
3097
  * Fires after a sub grid is collapsed.
3082
3098
  * @param {object} event Event object
3083
- * @param {Grid.view.Grid} event.source The firing Grid instance
3099
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3084
3100
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3085
3101
  */
3086
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3102
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3087
3103
  /**
3088
3104
  * Fires after a sub grid is expanded.
3089
3105
  * @param {object} event Event object
3090
- * @param {Grid.view.Grid} event.source The firing Grid instance
3106
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
3091
3107
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
3092
3108
  */
3093
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
3109
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
3094
3110
  /**
3095
3111
  * Triggered after a click on a task bar.
3096
3112
  * @param {object} event Event object
@@ -3538,7 +3554,8 @@ export type BryntumGanttBaseProps = {
3538
3554
  */
3539
3555
  cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
3540
3556
  /**
3541
- * Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by <b>default</b>
3557
+ * Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by
3558
+ * <b>default</b>
3542
3559
  * ...
3543
3560
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
3544
3561
  */
@@ -4358,6 +4375,7 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
4358
4375
  'onBeforeCellEditStart',
4359
4376
  'onBeforeCellRangeDelete',
4360
4377
  'onBeforeCellRangeEdit',
4378
+ 'onBeforeColumnCollapseToggle',
4361
4379
  'onBeforeColumnDragStart',
4362
4380
  'onBeforeColumnDropFinalize',
4363
4381
  'onBeforeColumnResize',
@@ -4435,6 +4453,7 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
4435
4453
  'onCellMouseOver',
4436
4454
  'onCollapse',
4437
4455
  'onCollapseNode',
4456
+ 'onColumnCollapseToggle',
4438
4457
  'onColumnDrag',
4439
4458
  'onColumnDragStart',
4440
4459
  'onColumnDrop',
@@ -790,6 +790,14 @@ export type BryntumGridProps = {
790
790
  * @param {any} event.value The value being set
791
791
  */
792
792
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
793
+ /**
794
+ * This event is triggered before a parent column is collapsed or expanded.
795
+ * @param {object} event Event object
796
+ * @param {Grid.view.GridBase} event.source The grid instance
797
+ * @param {Grid.column.Column} event.column The column
798
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
799
+ */
800
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
793
801
  /**
794
802
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
795
803
  * @param {object} event Event object
@@ -900,18 +908,18 @@ export type BryntumGridProps = {
900
908
  /**
901
909
  * Fires before a row is rendered.
902
910
  * @param {object} event Event object
903
- * @param {Grid.view.Grid} event.source The firing Grid instance.
904
- * @param {Grid.row.Row} event.row The row about to be rendered.
905
- * @param {Core.data.Model} event.record The record for the row.
906
- * @param {number} event.recordIndex The zero-based index of the record.
911
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
912
+ * @param {Grid.row.Row} event.row The row about to be rendered
913
+ * @param {Core.data.Model} event.record The record for the row
914
+ * @param {number} event.recordIndex The zero-based index of the record
907
915
  */
908
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
916
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
909
917
  /**
910
918
  * Grid rows are about to be rendered
911
919
  * @param {object} event Event object
912
- * @param {Grid.view.Grid} event.source This grid.
920
+ * @param {Grid.view.GridBase} event.source This grid.
913
921
  */
914
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
922
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
915
923
  /**
916
924
  * This event fires before row collapse is started.
917
925
  * ...
@@ -1142,6 +1150,14 @@ export type BryntumGridProps = {
1142
1150
  * @param {Core.data.Model} event.record The record which has been collapsed.
1143
1151
  */
1144
1152
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
1153
+ /**
1154
+ * This event is triggered after a parent column has been collapsed or expanded.
1155
+ * @param {object} event Event object
1156
+ * @param {Grid.view.GridBase} event.source The Grid instance
1157
+ * @param {Grid.column.Column} event.column The column being toggled
1158
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
1159
+ */
1160
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1145
1161
  /**
1146
1162
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1147
1163
  * to indicate whether the drop position is valid or not.
@@ -1223,14 +1239,14 @@ export type BryntumGridProps = {
1223
1239
  * ...
1224
1240
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/view/Grid#event-dataChange)
1225
1241
  * @param {object} event Event object
1226
- * @param {Grid.view.Grid} event.source Owning grid
1242
+ * @param {Grid.view.GridBase} event.source Owning grid
1227
1243
  * @param {Core.data.Store} event.store The originating store
1228
1244
  * @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'`
1229
1245
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
1230
1246
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
1231
1247
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
1232
1248
  */
1233
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1249
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1234
1250
  /**
1235
1251
  * Fires when an object is destroyed.
1236
1252
  * @param {object} event Event object
@@ -1538,18 +1554,18 @@ export type BryntumGridProps = {
1538
1554
  /**
1539
1555
  * Fires after a row is rendered.
1540
1556
  * @param {object} event Event object
1541
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1542
- * @param {Grid.row.Row} event.row The row that has been rendered.
1543
- * @param {Core.data.Model} event.record The record for the row.
1544
- * @param {number} event.recordIndex The zero-based index of the record.
1557
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1558
+ * @param {Grid.row.Row} event.row The row that has been rendered
1559
+ * @param {Core.data.Model} event.record The record for the row
1560
+ * @param {number} event.recordIndex The zero-based index of the record
1545
1561
  */
1546
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1562
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
1547
1563
  /**
1548
1564
  * Grid rows have been rendered
1549
1565
  * @param {object} event Event object
1550
- * @param {Grid.view.Grid} event.source This grid.
1566
+ * @param {Grid.view.GridBase} event.source This grid.
1551
1567
  */
1552
- onRenderRows? : ((event: { source: Grid }) => void)|string
1568
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
1553
1569
  /**
1554
1570
  * 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`*.
1555
1571
  * @param {object} event Event object
@@ -1609,10 +1625,10 @@ export type BryntumGridProps = {
1609
1625
  /**
1610
1626
  * Grid has scrolled vertically
1611
1627
  * @param {object} event Event object
1612
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1628
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
1613
1629
  * @param {number} event.scrollTop The vertical scroll position.
1614
1630
  */
1615
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
1631
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
1616
1632
  /**
1617
1633
  * The selection has been changed.
1618
1634
  * @param {object} event Event object
@@ -1700,17 +1716,17 @@ export type BryntumGridProps = {
1700
1716
  /**
1701
1717
  * Fires after a sub grid is collapsed.
1702
1718
  * @param {object} event Event object
1703
- * @param {Grid.view.Grid} event.source The firing Grid instance
1719
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1704
1720
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1705
1721
  */
1706
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1722
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
1707
1723
  /**
1708
1724
  * Fires after a sub grid is expanded.
1709
1725
  * @param {object} event Event object
1710
- * @param {Grid.view.Grid} event.source The firing Grid instance
1726
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1711
1727
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1712
1728
  */
1713
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1729
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
1714
1730
  /**
1715
1731
  * Fired when one or more groups are expanded or collapsed
1716
1732
  * @param {object} event Event object
@@ -2217,6 +2233,7 @@ export class BryntumGrid extends React.Component<BryntumGridProps> {
2217
2233
  'onBeforeCellEditStart',
2218
2234
  'onBeforeCellRangeDelete',
2219
2235
  'onBeforeCellRangeEdit',
2236
+ 'onBeforeColumnCollapseToggle',
2220
2237
  'onBeforeColumnDragStart',
2221
2238
  'onBeforeColumnDropFinalize',
2222
2239
  'onBeforeColumnResize',
@@ -2257,6 +2274,7 @@ export class BryntumGrid extends React.Component<BryntumGridProps> {
2257
2274
  'onCellMouseOver',
2258
2275
  'onCollapse',
2259
2276
  'onCollapseNode',
2277
+ 'onColumnCollapseToggle',
2260
2278
  'onColumnDrag',
2261
2279
  'onColumnDragStart',
2262
2280
  'onColumnDrop',
@@ -789,6 +789,14 @@ export type BryntumGridBaseProps = {
789
789
  * @param {any} event.value The value being set
790
790
  */
791
791
  onBeforeCellRangeEdit? : ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
792
+ /**
793
+ * This event is triggered before a parent column is collapsed or expanded.
794
+ * @param {object} event Event object
795
+ * @param {Grid.view.GridBase} event.source The grid instance
796
+ * @param {Grid.column.Column} event.column The column
797
+ * @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
798
+ */
799
+ onBeforeColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
792
800
  /**
793
801
  * This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
794
802
  * @param {object} event Event object
@@ -899,18 +907,18 @@ export type BryntumGridBaseProps = {
899
907
  /**
900
908
  * Fires before a row is rendered.
901
909
  * @param {object} event Event object
902
- * @param {Grid.view.Grid} event.source The firing Grid instance.
903
- * @param {Grid.row.Row} event.row The row about to be rendered.
904
- * @param {Core.data.Model} event.record The record for the row.
905
- * @param {number} event.recordIndex The zero-based index of the record.
910
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
911
+ * @param {Grid.row.Row} event.row The row about to be rendered
912
+ * @param {Core.data.Model} event.record The record for the row
913
+ * @param {number} event.recordIndex The zero-based index of the record
906
914
  */
907
- onBeforeRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
915
+ onBeforeRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
908
916
  /**
909
917
  * Grid rows are about to be rendered
910
918
  * @param {object} event Event object
911
- * @param {Grid.view.Grid} event.source This grid.
919
+ * @param {Grid.view.GridBase} event.source This grid.
912
920
  */
913
- onBeforeRenderRows? : ((event: { source: Grid }) => void)|string
921
+ onBeforeRenderRows? : ((event: { source: GridBase }) => void)|string
914
922
  /**
915
923
  * This event fires before row collapse is started.
916
924
  * ...
@@ -1141,6 +1149,14 @@ export type BryntumGridBaseProps = {
1141
1149
  * @param {Core.data.Model} event.record The record which has been collapsed.
1142
1150
  */
1143
1151
  onCollapseNode? : ((event: { source: Grid, record: Model }) => void)|string
1152
+ /**
1153
+ * This event is triggered after a parent column has been collapsed or expanded.
1154
+ * @param {object} event Event object
1155
+ * @param {Grid.view.GridBase} event.source The Grid instance
1156
+ * @param {Grid.column.Column} event.column The column being toggled
1157
+ * @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
1158
+ */
1159
+ onColumnCollapseToggle? : ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
1144
1160
  /**
1145
1161
  * This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
1146
1162
  * to indicate whether the drop position is valid or not.
@@ -1222,14 +1238,14 @@ export type BryntumGridBaseProps = {
1222
1238
  * ...
1223
1239
  * [View online docs...](https://bryntum.com/products/gantt/docs/api/Grid/view/GridBase#event-dataChange)
1224
1240
  * @param {object} event Event object
1225
- * @param {Grid.view.Grid} event.source Owning grid
1241
+ * @param {Grid.view.GridBase} event.source Owning grid
1226
1242
  * @param {Core.data.Store} event.store The originating store
1227
1243
  * @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'`
1228
1244
  * @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
1229
1245
  * @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
1230
1246
  * @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
1231
1247
  */
1232
- onDataChange? : ((event: { source: Grid, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1248
+ onDataChange? : ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
1233
1249
  /**
1234
1250
  * Fires when an object is destroyed.
1235
1251
  * @param {object} event Event object
@@ -1537,18 +1553,18 @@ export type BryntumGridBaseProps = {
1537
1553
  /**
1538
1554
  * Fires after a row is rendered.
1539
1555
  * @param {object} event Event object
1540
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1541
- * @param {Grid.row.Row} event.row The row that has been rendered.
1542
- * @param {Core.data.Model} event.record The record for the row.
1543
- * @param {number} event.recordIndex The zero-based index of the record.
1556
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1557
+ * @param {Grid.row.Row} event.row The row that has been rendered
1558
+ * @param {Core.data.Model} event.record The record for the row
1559
+ * @param {number} event.recordIndex The zero-based index of the record
1544
1560
  */
1545
- onRenderRow? : ((event: { source: Grid, row: Row, record: Model, recordIndex: number }) => void)|string
1561
+ onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
1546
1562
  /**
1547
1563
  * Grid rows have been rendered
1548
1564
  * @param {object} event Event object
1549
- * @param {Grid.view.Grid} event.source This grid.
1565
+ * @param {Grid.view.GridBase} event.source This grid.
1550
1566
  */
1551
- onRenderRows? : ((event: { source: Grid }) => void)|string
1567
+ onRenderRows? : ((event: { source: GridBase }) => void)|string
1552
1568
  /**
1553
1569
  * 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`*.
1554
1570
  * @param {object} event Event object
@@ -1608,10 +1624,10 @@ export type BryntumGridBaseProps = {
1608
1624
  /**
1609
1625
  * Grid has scrolled vertically
1610
1626
  * @param {object} event Event object
1611
- * @param {Grid.view.Grid} event.source The firing Grid instance.
1627
+ * @param {Grid.view.GridBase} event.source The firing Grid instance.
1612
1628
  * @param {number} event.scrollTop The vertical scroll position.
1613
1629
  */
1614
- onScroll? : ((event: { source: Grid, scrollTop: number }) => void)|string
1630
+ onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
1615
1631
  /**
1616
1632
  * The selection has been changed.
1617
1633
  * @param {object} event Event object
@@ -1699,17 +1715,17 @@ export type BryntumGridBaseProps = {
1699
1715
  /**
1700
1716
  * Fires after a sub grid is collapsed.
1701
1717
  * @param {object} event Event object
1702
- * @param {Grid.view.Grid} event.source The firing Grid instance
1718
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1703
1719
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1704
1720
  */
1705
- onSubGridCollapse? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1721
+ onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
1706
1722
  /**
1707
1723
  * Fires after a sub grid is expanded.
1708
1724
  * @param {object} event Event object
1709
- * @param {Grid.view.Grid} event.source The firing Grid instance
1725
+ * @param {Grid.view.GridBase} event.source The firing Grid instance
1710
1726
  * @param {Grid.view.SubGrid} event.subGrid The sub grid instance
1711
1727
  */
1712
- onSubGridExpand? : ((event: { source: Grid, subGrid: SubGrid }) => void)|string
1728
+ onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
1713
1729
  /**
1714
1730
  * Fired when one or more groups are expanded or collapsed
1715
1731
  * @param {object} event Event object
@@ -2214,6 +2230,7 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2214
2230
  'onBeforeCellEditStart',
2215
2231
  'onBeforeCellRangeDelete',
2216
2232
  'onBeforeCellRangeEdit',
2233
+ 'onBeforeColumnCollapseToggle',
2217
2234
  'onBeforeColumnDragStart',
2218
2235
  'onBeforeColumnDropFinalize',
2219
2236
  'onBeforeColumnResize',
@@ -2254,6 +2271,7 @@ export class BryntumGridBase extends React.Component<BryntumGridBaseProps> {
2254
2271
  'onCellMouseOver',
2255
2272
  'onCollapse',
2256
2273
  'onCollapseNode',
2274
+ 'onColumnCollapseToggle',
2257
2275
  'onColumnDrag',
2258
2276
  'onColumnDragStart',
2259
2277
  'onColumnDrop',