@bryntum/scheduler-thin-trial 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 +284 -20
- package/lib/crud/AbstractCrudManagerMixin.js +1 -1
- package/lib/crud/mixin/AbstractCrudManagerValidation.js +1 -1
- package/lib/crud/mixin/CrudManagerView.js +1 -1
- package/lib/crud/transport/AjaxTransport.js +1 -1
- package/lib/data/mixin/AssignmentStoreMixin.js +1 -1
- package/lib/data/mixin/ProjectConsumer.js +1 -1
- package/lib/eventlayout/HorizontalLayoutStack.js +1 -1
- package/lib/feature/AbstractTimeRanges.js +1 -1
- package/lib/feature/Dependencies.css +1 -1
- package/lib/feature/DependencyEdit.js +1 -1
- package/lib/feature/EventDrag.js +1 -1
- package/lib/feature/EventMenu.js +1 -1
- package/lib/feature/EventResize.js +1 -1
- package/lib/feature/Pan.css +3 -0
- package/lib/feature/Pan.js +1 -1
- package/lib/feature/ScheduleTooltip.js +1 -1
- package/lib/feature/ScrollButtons.css +4 -1
- package/lib/feature/ScrollButtons.js +1 -1
- package/lib/feature/SimpleEventEdit.js +1 -1
- package/lib/feature/Summary.js +1 -1
- package/lib/feature/TimeRanges.css +1 -2
- package/lib/feature/TimeRanges.js +1 -1
- package/lib/feature/TimeSelection.js +1 -1
- package/lib/feature/TimelineSummary.js +1 -1
- package/lib/feature/base/DragBase.js +1 -1
- package/lib/feature/base/EditBase.js +1 -1
- package/lib/feature/base/ResourceTimeRangesBase.js +1 -1
- package/lib/feature/mixin/DependencyCreation.js +1 -1
- package/lib/localization/En.js +1 -1
- package/lib/model/DependencyBaseModel.js +1 -1
- package/lib/model/mixin/AssignmentModelMixin.js +1 -1
- package/lib/model/mixin/EventModelMixin.js +1 -1
- package/lib/model/mixin/ProjectModelCommon.js +1 -1
- package/lib/model/mixin/RecurringTimeSpan.js +1 -1
- package/lib/model/mixin/ResourceModelMixin.js +1 -1
- package/lib/preset/ViewPreset.js +1 -1
- package/lib/util/RectangularPathFinder.js +1 -1
- package/lib/view/EventStyles.css +46 -0
- package/lib/view/HorizontalTimeAxis.css +5 -5
- package/lib/view/SchedulerBase.css +6 -0
- package/lib/view/SchedulerBase.js +1 -1
- package/lib/view/TimeAxisSubGrid.js +1 -1
- package/lib/view/TimelineBase.js +1 -1
- package/lib/view/TimelineHistogramBase.js +1 -1
- package/lib/view/VerticalTimeAxis.js +1 -1
- package/lib/view/export/SchedulerExportDialog.js +1 -1
- package/lib/view/mixin/SchedulerEventRendering.css +24 -10
- package/lib/view/mixin/SchedulerEventRendering.js +1 -1
- package/lib/view/mixin/SchedulerScroll.js +1 -1
- package/lib/view/mixin/SchedulerStores.js +1 -1
- package/lib/view/mixin/TimelineEventRendering.js +1 -1
- package/lib/view/mixin/TimelineHistogramGrouping.js +1 -1
- package/lib/view/mixin/TimelineScroll.js +1 -1
- package/lib/view/mixin/TimelineViewPresets.js +1 -1
- package/lib/view/model/TimeAxisViewModel.js +1 -1
- package/lib/view/orientation/HorizontalRendering.js +1 -1
- package/lib/view/orientation/VerticalRendering.js +1 -1
- package/lib/view/recurrence/RecurrenceConfirmationPopup.js +1 -1
- package/lib/view/recurrence/RecurrenceEditor.js +1 -1
- package/lib/widget/ProjectCombo.js +1 -1
- package/lib/widget/ResourceCombo.js +1 -1
- package/lib/widget/ResourceFilter.js +1 -1
- package/locales/scheduler.locale.En.js +1 -1
- package/package.json +1 -1
- package/postinstall.cjs +4 -5
- package/scheduler.css +56 -7
- package/scheduler.css.map +3 -3
- package/scheduler.d.ts +856 -480
package/scheduler.d.ts
CHANGED
|
@@ -508,7 +508,7 @@ type HistogramRenderData = {
|
|
|
508
508
|
*/
|
|
509
509
|
grid: TimelineHistogramBase
|
|
510
510
|
/**
|
|
511
|
-
* Row object. Can be null in case of export. Use the
|
|
511
|
+
* Row object. Can be `null` in case of export. Use the
|
|
512
512
|
* [row's API](https://bryntum.com/products/scheduler/docs/api/Grid/row/Row#function-assignCls) to manipulate CSS class names.
|
|
513
513
|
*/
|
|
514
514
|
row: Row
|
|
@@ -9270,7 +9270,9 @@ type AssignmentStoreConfig = {
|
|
|
9270
9270
|
*/
|
|
9271
9271
|
readUrl?: string
|
|
9272
9272
|
/**
|
|
9273
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
9273
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
9274
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
9275
|
+
* that changes a node's parent.
|
|
9274
9276
|
*/
|
|
9275
9277
|
reapplyFilterOnAdd?: boolean
|
|
9276
9278
|
/**
|
|
@@ -12584,7 +12586,9 @@ type DependencyStoreConfig = {
|
|
|
12584
12586
|
*/
|
|
12585
12587
|
readUrl?: string
|
|
12586
12588
|
/**
|
|
12587
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
12589
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
12590
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
12591
|
+
* that changes a node's parent.
|
|
12588
12592
|
*/
|
|
12589
12593
|
reapplyFilterOnAdd?: boolean
|
|
12590
12594
|
/**
|
|
@@ -14585,7 +14589,9 @@ type EventStoreConfig = {
|
|
|
14585
14589
|
*/
|
|
14586
14590
|
readUrl?: string
|
|
14587
14591
|
/**
|
|
14588
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
14592
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
14593
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
14594
|
+
* that changes a node's parent.
|
|
14589
14595
|
*/
|
|
14590
14596
|
reapplyFilterOnAdd?: boolean
|
|
14591
14597
|
/**
|
|
@@ -16766,7 +16772,9 @@ type ResourceStoreConfig = {
|
|
|
16766
16772
|
*/
|
|
16767
16773
|
readUrl?: string
|
|
16768
16774
|
/**
|
|
16769
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
16775
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
16776
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
16777
|
+
* that changes a node's parent.
|
|
16770
16778
|
*/
|
|
16771
16779
|
reapplyFilterOnAdd?: boolean
|
|
16772
16780
|
/**
|
|
@@ -18720,7 +18728,9 @@ type ResourceTimeRangeStoreConfig = {
|
|
|
18720
18728
|
*/
|
|
18721
18729
|
readUrl?: string
|
|
18722
18730
|
/**
|
|
18723
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
18731
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
18732
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
18733
|
+
* that changes a node's parent.
|
|
18724
18734
|
*/
|
|
18725
18735
|
reapplyFilterOnAdd?: boolean
|
|
18726
18736
|
/**
|
|
@@ -20458,7 +20468,9 @@ type TimeAxisConfig = {
|
|
|
20458
20468
|
*/
|
|
20459
20469
|
pageStartParamName?: string
|
|
20460
20470
|
/**
|
|
20461
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
20471
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
20472
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
20473
|
+
* that changes a node's parent.
|
|
20462
20474
|
*/
|
|
20463
20475
|
reapplyFilterOnAdd?: boolean
|
|
20464
20476
|
/**
|
|
@@ -22300,7 +22312,9 @@ type TimeRangeStoreConfig = {
|
|
|
22300
22312
|
*/
|
|
22301
22313
|
readUrl?: string
|
|
22302
22314
|
/**
|
|
22303
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
22315
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
22316
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
22317
|
+
* that changes a node's parent.
|
|
22304
22318
|
*/
|
|
22305
22319
|
reapplyFilterOnAdd?: boolean
|
|
22306
22320
|
/**
|
|
@@ -25354,8 +25368,8 @@ type AbstractTimeRangesConfig = {
|
|
|
25354
25368
|
*/
|
|
25355
25369
|
disabled?: boolean|'inert'
|
|
25356
25370
|
/**
|
|
25357
|
-
* Set to `true` to enable dragging and resizing of range elements in the header.
|
|
25358
|
-
* [showHeaderElements](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-showHeaderElements)
|
|
25371
|
+
* Set to `true` to enable dragging and resizing of range elements in the header. Note that enabling
|
|
25372
|
+
* dragging/resizing also enables [showHeaderElements](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-showHeaderElements) automatically.
|
|
25359
25373
|
*/
|
|
25360
25374
|
enableResizing?: boolean
|
|
25361
25375
|
/**
|
|
@@ -25400,7 +25414,9 @@ type AbstractTimeRangesConfig = {
|
|
|
25400
25414
|
*/
|
|
25401
25415
|
localizableProperties?: string[]
|
|
25402
25416
|
/**
|
|
25403
|
-
* Set to `false` to not render range elements into the time axis header
|
|
25417
|
+
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
25418
|
+
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
25419
|
+
* automatically enable this setting.
|
|
25404
25420
|
*/
|
|
25405
25421
|
showHeaderElements?: boolean
|
|
25406
25422
|
/**
|
|
@@ -25481,7 +25497,9 @@ export abstract class AbstractTimeRanges extends InstancePlugin {
|
|
|
25481
25497
|
*/
|
|
25482
25498
|
readonly isDelayable: boolean
|
|
25483
25499
|
/**
|
|
25484
|
-
* Set to `false` to not render range elements into the time axis header
|
|
25500
|
+
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
25501
|
+
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
25502
|
+
* automatically enable this setting.
|
|
25485
25503
|
*/
|
|
25486
25504
|
showHeaderElements: boolean
|
|
25487
25505
|
/**
|
|
@@ -25858,16 +25876,20 @@ type DependenciesListenersTypes = {
|
|
|
25858
25876
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
25859
25877
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
25860
25878
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
25879
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
25880
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
25861
25881
|
*/
|
|
25862
|
-
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
25882
|
+
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
25863
25883
|
/**
|
|
25864
25884
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
25865
25885
|
* @param {object} event Event object
|
|
25866
25886
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
25867
25887
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
25868
25888
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
25889
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
25890
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
25869
25891
|
*/
|
|
25870
|
-
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
25892
|
+
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
25871
25893
|
/**
|
|
25872
25894
|
* Fires when an object is destroyed.
|
|
25873
25895
|
* @param {object} event Event object
|
|
@@ -25962,16 +25984,20 @@ type DependenciesListeners = {
|
|
|
25962
25984
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
25963
25985
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
25964
25986
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
25987
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
25988
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
25965
25989
|
*/
|
|
25966
|
-
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
25990
|
+
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
25967
25991
|
/**
|
|
25968
25992
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
25969
25993
|
* @param {object} event Event object
|
|
25970
25994
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
25971
25995
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
25972
25996
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
25997
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
25998
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
25973
25999
|
*/
|
|
25974
|
-
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
26000
|
+
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
25975
26001
|
/**
|
|
25976
26002
|
* Fires when an object is destroyed.
|
|
25977
26003
|
* @param {object} event Event object
|
|
@@ -26279,16 +26305,20 @@ type DependenciesConfig = {
|
|
|
26279
26305
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
26280
26306
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
26281
26307
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
26308
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
26309
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
26282
26310
|
*/
|
|
26283
|
-
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
26311
|
+
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
26284
26312
|
/**
|
|
26285
26313
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
26286
26314
|
* @param {object} event Event object
|
|
26287
26315
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
26288
26316
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
26289
26317
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
26318
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
26319
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
26290
26320
|
*/
|
|
26291
|
-
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
26321
|
+
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
26292
26322
|
/**
|
|
26293
26323
|
* Fires when an object is destroyed.
|
|
26294
26324
|
* @param {object} event Event object
|
|
@@ -32106,7 +32136,9 @@ type NonWorkingTimeConfig = {
|
|
|
32106
32136
|
*/
|
|
32107
32137
|
maxTimeAxisUnit?: DurationUnit
|
|
32108
32138
|
/**
|
|
32109
|
-
* Set to `false` to not render range elements into the time axis header
|
|
32139
|
+
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
32140
|
+
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
32141
|
+
* automatically enable this setting.
|
|
32110
32142
|
*/
|
|
32111
32143
|
showHeaderElements?: boolean
|
|
32112
32144
|
/**
|
|
@@ -36204,8 +36236,8 @@ type TimeRangesConfig = {
|
|
|
36204
36236
|
*/
|
|
36205
36237
|
dragTipTemplate?: (data: { timeRange: TimeSpan, name: string, startDate: Date, endDate: Date, startText: string, endText: string, startClockHtml: string, endClockHtml: string, valid: boolean }) => string
|
|
36206
36238
|
/**
|
|
36207
|
-
* Set to `true` to enable dragging and resizing of range elements in the header.
|
|
36208
|
-
* [showHeaderElements](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-showHeaderElements)
|
|
36239
|
+
* Set to `true` to enable dragging and resizing of range elements in the header. Note that enabling
|
|
36240
|
+
* dragging/resizing also enables [showHeaderElements](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-showHeaderElements) automatically.
|
|
36209
36241
|
*/
|
|
36210
36242
|
enableResizing?: boolean
|
|
36211
36243
|
/**
|
|
@@ -36265,7 +36297,9 @@ type TimeRangesConfig = {
|
|
|
36265
36297
|
*/
|
|
36266
36298
|
showCurrentTimeLine?: boolean|TimeSpanConfig
|
|
36267
36299
|
/**
|
|
36268
|
-
* Set to `false` to not render range elements into the time axis header
|
|
36300
|
+
* Set to `false` to not render range elements into the time axis header. Note that header elements are
|
|
36301
|
+
* required for interaction such as dragging/resizing, so enabling [enableResizing](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/AbstractTimeRanges#config-enableResizing) will
|
|
36302
|
+
* automatically enable this setting.
|
|
36269
36303
|
*/
|
|
36270
36304
|
showHeaderElements?: boolean
|
|
36271
36305
|
/**
|
|
@@ -40623,9 +40657,9 @@ export class Print extends PdfExport {
|
|
|
40623
40657
|
/**
|
|
40624
40658
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
40625
40659
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
40626
|
-
* @param {
|
|
40660
|
+
* @param {PrintConfig} config
|
|
40627
40661
|
*/
|
|
40628
|
-
print(config:
|
|
40662
|
+
print(config: PrintConfig): Promise<any>;
|
|
40629
40663
|
/**
|
|
40630
40664
|
* Shows the [print dialog](https://bryntum.com/products/scheduler/docs/api/Grid/view/export/ExportDialog)
|
|
40631
40665
|
*/
|
|
@@ -42347,16 +42381,20 @@ type DependencyCreationClassConfig = {
|
|
|
42347
42381
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
42348
42382
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
42349
42383
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
42384
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
42385
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
42350
42386
|
*/
|
|
42351
|
-
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
42387
|
+
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
42352
42388
|
/**
|
|
42353
42389
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
42354
42390
|
* @param {object} event Event object
|
|
42355
42391
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
42356
42392
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
42357
42393
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
42394
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
42395
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
42358
42396
|
*/
|
|
42359
|
-
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
42397
|
+
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
42360
42398
|
}
|
|
42361
42399
|
|
|
42362
42400
|
export class DependencyCreationClass {
|
|
@@ -42714,7 +42752,7 @@ export class AssignmentModel extends Model {
|
|
|
42714
42752
|
/**
|
|
42715
42753
|
* Returns `true` if the Assignment can be persisted (e.g. task and resource are not 'phantoms').
|
|
42716
42754
|
*/
|
|
42717
|
-
isPersistable: boolean
|
|
42755
|
+
readonly isPersistable: boolean
|
|
42718
42756
|
/**
|
|
42719
42757
|
* Id for resource to assign to. Can be used as an alternative to `resourceId`, but please note that after
|
|
42720
42758
|
* load it will be populated with the actual resource and not its id. This field is not persistable.
|
|
@@ -42910,7 +42948,7 @@ export class DependencyBaseModel extends Model {
|
|
|
42910
42948
|
*/
|
|
42911
42949
|
readonly isDependencyBaseModel: boolean
|
|
42912
42950
|
/**
|
|
42913
|
-
* Returns true if the linked events have been persisted (e.g. neither of them are 'phantoms')
|
|
42951
|
+
* Returns `true` if the linked events have been persisted (e.g. neither of them are 'phantoms')
|
|
42914
42952
|
*/
|
|
42915
42953
|
readonly isPersistable: boolean
|
|
42916
42954
|
/**
|
|
@@ -43388,7 +43426,7 @@ export class EventModel extends TimeSpan {
|
|
|
43388
43426
|
*/
|
|
43389
43427
|
readonly isOccurrence: boolean
|
|
43390
43428
|
/**
|
|
43391
|
-
* Returns false if the event is not persistable. By default it always is, override this getter if you need
|
|
43429
|
+
* Returns `false` if the event is not persistable. By default it always is, override this getter if you need
|
|
43392
43430
|
* custom logic.
|
|
43393
43431
|
*/
|
|
43394
43432
|
readonly isPersistable: boolean
|
|
@@ -45924,7 +45962,7 @@ export class AssignmentModelMixinClass {
|
|
|
45924
45962
|
/**
|
|
45925
45963
|
* Returns `true` if the Assignment can be persisted (e.g. task and resource are not 'phantoms').
|
|
45926
45964
|
*/
|
|
45927
|
-
isPersistable: boolean
|
|
45965
|
+
readonly isPersistable: boolean
|
|
45928
45966
|
/**
|
|
45929
45967
|
* Id for the resource to assign to
|
|
45930
45968
|
*/
|
|
@@ -46102,7 +46140,7 @@ export class EventModelMixinClass {
|
|
|
46102
46140
|
*/
|
|
46103
46141
|
readonly isInterDay: boolean
|
|
46104
46142
|
/**
|
|
46105
|
-
* Returns false if the event is not persistable. By default it always is, override this getter if you need
|
|
46143
|
+
* Returns `false` if the event is not persistable. By default it always is, override this getter if you need
|
|
46106
46144
|
* custom logic.
|
|
46107
46145
|
*/
|
|
46108
46146
|
readonly isPersistable: boolean
|
|
@@ -48479,7 +48517,9 @@ type PresetStoreConfig = {
|
|
|
48479
48517
|
*/
|
|
48480
48518
|
pageStartParamName?: string
|
|
48481
48519
|
/**
|
|
48482
|
-
* Specify true to reapply filters when a record is added to the store.
|
|
48520
|
+
* Specify `true` to reapply filters when a record is added to or moved within the store.
|
|
48521
|
+
* This includes tree node operations like indent/outdent in Gantt, or any move operation
|
|
48522
|
+
* that changes a node's parent.
|
|
48483
48523
|
*/
|
|
48484
48524
|
reapplyFilterOnAdd?: boolean
|
|
48485
48525
|
/**
|
|
@@ -52037,6 +52077,14 @@ type SchedulerListenersTypes = {
|
|
|
52037
52077
|
* @param {any} event.value The value being set
|
|
52038
52078
|
*/
|
|
52039
52079
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
52080
|
+
/**
|
|
52081
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
52082
|
+
* @param {object} event Event object
|
|
52083
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
52084
|
+
* @param {Grid.column.Column} event.column The column
|
|
52085
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
52086
|
+
*/
|
|
52087
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
52040
52088
|
/**
|
|
52041
52089
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
52042
52090
|
* @param {object} event Event object
|
|
@@ -52384,9 +52432,9 @@ type SchedulerListenersTypes = {
|
|
|
52384
52432
|
/**
|
|
52385
52433
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
52386
52434
|
* @param {object} event Event object
|
|
52387
|
-
* @param {
|
|
52435
|
+
* @param {PdfExportConfig} event.config Export config
|
|
52388
52436
|
*/
|
|
52389
|
-
beforePdfExport: (event: { config:
|
|
52437
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
52390
52438
|
/**
|
|
52391
52439
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
52392
52440
|
* @param {object} event Event object
|
|
@@ -52400,18 +52448,18 @@ type SchedulerListenersTypes = {
|
|
|
52400
52448
|
/**
|
|
52401
52449
|
* Fires before a row is rendered.
|
|
52402
52450
|
* @param {object} event Event object
|
|
52403
|
-
* @param {Grid.view.
|
|
52404
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
52405
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
52406
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
52451
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
52452
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
52453
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
52454
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
52407
52455
|
*/
|
|
52408
|
-
beforeRenderRow: (event: { source:
|
|
52456
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
52409
52457
|
/**
|
|
52410
52458
|
* Grid rows are about to be rendered
|
|
52411
52459
|
* @param {object} event Event object
|
|
52412
|
-
* @param {Grid.view.
|
|
52460
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
52413
52461
|
*/
|
|
52414
|
-
beforeRenderRows: (event: { source:
|
|
52462
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
52415
52463
|
/**
|
|
52416
52464
|
* This event fires before row collapse is started.
|
|
52417
52465
|
* ...
|
|
@@ -52660,6 +52708,14 @@ type SchedulerListenersTypes = {
|
|
|
52660
52708
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
52661
52709
|
*/
|
|
52662
52710
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
52711
|
+
/**
|
|
52712
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
52713
|
+
* @param {object} event Event object
|
|
52714
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
52715
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
52716
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
52717
|
+
*/
|
|
52718
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
52663
52719
|
/**
|
|
52664
52720
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
52665
52721
|
* to indicate whether the drop position is valid or not.
|
|
@@ -52748,14 +52804,14 @@ type SchedulerListenersTypes = {
|
|
|
52748
52804
|
* ...
|
|
52749
52805
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#event-dataChange)
|
|
52750
52806
|
* @param {object} event Event object
|
|
52751
|
-
* @param {Grid.view.
|
|
52807
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
52752
52808
|
* @param {Core.data.Store} event.store The originating store
|
|
52753
52809
|
* @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'`
|
|
52754
52810
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
52755
52811
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
52756
52812
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
52757
52813
|
*/
|
|
52758
|
-
dataChange: (event: { source:
|
|
52814
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
52759
52815
|
/**
|
|
52760
52816
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
52761
52817
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -52866,16 +52922,20 @@ type SchedulerListenersTypes = {
|
|
|
52866
52922
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
52867
52923
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
52868
52924
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
52925
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
52926
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
52869
52927
|
*/
|
|
52870
|
-
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
52928
|
+
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
52871
52929
|
/**
|
|
52872
52930
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
52873
52931
|
* @param {object} event Event object
|
|
52874
52932
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
52875
52933
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
52876
52934
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
52935
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
52936
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
52877
52937
|
*/
|
|
52878
|
-
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
52938
|
+
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
52879
52939
|
/**
|
|
52880
52940
|
* Fires when an object is destroyed.
|
|
52881
52941
|
* @param {object} event Event object
|
|
@@ -53610,18 +53670,18 @@ type SchedulerListenersTypes = {
|
|
|
53610
53670
|
/**
|
|
53611
53671
|
* Fires after a row is rendered.
|
|
53612
53672
|
* @param {object} event Event object
|
|
53613
|
-
* @param {Grid.view.
|
|
53614
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
53615
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
53616
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
53673
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
53674
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
53675
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
53676
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
53617
53677
|
*/
|
|
53618
|
-
renderRow: (event: { source:
|
|
53678
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
53619
53679
|
/**
|
|
53620
53680
|
* Grid rows have been rendered
|
|
53621
53681
|
* @param {object} event Event object
|
|
53622
|
-
* @param {Grid.view.
|
|
53682
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
53623
53683
|
*/
|
|
53624
|
-
renderRows: (event: { source:
|
|
53684
|
+
renderRows: (event: { source: GridBase }) => void
|
|
53625
53685
|
/**
|
|
53626
53686
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
53627
53687
|
* @param {object} event Event object
|
|
@@ -53963,10 +54023,10 @@ type SchedulerListenersTypes = {
|
|
|
53963
54023
|
/**
|
|
53964
54024
|
* Grid has scrolled vertically
|
|
53965
54025
|
* @param {object} event Event object
|
|
53966
|
-
* @param {Grid.view.
|
|
54026
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
53967
54027
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
53968
54028
|
*/
|
|
53969
|
-
scroll: (event: { source:
|
|
54029
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
53970
54030
|
/**
|
|
53971
54031
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
53972
54032
|
* @param {object} event Event object
|
|
@@ -54070,17 +54130,17 @@ type SchedulerListenersTypes = {
|
|
|
54070
54130
|
/**
|
|
54071
54131
|
* Fires after a sub grid is collapsed.
|
|
54072
54132
|
* @param {object} event Event object
|
|
54073
|
-
* @param {Grid.view.
|
|
54133
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
54074
54134
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
54075
54135
|
*/
|
|
54076
|
-
subGridCollapse: (event: { source:
|
|
54136
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
54077
54137
|
/**
|
|
54078
54138
|
* Fires after a sub grid is expanded.
|
|
54079
54139
|
* @param {object} event Event object
|
|
54080
|
-
* @param {Grid.view.
|
|
54140
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
54081
54141
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
54082
54142
|
*/
|
|
54083
|
-
subGridExpand: (event: { source:
|
|
54143
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
54084
54144
|
/**
|
|
54085
54145
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
54086
54146
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -54490,6 +54550,14 @@ type SchedulerListeners = {
|
|
|
54490
54550
|
* @param {any} event.value The value being set
|
|
54491
54551
|
*/
|
|
54492
54552
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
54553
|
+
/**
|
|
54554
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
54555
|
+
* @param {object} event Event object
|
|
54556
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
54557
|
+
* @param {Grid.column.Column} event.column The column
|
|
54558
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
54559
|
+
*/
|
|
54560
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
54493
54561
|
/**
|
|
54494
54562
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
54495
54563
|
* @param {object} event Event object
|
|
@@ -54837,9 +54905,9 @@ type SchedulerListeners = {
|
|
|
54837
54905
|
/**
|
|
54838
54906
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
54839
54907
|
* @param {object} event Event object
|
|
54840
|
-
* @param {
|
|
54908
|
+
* @param {PdfExportConfig} event.config Export config
|
|
54841
54909
|
*/
|
|
54842
|
-
beforePdfExport?: ((event: { config:
|
|
54910
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
54843
54911
|
/**
|
|
54844
54912
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
54845
54913
|
* @param {object} event Event object
|
|
@@ -54853,18 +54921,18 @@ type SchedulerListeners = {
|
|
|
54853
54921
|
/**
|
|
54854
54922
|
* Fires before a row is rendered.
|
|
54855
54923
|
* @param {object} event Event object
|
|
54856
|
-
* @param {Grid.view.
|
|
54857
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
54858
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
54859
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
54924
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
54925
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
54926
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
54927
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
54860
54928
|
*/
|
|
54861
|
-
beforeRenderRow?: ((event: { source:
|
|
54929
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
54862
54930
|
/**
|
|
54863
54931
|
* Grid rows are about to be rendered
|
|
54864
54932
|
* @param {object} event Event object
|
|
54865
|
-
* @param {Grid.view.
|
|
54933
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
54866
54934
|
*/
|
|
54867
|
-
beforeRenderRows?: ((event: { source:
|
|
54935
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
54868
54936
|
/**
|
|
54869
54937
|
* This event fires before row collapse is started.
|
|
54870
54938
|
* ...
|
|
@@ -55113,6 +55181,14 @@ type SchedulerListeners = {
|
|
|
55113
55181
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
55114
55182
|
*/
|
|
55115
55183
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
55184
|
+
/**
|
|
55185
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
55186
|
+
* @param {object} event Event object
|
|
55187
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
55188
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
55189
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
55190
|
+
*/
|
|
55191
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
55116
55192
|
/**
|
|
55117
55193
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
55118
55194
|
* to indicate whether the drop position is valid or not.
|
|
@@ -55201,14 +55277,14 @@ type SchedulerListeners = {
|
|
|
55201
55277
|
* ...
|
|
55202
55278
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#event-dataChange)
|
|
55203
55279
|
* @param {object} event Event object
|
|
55204
|
-
* @param {Grid.view.
|
|
55280
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
55205
55281
|
* @param {Core.data.Store} event.store The originating store
|
|
55206
55282
|
* @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'`
|
|
55207
55283
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
55208
55284
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
55209
55285
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
55210
55286
|
*/
|
|
55211
|
-
dataChange?: ((event: { source:
|
|
55287
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
55212
55288
|
/**
|
|
55213
55289
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
55214
55290
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -55319,16 +55395,20 @@ type SchedulerListeners = {
|
|
|
55319
55395
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
55320
55396
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
55321
55397
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
55398
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
55399
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
55322
55400
|
*/
|
|
55323
|
-
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
55401
|
+
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
55324
55402
|
/**
|
|
55325
55403
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
55326
55404
|
* @param {object} event Event object
|
|
55327
55405
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
55328
55406
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
55329
55407
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
55408
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
55409
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
55330
55410
|
*/
|
|
55331
|
-
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
55411
|
+
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
55332
55412
|
/**
|
|
55333
55413
|
* Fires when an object is destroyed.
|
|
55334
55414
|
* @param {object} event Event object
|
|
@@ -56063,18 +56143,18 @@ type SchedulerListeners = {
|
|
|
56063
56143
|
/**
|
|
56064
56144
|
* Fires after a row is rendered.
|
|
56065
56145
|
* @param {object} event Event object
|
|
56066
|
-
* @param {Grid.view.
|
|
56067
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
56068
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
56069
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
56146
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
56147
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
56148
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
56149
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
56070
56150
|
*/
|
|
56071
|
-
renderRow?: ((event: { source:
|
|
56151
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
56072
56152
|
/**
|
|
56073
56153
|
* Grid rows have been rendered
|
|
56074
56154
|
* @param {object} event Event object
|
|
56075
|
-
* @param {Grid.view.
|
|
56155
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
56076
56156
|
*/
|
|
56077
|
-
renderRows?: ((event: { source:
|
|
56157
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
56078
56158
|
/**
|
|
56079
56159
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
56080
56160
|
* @param {object} event Event object
|
|
@@ -56416,10 +56496,10 @@ type SchedulerListeners = {
|
|
|
56416
56496
|
/**
|
|
56417
56497
|
* Grid has scrolled vertically
|
|
56418
56498
|
* @param {object} event Event object
|
|
56419
|
-
* @param {Grid.view.
|
|
56499
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
56420
56500
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
56421
56501
|
*/
|
|
56422
|
-
scroll?: ((event: { source:
|
|
56502
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
56423
56503
|
/**
|
|
56424
56504
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
56425
56505
|
* @param {object} event Event object
|
|
@@ -56523,17 +56603,17 @@ type SchedulerListeners = {
|
|
|
56523
56603
|
/**
|
|
56524
56604
|
* Fires after a sub grid is collapsed.
|
|
56525
56605
|
* @param {object} event Event object
|
|
56526
|
-
* @param {Grid.view.
|
|
56606
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
56527
56607
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
56528
56608
|
*/
|
|
56529
|
-
subGridCollapse?: ((event: { source:
|
|
56609
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
56530
56610
|
/**
|
|
56531
56611
|
* Fires after a sub grid is expanded.
|
|
56532
56612
|
* @param {object} event Event object
|
|
56533
|
-
* @param {Grid.view.
|
|
56613
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
56534
56614
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
56535
56615
|
*/
|
|
56536
|
-
subGridExpand?: ((event: { source:
|
|
56616
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
56537
56617
|
/**
|
|
56538
56618
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
56539
56619
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -58656,6 +58736,14 @@ type SchedulerConfig = {
|
|
|
58656
58736
|
* @param {any} event.value The value being set
|
|
58657
58737
|
*/
|
|
58658
58738
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
58739
|
+
/**
|
|
58740
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
58741
|
+
* @param {object} event Event object
|
|
58742
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
58743
|
+
* @param {Grid.column.Column} event.column The column
|
|
58744
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
58745
|
+
*/
|
|
58746
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
58659
58747
|
/**
|
|
58660
58748
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
58661
58749
|
* @param {object} event Event object
|
|
@@ -59003,9 +59091,9 @@ type SchedulerConfig = {
|
|
|
59003
59091
|
/**
|
|
59004
59092
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
59005
59093
|
* @param {object} event Event object
|
|
59006
|
-
* @param {
|
|
59094
|
+
* @param {PdfExportConfig} event.config Export config
|
|
59007
59095
|
*/
|
|
59008
|
-
onBeforePdfExport?: ((event: { config:
|
|
59096
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
59009
59097
|
/**
|
|
59010
59098
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
59011
59099
|
* @param {object} event Event object
|
|
@@ -59019,18 +59107,18 @@ type SchedulerConfig = {
|
|
|
59019
59107
|
/**
|
|
59020
59108
|
* Fires before a row is rendered.
|
|
59021
59109
|
* @param {object} event Event object
|
|
59022
|
-
* @param {Grid.view.
|
|
59023
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
59024
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
59025
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
59110
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
59111
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
59112
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
59113
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
59026
59114
|
*/
|
|
59027
|
-
onBeforeRenderRow?: ((event: { source:
|
|
59115
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
59028
59116
|
/**
|
|
59029
59117
|
* Grid rows are about to be rendered
|
|
59030
59118
|
* @param {object} event Event object
|
|
59031
|
-
* @param {Grid.view.
|
|
59119
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
59032
59120
|
*/
|
|
59033
|
-
onBeforeRenderRows?: ((event: { source:
|
|
59121
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
59034
59122
|
/**
|
|
59035
59123
|
* This event fires before row collapse is started.
|
|
59036
59124
|
* ...
|
|
@@ -59279,6 +59367,14 @@ type SchedulerConfig = {
|
|
|
59279
59367
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
59280
59368
|
*/
|
|
59281
59369
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
59370
|
+
/**
|
|
59371
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
59372
|
+
* @param {object} event Event object
|
|
59373
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
59374
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
59375
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
59376
|
+
*/
|
|
59377
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
59282
59378
|
/**
|
|
59283
59379
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
59284
59380
|
* to indicate whether the drop position is valid or not.
|
|
@@ -59367,14 +59463,14 @@ type SchedulerConfig = {
|
|
|
59367
59463
|
* ...
|
|
59368
59464
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#event-dataChange)
|
|
59369
59465
|
* @param {object} event Event object
|
|
59370
|
-
* @param {Grid.view.
|
|
59466
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
59371
59467
|
* @param {Core.data.Store} event.store The originating store
|
|
59372
59468
|
* @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'`
|
|
59373
59469
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
59374
59470
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
59375
59471
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
59376
59472
|
*/
|
|
59377
|
-
onDataChange?: ((event: { source:
|
|
59473
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
59378
59474
|
/**
|
|
59379
59475
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
59380
59476
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -59485,16 +59581,20 @@ type SchedulerConfig = {
|
|
|
59485
59581
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
59486
59582
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
59487
59583
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
59584
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
59585
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
59488
59586
|
*/
|
|
59489
|
-
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
59587
|
+
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
59490
59588
|
/**
|
|
59491
59589
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
59492
59590
|
* @param {object} event Event object
|
|
59493
59591
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
59494
59592
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
59495
59593
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
59594
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
59595
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
59496
59596
|
*/
|
|
59497
|
-
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
59597
|
+
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
59498
59598
|
/**
|
|
59499
59599
|
* Fires when an object is destroyed.
|
|
59500
59600
|
* @param {object} event Event object
|
|
@@ -60229,18 +60329,18 @@ type SchedulerConfig = {
|
|
|
60229
60329
|
/**
|
|
60230
60330
|
* Fires after a row is rendered.
|
|
60231
60331
|
* @param {object} event Event object
|
|
60232
|
-
* @param {Grid.view.
|
|
60233
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
60234
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
60235
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
60332
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
60333
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
60334
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
60335
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
60236
60336
|
*/
|
|
60237
|
-
onRenderRow?: ((event: { source:
|
|
60337
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
60238
60338
|
/**
|
|
60239
60339
|
* Grid rows have been rendered
|
|
60240
60340
|
* @param {object} event Event object
|
|
60241
|
-
* @param {Grid.view.
|
|
60341
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
60242
60342
|
*/
|
|
60243
|
-
onRenderRows?: ((event: { source:
|
|
60343
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
60244
60344
|
/**
|
|
60245
60345
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
60246
60346
|
* @param {object} event Event object
|
|
@@ -60582,10 +60682,10 @@ type SchedulerConfig = {
|
|
|
60582
60682
|
/**
|
|
60583
60683
|
* Grid has scrolled vertically
|
|
60584
60684
|
* @param {object} event Event object
|
|
60585
|
-
* @param {Grid.view.
|
|
60685
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
60586
60686
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
60587
60687
|
*/
|
|
60588
|
-
onScroll?: ((event: { source:
|
|
60688
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
60589
60689
|
/**
|
|
60590
60690
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
60591
60691
|
* @param {object} event Event object
|
|
@@ -60689,17 +60789,17 @@ type SchedulerConfig = {
|
|
|
60689
60789
|
/**
|
|
60690
60790
|
* Fires after a sub grid is collapsed.
|
|
60691
60791
|
* @param {object} event Event object
|
|
60692
|
-
* @param {Grid.view.
|
|
60792
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
60693
60793
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
60694
60794
|
*/
|
|
60695
|
-
onSubGridCollapse?: ((event: { source:
|
|
60795
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
60696
60796
|
/**
|
|
60697
60797
|
* Fires after a sub grid is expanded.
|
|
60698
60798
|
* @param {object} event Event object
|
|
60699
|
-
* @param {Grid.view.
|
|
60799
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
60700
60800
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
60701
60801
|
*/
|
|
60702
|
-
onSubGridExpand?: ((event: { source:
|
|
60802
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
60703
60803
|
/**
|
|
60704
60804
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
60705
60805
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -61742,6 +61842,14 @@ type SchedulerBaseListenersTypes = {
|
|
|
61742
61842
|
* @param {any} event.value The value being set
|
|
61743
61843
|
*/
|
|
61744
61844
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
61845
|
+
/**
|
|
61846
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
61847
|
+
* @param {object} event Event object
|
|
61848
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
61849
|
+
* @param {Grid.column.Column} event.column The column
|
|
61850
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
61851
|
+
*/
|
|
61852
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
61745
61853
|
/**
|
|
61746
61854
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
61747
61855
|
* @param {object} event Event object
|
|
@@ -62089,9 +62197,9 @@ type SchedulerBaseListenersTypes = {
|
|
|
62089
62197
|
/**
|
|
62090
62198
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
62091
62199
|
* @param {object} event Event object
|
|
62092
|
-
* @param {
|
|
62200
|
+
* @param {PdfExportConfig} event.config Export config
|
|
62093
62201
|
*/
|
|
62094
|
-
beforePdfExport: (event: { config:
|
|
62202
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
62095
62203
|
/**
|
|
62096
62204
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
62097
62205
|
* @param {object} event Event object
|
|
@@ -62105,18 +62213,18 @@ type SchedulerBaseListenersTypes = {
|
|
|
62105
62213
|
/**
|
|
62106
62214
|
* Fires before a row is rendered.
|
|
62107
62215
|
* @param {object} event Event object
|
|
62108
|
-
* @param {Grid.view.
|
|
62109
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
62110
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
62111
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
62216
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
62217
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
62218
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
62219
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
62112
62220
|
*/
|
|
62113
|
-
beforeRenderRow: (event: { source:
|
|
62221
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
62114
62222
|
/**
|
|
62115
62223
|
* Grid rows are about to be rendered
|
|
62116
62224
|
* @param {object} event Event object
|
|
62117
|
-
* @param {Grid.view.
|
|
62225
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
62118
62226
|
*/
|
|
62119
|
-
beforeRenderRows: (event: { source:
|
|
62227
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
62120
62228
|
/**
|
|
62121
62229
|
* This event fires before row collapse is started.
|
|
62122
62230
|
* ...
|
|
@@ -62365,6 +62473,14 @@ type SchedulerBaseListenersTypes = {
|
|
|
62365
62473
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
62366
62474
|
*/
|
|
62367
62475
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
62476
|
+
/**
|
|
62477
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
62478
|
+
* @param {object} event Event object
|
|
62479
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
62480
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
62481
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
62482
|
+
*/
|
|
62483
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
62368
62484
|
/**
|
|
62369
62485
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
62370
62486
|
* to indicate whether the drop position is valid or not.
|
|
@@ -62453,14 +62569,14 @@ type SchedulerBaseListenersTypes = {
|
|
|
62453
62569
|
* ...
|
|
62454
62570
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#event-dataChange)
|
|
62455
62571
|
* @param {object} event Event object
|
|
62456
|
-
* @param {Grid.view.
|
|
62572
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
62457
62573
|
* @param {Core.data.Store} event.store The originating store
|
|
62458
62574
|
* @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'`
|
|
62459
62575
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
62460
62576
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
62461
62577
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
62462
62578
|
*/
|
|
62463
|
-
dataChange: (event: { source:
|
|
62579
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
62464
62580
|
/**
|
|
62465
62581
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
62466
62582
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -62571,16 +62687,20 @@ type SchedulerBaseListenersTypes = {
|
|
|
62571
62687
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
62572
62688
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
62573
62689
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
62690
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
62691
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
62574
62692
|
*/
|
|
62575
|
-
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
62693
|
+
dependencyValidationComplete: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
62576
62694
|
/**
|
|
62577
62695
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
62578
62696
|
* @param {object} event Event object
|
|
62579
62697
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
62580
62698
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
62581
62699
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
62700
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
62701
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
62582
62702
|
*/
|
|
62583
|
-
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void
|
|
62703
|
+
dependencyValidationStart: (event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void
|
|
62584
62704
|
/**
|
|
62585
62705
|
* Fires when an object is destroyed.
|
|
62586
62706
|
* @param {object} event Event object
|
|
@@ -63315,18 +63435,18 @@ type SchedulerBaseListenersTypes = {
|
|
|
63315
63435
|
/**
|
|
63316
63436
|
* Fires after a row is rendered.
|
|
63317
63437
|
* @param {object} event Event object
|
|
63318
|
-
* @param {Grid.view.
|
|
63319
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
63320
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
63321
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
63438
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
63439
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
63440
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
63441
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
63322
63442
|
*/
|
|
63323
|
-
renderRow: (event: { source:
|
|
63443
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
63324
63444
|
/**
|
|
63325
63445
|
* Grid rows have been rendered
|
|
63326
63446
|
* @param {object} event Event object
|
|
63327
|
-
* @param {Grid.view.
|
|
63447
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
63328
63448
|
*/
|
|
63329
|
-
renderRows: (event: { source:
|
|
63449
|
+
renderRows: (event: { source: GridBase }) => void
|
|
63330
63450
|
/**
|
|
63331
63451
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
63332
63452
|
* @param {object} event Event object
|
|
@@ -63668,10 +63788,10 @@ type SchedulerBaseListenersTypes = {
|
|
|
63668
63788
|
/**
|
|
63669
63789
|
* Grid has scrolled vertically
|
|
63670
63790
|
* @param {object} event Event object
|
|
63671
|
-
* @param {Grid.view.
|
|
63791
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
63672
63792
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
63673
63793
|
*/
|
|
63674
|
-
scroll: (event: { source:
|
|
63794
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
63675
63795
|
/**
|
|
63676
63796
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
63677
63797
|
* @param {object} event Event object
|
|
@@ -63775,17 +63895,17 @@ type SchedulerBaseListenersTypes = {
|
|
|
63775
63895
|
/**
|
|
63776
63896
|
* Fires after a sub grid is collapsed.
|
|
63777
63897
|
* @param {object} event Event object
|
|
63778
|
-
* @param {Grid.view.
|
|
63898
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
63779
63899
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
63780
63900
|
*/
|
|
63781
|
-
subGridCollapse: (event: { source:
|
|
63901
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
63782
63902
|
/**
|
|
63783
63903
|
* Fires after a sub grid is expanded.
|
|
63784
63904
|
* @param {object} event Event object
|
|
63785
|
-
* @param {Grid.view.
|
|
63905
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
63786
63906
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
63787
63907
|
*/
|
|
63788
|
-
subGridExpand: (event: { source:
|
|
63908
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
63789
63909
|
/**
|
|
63790
63910
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
63791
63911
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -64195,6 +64315,14 @@ type SchedulerBaseListeners = {
|
|
|
64195
64315
|
* @param {any} event.value The value being set
|
|
64196
64316
|
*/
|
|
64197
64317
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
64318
|
+
/**
|
|
64319
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
64320
|
+
* @param {object} event Event object
|
|
64321
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
64322
|
+
* @param {Grid.column.Column} event.column The column
|
|
64323
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
64324
|
+
*/
|
|
64325
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
64198
64326
|
/**
|
|
64199
64327
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
64200
64328
|
* @param {object} event Event object
|
|
@@ -64542,9 +64670,9 @@ type SchedulerBaseListeners = {
|
|
|
64542
64670
|
/**
|
|
64543
64671
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
64544
64672
|
* @param {object} event Event object
|
|
64545
|
-
* @param {
|
|
64673
|
+
* @param {PdfExportConfig} event.config Export config
|
|
64546
64674
|
*/
|
|
64547
|
-
beforePdfExport?: ((event: { config:
|
|
64675
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
64548
64676
|
/**
|
|
64549
64677
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
64550
64678
|
* @param {object} event Event object
|
|
@@ -64558,18 +64686,18 @@ type SchedulerBaseListeners = {
|
|
|
64558
64686
|
/**
|
|
64559
64687
|
* Fires before a row is rendered.
|
|
64560
64688
|
* @param {object} event Event object
|
|
64561
|
-
* @param {Grid.view.
|
|
64562
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
64563
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
64564
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
64689
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
64690
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
64691
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
64692
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
64565
64693
|
*/
|
|
64566
|
-
beforeRenderRow?: ((event: { source:
|
|
64694
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
64567
64695
|
/**
|
|
64568
64696
|
* Grid rows are about to be rendered
|
|
64569
64697
|
* @param {object} event Event object
|
|
64570
|
-
* @param {Grid.view.
|
|
64698
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
64571
64699
|
*/
|
|
64572
|
-
beforeRenderRows?: ((event: { source:
|
|
64700
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
64573
64701
|
/**
|
|
64574
64702
|
* This event fires before row collapse is started.
|
|
64575
64703
|
* ...
|
|
@@ -64818,6 +64946,14 @@ type SchedulerBaseListeners = {
|
|
|
64818
64946
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
64819
64947
|
*/
|
|
64820
64948
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
64949
|
+
/**
|
|
64950
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
64951
|
+
* @param {object} event Event object
|
|
64952
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
64953
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
64954
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
64955
|
+
*/
|
|
64956
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
64821
64957
|
/**
|
|
64822
64958
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
64823
64959
|
* to indicate whether the drop position is valid or not.
|
|
@@ -64906,14 +65042,14 @@ type SchedulerBaseListeners = {
|
|
|
64906
65042
|
* ...
|
|
64907
65043
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#event-dataChange)
|
|
64908
65044
|
* @param {object} event Event object
|
|
64909
|
-
* @param {Grid.view.
|
|
65045
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
64910
65046
|
* @param {Core.data.Store} event.store The originating store
|
|
64911
65047
|
* @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'`
|
|
64912
65048
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
64913
65049
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
64914
65050
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
64915
65051
|
*/
|
|
64916
|
-
dataChange?: ((event: { source:
|
|
65052
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
64917
65053
|
/**
|
|
64918
65054
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
64919
65055
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -65024,16 +65160,20 @@ type SchedulerBaseListeners = {
|
|
|
65024
65160
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
65025
65161
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
65026
65162
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
65163
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
65164
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
65027
65165
|
*/
|
|
65028
|
-
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
65166
|
+
dependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
65029
65167
|
/**
|
|
65030
65168
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
65031
65169
|
* @param {object} event Event object
|
|
65032
65170
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
65033
65171
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
65034
65172
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
65173
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
65174
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
65035
65175
|
*/
|
|
65036
|
-
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
65176
|
+
dependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
65037
65177
|
/**
|
|
65038
65178
|
* Fires when an object is destroyed.
|
|
65039
65179
|
* @param {object} event Event object
|
|
@@ -65768,18 +65908,18 @@ type SchedulerBaseListeners = {
|
|
|
65768
65908
|
/**
|
|
65769
65909
|
* Fires after a row is rendered.
|
|
65770
65910
|
* @param {object} event Event object
|
|
65771
|
-
* @param {Grid.view.
|
|
65772
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
65773
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
65774
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
65911
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
65912
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
65913
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
65914
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
65775
65915
|
*/
|
|
65776
|
-
renderRow?: ((event: { source:
|
|
65916
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
65777
65917
|
/**
|
|
65778
65918
|
* Grid rows have been rendered
|
|
65779
65919
|
* @param {object} event Event object
|
|
65780
|
-
* @param {Grid.view.
|
|
65920
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
65781
65921
|
*/
|
|
65782
|
-
renderRows?: ((event: { source:
|
|
65922
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
65783
65923
|
/**
|
|
65784
65924
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
65785
65925
|
* @param {object} event Event object
|
|
@@ -66121,10 +66261,10 @@ type SchedulerBaseListeners = {
|
|
|
66121
66261
|
/**
|
|
66122
66262
|
* Grid has scrolled vertically
|
|
66123
66263
|
* @param {object} event Event object
|
|
66124
|
-
* @param {Grid.view.
|
|
66264
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
66125
66265
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
66126
66266
|
*/
|
|
66127
|
-
scroll?: ((event: { source:
|
|
66267
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
66128
66268
|
/**
|
|
66129
66269
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
66130
66270
|
* @param {object} event Event object
|
|
@@ -66228,17 +66368,17 @@ type SchedulerBaseListeners = {
|
|
|
66228
66368
|
/**
|
|
66229
66369
|
* Fires after a sub grid is collapsed.
|
|
66230
66370
|
* @param {object} event Event object
|
|
66231
|
-
* @param {Grid.view.
|
|
66371
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
66232
66372
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
66233
66373
|
*/
|
|
66234
|
-
subGridCollapse?: ((event: { source:
|
|
66374
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
66235
66375
|
/**
|
|
66236
66376
|
* Fires after a sub grid is expanded.
|
|
66237
66377
|
* @param {object} event Event object
|
|
66238
|
-
* @param {Grid.view.
|
|
66378
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
66239
66379
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
66240
66380
|
*/
|
|
66241
|
-
subGridExpand?: ((event: { source:
|
|
66381
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
66242
66382
|
/**
|
|
66243
66383
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
66244
66384
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -68360,6 +68500,14 @@ type SchedulerBaseConfig = {
|
|
|
68360
68500
|
* @param {any} event.value The value being set
|
|
68361
68501
|
*/
|
|
68362
68502
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
68503
|
+
/**
|
|
68504
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
68505
|
+
* @param {object} event Event object
|
|
68506
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
68507
|
+
* @param {Grid.column.Column} event.column The column
|
|
68508
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
68509
|
+
*/
|
|
68510
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
68363
68511
|
/**
|
|
68364
68512
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
68365
68513
|
* @param {object} event Event object
|
|
@@ -68707,9 +68855,9 @@ type SchedulerBaseConfig = {
|
|
|
68707
68855
|
/**
|
|
68708
68856
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
68709
68857
|
* @param {object} event Event object
|
|
68710
|
-
* @param {
|
|
68858
|
+
* @param {PdfExportConfig} event.config Export config
|
|
68711
68859
|
*/
|
|
68712
|
-
onBeforePdfExport?: ((event: { config:
|
|
68860
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
68713
68861
|
/**
|
|
68714
68862
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
68715
68863
|
* @param {object} event Event object
|
|
@@ -68723,18 +68871,18 @@ type SchedulerBaseConfig = {
|
|
|
68723
68871
|
/**
|
|
68724
68872
|
* Fires before a row is rendered.
|
|
68725
68873
|
* @param {object} event Event object
|
|
68726
|
-
* @param {Grid.view.
|
|
68727
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
68728
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
68729
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
68874
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
68875
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
68876
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
68877
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
68730
68878
|
*/
|
|
68731
|
-
onBeforeRenderRow?: ((event: { source:
|
|
68879
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
68732
68880
|
/**
|
|
68733
68881
|
* Grid rows are about to be rendered
|
|
68734
68882
|
* @param {object} event Event object
|
|
68735
|
-
* @param {Grid.view.
|
|
68883
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
68736
68884
|
*/
|
|
68737
|
-
onBeforeRenderRows?: ((event: { source:
|
|
68885
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
68738
68886
|
/**
|
|
68739
68887
|
* This event fires before row collapse is started.
|
|
68740
68888
|
* ...
|
|
@@ -68983,6 +69131,14 @@ type SchedulerBaseConfig = {
|
|
|
68983
69131
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
68984
69132
|
*/
|
|
68985
69133
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
69134
|
+
/**
|
|
69135
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
69136
|
+
* @param {object} event Event object
|
|
69137
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
69138
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
69139
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
69140
|
+
*/
|
|
69141
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
68986
69142
|
/**
|
|
68987
69143
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
68988
69144
|
* to indicate whether the drop position is valid or not.
|
|
@@ -69071,14 +69227,14 @@ type SchedulerBaseConfig = {
|
|
|
69071
69227
|
* ...
|
|
69072
69228
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#event-dataChange)
|
|
69073
69229
|
* @param {object} event Event object
|
|
69074
|
-
* @param {Grid.view.
|
|
69230
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
69075
69231
|
* @param {Core.data.Store} event.store The originating store
|
|
69076
69232
|
* @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'`
|
|
69077
69233
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
69078
69234
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
69079
69235
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
69080
69236
|
*/
|
|
69081
|
-
onDataChange?: ((event: { source:
|
|
69237
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
69082
69238
|
/**
|
|
69083
69239
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
69084
69240
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -69189,16 +69345,20 @@ type SchedulerBaseConfig = {
|
|
|
69189
69345
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
69190
69346
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
69191
69347
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
69348
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
69349
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
69192
69350
|
*/
|
|
69193
|
-
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
69351
|
+
onDependencyValidationComplete?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
69194
69352
|
/**
|
|
69195
69353
|
* Fired on the owning Scheduler/Gantt when asynchronous dependency validation starts
|
|
69196
69354
|
* @param {object} event Event object
|
|
69197
69355
|
* @param {Scheduler.model.TimeSpan} event.source The source task
|
|
69198
69356
|
* @param {Scheduler.model.TimeSpan} event.target The target task
|
|
69199
69357
|
* @param {number} event.dependencyType The dependency type, see [Type](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/DependencyBaseModel#property-Type-static)
|
|
69358
|
+
* @param {'start','end','top','bottom'} event.fromSide The side of the source task where the dependency starts
|
|
69359
|
+
* @param {'start','end','top','bottom'} event.toSide The side of the target task where the dependency ends
|
|
69200
69360
|
*/
|
|
69201
|
-
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number }) => void)|string
|
|
69361
|
+
onDependencyValidationStart?: ((event: { source: TimeSpan, target: TimeSpan, dependencyType: number, fromSide: 'start'|'end'|'top'|'bottom', toSide: 'start'|'end'|'top'|'bottom' }) => void)|string
|
|
69202
69362
|
/**
|
|
69203
69363
|
* Fires when an object is destroyed.
|
|
69204
69364
|
* @param {object} event Event object
|
|
@@ -69933,18 +70093,18 @@ type SchedulerBaseConfig = {
|
|
|
69933
70093
|
/**
|
|
69934
70094
|
* Fires after a row is rendered.
|
|
69935
70095
|
* @param {object} event Event object
|
|
69936
|
-
* @param {Grid.view.
|
|
69937
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
69938
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
69939
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
70096
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
70097
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
70098
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
70099
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
69940
70100
|
*/
|
|
69941
|
-
onRenderRow?: ((event: { source:
|
|
70101
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
69942
70102
|
/**
|
|
69943
70103
|
* Grid rows have been rendered
|
|
69944
70104
|
* @param {object} event Event object
|
|
69945
|
-
* @param {Grid.view.
|
|
70105
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
69946
70106
|
*/
|
|
69947
|
-
onRenderRows?: ((event: { source:
|
|
70107
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
69948
70108
|
/**
|
|
69949
70109
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
69950
70110
|
* @param {object} event Event object
|
|
@@ -70286,10 +70446,10 @@ type SchedulerBaseConfig = {
|
|
|
70286
70446
|
/**
|
|
70287
70447
|
* Grid has scrolled vertically
|
|
70288
70448
|
* @param {object} event Event object
|
|
70289
|
-
* @param {Grid.view.
|
|
70449
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
70290
70450
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
70291
70451
|
*/
|
|
70292
|
-
onScroll?: ((event: { source:
|
|
70452
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
70293
70453
|
/**
|
|
70294
70454
|
* Fires on owner when the scroll button is clicked, return `false` to prevent default scroll behavior
|
|
70295
70455
|
* @param {object} event Event object
|
|
@@ -70393,17 +70553,17 @@ type SchedulerBaseConfig = {
|
|
|
70393
70553
|
/**
|
|
70394
70554
|
* Fires after a sub grid is collapsed.
|
|
70395
70555
|
* @param {object} event Event object
|
|
70396
|
-
* @param {Grid.view.
|
|
70556
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
70397
70557
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
70398
70558
|
*/
|
|
70399
|
-
onSubGridCollapse?: ((event: { source:
|
|
70559
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
70400
70560
|
/**
|
|
70401
70561
|
* Fires after a sub grid is expanded.
|
|
70402
70562
|
* @param {object} event Event object
|
|
70403
|
-
* @param {Grid.view.
|
|
70563
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
70404
70564
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
70405
70565
|
*/
|
|
70406
|
-
onSubGridExpand?: ((event: { source:
|
|
70566
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
70407
70567
|
/**
|
|
70408
70568
|
* Triggered for click on a tick cell. Only triggered if the TreeSummary feature is configured with
|
|
70409
70569
|
* `[enableMouseEvents](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/TreeSummary#config-enableMouseEvents): true`.
|
|
@@ -73114,9 +73274,9 @@ export class SchedulerBase extends TimelineBase {
|
|
|
73114
73274
|
/**
|
|
73115
73275
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
73116
73276
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
73117
|
-
* @param {
|
|
73277
|
+
* @param {PrintConfig} config
|
|
73118
73278
|
*/
|
|
73119
|
-
print(config:
|
|
73279
|
+
print(config: PrintConfig): Promise<any>;
|
|
73120
73280
|
/**
|
|
73121
73281
|
* Triggers a render of all the cells (in horizontal mode) in and event bars for the passed resource.
|
|
73122
73282
|
* @param {Scheduler.model.ResourceModel} resourceRecord The resource that should be refreshed
|
|
@@ -73533,6 +73693,14 @@ type TimelineBaseListenersTypes = {
|
|
|
73533
73693
|
* @param {any} event.value The value being set
|
|
73534
73694
|
*/
|
|
73535
73695
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
73696
|
+
/**
|
|
73697
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
73698
|
+
* @param {object} event Event object
|
|
73699
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
73700
|
+
* @param {Grid.column.Column} event.column The column
|
|
73701
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
73702
|
+
*/
|
|
73703
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
73536
73704
|
/**
|
|
73537
73705
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
73538
73706
|
* @param {object} event Event object
|
|
@@ -73641,9 +73809,9 @@ type TimelineBaseListenersTypes = {
|
|
|
73641
73809
|
/**
|
|
73642
73810
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
73643
73811
|
* @param {object} event Event object
|
|
73644
|
-
* @param {
|
|
73812
|
+
* @param {PdfExportConfig} event.config Export config
|
|
73645
73813
|
*/
|
|
73646
|
-
beforePdfExport: (event: { config:
|
|
73814
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
73647
73815
|
/**
|
|
73648
73816
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
73649
73817
|
* @param {object} event Event object
|
|
@@ -73657,18 +73825,18 @@ type TimelineBaseListenersTypes = {
|
|
|
73657
73825
|
/**
|
|
73658
73826
|
* Fires before a row is rendered.
|
|
73659
73827
|
* @param {object} event Event object
|
|
73660
|
-
* @param {Grid.view.
|
|
73661
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
73662
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
73663
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
73828
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
73829
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
73830
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
73831
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
73664
73832
|
*/
|
|
73665
|
-
beforeRenderRow: (event: { source:
|
|
73833
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
73666
73834
|
/**
|
|
73667
73835
|
* Grid rows are about to be rendered
|
|
73668
73836
|
* @param {object} event Event object
|
|
73669
|
-
* @param {Grid.view.
|
|
73837
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
73670
73838
|
*/
|
|
73671
|
-
beforeRenderRows: (event: { source:
|
|
73839
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
73672
73840
|
/**
|
|
73673
73841
|
* This event fires before row collapse is started.
|
|
73674
73842
|
* ...
|
|
@@ -73899,6 +74067,14 @@ type TimelineBaseListenersTypes = {
|
|
|
73899
74067
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
73900
74068
|
*/
|
|
73901
74069
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
74070
|
+
/**
|
|
74071
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
74072
|
+
* @param {object} event Event object
|
|
74073
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
74074
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
74075
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
74076
|
+
*/
|
|
74077
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
73902
74078
|
/**
|
|
73903
74079
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
73904
74080
|
* to indicate whether the drop position is valid or not.
|
|
@@ -73980,14 +74156,14 @@ type TimelineBaseListenersTypes = {
|
|
|
73980
74156
|
* ...
|
|
73981
74157
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#event-dataChange)
|
|
73982
74158
|
* @param {object} event Event object
|
|
73983
|
-
* @param {Grid.view.
|
|
74159
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
73984
74160
|
* @param {Core.data.Store} event.store The originating store
|
|
73985
74161
|
* @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'`
|
|
73986
74162
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
73987
74163
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
73988
74164
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
73989
74165
|
*/
|
|
73990
|
-
dataChange: (event: { source:
|
|
74166
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
73991
74167
|
/**
|
|
73992
74168
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
73993
74169
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -74330,18 +74506,18 @@ type TimelineBaseListenersTypes = {
|
|
|
74330
74506
|
/**
|
|
74331
74507
|
* Fires after a row is rendered.
|
|
74332
74508
|
* @param {object} event Event object
|
|
74333
|
-
* @param {Grid.view.
|
|
74334
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
74335
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
74336
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
74509
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
74510
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
74511
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
74512
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
74337
74513
|
*/
|
|
74338
|
-
renderRow: (event: { source:
|
|
74514
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
74339
74515
|
/**
|
|
74340
74516
|
* Grid rows have been rendered
|
|
74341
74517
|
* @param {object} event Event object
|
|
74342
|
-
* @param {Grid.view.
|
|
74518
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
74343
74519
|
*/
|
|
74344
|
-
renderRows: (event: { source:
|
|
74520
|
+
renderRows: (event: { source: GridBase }) => void
|
|
74345
74521
|
/**
|
|
74346
74522
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
74347
74523
|
* @param {object} event Event object
|
|
@@ -74401,10 +74577,10 @@ type TimelineBaseListenersTypes = {
|
|
|
74401
74577
|
/**
|
|
74402
74578
|
* Grid has scrolled vertically
|
|
74403
74579
|
* @param {object} event Event object
|
|
74404
|
-
* @param {Grid.view.
|
|
74580
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
74405
74581
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
74406
74582
|
*/
|
|
74407
|
-
scroll: (event: { source:
|
|
74583
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
74408
74584
|
/**
|
|
74409
74585
|
* The selection has been changed.
|
|
74410
74586
|
* @param {object} event Event object
|
|
@@ -74492,17 +74668,17 @@ type TimelineBaseListenersTypes = {
|
|
|
74492
74668
|
/**
|
|
74493
74669
|
* Fires after a sub grid is collapsed.
|
|
74494
74670
|
* @param {object} event Event object
|
|
74495
|
-
* @param {Grid.view.
|
|
74671
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
74496
74672
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
74497
74673
|
*/
|
|
74498
|
-
subGridCollapse: (event: { source:
|
|
74674
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
74499
74675
|
/**
|
|
74500
74676
|
* Fires after a sub grid is expanded.
|
|
74501
74677
|
* @param {object} event Event object
|
|
74502
|
-
* @param {Grid.view.
|
|
74678
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
74503
74679
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
74504
74680
|
*/
|
|
74505
|
-
subGridExpand: (event: { source:
|
|
74681
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
74506
74682
|
/**
|
|
74507
74683
|
* Fired when the tick size changes.
|
|
74508
74684
|
* ...
|
|
@@ -74688,6 +74864,14 @@ type TimelineBaseListeners = {
|
|
|
74688
74864
|
* @param {any} event.value The value being set
|
|
74689
74865
|
*/
|
|
74690
74866
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
74867
|
+
/**
|
|
74868
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
74869
|
+
* @param {object} event Event object
|
|
74870
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
74871
|
+
* @param {Grid.column.Column} event.column The column
|
|
74872
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
74873
|
+
*/
|
|
74874
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
74691
74875
|
/**
|
|
74692
74876
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
74693
74877
|
* @param {object} event Event object
|
|
@@ -74796,9 +74980,9 @@ type TimelineBaseListeners = {
|
|
|
74796
74980
|
/**
|
|
74797
74981
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
74798
74982
|
* @param {object} event Event object
|
|
74799
|
-
* @param {
|
|
74983
|
+
* @param {PdfExportConfig} event.config Export config
|
|
74800
74984
|
*/
|
|
74801
|
-
beforePdfExport?: ((event: { config:
|
|
74985
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
74802
74986
|
/**
|
|
74803
74987
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
74804
74988
|
* @param {object} event Event object
|
|
@@ -74812,18 +74996,18 @@ type TimelineBaseListeners = {
|
|
|
74812
74996
|
/**
|
|
74813
74997
|
* Fires before a row is rendered.
|
|
74814
74998
|
* @param {object} event Event object
|
|
74815
|
-
* @param {Grid.view.
|
|
74816
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
74817
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
74818
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
74999
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
75000
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
75001
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
75002
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
74819
75003
|
*/
|
|
74820
|
-
beforeRenderRow?: ((event: { source:
|
|
75004
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
74821
75005
|
/**
|
|
74822
75006
|
* Grid rows are about to be rendered
|
|
74823
75007
|
* @param {object} event Event object
|
|
74824
|
-
* @param {Grid.view.
|
|
75008
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
74825
75009
|
*/
|
|
74826
|
-
beforeRenderRows?: ((event: { source:
|
|
75010
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
74827
75011
|
/**
|
|
74828
75012
|
* This event fires before row collapse is started.
|
|
74829
75013
|
* ...
|
|
@@ -75054,6 +75238,14 @@ type TimelineBaseListeners = {
|
|
|
75054
75238
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
75055
75239
|
*/
|
|
75056
75240
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
75241
|
+
/**
|
|
75242
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
75243
|
+
* @param {object} event Event object
|
|
75244
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
75245
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
75246
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
75247
|
+
*/
|
|
75248
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
75057
75249
|
/**
|
|
75058
75250
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
75059
75251
|
* to indicate whether the drop position is valid or not.
|
|
@@ -75135,14 +75327,14 @@ type TimelineBaseListeners = {
|
|
|
75135
75327
|
* ...
|
|
75136
75328
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#event-dataChange)
|
|
75137
75329
|
* @param {object} event Event object
|
|
75138
|
-
* @param {Grid.view.
|
|
75330
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
75139
75331
|
* @param {Core.data.Store} event.store The originating store
|
|
75140
75332
|
* @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'`
|
|
75141
75333
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
75142
75334
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
75143
75335
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
75144
75336
|
*/
|
|
75145
|
-
dataChange?: ((event: { source:
|
|
75337
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
75146
75338
|
/**
|
|
75147
75339
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
75148
75340
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -75485,18 +75677,18 @@ type TimelineBaseListeners = {
|
|
|
75485
75677
|
/**
|
|
75486
75678
|
* Fires after a row is rendered.
|
|
75487
75679
|
* @param {object} event Event object
|
|
75488
|
-
* @param {Grid.view.
|
|
75489
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
75490
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
75491
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
75680
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
75681
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
75682
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
75683
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
75492
75684
|
*/
|
|
75493
|
-
renderRow?: ((event: { source:
|
|
75685
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
75494
75686
|
/**
|
|
75495
75687
|
* Grid rows have been rendered
|
|
75496
75688
|
* @param {object} event Event object
|
|
75497
|
-
* @param {Grid.view.
|
|
75689
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
75498
75690
|
*/
|
|
75499
|
-
renderRows?: ((event: { source:
|
|
75691
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
75500
75692
|
/**
|
|
75501
75693
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
75502
75694
|
* @param {object} event Event object
|
|
@@ -75556,10 +75748,10 @@ type TimelineBaseListeners = {
|
|
|
75556
75748
|
/**
|
|
75557
75749
|
* Grid has scrolled vertically
|
|
75558
75750
|
* @param {object} event Event object
|
|
75559
|
-
* @param {Grid.view.
|
|
75751
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
75560
75752
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
75561
75753
|
*/
|
|
75562
|
-
scroll?: ((event: { source:
|
|
75754
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
75563
75755
|
/**
|
|
75564
75756
|
* The selection has been changed.
|
|
75565
75757
|
* @param {object} event Event object
|
|
@@ -75647,17 +75839,17 @@ type TimelineBaseListeners = {
|
|
|
75647
75839
|
/**
|
|
75648
75840
|
* Fires after a sub grid is collapsed.
|
|
75649
75841
|
* @param {object} event Event object
|
|
75650
|
-
* @param {Grid.view.
|
|
75842
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
75651
75843
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
75652
75844
|
*/
|
|
75653
|
-
subGridCollapse?: ((event: { source:
|
|
75845
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
75654
75846
|
/**
|
|
75655
75847
|
* Fires after a sub grid is expanded.
|
|
75656
75848
|
* @param {object} event Event object
|
|
75657
|
-
* @param {Grid.view.
|
|
75849
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
75658
75850
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
75659
75851
|
*/
|
|
75660
|
-
subGridExpand?: ((event: { source:
|
|
75852
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
75661
75853
|
/**
|
|
75662
75854
|
* Fired when the tick size changes.
|
|
75663
75855
|
* ...
|
|
@@ -76943,6 +77135,14 @@ type TimelineBaseConfig = {
|
|
|
76943
77135
|
* @param {any} event.value The value being set
|
|
76944
77136
|
*/
|
|
76945
77137
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
77138
|
+
/**
|
|
77139
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
77140
|
+
* @param {object} event Event object
|
|
77141
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
77142
|
+
* @param {Grid.column.Column} event.column The column
|
|
77143
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
77144
|
+
*/
|
|
77145
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
76946
77146
|
/**
|
|
76947
77147
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
76948
77148
|
* @param {object} event Event object
|
|
@@ -77051,9 +77251,9 @@ type TimelineBaseConfig = {
|
|
|
77051
77251
|
/**
|
|
77052
77252
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
77053
77253
|
* @param {object} event Event object
|
|
77054
|
-
* @param {
|
|
77254
|
+
* @param {PdfExportConfig} event.config Export config
|
|
77055
77255
|
*/
|
|
77056
|
-
onBeforePdfExport?: ((event: { config:
|
|
77256
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
77057
77257
|
/**
|
|
77058
77258
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
77059
77259
|
* @param {object} event Event object
|
|
@@ -77067,18 +77267,18 @@ type TimelineBaseConfig = {
|
|
|
77067
77267
|
/**
|
|
77068
77268
|
* Fires before a row is rendered.
|
|
77069
77269
|
* @param {object} event Event object
|
|
77070
|
-
* @param {Grid.view.
|
|
77071
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
77072
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
77073
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
77270
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
77271
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
77272
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
77273
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
77074
77274
|
*/
|
|
77075
|
-
onBeforeRenderRow?: ((event: { source:
|
|
77275
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
77076
77276
|
/**
|
|
77077
77277
|
* Grid rows are about to be rendered
|
|
77078
77278
|
* @param {object} event Event object
|
|
77079
|
-
* @param {Grid.view.
|
|
77279
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
77080
77280
|
*/
|
|
77081
|
-
onBeforeRenderRows?: ((event: { source:
|
|
77281
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
77082
77282
|
/**
|
|
77083
77283
|
* This event fires before row collapse is started.
|
|
77084
77284
|
* ...
|
|
@@ -77309,6 +77509,14 @@ type TimelineBaseConfig = {
|
|
|
77309
77509
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
77310
77510
|
*/
|
|
77311
77511
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
77512
|
+
/**
|
|
77513
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
77514
|
+
* @param {object} event Event object
|
|
77515
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
77516
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
77517
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
77518
|
+
*/
|
|
77519
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
77312
77520
|
/**
|
|
77313
77521
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
77314
77522
|
* to indicate whether the drop position is valid or not.
|
|
@@ -77390,14 +77598,14 @@ type TimelineBaseConfig = {
|
|
|
77390
77598
|
* ...
|
|
77391
77599
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#event-dataChange)
|
|
77392
77600
|
* @param {object} event Event object
|
|
77393
|
-
* @param {Grid.view.
|
|
77601
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
77394
77602
|
* @param {Core.data.Store} event.store The originating store
|
|
77395
77603
|
* @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'`
|
|
77396
77604
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
77397
77605
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
77398
77606
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
77399
77607
|
*/
|
|
77400
|
-
onDataChange?: ((event: { source:
|
|
77608
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
77401
77609
|
/**
|
|
77402
77610
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
77403
77611
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -77740,18 +77948,18 @@ type TimelineBaseConfig = {
|
|
|
77740
77948
|
/**
|
|
77741
77949
|
* Fires after a row is rendered.
|
|
77742
77950
|
* @param {object} event Event object
|
|
77743
|
-
* @param {Grid.view.
|
|
77744
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
77745
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
77746
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
77951
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
77952
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
77953
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
77954
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
77747
77955
|
*/
|
|
77748
|
-
onRenderRow?: ((event: { source:
|
|
77956
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
77749
77957
|
/**
|
|
77750
77958
|
* Grid rows have been rendered
|
|
77751
77959
|
* @param {object} event Event object
|
|
77752
|
-
* @param {Grid.view.
|
|
77960
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
77753
77961
|
*/
|
|
77754
|
-
onRenderRows?: ((event: { source:
|
|
77962
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
77755
77963
|
/**
|
|
77756
77964
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
77757
77965
|
* @param {object} event Event object
|
|
@@ -77811,10 +78019,10 @@ type TimelineBaseConfig = {
|
|
|
77811
78019
|
/**
|
|
77812
78020
|
* Grid has scrolled vertically
|
|
77813
78021
|
* @param {object} event Event object
|
|
77814
|
-
* @param {Grid.view.
|
|
78022
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
77815
78023
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
77816
78024
|
*/
|
|
77817
|
-
onScroll?: ((event: { source:
|
|
78025
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
77818
78026
|
/**
|
|
77819
78027
|
* The selection has been changed.
|
|
77820
78028
|
* @param {object} event Event object
|
|
@@ -77902,17 +78110,17 @@ type TimelineBaseConfig = {
|
|
|
77902
78110
|
/**
|
|
77903
78111
|
* Fires after a sub grid is collapsed.
|
|
77904
78112
|
* @param {object} event Event object
|
|
77905
|
-
* @param {Grid.view.
|
|
78113
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
77906
78114
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
77907
78115
|
*/
|
|
77908
|
-
onSubGridCollapse?: ((event: { source:
|
|
78116
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
77909
78117
|
/**
|
|
77910
78118
|
* Fires after a sub grid is expanded.
|
|
77911
78119
|
* @param {object} event Event object
|
|
77912
|
-
* @param {Grid.view.
|
|
78120
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
77913
78121
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
77914
78122
|
*/
|
|
77915
|
-
onSubGridExpand?: ((event: { source:
|
|
78123
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
77916
78124
|
/**
|
|
77917
78125
|
* Fired when the tick size changes.
|
|
77918
78126
|
* ...
|
|
@@ -78168,10 +78376,22 @@ export abstract class TimelineBase extends Grid {
|
|
|
78168
78376
|
* Identifies an object as an instance of [TimelineZoomable](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable) class, or subclass thereof.
|
|
78169
78377
|
*/
|
|
78170
78378
|
readonly isTimelineZoomable: boolean
|
|
78379
|
+
/**
|
|
78380
|
+
* Get/set end date limit of the timeline.
|
|
78381
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
78382
|
+
* will respect this limit.
|
|
78383
|
+
*/
|
|
78384
|
+
maxDate: Date|string
|
|
78171
78385
|
/**
|
|
78172
78386
|
* Get/set the [maxZoomLevel](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#config-maxZoomLevel) value
|
|
78173
78387
|
*/
|
|
78174
78388
|
maxZoomLevel: number
|
|
78389
|
+
/**
|
|
78390
|
+
* Get/set start date limit of the timeline.
|
|
78391
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
78392
|
+
* will respect this limit.
|
|
78393
|
+
*/
|
|
78394
|
+
minDate: Date|string
|
|
78175
78395
|
/**
|
|
78176
78396
|
* Sets the [minZoomLevel](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#config-minZoomLevel) value
|
|
78177
78397
|
*/
|
|
@@ -78991,6 +79211,14 @@ type TimelineHistogramListenersTypes = {
|
|
|
78991
79211
|
* @param {any} event.value The value being set
|
|
78992
79212
|
*/
|
|
78993
79213
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
79214
|
+
/**
|
|
79215
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
79216
|
+
* @param {object} event Event object
|
|
79217
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
79218
|
+
* @param {Grid.column.Column} event.column The column
|
|
79219
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
79220
|
+
*/
|
|
79221
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
78994
79222
|
/**
|
|
78995
79223
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
78996
79224
|
* @param {object} event Event object
|
|
@@ -79115,9 +79343,9 @@ type TimelineHistogramListenersTypes = {
|
|
|
79115
79343
|
/**
|
|
79116
79344
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
79117
79345
|
* @param {object} event Event object
|
|
79118
|
-
* @param {
|
|
79346
|
+
* @param {PdfExportConfig} event.config Export config
|
|
79119
79347
|
*/
|
|
79120
|
-
beforePdfExport: (event: { config:
|
|
79348
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
79121
79349
|
/**
|
|
79122
79350
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
79123
79351
|
* @param {object} event Event object
|
|
@@ -79151,18 +79379,18 @@ type TimelineHistogramListenersTypes = {
|
|
|
79151
79379
|
/**
|
|
79152
79380
|
* Fires before a row is rendered.
|
|
79153
79381
|
* @param {object} event Event object
|
|
79154
|
-
* @param {Grid.view.
|
|
79155
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
79156
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
79157
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
79382
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
79383
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
79384
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
79385
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
79158
79386
|
*/
|
|
79159
|
-
beforeRenderRow: (event: { source:
|
|
79387
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
79160
79388
|
/**
|
|
79161
79389
|
* Grid rows are about to be rendered
|
|
79162
79390
|
* @param {object} event Event object
|
|
79163
|
-
* @param {Grid.view.
|
|
79391
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
79164
79392
|
*/
|
|
79165
|
-
beforeRenderRows: (event: { source:
|
|
79393
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
79166
79394
|
/**
|
|
79167
79395
|
* This event fires before row collapse is started.
|
|
79168
79396
|
* ...
|
|
@@ -79393,6 +79621,14 @@ type TimelineHistogramListenersTypes = {
|
|
|
79393
79621
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
79394
79622
|
*/
|
|
79395
79623
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
79624
|
+
/**
|
|
79625
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
79626
|
+
* @param {object} event Event object
|
|
79627
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
79628
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
79629
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
79630
|
+
*/
|
|
79631
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
79396
79632
|
/**
|
|
79397
79633
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
79398
79634
|
* to indicate whether the drop position is valid or not.
|
|
@@ -79481,14 +79717,14 @@ type TimelineHistogramListenersTypes = {
|
|
|
79481
79717
|
* ...
|
|
79482
79718
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
79483
79719
|
* @param {object} event Event object
|
|
79484
|
-
* @param {Grid.view.
|
|
79720
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
79485
79721
|
* @param {Core.data.Store} event.store The originating store
|
|
79486
79722
|
* @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'`
|
|
79487
79723
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
79488
79724
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
79489
79725
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
79490
79726
|
*/
|
|
79491
|
-
dataChange: (event: { source:
|
|
79727
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
79492
79728
|
/**
|
|
79493
79729
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
79494
79730
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -79842,18 +80078,18 @@ type TimelineHistogramListenersTypes = {
|
|
|
79842
80078
|
/**
|
|
79843
80079
|
* Fires after a row is rendered.
|
|
79844
80080
|
* @param {object} event Event object
|
|
79845
|
-
* @param {Grid.view.
|
|
79846
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
79847
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
79848
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
80081
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
80082
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
80083
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
80084
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
79849
80085
|
*/
|
|
79850
|
-
renderRow: (event: { source:
|
|
80086
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
79851
80087
|
/**
|
|
79852
80088
|
* Grid rows have been rendered
|
|
79853
80089
|
* @param {object} event Event object
|
|
79854
|
-
* @param {Grid.view.
|
|
80090
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
79855
80091
|
*/
|
|
79856
|
-
renderRows: (event: { source:
|
|
80092
|
+
renderRows: (event: { source: GridBase }) => void
|
|
79857
80093
|
/**
|
|
79858
80094
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
79859
80095
|
* @param {object} event Event object
|
|
@@ -80031,10 +80267,10 @@ type TimelineHistogramListenersTypes = {
|
|
|
80031
80267
|
/**
|
|
80032
80268
|
* Grid has scrolled vertically
|
|
80033
80269
|
* @param {object} event Event object
|
|
80034
|
-
* @param {Grid.view.
|
|
80270
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
80035
80271
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
80036
80272
|
*/
|
|
80037
|
-
scroll: (event: { source:
|
|
80273
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
80038
80274
|
/**
|
|
80039
80275
|
* The selection has been changed.
|
|
80040
80276
|
* @param {object} event Event object
|
|
@@ -80122,17 +80358,17 @@ type TimelineHistogramListenersTypes = {
|
|
|
80122
80358
|
/**
|
|
80123
80359
|
* Fires after a sub grid is collapsed.
|
|
80124
80360
|
* @param {object} event Event object
|
|
80125
|
-
* @param {Grid.view.
|
|
80361
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
80126
80362
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
80127
80363
|
*/
|
|
80128
|
-
subGridCollapse: (event: { source:
|
|
80364
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
80129
80365
|
/**
|
|
80130
80366
|
* Fires after a sub grid is expanded.
|
|
80131
80367
|
* @param {object} event Event object
|
|
80132
|
-
* @param {Grid.view.
|
|
80368
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
80133
80369
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
80134
80370
|
*/
|
|
80135
|
-
subGridExpand: (event: { source:
|
|
80371
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
80136
80372
|
/**
|
|
80137
80373
|
* Fired when the tick size changes.
|
|
80138
80374
|
* ...
|
|
@@ -80372,6 +80608,14 @@ type TimelineHistogramListeners = {
|
|
|
80372
80608
|
* @param {any} event.value The value being set
|
|
80373
80609
|
*/
|
|
80374
80610
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
80611
|
+
/**
|
|
80612
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
80613
|
+
* @param {object} event Event object
|
|
80614
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
80615
|
+
* @param {Grid.column.Column} event.column The column
|
|
80616
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
80617
|
+
*/
|
|
80618
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
80375
80619
|
/**
|
|
80376
80620
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
80377
80621
|
* @param {object} event Event object
|
|
@@ -80496,9 +80740,9 @@ type TimelineHistogramListeners = {
|
|
|
80496
80740
|
/**
|
|
80497
80741
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
80498
80742
|
* @param {object} event Event object
|
|
80499
|
-
* @param {
|
|
80743
|
+
* @param {PdfExportConfig} event.config Export config
|
|
80500
80744
|
*/
|
|
80501
|
-
beforePdfExport?: ((event: { config:
|
|
80745
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
80502
80746
|
/**
|
|
80503
80747
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
80504
80748
|
* @param {object} event Event object
|
|
@@ -80532,18 +80776,18 @@ type TimelineHistogramListeners = {
|
|
|
80532
80776
|
/**
|
|
80533
80777
|
* Fires before a row is rendered.
|
|
80534
80778
|
* @param {object} event Event object
|
|
80535
|
-
* @param {Grid.view.
|
|
80536
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
80537
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
80538
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
80779
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
80780
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
80781
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
80782
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
80539
80783
|
*/
|
|
80540
|
-
beforeRenderRow?: ((event: { source:
|
|
80784
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
80541
80785
|
/**
|
|
80542
80786
|
* Grid rows are about to be rendered
|
|
80543
80787
|
* @param {object} event Event object
|
|
80544
|
-
* @param {Grid.view.
|
|
80788
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
80545
80789
|
*/
|
|
80546
|
-
beforeRenderRows?: ((event: { source:
|
|
80790
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
80547
80791
|
/**
|
|
80548
80792
|
* This event fires before row collapse is started.
|
|
80549
80793
|
* ...
|
|
@@ -80774,6 +81018,14 @@ type TimelineHistogramListeners = {
|
|
|
80774
81018
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
80775
81019
|
*/
|
|
80776
81020
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
81021
|
+
/**
|
|
81022
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
81023
|
+
* @param {object} event Event object
|
|
81024
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
81025
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
81026
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
81027
|
+
*/
|
|
81028
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
80777
81029
|
/**
|
|
80778
81030
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
80779
81031
|
* to indicate whether the drop position is valid or not.
|
|
@@ -80862,14 +81114,14 @@ type TimelineHistogramListeners = {
|
|
|
80862
81114
|
* ...
|
|
80863
81115
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
80864
81116
|
* @param {object} event Event object
|
|
80865
|
-
* @param {Grid.view.
|
|
81117
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
80866
81118
|
* @param {Core.data.Store} event.store The originating store
|
|
80867
81119
|
* @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'`
|
|
80868
81120
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
80869
81121
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
80870
81122
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
80871
81123
|
*/
|
|
80872
|
-
dataChange?: ((event: { source:
|
|
81124
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
80873
81125
|
/**
|
|
80874
81126
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
80875
81127
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -81223,18 +81475,18 @@ type TimelineHistogramListeners = {
|
|
|
81223
81475
|
/**
|
|
81224
81476
|
* Fires after a row is rendered.
|
|
81225
81477
|
* @param {object} event Event object
|
|
81226
|
-
* @param {Grid.view.
|
|
81227
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
81228
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
81229
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
81478
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
81479
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
81480
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
81481
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
81230
81482
|
*/
|
|
81231
|
-
renderRow?: ((event: { source:
|
|
81483
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
81232
81484
|
/**
|
|
81233
81485
|
* Grid rows have been rendered
|
|
81234
81486
|
* @param {object} event Event object
|
|
81235
|
-
* @param {Grid.view.
|
|
81487
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
81236
81488
|
*/
|
|
81237
|
-
renderRows?: ((event: { source:
|
|
81489
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
81238
81490
|
/**
|
|
81239
81491
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
81240
81492
|
* @param {object} event Event object
|
|
@@ -81412,10 +81664,10 @@ type TimelineHistogramListeners = {
|
|
|
81412
81664
|
/**
|
|
81413
81665
|
* Grid has scrolled vertically
|
|
81414
81666
|
* @param {object} event Event object
|
|
81415
|
-
* @param {Grid.view.
|
|
81667
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
81416
81668
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
81417
81669
|
*/
|
|
81418
|
-
scroll?: ((event: { source:
|
|
81670
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
81419
81671
|
/**
|
|
81420
81672
|
* The selection has been changed.
|
|
81421
81673
|
* @param {object} event Event object
|
|
@@ -81503,17 +81755,17 @@ type TimelineHistogramListeners = {
|
|
|
81503
81755
|
/**
|
|
81504
81756
|
* Fires after a sub grid is collapsed.
|
|
81505
81757
|
* @param {object} event Event object
|
|
81506
|
-
* @param {Grid.view.
|
|
81758
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
81507
81759
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
81508
81760
|
*/
|
|
81509
|
-
subGridCollapse?: ((event: { source:
|
|
81761
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
81510
81762
|
/**
|
|
81511
81763
|
* Fires after a sub grid is expanded.
|
|
81512
81764
|
* @param {object} event Event object
|
|
81513
|
-
* @param {Grid.view.
|
|
81765
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
81514
81766
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
81515
81767
|
*/
|
|
81516
|
-
subGridExpand?: ((event: { source:
|
|
81768
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
81517
81769
|
/**
|
|
81518
81770
|
* Fired when the tick size changes.
|
|
81519
81771
|
* ...
|
|
@@ -83076,6 +83328,14 @@ type TimelineHistogramConfig = {
|
|
|
83076
83328
|
* @param {any} event.value The value being set
|
|
83077
83329
|
*/
|
|
83078
83330
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
83331
|
+
/**
|
|
83332
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
83333
|
+
* @param {object} event Event object
|
|
83334
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
83335
|
+
* @param {Grid.column.Column} event.column The column
|
|
83336
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
83337
|
+
*/
|
|
83338
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
83079
83339
|
/**
|
|
83080
83340
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
83081
83341
|
* @param {object} event Event object
|
|
@@ -83200,9 +83460,9 @@ type TimelineHistogramConfig = {
|
|
|
83200
83460
|
/**
|
|
83201
83461
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
83202
83462
|
* @param {object} event Event object
|
|
83203
|
-
* @param {
|
|
83463
|
+
* @param {PdfExportConfig} event.config Export config
|
|
83204
83464
|
*/
|
|
83205
|
-
onBeforePdfExport?: ((event: { config:
|
|
83465
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
83206
83466
|
/**
|
|
83207
83467
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
83208
83468
|
* @param {object} event Event object
|
|
@@ -83236,18 +83496,18 @@ type TimelineHistogramConfig = {
|
|
|
83236
83496
|
/**
|
|
83237
83497
|
* Fires before a row is rendered.
|
|
83238
83498
|
* @param {object} event Event object
|
|
83239
|
-
* @param {Grid.view.
|
|
83240
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
83241
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
83242
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
83499
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
83500
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
83501
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
83502
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
83243
83503
|
*/
|
|
83244
|
-
onBeforeRenderRow?: ((event: { source:
|
|
83504
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
83245
83505
|
/**
|
|
83246
83506
|
* Grid rows are about to be rendered
|
|
83247
83507
|
* @param {object} event Event object
|
|
83248
|
-
* @param {Grid.view.
|
|
83508
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
83249
83509
|
*/
|
|
83250
|
-
onBeforeRenderRows?: ((event: { source:
|
|
83510
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
83251
83511
|
/**
|
|
83252
83512
|
* This event fires before row collapse is started.
|
|
83253
83513
|
* ...
|
|
@@ -83478,6 +83738,14 @@ type TimelineHistogramConfig = {
|
|
|
83478
83738
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
83479
83739
|
*/
|
|
83480
83740
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
83741
|
+
/**
|
|
83742
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
83743
|
+
* @param {object} event Event object
|
|
83744
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
83745
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
83746
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
83747
|
+
*/
|
|
83748
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
83481
83749
|
/**
|
|
83482
83750
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
83483
83751
|
* to indicate whether the drop position is valid or not.
|
|
@@ -83566,14 +83834,14 @@ type TimelineHistogramConfig = {
|
|
|
83566
83834
|
* ...
|
|
83567
83835
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#event-dataChange)
|
|
83568
83836
|
* @param {object} event Event object
|
|
83569
|
-
* @param {Grid.view.
|
|
83837
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
83570
83838
|
* @param {Core.data.Store} event.store The originating store
|
|
83571
83839
|
* @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'`
|
|
83572
83840
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
83573
83841
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
83574
83842
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
83575
83843
|
*/
|
|
83576
|
-
onDataChange?: ((event: { source:
|
|
83844
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
83577
83845
|
/**
|
|
83578
83846
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
83579
83847
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -83927,18 +84195,18 @@ type TimelineHistogramConfig = {
|
|
|
83927
84195
|
/**
|
|
83928
84196
|
* Fires after a row is rendered.
|
|
83929
84197
|
* @param {object} event Event object
|
|
83930
|
-
* @param {Grid.view.
|
|
83931
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
83932
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
83933
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
84198
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
84199
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
84200
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
84201
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
83934
84202
|
*/
|
|
83935
|
-
onRenderRow?: ((event: { source:
|
|
84203
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
83936
84204
|
/**
|
|
83937
84205
|
* Grid rows have been rendered
|
|
83938
84206
|
* @param {object} event Event object
|
|
83939
|
-
* @param {Grid.view.
|
|
84207
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
83940
84208
|
*/
|
|
83941
|
-
onRenderRows?: ((event: { source:
|
|
84209
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
83942
84210
|
/**
|
|
83943
84211
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
83944
84212
|
* @param {object} event Event object
|
|
@@ -84116,10 +84384,10 @@ type TimelineHistogramConfig = {
|
|
|
84116
84384
|
/**
|
|
84117
84385
|
* Grid has scrolled vertically
|
|
84118
84386
|
* @param {object} event Event object
|
|
84119
|
-
* @param {Grid.view.
|
|
84387
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
84120
84388
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
84121
84389
|
*/
|
|
84122
|
-
onScroll?: ((event: { source:
|
|
84390
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
84123
84391
|
/**
|
|
84124
84392
|
* The selection has been changed.
|
|
84125
84393
|
* @param {object} event Event object
|
|
@@ -84207,17 +84475,17 @@ type TimelineHistogramConfig = {
|
|
|
84207
84475
|
/**
|
|
84208
84476
|
* Fires after a sub grid is collapsed.
|
|
84209
84477
|
* @param {object} event Event object
|
|
84210
|
-
* @param {Grid.view.
|
|
84478
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
84211
84479
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
84212
84480
|
*/
|
|
84213
|
-
onSubGridCollapse?: ((event: { source:
|
|
84481
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
84214
84482
|
/**
|
|
84215
84483
|
* Fires after a sub grid is expanded.
|
|
84216
84484
|
* @param {object} event Event object
|
|
84217
|
-
* @param {Grid.view.
|
|
84485
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
84218
84486
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
84219
84487
|
*/
|
|
84220
|
-
onSubGridExpand?: ((event: { source:
|
|
84488
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
84221
84489
|
/**
|
|
84222
84490
|
* Fired when the tick size changes.
|
|
84223
84491
|
* ...
|
|
@@ -85019,6 +85287,12 @@ export class TimelineHistogram extends TimelineHistogramBase {
|
|
|
85019
85287
|
* numeric-only values are interpreted as pixels.
|
|
85020
85288
|
*/
|
|
85021
85289
|
margin: number|string
|
|
85290
|
+
/**
|
|
85291
|
+
* Get/set end date limit of the timeline.
|
|
85292
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
85293
|
+
* will respect this limit.
|
|
85294
|
+
*/
|
|
85295
|
+
maxDate: Date|string
|
|
85022
85296
|
/**
|
|
85023
85297
|
* Get/set element's maxHeight. Getter returns max-height from elements style, which is always a string. Setter
|
|
85024
85298
|
* accepts either a String or a Number (which will have 'px' appended). Note that like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height),
|
|
@@ -85035,6 +85309,12 @@ export class TimelineHistogram extends TimelineHistogramBase {
|
|
|
85035
85309
|
* Get/set the [maxZoomLevel](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineZoomable#config-maxZoomLevel) value
|
|
85036
85310
|
*/
|
|
85037
85311
|
maxZoomLevel: number
|
|
85312
|
+
/**
|
|
85313
|
+
* Get/set start date limit of the timeline.
|
|
85314
|
+
* Actions such as timeline scrolling, all types of timeline zooms and shifts
|
|
85315
|
+
* will respect this limit.
|
|
85316
|
+
*/
|
|
85317
|
+
minDate: Date|string
|
|
85038
85318
|
/**
|
|
85039
85319
|
* Get/set element's minHeight. Getter returns min-height from elements style, which is always a string. Setter
|
|
85040
85320
|
* accepts either a String or a Number (which will have 'px' appended). Note that like [height](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-height),
|
|
@@ -86466,9 +86746,9 @@ export class TimelineHistogram extends TimelineHistogramBase {
|
|
|
86466
86746
|
/**
|
|
86467
86747
|
* Starts the print process. Accepts a config object which overrides any default configs.
|
|
86468
86748
|
* <strong>NOTE</strong> Component should not be interacted with when print is in progress
|
|
86469
|
-
* @param {
|
|
86749
|
+
* @param {PrintConfig} config
|
|
86470
86750
|
*/
|
|
86471
|
-
print(config:
|
|
86751
|
+
print(config: PrintConfig): Promise<any>;
|
|
86472
86752
|
/**
|
|
86473
86753
|
* Returns the first descendant widgets which the passed
|
|
86474
86754
|
* filter function returns `true` for.
|
|
@@ -87065,6 +87345,14 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87065
87345
|
* @param {any} event.value The value being set
|
|
87066
87346
|
*/
|
|
87067
87347
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
87348
|
+
/**
|
|
87349
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
87350
|
+
* @param {object} event Event object
|
|
87351
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
87352
|
+
* @param {Grid.column.Column} event.column The column
|
|
87353
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
87354
|
+
*/
|
|
87355
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
87068
87356
|
/**
|
|
87069
87357
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
87070
87358
|
* @param {object} event Event object
|
|
@@ -87183,9 +87471,9 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87183
87471
|
/**
|
|
87184
87472
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
87185
87473
|
* @param {object} event Event object
|
|
87186
|
-
* @param {
|
|
87474
|
+
* @param {PdfExportConfig} event.config Export config
|
|
87187
87475
|
*/
|
|
87188
|
-
beforePdfExport: (event: { config:
|
|
87476
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
87189
87477
|
/**
|
|
87190
87478
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
87191
87479
|
* @param {object} event Event object
|
|
@@ -87219,18 +87507,18 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87219
87507
|
/**
|
|
87220
87508
|
* Fires before a row is rendered.
|
|
87221
87509
|
* @param {object} event Event object
|
|
87222
|
-
* @param {Grid.view.
|
|
87223
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
87224
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
87225
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
87510
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
87511
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
87512
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
87513
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
87226
87514
|
*/
|
|
87227
|
-
beforeRenderRow: (event: { source:
|
|
87515
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
87228
87516
|
/**
|
|
87229
87517
|
* Grid rows are about to be rendered
|
|
87230
87518
|
* @param {object} event Event object
|
|
87231
|
-
* @param {Grid.view.
|
|
87519
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
87232
87520
|
*/
|
|
87233
|
-
beforeRenderRows: (event: { source:
|
|
87521
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
87234
87522
|
/**
|
|
87235
87523
|
* This event fires before row collapse is started.
|
|
87236
87524
|
* ...
|
|
@@ -87461,6 +87749,14 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87461
87749
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
87462
87750
|
*/
|
|
87463
87751
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
87752
|
+
/**
|
|
87753
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
87754
|
+
* @param {object} event Event object
|
|
87755
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
87756
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
87757
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
87758
|
+
*/
|
|
87759
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
87464
87760
|
/**
|
|
87465
87761
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
87466
87762
|
* to indicate whether the drop position is valid or not.
|
|
@@ -87542,14 +87838,14 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87542
87838
|
* ...
|
|
87543
87839
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#event-dataChange)
|
|
87544
87840
|
* @param {object} event Event object
|
|
87545
|
-
* @param {Grid.view.
|
|
87841
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
87546
87842
|
* @param {Core.data.Store} event.store The originating store
|
|
87547
87843
|
* @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'`
|
|
87548
87844
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
87549
87845
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
87550
87846
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
87551
87847
|
*/
|
|
87552
|
-
dataChange: (event: { source:
|
|
87848
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
87553
87849
|
/**
|
|
87554
87850
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
87555
87851
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -87903,18 +88199,18 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87903
88199
|
/**
|
|
87904
88200
|
* Fires after a row is rendered.
|
|
87905
88201
|
* @param {object} event Event object
|
|
87906
|
-
* @param {Grid.view.
|
|
87907
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
87908
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
87909
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
88202
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
88203
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
88204
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
88205
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
87910
88206
|
*/
|
|
87911
|
-
renderRow: (event: { source:
|
|
88207
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
87912
88208
|
/**
|
|
87913
88209
|
* Grid rows have been rendered
|
|
87914
88210
|
* @param {object} event Event object
|
|
87915
|
-
* @param {Grid.view.
|
|
88211
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
87916
88212
|
*/
|
|
87917
|
-
renderRows: (event: { source:
|
|
88213
|
+
renderRows: (event: { source: GridBase }) => void
|
|
87918
88214
|
/**
|
|
87919
88215
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
87920
88216
|
* @param {object} event Event object
|
|
@@ -87974,10 +88270,10 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
87974
88270
|
/**
|
|
87975
88271
|
* Grid has scrolled vertically
|
|
87976
88272
|
* @param {object} event Event object
|
|
87977
|
-
* @param {Grid.view.
|
|
88273
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
87978
88274
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
87979
88275
|
*/
|
|
87980
|
-
scroll: (event: { source:
|
|
88276
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
87981
88277
|
/**
|
|
87982
88278
|
* The selection has been changed.
|
|
87983
88279
|
* @param {object} event Event object
|
|
@@ -88065,17 +88361,17 @@ type TimelineHistogramBaseListenersTypes = {
|
|
|
88065
88361
|
/**
|
|
88066
88362
|
* Fires after a sub grid is collapsed.
|
|
88067
88363
|
* @param {object} event Event object
|
|
88068
|
-
* @param {Grid.view.
|
|
88364
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
88069
88365
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
88070
88366
|
*/
|
|
88071
|
-
subGridCollapse: (event: { source:
|
|
88367
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
88072
88368
|
/**
|
|
88073
88369
|
* Fires after a sub grid is expanded.
|
|
88074
88370
|
* @param {object} event Event object
|
|
88075
|
-
* @param {Grid.view.
|
|
88371
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
88076
88372
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
88077
88373
|
*/
|
|
88078
|
-
subGridExpand: (event: { source:
|
|
88374
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
88079
88375
|
/**
|
|
88080
88376
|
* Fired when the tick size changes.
|
|
88081
88377
|
* ...
|
|
@@ -88261,6 +88557,14 @@ type TimelineHistogramBaseListeners = {
|
|
|
88261
88557
|
* @param {any} event.value The value being set
|
|
88262
88558
|
*/
|
|
88263
88559
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
88560
|
+
/**
|
|
88561
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
88562
|
+
* @param {object} event Event object
|
|
88563
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
88564
|
+
* @param {Grid.column.Column} event.column The column
|
|
88565
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
88566
|
+
*/
|
|
88567
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
88264
88568
|
/**
|
|
88265
88569
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
88266
88570
|
* @param {object} event Event object
|
|
@@ -88379,9 +88683,9 @@ type TimelineHistogramBaseListeners = {
|
|
|
88379
88683
|
/**
|
|
88380
88684
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
88381
88685
|
* @param {object} event Event object
|
|
88382
|
-
* @param {
|
|
88686
|
+
* @param {PdfExportConfig} event.config Export config
|
|
88383
88687
|
*/
|
|
88384
|
-
beforePdfExport?: ((event: { config:
|
|
88688
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
88385
88689
|
/**
|
|
88386
88690
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
88387
88691
|
* @param {object} event Event object
|
|
@@ -88415,18 +88719,18 @@ type TimelineHistogramBaseListeners = {
|
|
|
88415
88719
|
/**
|
|
88416
88720
|
* Fires before a row is rendered.
|
|
88417
88721
|
* @param {object} event Event object
|
|
88418
|
-
* @param {Grid.view.
|
|
88419
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
88420
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
88421
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
88722
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
88723
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
88724
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
88725
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
88422
88726
|
*/
|
|
88423
|
-
beforeRenderRow?: ((event: { source:
|
|
88727
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
88424
88728
|
/**
|
|
88425
88729
|
* Grid rows are about to be rendered
|
|
88426
88730
|
* @param {object} event Event object
|
|
88427
|
-
* @param {Grid.view.
|
|
88731
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
88428
88732
|
*/
|
|
88429
|
-
beforeRenderRows?: ((event: { source:
|
|
88733
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
88430
88734
|
/**
|
|
88431
88735
|
* This event fires before row collapse is started.
|
|
88432
88736
|
* ...
|
|
@@ -88657,6 +88961,14 @@ type TimelineHistogramBaseListeners = {
|
|
|
88657
88961
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
88658
88962
|
*/
|
|
88659
88963
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
88964
|
+
/**
|
|
88965
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
88966
|
+
* @param {object} event Event object
|
|
88967
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
88968
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
88969
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
88970
|
+
*/
|
|
88971
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
88660
88972
|
/**
|
|
88661
88973
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
88662
88974
|
* to indicate whether the drop position is valid or not.
|
|
@@ -88738,14 +89050,14 @@ type TimelineHistogramBaseListeners = {
|
|
|
88738
89050
|
* ...
|
|
88739
89051
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#event-dataChange)
|
|
88740
89052
|
* @param {object} event Event object
|
|
88741
|
-
* @param {Grid.view.
|
|
89053
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
88742
89054
|
* @param {Core.data.Store} event.store The originating store
|
|
88743
89055
|
* @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'`
|
|
88744
89056
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
88745
89057
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
88746
89058
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
88747
89059
|
*/
|
|
88748
|
-
dataChange?: ((event: { source:
|
|
89060
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
88749
89061
|
/**
|
|
88750
89062
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
88751
89063
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -89099,18 +89411,18 @@ type TimelineHistogramBaseListeners = {
|
|
|
89099
89411
|
/**
|
|
89100
89412
|
* Fires after a row is rendered.
|
|
89101
89413
|
* @param {object} event Event object
|
|
89102
|
-
* @param {Grid.view.
|
|
89103
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
89104
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
89105
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
89414
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
89415
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
89416
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
89417
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
89106
89418
|
*/
|
|
89107
|
-
renderRow?: ((event: { source:
|
|
89419
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
89108
89420
|
/**
|
|
89109
89421
|
* Grid rows have been rendered
|
|
89110
89422
|
* @param {object} event Event object
|
|
89111
|
-
* @param {Grid.view.
|
|
89423
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
89112
89424
|
*/
|
|
89113
|
-
renderRows?: ((event: { source:
|
|
89425
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
89114
89426
|
/**
|
|
89115
89427
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
89116
89428
|
* @param {object} event Event object
|
|
@@ -89170,10 +89482,10 @@ type TimelineHistogramBaseListeners = {
|
|
|
89170
89482
|
/**
|
|
89171
89483
|
* Grid has scrolled vertically
|
|
89172
89484
|
* @param {object} event Event object
|
|
89173
|
-
* @param {Grid.view.
|
|
89485
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
89174
89486
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
89175
89487
|
*/
|
|
89176
|
-
scroll?: ((event: { source:
|
|
89488
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
89177
89489
|
/**
|
|
89178
89490
|
* The selection has been changed.
|
|
89179
89491
|
* @param {object} event Event object
|
|
@@ -89261,17 +89573,17 @@ type TimelineHistogramBaseListeners = {
|
|
|
89261
89573
|
/**
|
|
89262
89574
|
* Fires after a sub grid is collapsed.
|
|
89263
89575
|
* @param {object} event Event object
|
|
89264
|
-
* @param {Grid.view.
|
|
89576
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
89265
89577
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
89266
89578
|
*/
|
|
89267
|
-
subGridCollapse?: ((event: { source:
|
|
89579
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
89268
89580
|
/**
|
|
89269
89581
|
* Fires after a sub grid is expanded.
|
|
89270
89582
|
* @param {object} event Event object
|
|
89271
|
-
* @param {Grid.view.
|
|
89583
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
89272
89584
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
89273
89585
|
*/
|
|
89274
|
-
subGridExpand?: ((event: { source:
|
|
89586
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
89275
89587
|
/**
|
|
89276
89588
|
* Fired when the tick size changes.
|
|
89277
89589
|
* ...
|
|
@@ -90694,6 +91006,14 @@ type TimelineHistogramBaseConfig = {
|
|
|
90694
91006
|
* @param {any} event.value The value being set
|
|
90695
91007
|
*/
|
|
90696
91008
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
91009
|
+
/**
|
|
91010
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
91011
|
+
* @param {object} event Event object
|
|
91012
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
91013
|
+
* @param {Grid.column.Column} event.column The column
|
|
91014
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
91015
|
+
*/
|
|
91016
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
90697
91017
|
/**
|
|
90698
91018
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
90699
91019
|
* @param {object} event Event object
|
|
@@ -90812,9 +91132,9 @@ type TimelineHistogramBaseConfig = {
|
|
|
90812
91132
|
/**
|
|
90813
91133
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
90814
91134
|
* @param {object} event Event object
|
|
90815
|
-
* @param {
|
|
91135
|
+
* @param {PdfExportConfig} event.config Export config
|
|
90816
91136
|
*/
|
|
90817
|
-
onBeforePdfExport?: ((event: { config:
|
|
91137
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
90818
91138
|
/**
|
|
90819
91139
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
90820
91140
|
* @param {object} event Event object
|
|
@@ -90848,18 +91168,18 @@ type TimelineHistogramBaseConfig = {
|
|
|
90848
91168
|
/**
|
|
90849
91169
|
* Fires before a row is rendered.
|
|
90850
91170
|
* @param {object} event Event object
|
|
90851
|
-
* @param {Grid.view.
|
|
90852
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
90853
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
90854
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
91171
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
91172
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
91173
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
91174
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
90855
91175
|
*/
|
|
90856
|
-
onBeforeRenderRow?: ((event: { source:
|
|
91176
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
90857
91177
|
/**
|
|
90858
91178
|
* Grid rows are about to be rendered
|
|
90859
91179
|
* @param {object} event Event object
|
|
90860
|
-
* @param {Grid.view.
|
|
91180
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
90861
91181
|
*/
|
|
90862
|
-
onBeforeRenderRows?: ((event: { source:
|
|
91182
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
90863
91183
|
/**
|
|
90864
91184
|
* This event fires before row collapse is started.
|
|
90865
91185
|
* ...
|
|
@@ -91090,6 +91410,14 @@ type TimelineHistogramBaseConfig = {
|
|
|
91090
91410
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
91091
91411
|
*/
|
|
91092
91412
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
91413
|
+
/**
|
|
91414
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
91415
|
+
* @param {object} event Event object
|
|
91416
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
91417
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
91418
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
91419
|
+
*/
|
|
91420
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
91093
91421
|
/**
|
|
91094
91422
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
91095
91423
|
* to indicate whether the drop position is valid or not.
|
|
@@ -91171,14 +91499,14 @@ type TimelineHistogramBaseConfig = {
|
|
|
91171
91499
|
* ...
|
|
91172
91500
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#event-dataChange)
|
|
91173
91501
|
* @param {object} event Event object
|
|
91174
|
-
* @param {Grid.view.
|
|
91502
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
91175
91503
|
* @param {Core.data.Store} event.store The originating store
|
|
91176
91504
|
* @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'`
|
|
91177
91505
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
91178
91506
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
91179
91507
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
91180
91508
|
*/
|
|
91181
|
-
onDataChange?: ((event: { source:
|
|
91509
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
91182
91510
|
/**
|
|
91183
91511
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
91184
91512
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -91532,18 +91860,18 @@ type TimelineHistogramBaseConfig = {
|
|
|
91532
91860
|
/**
|
|
91533
91861
|
* Fires after a row is rendered.
|
|
91534
91862
|
* @param {object} event Event object
|
|
91535
|
-
* @param {Grid.view.
|
|
91536
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
91537
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
91538
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
91863
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
91864
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
91865
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
91866
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
91539
91867
|
*/
|
|
91540
|
-
onRenderRow?: ((event: { source:
|
|
91868
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
91541
91869
|
/**
|
|
91542
91870
|
* Grid rows have been rendered
|
|
91543
91871
|
* @param {object} event Event object
|
|
91544
|
-
* @param {Grid.view.
|
|
91872
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
91545
91873
|
*/
|
|
91546
|
-
onRenderRows?: ((event: { source:
|
|
91874
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
91547
91875
|
/**
|
|
91548
91876
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
91549
91877
|
* @param {object} event Event object
|
|
@@ -91603,10 +91931,10 @@ type TimelineHistogramBaseConfig = {
|
|
|
91603
91931
|
/**
|
|
91604
91932
|
* Grid has scrolled vertically
|
|
91605
91933
|
* @param {object} event Event object
|
|
91606
|
-
* @param {Grid.view.
|
|
91934
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
91607
91935
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
91608
91936
|
*/
|
|
91609
|
-
onScroll?: ((event: { source:
|
|
91937
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
91610
91938
|
/**
|
|
91611
91939
|
* The selection has been changed.
|
|
91612
91940
|
* @param {object} event Event object
|
|
@@ -91694,17 +92022,17 @@ type TimelineHistogramBaseConfig = {
|
|
|
91694
92022
|
/**
|
|
91695
92023
|
* Fires after a sub grid is collapsed.
|
|
91696
92024
|
* @param {object} event Event object
|
|
91697
|
-
* @param {Grid.view.
|
|
92025
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
91698
92026
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
91699
92027
|
*/
|
|
91700
|
-
onSubGridCollapse?: ((event: { source:
|
|
92028
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
91701
92029
|
/**
|
|
91702
92030
|
* Fires after a sub grid is expanded.
|
|
91703
92031
|
* @param {object} event Event object
|
|
91704
|
-
* @param {Grid.view.
|
|
92032
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
91705
92033
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
91706
92034
|
*/
|
|
91707
|
-
onSubGridExpand?: ((event: { source:
|
|
92035
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
91708
92036
|
/**
|
|
91709
92037
|
* Fired when the tick size changes.
|
|
91710
92038
|
* ...
|
|
@@ -95673,6 +96001,14 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
95673
96001
|
* @param {any} event.value The value being set
|
|
95674
96002
|
*/
|
|
95675
96003
|
beforeCellRangeEdit: (event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void
|
|
96004
|
+
/**
|
|
96005
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
96006
|
+
* @param {object} event Event object
|
|
96007
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
96008
|
+
* @param {Grid.column.Column} event.column The column
|
|
96009
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
96010
|
+
*/
|
|
96011
|
+
beforeColumnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
95676
96012
|
/**
|
|
95677
96013
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
95678
96014
|
* @param {object} event Event object
|
|
@@ -95791,9 +96127,9 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
95791
96127
|
/**
|
|
95792
96128
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
95793
96129
|
* @param {object} event Event object
|
|
95794
|
-
* @param {
|
|
96130
|
+
* @param {PdfExportConfig} event.config Export config
|
|
95795
96131
|
*/
|
|
95796
|
-
beforePdfExport: (event: { config:
|
|
96132
|
+
beforePdfExport: (event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void
|
|
95797
96133
|
/**
|
|
95798
96134
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
95799
96135
|
* @param {object} event Event object
|
|
@@ -95827,18 +96163,18 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
95827
96163
|
/**
|
|
95828
96164
|
* Fires before a row is rendered.
|
|
95829
96165
|
* @param {object} event Event object
|
|
95830
|
-
* @param {Grid.view.
|
|
95831
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
95832
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
95833
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
96166
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
96167
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
96168
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
96169
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
95834
96170
|
*/
|
|
95835
|
-
beforeRenderRow: (event: { source:
|
|
96171
|
+
beforeRenderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
95836
96172
|
/**
|
|
95837
96173
|
* Grid rows are about to be rendered
|
|
95838
96174
|
* @param {object} event Event object
|
|
95839
|
-
* @param {Grid.view.
|
|
96175
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
95840
96176
|
*/
|
|
95841
|
-
beforeRenderRows: (event: { source:
|
|
96177
|
+
beforeRenderRows: (event: { source: GridBase }) => void
|
|
95842
96178
|
/**
|
|
95843
96179
|
* This event fires before row collapse is started.
|
|
95844
96180
|
* ...
|
|
@@ -96069,6 +96405,14 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
96069
96405
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
96070
96406
|
*/
|
|
96071
96407
|
collapseNode: (event: { source: Grid, record: Model }) => void
|
|
96408
|
+
/**
|
|
96409
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
96410
|
+
* @param {object} event Event object
|
|
96411
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
96412
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
96413
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
96414
|
+
*/
|
|
96415
|
+
columnCollapseToggle: (event: { source: GridBase, column: Column, collapsed: boolean }) => void
|
|
96072
96416
|
/**
|
|
96073
96417
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
96074
96418
|
* to indicate whether the drop position is valid or not.
|
|
@@ -96150,14 +96494,14 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
96150
96494
|
* ...
|
|
96151
96495
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#event-dataChange)
|
|
96152
96496
|
* @param {object} event Event object
|
|
96153
|
-
* @param {Grid.view.
|
|
96497
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
96154
96498
|
* @param {Core.data.Store} event.store The originating store
|
|
96155
96499
|
* @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'`
|
|
96156
96500
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
96157
96501
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
96158
96502
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
96159
96503
|
*/
|
|
96160
|
-
dataChange: (event: { source:
|
|
96504
|
+
dataChange: (event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void
|
|
96161
96505
|
/**
|
|
96162
96506
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
96163
96507
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -96511,18 +96855,18 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
96511
96855
|
/**
|
|
96512
96856
|
* Fires after a row is rendered.
|
|
96513
96857
|
* @param {object} event Event object
|
|
96514
|
-
* @param {Grid.view.
|
|
96515
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
96516
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
96517
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
96858
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
96859
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
96860
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
96861
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
96518
96862
|
*/
|
|
96519
|
-
renderRow: (event: { source:
|
|
96863
|
+
renderRow: (event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void
|
|
96520
96864
|
/**
|
|
96521
96865
|
* Grid rows have been rendered
|
|
96522
96866
|
* @param {object} event Event object
|
|
96523
|
-
* @param {Grid.view.
|
|
96867
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
96524
96868
|
*/
|
|
96525
|
-
renderRows: (event: { source:
|
|
96869
|
+
renderRows: (event: { source: GridBase }) => void
|
|
96526
96870
|
/**
|
|
96527
96871
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
96528
96872
|
* @param {object} event Event object
|
|
@@ -96582,10 +96926,10 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
96582
96926
|
/**
|
|
96583
96927
|
* Grid has scrolled vertically
|
|
96584
96928
|
* @param {object} event Event object
|
|
96585
|
-
* @param {Grid.view.
|
|
96929
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
96586
96930
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
96587
96931
|
*/
|
|
96588
|
-
scroll: (event: { source:
|
|
96932
|
+
scroll: (event: { source: GridBase, scrollTop: number }) => void
|
|
96589
96933
|
/**
|
|
96590
96934
|
* The selection has been changed.
|
|
96591
96935
|
* @param {object} event Event object
|
|
@@ -96673,17 +97017,17 @@ type TimelineHistogramGroupingClassListenersTypes = {
|
|
|
96673
97017
|
/**
|
|
96674
97018
|
* Fires after a sub grid is collapsed.
|
|
96675
97019
|
* @param {object} event Event object
|
|
96676
|
-
* @param {Grid.view.
|
|
97020
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
96677
97021
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
96678
97022
|
*/
|
|
96679
|
-
subGridCollapse: (event: { source:
|
|
97023
|
+
subGridCollapse: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
96680
97024
|
/**
|
|
96681
97025
|
* Fires after a sub grid is expanded.
|
|
96682
97026
|
* @param {object} event Event object
|
|
96683
|
-
* @param {Grid.view.
|
|
97027
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
96684
97028
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
96685
97029
|
*/
|
|
96686
|
-
subGridExpand: (event: { source:
|
|
97030
|
+
subGridExpand: (event: { source: GridBase, subGrid: SubGrid }) => void
|
|
96687
97031
|
/**
|
|
96688
97032
|
* Fired when the tick size changes.
|
|
96689
97033
|
* ...
|
|
@@ -96869,6 +97213,14 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
96869
97213
|
* @param {any} event.value The value being set
|
|
96870
97214
|
*/
|
|
96871
97215
|
beforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
97216
|
+
/**
|
|
97217
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
97218
|
+
* @param {object} event Event object
|
|
97219
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
97220
|
+
* @param {Grid.column.Column} event.column The column
|
|
97221
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
97222
|
+
*/
|
|
97223
|
+
beforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
96872
97224
|
/**
|
|
96873
97225
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
96874
97226
|
* @param {object} event Event object
|
|
@@ -96987,9 +97339,9 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
96987
97339
|
/**
|
|
96988
97340
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
96989
97341
|
* @param {object} event Event object
|
|
96990
|
-
* @param {
|
|
97342
|
+
* @param {PdfExportConfig} event.config Export config
|
|
96991
97343
|
*/
|
|
96992
|
-
beforePdfExport?: ((event: { config:
|
|
97344
|
+
beforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
96993
97345
|
/**
|
|
96994
97346
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
96995
97347
|
* @param {object} event Event object
|
|
@@ -97023,18 +97375,18 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97023
97375
|
/**
|
|
97024
97376
|
* Fires before a row is rendered.
|
|
97025
97377
|
* @param {object} event Event object
|
|
97026
|
-
* @param {Grid.view.
|
|
97027
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
97028
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
97029
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
97378
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
97379
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
97380
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
97381
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
97030
97382
|
*/
|
|
97031
|
-
beforeRenderRow?: ((event: { source:
|
|
97383
|
+
beforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
97032
97384
|
/**
|
|
97033
97385
|
* Grid rows are about to be rendered
|
|
97034
97386
|
* @param {object} event Event object
|
|
97035
|
-
* @param {Grid.view.
|
|
97387
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
97036
97388
|
*/
|
|
97037
|
-
beforeRenderRows?: ((event: { source:
|
|
97389
|
+
beforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
97038
97390
|
/**
|
|
97039
97391
|
* This event fires before row collapse is started.
|
|
97040
97392
|
* ...
|
|
@@ -97265,6 +97617,14 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97265
97617
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
97266
97618
|
*/
|
|
97267
97619
|
collapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
97620
|
+
/**
|
|
97621
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
97622
|
+
* @param {object} event Event object
|
|
97623
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
97624
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
97625
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
97626
|
+
*/
|
|
97627
|
+
columnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
97268
97628
|
/**
|
|
97269
97629
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
97270
97630
|
* to indicate whether the drop position is valid or not.
|
|
@@ -97346,14 +97706,14 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97346
97706
|
* ...
|
|
97347
97707
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#event-dataChange)
|
|
97348
97708
|
* @param {object} event Event object
|
|
97349
|
-
* @param {Grid.view.
|
|
97709
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
97350
97710
|
* @param {Core.data.Store} event.store The originating store
|
|
97351
97711
|
* @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'`
|
|
97352
97712
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
97353
97713
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
97354
97714
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
97355
97715
|
*/
|
|
97356
|
-
dataChange?: ((event: { source:
|
|
97716
|
+
dataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
97357
97717
|
/**
|
|
97358
97718
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
97359
97719
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -97707,18 +98067,18 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97707
98067
|
/**
|
|
97708
98068
|
* Fires after a row is rendered.
|
|
97709
98069
|
* @param {object} event Event object
|
|
97710
|
-
* @param {Grid.view.
|
|
97711
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
97712
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
97713
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
98070
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
98071
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
98072
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
98073
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
97714
98074
|
*/
|
|
97715
|
-
renderRow?: ((event: { source:
|
|
98075
|
+
renderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
97716
98076
|
/**
|
|
97717
98077
|
* Grid rows have been rendered
|
|
97718
98078
|
* @param {object} event Event object
|
|
97719
|
-
* @param {Grid.view.
|
|
98079
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
97720
98080
|
*/
|
|
97721
|
-
renderRows?: ((event: { source:
|
|
98081
|
+
renderRows?: ((event: { source: GridBase }) => void)|string
|
|
97722
98082
|
/**
|
|
97723
98083
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
97724
98084
|
* @param {object} event Event object
|
|
@@ -97778,10 +98138,10 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97778
98138
|
/**
|
|
97779
98139
|
* Grid has scrolled vertically
|
|
97780
98140
|
* @param {object} event Event object
|
|
97781
|
-
* @param {Grid.view.
|
|
98141
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
97782
98142
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
97783
98143
|
*/
|
|
97784
|
-
scroll?: ((event: { source:
|
|
98144
|
+
scroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
97785
98145
|
/**
|
|
97786
98146
|
* The selection has been changed.
|
|
97787
98147
|
* @param {object} event Event object
|
|
@@ -97869,17 +98229,17 @@ type TimelineHistogramGroupingClassListeners = {
|
|
|
97869
98229
|
/**
|
|
97870
98230
|
* Fires after a sub grid is collapsed.
|
|
97871
98231
|
* @param {object} event Event object
|
|
97872
|
-
* @param {Grid.view.
|
|
98232
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
97873
98233
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
97874
98234
|
*/
|
|
97875
|
-
subGridCollapse?: ((event: { source:
|
|
98235
|
+
subGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
97876
98236
|
/**
|
|
97877
98237
|
* Fires after a sub grid is expanded.
|
|
97878
98238
|
* @param {object} event Event object
|
|
97879
|
-
* @param {Grid.view.
|
|
98239
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
97880
98240
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
97881
98241
|
*/
|
|
97882
|
-
subGridExpand?: ((event: { source:
|
|
98242
|
+
subGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
97883
98243
|
/**
|
|
97884
98244
|
* Fired when the tick size changes.
|
|
97885
98245
|
* ...
|
|
@@ -99335,6 +99695,14 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99335
99695
|
* @param {any} event.value The value being set
|
|
99336
99696
|
*/
|
|
99337
99697
|
onBeforeCellRangeEdit?: ((event: { record: Model, field: string, value: any }) => Promise<boolean>|boolean|void)|string
|
|
99698
|
+
/**
|
|
99699
|
+
* This event is triggered before a parent column is collapsed or expanded.
|
|
99700
|
+
* @param {object} event Event object
|
|
99701
|
+
* @param {Grid.view.GridBase} event.source The grid instance
|
|
99702
|
+
* @param {Grid.column.Column} event.column The column
|
|
99703
|
+
* @param {boolean} event.collapsed `true` if the column is being collapsed, `false` if expanded
|
|
99704
|
+
*/
|
|
99705
|
+
onBeforeColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
99338
99706
|
/**
|
|
99339
99707
|
* This event is fired prior to starting a column drag gesture. The drag is canceled if a listener returns `false`.
|
|
99340
99708
|
* @param {object} event Event object
|
|
@@ -99453,9 +99821,9 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99453
99821
|
/**
|
|
99454
99822
|
* Fires on the owning Grid before export started. Return `false` to cancel the export.
|
|
99455
99823
|
* @param {object} event Event object
|
|
99456
|
-
* @param {
|
|
99824
|
+
* @param {PdfExportConfig} event.config Export config
|
|
99457
99825
|
*/
|
|
99458
|
-
onBeforePdfExport?: ((event: { config:
|
|
99826
|
+
onBeforePdfExport?: ((event: { config: PdfExportConfig }) => Promise<boolean>|boolean|void)|string
|
|
99459
99827
|
/**
|
|
99460
99828
|
* Fired before the [viewPreset](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineViewPresets#config-viewPreset) is changed.
|
|
99461
99829
|
* @param {object} event Event object
|
|
@@ -99489,18 +99857,18 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99489
99857
|
/**
|
|
99490
99858
|
* Fires before a row is rendered.
|
|
99491
99859
|
* @param {object} event Event object
|
|
99492
|
-
* @param {Grid.view.
|
|
99493
|
-
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
99494
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
99495
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
99860
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
99861
|
+
* @param {Grid.row.Row} event.row The row about to be rendered
|
|
99862
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
99863
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
99496
99864
|
*/
|
|
99497
|
-
onBeforeRenderRow?: ((event: { source:
|
|
99865
|
+
onBeforeRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
99498
99866
|
/**
|
|
99499
99867
|
* Grid rows are about to be rendered
|
|
99500
99868
|
* @param {object} event Event object
|
|
99501
|
-
* @param {Grid.view.
|
|
99869
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
99502
99870
|
*/
|
|
99503
|
-
onBeforeRenderRows?: ((event: { source:
|
|
99871
|
+
onBeforeRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
99504
99872
|
/**
|
|
99505
99873
|
* This event fires before row collapse is started.
|
|
99506
99874
|
* ...
|
|
@@ -99731,6 +100099,14 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99731
100099
|
* @param {Core.data.Model} event.record The record which has been collapsed.
|
|
99732
100100
|
*/
|
|
99733
100101
|
onCollapseNode?: ((event: { source: Grid, record: Model }) => void)|string
|
|
100102
|
+
/**
|
|
100103
|
+
* This event is triggered after a parent column has been collapsed or expanded.
|
|
100104
|
+
* @param {object} event Event object
|
|
100105
|
+
* @param {Grid.view.GridBase} event.source The Grid instance
|
|
100106
|
+
* @param {Grid.column.Column} event.column The column being toggled
|
|
100107
|
+
* @param {boolean} event.collapsed `true` if the column is now collapsed, `false` if expanded
|
|
100108
|
+
*/
|
|
100109
|
+
onColumnCollapseToggle?: ((event: { source: GridBase, column: Column, collapsed: boolean }) => void)|string
|
|
99734
100110
|
/**
|
|
99735
100111
|
* This event is fired when a column is being dragged, and you can set the `valid` flag on the `context` object
|
|
99736
100112
|
* to indicate whether the drop position is valid or not.
|
|
@@ -99812,14 +100188,14 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
99812
100188
|
* ...
|
|
99813
100189
|
* [View online docs...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#event-dataChange)
|
|
99814
100190
|
* @param {object} event Event object
|
|
99815
|
-
* @param {Grid.view.
|
|
100191
|
+
* @param {Grid.view.GridBase} event.source Owning grid
|
|
99816
100192
|
* @param {Core.data.Store} event.store The originating store
|
|
99817
100193
|
* @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'`
|
|
99818
100194
|
* @param {Core.data.Model} event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
99819
100195
|
* @param {Core.data.Model[]} event.records Changed records, passed for all actions except `'removeAll'`
|
|
99820
100196
|
* @param {object} event.changes Passed for the `'update'` action, info on which record fields changed
|
|
99821
100197
|
*/
|
|
99822
|
-
onDataChange?: ((event: { source:
|
|
100198
|
+
onDataChange?: ((event: { source: GridBase, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string
|
|
99823
100199
|
/**
|
|
99824
100200
|
* Fired when the range of dates encapsulated by the UI changes. This will be when
|
|
99825
100201
|
* moving a view in time by reconfiguring its [timeAxis](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-timeAxis). This will happen
|
|
@@ -100173,18 +100549,18 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
100173
100549
|
/**
|
|
100174
100550
|
* Fires after a row is rendered.
|
|
100175
100551
|
* @param {object} event Event object
|
|
100176
|
-
* @param {Grid.view.
|
|
100177
|
-
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
100178
|
-
* @param {Core.data.Model} event.record The record for the row
|
|
100179
|
-
* @param {number} event.recordIndex The zero-based index of the record
|
|
100552
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
100553
|
+
* @param {Grid.row.Row} event.row The row that has been rendered
|
|
100554
|
+
* @param {Core.data.Model} event.record The record for the row
|
|
100555
|
+
* @param {number} event.recordIndex The zero-based index of the record
|
|
100180
100556
|
*/
|
|
100181
|
-
onRenderRow?: ((event: { source:
|
|
100557
|
+
onRenderRow?: ((event: { source: GridBase, row: Row, record: Model, recordIndex: number }) => void)|string
|
|
100182
100558
|
/**
|
|
100183
100559
|
* Grid rows have been rendered
|
|
100184
100560
|
* @param {object} event Event object
|
|
100185
|
-
* @param {Grid.view.
|
|
100561
|
+
* @param {Grid.view.GridBase} event.source This grid.
|
|
100186
100562
|
*/
|
|
100187
|
-
onRenderRows?: ((event: { source:
|
|
100563
|
+
onRenderRows?: ((event: { source: GridBase }) => void)|string
|
|
100188
100564
|
/**
|
|
100189
100565
|
* Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
|
|
100190
100566
|
* @param {object} event Event object
|
|
@@ -100244,10 +100620,10 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
100244
100620
|
/**
|
|
100245
100621
|
* Grid has scrolled vertically
|
|
100246
100622
|
* @param {object} event Event object
|
|
100247
|
-
* @param {Grid.view.
|
|
100623
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance.
|
|
100248
100624
|
* @param {number} event.scrollTop The vertical scroll position.
|
|
100249
100625
|
*/
|
|
100250
|
-
onScroll?: ((event: { source:
|
|
100626
|
+
onScroll?: ((event: { source: GridBase, scrollTop: number }) => void)|string
|
|
100251
100627
|
/**
|
|
100252
100628
|
* The selection has been changed.
|
|
100253
100629
|
* @param {object} event Event object
|
|
@@ -100335,17 +100711,17 @@ type TimelineHistogramGroupingClassConfig = {
|
|
|
100335
100711
|
/**
|
|
100336
100712
|
* Fires after a sub grid is collapsed.
|
|
100337
100713
|
* @param {object} event Event object
|
|
100338
|
-
* @param {Grid.view.
|
|
100714
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
100339
100715
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
100340
100716
|
*/
|
|
100341
|
-
onSubGridCollapse?: ((event: { source:
|
|
100717
|
+
onSubGridCollapse?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
100342
100718
|
/**
|
|
100343
100719
|
* Fires after a sub grid is expanded.
|
|
100344
100720
|
* @param {object} event Event object
|
|
100345
|
-
* @param {Grid.view.
|
|
100721
|
+
* @param {Grid.view.GridBase} event.source The firing Grid instance
|
|
100346
100722
|
* @param {Grid.view.SubGrid} event.subGrid The sub grid instance
|
|
100347
100723
|
*/
|
|
100348
|
-
onSubGridExpand?: ((event: { source:
|
|
100724
|
+
onSubGridExpand?: ((event: { source: GridBase, subGrid: SubGrid }) => void)|string
|
|
100349
100725
|
/**
|
|
100350
100726
|
* Fired when the tick size changes.
|
|
100351
100727
|
* ...
|