@bryntum/gantt-react 7.1.1 → 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 +199 -21
- package/lib/BryntumAssignmentGrid.d.ts +20 -10
- package/lib/BryntumAssignmentGrid.js +2 -0
- package/lib/BryntumAssignmentGrid.js.map +1 -1
- package/lib/BryntumAssignmentPicker.d.ts +253 -0
- package/lib/BryntumAssignmentPicker.js +182 -0
- package/lib/BryntumAssignmentPicker.js.map +1 -0
- package/lib/BryntumGantt.d.ts +23 -9
- package/lib/BryntumGantt.js +4 -2
- package/lib/BryntumGantt.js.map +1 -1
- package/lib/BryntumGanttBase.d.ts +23 -9
- package/lib/BryntumGanttBase.js +4 -2
- package/lib/BryntumGanttBase.js.map +1 -1
- package/lib/BryntumGrid.d.ts +20 -10
- package/lib/BryntumGrid.js +2 -0
- package/lib/BryntumGrid.js.map +1 -1
- package/lib/BryntumGridBase.d.ts +20 -10
- package/lib/BryntumGridBase.js +2 -0
- package/lib/BryntumGridBase.js.map +1 -1
- package/lib/BryntumResourceGrid.d.ts +20 -10
- package/lib/BryntumResourceGrid.js +2 -0
- package/lib/BryntumResourceGrid.js.map +1 -1
- package/lib/BryntumResourceHistogram.d.ts +20 -10
- package/lib/BryntumResourceHistogram.js +4 -2
- package/lib/BryntumResourceHistogram.js.map +1 -1
- package/lib/BryntumResourceUtilization.d.ts +20 -10
- package/lib/BryntumResourceUtilization.js +4 -2
- package/lib/BryntumResourceUtilization.js.map +1 -1
- package/lib/BryntumScheduler.d.ts +24 -10
- package/lib/BryntumScheduler.js +4 -2
- package/lib/BryntumScheduler.js.map +1 -1
- package/lib/BryntumSchedulerBase.d.ts +24 -10
- package/lib/BryntumSchedulerBase.js +4 -2
- package/lib/BryntumSchedulerBase.js.map +1 -1
- package/lib/BryntumSchedulerPro.d.ts +24 -10
- package/lib/BryntumSchedulerPro.js +4 -2
- package/lib/BryntumSchedulerPro.js.map +1 -1
- package/lib/BryntumSchedulerProBase.d.ts +24 -10
- package/lib/BryntumSchedulerProBase.js +4 -2
- package/lib/BryntumSchedulerProBase.js.map +1 -1
- package/lib/BryntumTimeline.d.ts +24 -10
- package/lib/BryntumTimeline.js +4 -2
- package/lib/BryntumTimeline.js.map +1 -1
- package/lib/BryntumTimelineHistogram.d.ts +20 -10
- package/lib/BryntumTimelineHistogram.js +4 -2
- package/lib/BryntumTimelineHistogram.js.map +1 -1
- package/lib/BryntumTreeGrid.d.ts +20 -10
- package/lib/BryntumTreeGrid.js +2 -0
- package/lib/BryntumTreeGrid.js.map +1 -1
- package/lib/BryntumVersionGrid.d.ts +20 -10
- package/lib/BryntumVersionGrid.js +2 -0
- package/lib/BryntumVersionGrid.js.map +1 -1
- package/lib/WrapperHelper.js +1 -1
- package/lib/WrapperHelper.js.map +1 -1
- package/lib/index.d.ts +1 -0
- package/lib/index.js +1 -0
- package/lib/index.js.map +1 -1
- package/package.json +1 -1
- package/src/BryntumAssignmentGrid.tsx +43 -25
- package/src/BryntumAssignmentPicker.tsx +1109 -0
- package/src/BryntumGantt.tsx +52 -29
- package/src/BryntumGanttBase.tsx +52 -29
- package/src/BryntumGrid.tsx +43 -25
- package/src/BryntumGridBase.tsx +43 -25
- package/src/BryntumResourceGrid.tsx +43 -25
- package/src/BryntumResourceHistogram.tsx +45 -27
- package/src/BryntumResourceUtilization.tsx +45 -27
- package/src/BryntumScheduler.tsx +51 -29
- package/src/BryntumSchedulerBase.tsx +51 -29
- package/src/BryntumSchedulerPro.tsx +51 -29
- package/src/BryntumSchedulerProBase.tsx +51 -29
- package/src/BryntumTimeline.tsx +51 -29
- package/src/BryntumTimelineHistogram.tsx +45 -27
- package/src/BryntumTreeGrid.tsx +43 -25
- package/src/BryntumVersionGrid.tsx +43 -25
- package/src/WrapperHelper.tsx +2 -1
- package/src/index.ts +1 -0
package/src/BryntumGantt.tsx
CHANGED
|
@@ -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
|
|
@@ -1712,9 +1720,9 @@ export type BryntumGanttProps = {
|
|
|
1712
1720
|
/**
|
|
1713
1721
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
1714
1722
|
* @param {object} event Event object
|
|
1715
|
-
* @param {
|
|
1723
|
+
* @param {PdfExportConfig} event.config Export config
|
|
1716
1724
|
*/
|
|
1717
|
-
onBeforePdfExport? : ((event: { config:
|
|
1725
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
1718
1726
|
/**
|
|
1719
1727
|
* Fired before the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
1720
1728
|
* @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.
|
|
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:
|
|
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.
|
|
1780
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1773
1781
|
*/
|
|
1774
|
-
onBeforeRenderRows? : ((event: { source:
|
|
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.
|
|
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:
|
|
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
|
|
@@ -2337,16 +2353,20 @@ export type BryntumGanttProps = {
|
|
|
2337
2353
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
2338
2354
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
2339
2355
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
2356
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
2357
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
2340
2358
|
*/
|
|
2341
|
-
onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
2359
|
+
onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
2342
2360
|
/**
|
|
2343
2361
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
2344
2362
|
* @param {object} event Event object
|
|
2345
2363
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
2346
2364
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
2347
2365
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
2366
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
2367
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
2348
2368
|
*/
|
|
2349
|
-
onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
2369
|
+
onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
2350
2370
|
/**
|
|
2351
2371
|
* Fires when an object is destroyed.
|
|
2352
2372
|
* @param {object} event Event object
|
|
@@ -2856,18 +2876,18 @@ export type BryntumGanttProps = {
|
|
|
2856
2876
|
/**
|
|
2857
2877
|
* Fires after a row is rendered.
|
|
2858
2878
|
* @param {object} event Event object
|
|
2859
|
-
* @param {Grid.view.
|
|
2860
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2861
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
2862
|
-
* @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
|
|
2863
2883
|
*/
|
|
2864
|
-
onRenderRow? : ((event: { source:
|
|
2884
|
+
onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
2865
2885
|
/**
|
|
2866
2886
|
* Grid rows have been rendered
|
|
2867
2887
|
* @param {object} event Event object
|
|
2868
|
-
* @param {Grid.view.
|
|
2888
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
2869
2889
|
*/
|
|
2870
|
-
onRenderRows? : ((event: { source:
|
|
2890
|
+
onRenderRows? : ((event: { source: GridBase }) => void)|string
|
|
2871
2891
|
/**
|
|
2872
2892
|
* Task is rendered, its element is available in DOM.
|
|
2873
2893
|
* @param {object} event Event object
|
|
@@ -2979,10 +2999,10 @@ export type BryntumGanttProps = {
|
|
|
2979
2999
|
/**
|
|
2980
3000
|
* Grid has scrolled vertically
|
|
2981
3001
|
* @param {object} event Event object
|
|
2982
|
-
* @param {Grid.view.
|
|
3002
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
2983
3003
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
2984
3004
|
*/
|
|
2985
|
-
onScroll? : ((event: { source:
|
|
3005
|
+
onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
2986
3006
|
/**
|
|
2987
3007
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
2988
3008
|
* @param {object} event Event object
|
|
@@ -3077,17 +3097,17 @@ export type BryntumGanttProps = {
|
|
|
3077
3097
|
/**
|
|
3078
3098
|
* Fires after a sub grid is collapsed.
|
|
3079
3099
|
* @param {object} event Event object
|
|
3080
|
-
* @param {Grid.view.
|
|
3100
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
3081
3101
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
3082
3102
|
*/
|
|
3083
|
-
onSubGridCollapse? : ((event: { source:
|
|
3103
|
+
onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
3084
3104
|
/**
|
|
3085
3105
|
* Fires after a sub grid is expanded.
|
|
3086
3106
|
* @param {object} event Event object
|
|
3087
|
-
* @param {Grid.view.
|
|
3107
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
3088
3108
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
3089
3109
|
*/
|
|
3090
|
-
onSubGridExpand? : ((event: { source:
|
|
3110
|
+
onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
3091
3111
|
/**
|
|
3092
3112
|
* Triggered after a click on a task bar.
|
|
3093
3113
|
* @param {object} event Event object
|
|
@@ -3535,7 +3555,8 @@ export type BryntumGanttProps = {
|
|
|
3535
3555
|
*/
|
|
3536
3556
|
cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
3537
3557
|
/**
|
|
3538
|
-
* Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by
|
|
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>
|
|
3539
3560
|
* ...
|
|
3540
3561
|
* [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
|
|
3541
3562
|
*/
|
|
@@ -4232,9 +4253,7 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
|
|
|
4232
4253
|
'managedEventSizing',
|
|
4233
4254
|
'maskDefaults',
|
|
4234
4255
|
'masked',
|
|
4235
|
-
'maxDate',
|
|
4236
4256
|
'maxTimeAxisUnit',
|
|
4237
|
-
'minDate',
|
|
4238
4257
|
'monitorResize',
|
|
4239
4258
|
'newTaskDefaults',
|
|
4240
4259
|
'owner',
|
|
@@ -4333,9 +4352,11 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
|
|
|
4333
4352
|
'labelPosition',
|
|
4334
4353
|
'longPressTime',
|
|
4335
4354
|
'margin',
|
|
4355
|
+
'maxDate',
|
|
4336
4356
|
'maxHeight',
|
|
4337
4357
|
'maxWidth',
|
|
4338
4358
|
'maxZoomLevel',
|
|
4359
|
+
'minDate',
|
|
4339
4360
|
'minHeight',
|
|
4340
4361
|
'minWidth',
|
|
4341
4362
|
'minZoomLevel',
|
|
@@ -4356,6 +4377,7 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
|
|
|
4356
4377
|
'onBeforeCellEditStart',
|
|
4357
4378
|
'onBeforeCellRangeDelete',
|
|
4358
4379
|
'onBeforeCellRangeEdit',
|
|
4380
|
+
'onBeforeColumnCollapseToggle',
|
|
4359
4381
|
'onBeforeColumnDragStart',
|
|
4360
4382
|
'onBeforeColumnDropFinalize',
|
|
4361
4383
|
'onBeforeColumnResize',
|
|
@@ -4433,6 +4455,7 @@ export class BryntumGantt extends React.Component<BryntumGanttProps> {
|
|
|
4433
4455
|
'onCellMouseOver',
|
|
4434
4456
|
'onCollapse',
|
|
4435
4457
|
'onCollapseNode',
|
|
4458
|
+
'onColumnCollapseToggle',
|
|
4436
4459
|
'onColumnDrag',
|
|
4437
4460
|
'onColumnDragStart',
|
|
4438
4461
|
'onColumnDrop',
|
package/src/BryntumGanttBase.tsx
CHANGED
|
@@ -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
|
|
@@ -1711,9 +1719,9 @@ export type BryntumGanttBaseProps = {
|
|
|
1711
1719
|
/**
|
|
1712
1720
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
1713
1721
|
* @param {object} event Event object
|
|
1714
|
-
* @param {
|
|
1722
|
+
* @param {PdfExportConfig} event.config Export config
|
|
1715
1723
|
*/
|
|
1716
|
-
onBeforePdfExport? : ((event: { config:
|
|
1724
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
1717
1725
|
/**
|
|
1718
1726
|
* Fired before the [viewPreset](https://bryntum.com/products/gantt/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
1719
1727
|
* @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.
|
|
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:
|
|
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.
|
|
1779
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1772
1780
|
*/
|
|
1773
|
-
onBeforeRenderRows? : ((event: { source:
|
|
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.
|
|
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:
|
|
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
|
|
@@ -2336,16 +2352,20 @@ export type BryntumGanttBaseProps = {
|
|
|
2336
2352
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
2337
2353
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
2338
2354
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
2355
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
2356
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
2339
2357
|
*/
|
|
2340
|
-
onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
2358
|
+
onDependencyValidationComplete? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
2341
2359
|
/**
|
|
2342
2360
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
2343
2361
|
* @param {object} event Event object
|
|
2344
2362
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
2345
2363
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
2346
2364
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/gantt/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
2365
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
2366
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
2347
2367
|
*/
|
|
2348
|
-
onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
2368
|
+
onDependencyValidationStart? : ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
2349
2369
|
/**
|
|
2350
2370
|
* Fires when an object is destroyed.
|
|
2351
2371
|
* @param {object} event Event object
|
|
@@ -2855,18 +2875,18 @@ export type BryntumGanttBaseProps = {
|
|
|
2855
2875
|
/**
|
|
2856
2876
|
* Fires after a row is rendered.
|
|
2857
2877
|
* @param {object} event Event object
|
|
2858
|
-
* @param {Grid.view.
|
|
2859
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
2860
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
2861
|
-
* @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
|
|
2862
2882
|
*/
|
|
2863
|
-
onRenderRow? : ((event: { source:
|
|
2883
|
+
onRenderRow? : ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
2864
2884
|
/**
|
|
2865
2885
|
* Grid rows have been rendered
|
|
2866
2886
|
* @param {object} event Event object
|
|
2867
|
-
* @param {Grid.view.
|
|
2887
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
2868
2888
|
*/
|
|
2869
|
-
onRenderRows? : ((event: { source:
|
|
2889
|
+
onRenderRows? : ((event: { source: GridBase }) => void)|string
|
|
2870
2890
|
/**
|
|
2871
2891
|
* Task is rendered, its element is available in DOM.
|
|
2872
2892
|
* @param {object} event Event object
|
|
@@ -2978,10 +2998,10 @@ export type BryntumGanttBaseProps = {
|
|
|
2978
2998
|
/**
|
|
2979
2999
|
* Grid has scrolled vertically
|
|
2980
3000
|
* @param {object} event Event object
|
|
2981
|
-
* @param {Grid.view.
|
|
3001
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
2982
3002
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
2983
3003
|
*/
|
|
2984
|
-
onScroll? : ((event: { source:
|
|
3004
|
+
onScroll? : ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
2985
3005
|
/**
|
|
2986
3006
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
2987
3007
|
* @param {object} event Event object
|
|
@@ -3076,17 +3096,17 @@ export type BryntumGanttBaseProps = {
|
|
|
3076
3096
|
/**
|
|
3077
3097
|
* Fires after a sub grid is collapsed.
|
|
3078
3098
|
* @param {object} event Event object
|
|
3079
|
-
* @param {Grid.view.
|
|
3099
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
3080
3100
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
3081
3101
|
*/
|
|
3082
|
-
onSubGridCollapse? : ((event: { source:
|
|
3102
|
+
onSubGridCollapse? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
3083
3103
|
/**
|
|
3084
3104
|
* Fires after a sub grid is expanded.
|
|
3085
3105
|
* @param {object} event Event object
|
|
3086
|
-
* @param {Grid.view.
|
|
3106
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
3087
3107
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
3088
3108
|
*/
|
|
3089
|
-
onSubGridExpand? : ((event: { source:
|
|
3109
|
+
onSubGridExpand? : ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
3090
3110
|
/**
|
|
3091
3111
|
* Triggered after a click on a task bar.
|
|
3092
3112
|
* @param {object} event Event object
|
|
@@ -3534,7 +3554,8 @@ export type BryntumGanttBaseProps = {
|
|
|
3534
3554
|
*/
|
|
3535
3555
|
cellCopyPasteFeature? : object|boolean|string|CellCopyPaste|CellCopyPasteConfig
|
|
3536
3556
|
/**
|
|
3537
|
-
* Extends the [CellEdit](https://bryntum.com/products/gantt/docs/api/Grid/feature/CellEdit) to encapsulate Gantt functionality. This feature is enabled by
|
|
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>
|
|
3538
3559
|
* ...
|
|
3539
3560
|
* [View online docs...](https://bryntum.com/products/gantt/docs/api/Gantt/feature/CellEdit)
|
|
3540
3561
|
*/
|
|
@@ -4231,9 +4252,7 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
|
|
|
4231
4252
|
'managedEventSizing',
|
|
4232
4253
|
'maskDefaults',
|
|
4233
4254
|
'masked',
|
|
4234
|
-
'maxDate',
|
|
4235
4255
|
'maxTimeAxisUnit',
|
|
4236
|
-
'minDate',
|
|
4237
4256
|
'monitorResize',
|
|
4238
4257
|
'newTaskDefaults',
|
|
4239
4258
|
'owner',
|
|
@@ -4331,9 +4350,11 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
|
|
|
4331
4350
|
'labelPosition',
|
|
4332
4351
|
'longPressTime',
|
|
4333
4352
|
'margin',
|
|
4353
|
+
'maxDate',
|
|
4334
4354
|
'maxHeight',
|
|
4335
4355
|
'maxWidth',
|
|
4336
4356
|
'maxZoomLevel',
|
|
4357
|
+
'minDate',
|
|
4337
4358
|
'minHeight',
|
|
4338
4359
|
'minWidth',
|
|
4339
4360
|
'minZoomLevel',
|
|
@@ -4354,6 +4375,7 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
|
|
|
4354
4375
|
'onBeforeCellEditStart',
|
|
4355
4376
|
'onBeforeCellRangeDelete',
|
|
4356
4377
|
'onBeforeCellRangeEdit',
|
|
4378
|
+
'onBeforeColumnCollapseToggle',
|
|
4357
4379
|
'onBeforeColumnDragStart',
|
|
4358
4380
|
'onBeforeColumnDropFinalize',
|
|
4359
4381
|
'onBeforeColumnResize',
|
|
@@ -4431,6 +4453,7 @@ export class BryntumGanttBase extends React.Component<BryntumGanttBaseProps> {
|
|
|
4431
4453
|
'onCellMouseOver',
|
|
4432
4454
|
'onCollapse',
|
|
4433
4455
|
'onCollapseNode',
|
|
4456
|
+
'onColumnCollapseToggle',
|
|
4434
4457
|
'onColumnDrag',
|
|
4435
4458
|
'onColumnDragStart',
|
|
4436
4459
|
'onColumnDrop',
|
package/src/BryntumGrid.tsx
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
*/
|
|
4
4
|
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
5
5
|
import React, { RefObject } from 'react';
|
|
6
|
-
import { AIFilter, AIFilterConfig, AjaxStore, AjaxStoreConfig, Base, CellCopyPaste, CellCopyPasteConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, Container, ContainerItemConfig, DomConfig, EmptyTextDomConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, FormulaProviderConfig, Grid, GridBase, GridCellEdit, GridCellEditConfig, GridColumnConfig, GridExcelExporter, GridExcelExporterConfig, GridGroupSummary, GridGroupSummaryConfig, GridListeners, GridLocation, GridLocationConfig, GridLockRows, GridLockRowsConfig, GridPdfExport, GridPdfExportConfig, GridPrint, GridPrintConfig, GridRowReorder, GridRowReorderConfig, GridRowResize, GridRowResizeConfig, GridSelectionMode, GridSplit, GridSplitConfig, GridStateInfo, GridSummary, GridSummaryConfig, GridTreeGroup, GridTreeGroupConfig, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, MergeCells, MergeCellsConfig, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, Search, SearchConfig, Sort, SortConfig, StateProvider, StickyCells, StickyCellsConfig, Store, StoreConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Tree, TreeConfig, Widget, XLSColumn } from '@bryntum/gantt';
|
|
6
|
+
import { AIFilter, AIFilterConfig, AjaxStore, AjaxStoreConfig, Base, CellCopyPaste, CellCopyPasteConfig, CellEditorContext, CellMenu, CellMenuConfig, CellTooltip, CellTooltipConfig, Charts, ChartsConfig, Column, ColumnAutoWidth, ColumnAutoWidthConfig, ColumnDragToolbar, ColumnDragToolbarConfig, ColumnPicker, ColumnPickerConfig, ColumnRename, ColumnRenameConfig, ColumnReorder, ColumnReorderConfig, ColumnResize, ColumnResizeConfig, ColumnStore, ColumnStoreConfig, Container, ContainerItemConfig, DomConfig, EmptyTextDomConfig, ExportConfig, FileDrop, FileDropConfig, FillHandle, FillHandleConfig, Filter, FilterBar, FilterBarConfig, FilterConfig, FormulaProviderConfig, Grid, GridBase, GridCellEdit, GridCellEditConfig, GridColumnConfig, GridExcelExporter, GridExcelExporterConfig, GridGroupSummary, GridGroupSummaryConfig, GridListeners, GridLocation, GridLocationConfig, GridLockRows, GridLockRowsConfig, GridPdfExport, GridPdfExportConfig, GridPrint, GridPrintConfig, GridRowReorder, GridRowReorderConfig, GridRowResize, GridRowResizeConfig, GridSelectionMode, GridSplit, GridSplitConfig, GridStateInfo, GridSummary, GridSummaryConfig, GridTreeGroup, GridTreeGroupConfig, Group, GroupConfig, HeaderMenu, HeaderMenuConfig, KeyMapConfig, Mask, MaskConfig, Menu, MenuItem, MenuItemEntry, MergeCells, MergeCellsConfig, Model, ModelConfig, PagingToolbarConfig, Panel, PanelCollapserConfig, PanelCollapserOverlayConfig, PanelHeader, PdfExportConfig, PinColumns, PinColumnsConfig, PreserveScrollOptions, QuickFind, QuickFindConfig, RecordPositionContext, RegionResize, RegionResizeConfig, ResponsiveLevelConfig, Row, RowCopyPaste, RowCopyPasteConfig, RowEdit, RowEditConfig, RowEditorContext, RowExpander, RowExpanderConfig, ScrollManager, ScrollManagerConfig, Scroller, ScrollerConfig, Search, SearchConfig, Sort, SortConfig, StateProvider, StickyCells, StickyCellsConfig, Store, StoreConfig, Stripe, StripeConfig, SubGrid, SubGridConfig, TabConfig, Tool, ToolConfig, ToolbarConfig, ToolbarItems, TooltipConfig, Tree, TreeConfig, Widget, XLSColumn } from '@bryntum/gantt';
|
|
7
7
|
|
|
8
8
|
import { createWidget, shouldComponentUpdate, processWidgetContent } from './WrapperHelper.js';
|
|
9
9
|
|
|
@@ -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
|
|
@@ -894,24 +902,24 @@ export type BryntumGridProps = {
|
|
|
894
902
|
/**
|
|
895
903
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
896
904
|
* @param {object} event Event object
|
|
897
|
-
* @param {
|
|
905
|
+
* @param {PdfExportConfig} event.config Export config
|
|
898
906
|
*/
|
|
899
|
-
onBeforePdfExport? : ((event: { config:
|
|
907
|
+
onBeforePdfExport? : ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
900
908
|
/**
|
|
901
909
|
* Fires before a row is rendered.
|
|
902
910
|
* @param {object} event Event object
|
|
903
|
-
* @param {Grid.view.
|
|
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:
|
|
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.
|
|
920
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
913
921
|
*/
|
|
914
|
-
onBeforeRenderRows? : ((event: { source:
|
|
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.
|
|
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:
|
|
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.
|
|
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:
|
|
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.
|
|
1566
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
1551
1567
|
*/
|
|
1552
|
-
onRenderRows? : ((event: { source:
|
|
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.
|
|
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:
|
|
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.
|
|
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:
|
|
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.
|
|
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:
|
|
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',
|