@bryntum/scheduler-trial 7.3.1 → 7.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (52) hide show
  1. package/README.md +22 -0
  2. package/locales/scheduler.locale.Ar.js +1 -1
  3. package/locales/scheduler.locale.Bg.js +1 -1
  4. package/locales/scheduler.locale.Ca.js +1 -1
  5. package/locales/scheduler.locale.Cs.js +1 -1
  6. package/locales/scheduler.locale.Da.js +1 -1
  7. package/locales/scheduler.locale.De.js +1 -1
  8. package/locales/scheduler.locale.El.js +1 -1
  9. package/locales/scheduler.locale.En.js +1 -1
  10. package/locales/scheduler.locale.EnGb.js +1 -1
  11. package/locales/scheduler.locale.Es.js +1 -1
  12. package/locales/scheduler.locale.Et.js +1 -1
  13. package/locales/scheduler.locale.Eu.js +1 -1
  14. package/locales/scheduler.locale.Fi.js +1 -1
  15. package/locales/scheduler.locale.FrFr.js +1 -1
  16. package/locales/scheduler.locale.Gl.js +1 -1
  17. package/locales/scheduler.locale.He.js +1 -1
  18. package/locales/scheduler.locale.Hi.js +1 -1
  19. package/locales/scheduler.locale.Hr.js +1 -1
  20. package/locales/scheduler.locale.Hu.js +1 -1
  21. package/locales/scheduler.locale.Id.js +1 -1
  22. package/locales/scheduler.locale.It.js +1 -1
  23. package/locales/scheduler.locale.Ja.js +1 -1
  24. package/locales/scheduler.locale.Kk.js +1 -1
  25. package/locales/scheduler.locale.Ko.js +1 -1
  26. package/locales/scheduler.locale.Lt.js +1 -1
  27. package/locales/scheduler.locale.Lv.js +1 -1
  28. package/locales/scheduler.locale.Ms.js +1 -1
  29. package/locales/scheduler.locale.Nl.js +1 -1
  30. package/locales/scheduler.locale.No.js +1 -1
  31. package/locales/scheduler.locale.Pl.js +1 -1
  32. package/locales/scheduler.locale.Pt.js +1 -1
  33. package/locales/scheduler.locale.PtBr.js +1 -1
  34. package/locales/scheduler.locale.Ro.js +1 -1
  35. package/locales/scheduler.locale.Ru.js +1 -1
  36. package/locales/scheduler.locale.Sk.js +1 -1
  37. package/locales/scheduler.locale.Sl.js +1 -1
  38. package/locales/scheduler.locale.Sr.js +1 -1
  39. package/locales/scheduler.locale.SrRs.js +1 -1
  40. package/locales/scheduler.locale.SvSE.js +1 -1
  41. package/locales/scheduler.locale.Th.js +1 -1
  42. package/locales/scheduler.locale.Tr.js +1 -1
  43. package/locales/scheduler.locale.Uk.js +1 -1
  44. package/locales/scheduler.locale.Vi.js +1 -1
  45. package/locales/scheduler.locale.ZhCn.js +1 -1
  46. package/locales/scheduler.locale.ZhTw.js +1 -1
  47. package/package.json +1 -1
  48. package/scheduler.css +1 -1
  49. package/scheduler.d.ts +1710 -628
  50. package/scheduler.module.js +46 -46
  51. package/scheduler.thin.d.ts +623 -193
  52. package/scheduler.umd.js +57 -57
@@ -80,6 +80,62 @@ type CrudManagerStoreDescriptor = {
80
80
  writeAllFields?: boolean
81
81
  }
82
82
 
83
+ /**
84
+ * State object passed to the resolve/reject handlers of the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load)
85
+ * Promise.
86
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#typedef-CrudManagerLoadResult)
87
+ */
88
+ type CrudManagerLoadResult = {
89
+ /**
90
+ * Processed response in form of object.
91
+ */
92
+ response: object
93
+ /**
94
+ * The native `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
95
+ */
96
+ rawResponse: Response
97
+ /**
98
+ * Raw response text as String from the request.
99
+ */
100
+ responseText: string
101
+ /**
102
+ * The request descriptor object.
103
+ */
104
+ request: object
105
+ /**
106
+ * Present (and `true`) when the promise was rejected because the request was cancelled.
107
+ */
108
+ cancelled?: boolean
109
+ }
110
+
111
+ /**
112
+ * State object passed to the resolve/reject handlers of the [sync](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync)
113
+ * Promise.
114
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#typedef-CrudManagerSyncResult)
115
+ */
116
+ type CrudManagerSyncResult = {
117
+ /**
118
+ * Processed response in form of object.
119
+ */
120
+ response: object
121
+ /**
122
+ * The native `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
123
+ */
124
+ rawResponse: Response
125
+ /**
126
+ * Raw response text as String from the request.
127
+ */
128
+ responseText: string
129
+ /**
130
+ * The request descriptor object.
131
+ */
132
+ request: object
133
+ /**
134
+ * Present (and `true`) when the promise was rejected because the request was cancelled.
135
+ */
136
+ cancelled?: boolean
137
+ }
138
+
83
139
  /**
84
140
  * An object containing details about the requested data
85
141
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/mixin/LazyLoadCrudManager#typedef-LazyLoadCrudManagerRequestParams)
@@ -775,7 +831,7 @@ type DurationColumnConfig = {
775
831
  */
776
832
  alwaysClearCell?: boolean
777
833
  /**
778
- * The `aria-label` to use for this Column`s header element
834
+ * The `aria-label` to use for this Column's header element
779
835
  */
780
836
  ariaLabel?: string
781
837
  /**
@@ -1497,7 +1553,7 @@ type EventColorColumnConfig = {
1497
1553
  */
1498
1554
  alwaysClearCell?: boolean
1499
1555
  /**
1500
- * The `aria-label` to use for this Column`s header element
1556
+ * The `aria-label` to use for this Column's header element
1501
1557
  */
1502
1558
  ariaLabel?: string
1503
1559
  /**
@@ -2167,7 +2223,13 @@ type ResourceCollapseColumnConfig = {
2167
2223
  */
2168
2224
  alwaysClearCell?: boolean
2169
2225
  /**
2170
- * The `aria-label` to use for this Column`s header element
2226
+ * Controls when to use a resource's per-record [rowHeight](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#field-rowHeight),
2227
+ * whether the row is collapsed (`eventLayout === 'none'`) or expanded (`eventLayout === 'stack'`).
2228
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceCollapseColumn#config-applyResourceRowHeightOnCollapse)
2229
+ */
2230
+ applyResourceRowHeightOnCollapse?: boolean
2231
+ /**
2232
+ * The `aria-label` to use for this Column's header element
2171
2233
  */
2172
2234
  ariaLabel?: string
2173
2235
  /**
@@ -2685,10 +2747,9 @@ type ResourceCollapseColumnConfig = {
2685
2747
  }
2686
2748
 
2687
2749
  /**
2688
- * A column toggling the resource [eventLayout](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#field-eventLayout) between `none` and the
2689
- * row's previously remembered layout. When collapsed (`none`), all events in a row overlap and the row takes
2690
- * minimal height; the current layout is memorized so that expanding restores `eventLayout` to that remembered value
2691
- * (falling back to `stack`).
2750
+ * A column toggling the resource [eventLayout](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#field-eventLayout) between `none` and `stack`.
2751
+ * When collapsed (`none`), all events in a row overlap and the row takes minimal height. Click the toggle to expand
2752
+ * the row to `stack` layout, which spaces events vertically.
2692
2753
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceCollapseColumn)
2693
2754
  */
2694
2755
  export class ResourceCollapseColumn extends Column {
@@ -2696,6 +2757,11 @@ export class ResourceCollapseColumn extends Column {
2696
2757
  * Identifies an object as an instance of [ResourceCollapseColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceCollapseColumn) class, or subclass thereof.
2697
2758
  */
2698
2759
  static readonly isResourceCollapseColumn: boolean
2760
+ /**
2761
+ * Controls when to use a resource's per-record [rowHeight](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#field-rowHeight),
2762
+ * whether the row is collapsed (`eventLayout === 'none'`) or expanded (`eventLayout === 'stack'`).
2763
+ */
2764
+ applyResourceRowHeightOnCollapse: boolean
2699
2765
  /**
2700
2766
  * Identifies an object as an instance of [ResourceCollapseColumn](https://bryntum.com/products/scheduler/docs/api/Scheduler/column/ResourceCollapseColumn) class, or subclass thereof.
2701
2767
  */
@@ -2720,6 +2786,13 @@ export class ResourceCollapseColumn extends Column {
2720
2786
  * @param {Core.Base} event.source The Object that is being destroyed.
2721
2787
  */
2722
2788
  onDestroy: ((event: { source: Base }) => void)|string
2789
+ /**
2790
+ * Constructs a new record from the supplied data config.
2791
+ * @param {ProjectModelMixinClassConfig} [config] Raw model config
2792
+ * @param {Core.data.Store} [store] Data store
2793
+ * @param {object} [meta] Meta data
2794
+ */
2795
+ constructor(config?: ResourceCollapseColumnConfig, store?: Store, meta?: object);
2723
2796
  }
2724
2797
 
2725
2798
  /**
@@ -2816,7 +2889,7 @@ type ResourceInfoColumnConfig = {
2816
2889
  */
2817
2890
  alwaysClearCell?: boolean
2818
2891
  /**
2819
- * The `aria-label` to use for this Column`s header element
2892
+ * The `aria-label` to use for this Column's header element
2820
2893
  */
2821
2894
  ariaLabel?: string
2822
2895
  /**
@@ -3529,7 +3602,7 @@ type ScaleColumnConfig = {
3529
3602
  */
3530
3603
  alwaysClearCell?: boolean
3531
3604
  /**
3532
- * The `aria-label` to use for this Column`s header element
3605
+ * The `aria-label` to use for this Column's header element
3533
3606
  */
3534
3607
  ariaLabel?: string
3535
3608
  /**
@@ -4220,7 +4293,7 @@ type TimeAxisColumnConfig = {
4220
4293
  */
4221
4294
  alwaysClearCell?: boolean
4222
4295
  /**
4223
- * The `aria-label` to use for this Column`s header element
4296
+ * The `aria-label` to use for this Column's header element
4224
4297
  */
4225
4298
  ariaLabel?: string
4226
4299
  /**
@@ -4918,7 +4991,7 @@ type VerticalTimeAxisColumnConfig = {
4918
4991
  */
4919
4992
  alwaysClearCell?: boolean
4920
4993
  /**
4921
- * The `aria-label` to use for this Column`s header element
4994
+ * The `aria-label` to use for this Column's header element
4922
4995
  */
4923
4996
  ariaLabel?: string
4924
4997
  /**
@@ -5514,9 +5587,10 @@ type AbstractCrudManagerListenersTypes = {
5514
5587
  * @param {object} event.response The decoded server response object.
5515
5588
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
5516
5589
  * @param {object} event.requestOptions The request options passed to the request.
5590
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
5517
5591
  * @param {Response} event.rawResponse The native Response object
5518
5592
  */
5519
- load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
5593
+ load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
5520
5594
  /**
5521
5595
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
5522
5596
  * listener or due to incomplete prior load request.
@@ -5533,9 +5607,10 @@ type AbstractCrudManagerListenersTypes = {
5533
5607
  * @param {string} event.responseText The raw server response text
5534
5608
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
5535
5609
  * @param {object} event.requestOptions The request options passed to the request.
5610
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
5536
5611
  * @param {Response} event.rawResponse The native Response object
5537
5612
  */
5538
- loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
5613
+ loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
5539
5614
  /**
5540
5615
  * Fires when registered stores get into state when they don't have any
5541
5616
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -5688,9 +5763,10 @@ type AbstractCrudManagerListeners = {
5688
5763
  * @param {object} event.response The decoded server response object.
5689
5764
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
5690
5765
  * @param {object} event.requestOptions The request options passed to the request.
5766
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
5691
5767
  * @param {Response} event.rawResponse The native Response object
5692
5768
  */
5693
- load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
5769
+ load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
5694
5770
  /**
5695
5771
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
5696
5772
  * listener or due to incomplete prior load request.
@@ -5707,9 +5783,10 @@ type AbstractCrudManagerListeners = {
5707
5783
  * @param {string} event.responseText The raw server response text
5708
5784
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
5709
5785
  * @param {object} event.requestOptions The request options passed to the request.
5786
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
5710
5787
  * @param {Response} event.rawResponse The native Response object
5711
5788
  */
5712
- loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
5789
+ loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
5713
5790
  /**
5714
5791
  * Fires when registered stores get into state when they don't have any
5715
5792
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -5995,9 +6072,10 @@ type AbstractCrudManagerConfig = {
5995
6072
  * @param {object} event.response The decoded server response object.
5996
6073
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
5997
6074
  * @param {object} event.requestOptions The request options passed to the request.
6075
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
5998
6076
  * @param {Response} event.rawResponse The native Response object
5999
6077
  */
6000
- onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6078
+ onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6001
6079
  /**
6002
6080
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
6003
6081
  * listener or due to incomplete prior load request.
@@ -6014,9 +6092,10 @@ type AbstractCrudManagerConfig = {
6014
6092
  * @param {string} event.responseText The raw server response text
6015
6093
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6016
6094
  * @param {object} event.requestOptions The request options passed to the request.
6095
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6017
6096
  * @param {Response} event.rawResponse The native Response object
6018
6097
  */
6019
- onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6098
+ onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6020
6099
  /**
6021
6100
  * Fires when registered stores get into state when they don't have any
6022
6101
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -6297,9 +6376,10 @@ export abstract class AbstractCrudManager extends Base {
6297
6376
  * @param {object} event.response The decoded server response object.
6298
6377
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6299
6378
  * @param {object} event.requestOptions The request options passed to the request.
6379
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6300
6380
  * @param {Response} event.rawResponse The native Response object
6301
6381
  */
6302
- onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6382
+ onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6303
6383
  /**
6304
6384
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
6305
6385
  * listener or due to incomplete prior load request.
@@ -6316,9 +6396,10 @@ export abstract class AbstractCrudManager extends Base {
6316
6396
  * @param {string} event.responseText The raw server response text
6317
6397
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6318
6398
  * @param {object} event.requestOptions The request options passed to the request.
6399
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6319
6400
  * @param {Response} event.rawResponse The native Response object
6320
6401
  */
6321
- onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6402
+ onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6322
6403
  /**
6323
6404
  * Fires when registered stores get into state when they don't have any
6324
6405
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -6502,7 +6583,7 @@ export abstract class AbstractCrudManager extends Base {
6502
6583
  * @param {string} [options.request.failure.rawResponse] `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
6503
6584
  * @param {object} [options.request.thisObj] `this` reference for the above `success` and `failure` functions.
6504
6585
  */
6505
- load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<any>;
6586
+ load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<CrudManagerLoadResult>;
6506
6587
  /**
6507
6588
  * Loads data to the Crud Manager
6508
6589
  * @param {object} response A simple object representing the data. The object structure matches the decoded `load` response structure: ```javascript // load static data into crudManager crudManager.loadCrudManagerData({ success : true, resources : { rows : [ { id : 1, name : 'John' }, { id : 2, name : 'Abby' } ] } }); ```
@@ -6588,6 +6669,7 @@ export abstract class AbstractCrudManager extends Base {
6588
6669
  suspendAutoSync(): void;
6589
6670
  /**
6590
6671
  * Suspends [hasChanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#event-hasChanges) and [noChanges](#Scheduler/crud/AbstractCrudManagerMixin#event-noChanges) events.
6672
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManager#function-suspendChangeTracking)
6591
6673
  */
6592
6674
  suspendChangeTracking(): void;
6593
6675
  /**
@@ -6601,7 +6683,7 @@ export abstract class AbstractCrudManager extends Base {
6601
6683
  * Usage:
6602
6684
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManager#function-sync)
6603
6685
  */
6604
- sync(): Promise<any>;
6686
+ sync(): Promise<CrudManagerSyncResult>;
6605
6687
  /**
6606
6688
  * Returns the data from all CrudManager `crudStores` in a format that can be consumed by `inlineData`.
6607
6689
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManager#function-toJSON)
@@ -6705,9 +6787,10 @@ type AbstractCrudManagerMixinClassListenersTypes = {
6705
6787
  * @param {object} event.response The decoded server response object.
6706
6788
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6707
6789
  * @param {object} event.requestOptions The request options passed to the request.
6790
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6708
6791
  * @param {Response} event.rawResponse The native Response object
6709
6792
  */
6710
- load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
6793
+ load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
6711
6794
  /**
6712
6795
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
6713
6796
  * listener or due to incomplete prior load request.
@@ -6724,9 +6807,10 @@ type AbstractCrudManagerMixinClassListenersTypes = {
6724
6807
  * @param {string} event.responseText The raw server response text
6725
6808
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6726
6809
  * @param {object} event.requestOptions The request options passed to the request.
6810
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6727
6811
  * @param {Response} event.rawResponse The native Response object
6728
6812
  */
6729
- loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
6813
+ loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
6730
6814
  /**
6731
6815
  * Fires when registered stores get into state when they don't have any
6732
6816
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -6879,9 +6963,10 @@ type AbstractCrudManagerMixinClassListeners = {
6879
6963
  * @param {object} event.response The decoded server response object.
6880
6964
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6881
6965
  * @param {object} event.requestOptions The request options passed to the request.
6966
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6882
6967
  * @param {Response} event.rawResponse The native Response object
6883
6968
  */
6884
- load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6969
+ load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6885
6970
  /**
6886
6971
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
6887
6972
  * listener or due to incomplete prior load request.
@@ -6898,9 +6983,10 @@ type AbstractCrudManagerMixinClassListeners = {
6898
6983
  * @param {string} event.responseText The raw server response text
6899
6984
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
6900
6985
  * @param {object} event.requestOptions The request options passed to the request.
6986
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
6901
6987
  * @param {Response} event.rawResponse The native Response object
6902
6988
  */
6903
- loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
6989
+ loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
6904
6990
  /**
6905
6991
  * Fires when registered stores get into state when they don't have any
6906
6992
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -7181,9 +7267,10 @@ type AbstractCrudManagerMixinClassConfig = {
7181
7267
  * @param {object} event.response The decoded server response object.
7182
7268
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
7183
7269
  * @param {object} event.requestOptions The request options passed to the request.
7270
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
7184
7271
  * @param {Response} event.rawResponse The native Response object
7185
7272
  */
7186
- onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
7273
+ onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
7187
7274
  /**
7188
7275
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
7189
7276
  * listener or due to incomplete prior load request.
@@ -7200,9 +7287,10 @@ type AbstractCrudManagerMixinClassConfig = {
7200
7287
  * @param {string} event.responseText The raw server response text
7201
7288
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
7202
7289
  * @param {object} event.requestOptions The request options passed to the request.
7290
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
7203
7291
  * @param {Response} event.rawResponse The native Response object
7204
7292
  */
7205
- onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
7293
+ onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
7206
7294
  /**
7207
7295
  * Fires when registered stores get into state when they don't have any
7208
7296
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -7443,9 +7531,10 @@ export abstract class AbstractCrudManagerMixinClass {
7443
7531
  * @param {object} event.response The decoded server response object.
7444
7532
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
7445
7533
  * @param {object} event.requestOptions The request options passed to the request.
7534
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
7446
7535
  * @param {Response} event.rawResponse The native Response object
7447
7536
  */
7448
- onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
7537
+ onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
7449
7538
  /**
7450
7539
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
7451
7540
  * listener or due to incomplete prior load request.
@@ -7462,9 +7551,10 @@ export abstract class AbstractCrudManagerMixinClass {
7462
7551
  * @param {string} event.responseText The raw server response text
7463
7552
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
7464
7553
  * @param {object} event.requestOptions The request options passed to the request.
7554
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
7465
7555
  * @param {Response} event.rawResponse The native Response object
7466
7556
  */
7467
- onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
7557
+ onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
7468
7558
  /**
7469
7559
  * Fires when registered stores get into state when they don't have any
7470
7560
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -7640,7 +7730,7 @@ export abstract class AbstractCrudManagerMixinClass {
7640
7730
  * @param {string} [options.request.failure.rawResponse] `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
7641
7731
  * @param {object} [options.request.thisObj] `this` reference for the above `success` and `failure` functions.
7642
7732
  */
7643
- load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<any>;
7733
+ load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<CrudManagerLoadResult>;
7644
7734
  /**
7645
7735
  * Loads data to the Crud Manager
7646
7736
  * @param {object} response A simple object representing the data. The object structure matches the decoded `load` response structure: ```javascript // load static data into crudManager crudManager.loadCrudManagerData({ success : true, resources : { rows : [ { id : 1, name : 'John' }, { id : 2, name : 'Abby' } ] } }); ```
@@ -7726,6 +7816,7 @@ export abstract class AbstractCrudManagerMixinClass {
7726
7816
  suspendAutoSync(): void;
7727
7817
  /**
7728
7818
  * Suspends [hasChanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#event-hasChanges) and [noChanges](#Scheduler/crud/AbstractCrudManagerMixin#event-noChanges) events.
7819
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-suspendChangeTracking)
7729
7820
  */
7730
7821
  suspendChangeTracking(): void;
7731
7822
  /**
@@ -7739,7 +7830,7 @@ export abstract class AbstractCrudManagerMixinClass {
7739
7830
  * Usage:
7740
7831
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync)
7741
7832
  */
7742
- sync(): Promise<any>;
7833
+ sync(): Promise<CrudManagerSyncResult>;
7743
7834
  /**
7744
7835
  * Triggers an event, calling all registered listeners with the supplied arguments. Returning false from any listener
7745
7836
  * makes function return false.
@@ -8912,6 +9003,22 @@ type AssignmentStoreConfig = {
8912
9003
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AssignmentStore#config-dontRelayToMaster)
8913
9004
  */
8914
9005
  dontRelayToMaster?: string
9006
+ /**
9007
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
9008
+ * any filters to the server upon load.
9009
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AssignmentStore#config-encodeFilterParams)
9010
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
9011
+ * @returns {string} The encoded value for the filter parameter.
9012
+ */
9013
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
9014
+ /**
9015
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
9016
+ * any sorters to the server upon load.
9017
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AssignmentStore#config-encodeSorterParams)
9018
+ * @param {Sorter[]} sorters The sorters to encode.
9019
+ * @returns {string} The encoded value for the sort parameter.
9020
+ */
9021
+ encodeSorterParams?: (sorters: Sorter[]) => string
8915
9022
  /**
8916
9023
  * If `true`, collapsed records in original tree will be excluded from the chained store.
8917
9024
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/AssignmentStore#config-excludeCollapsedRecords)
@@ -9261,7 +9368,7 @@ type AssignmentStoreConfig = {
9261
9368
  */
9262
9369
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
9263
9370
  /**
9264
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
9371
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
9265
9372
  */
9266
9373
  useRestfulMethods?: boolean
9267
9374
  /**
@@ -10081,9 +10188,10 @@ type CrudManagerListenersTypes = {
10081
10188
  * @param {object} event.response The decoded server response object.
10082
10189
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10083
10190
  * @param {object} event.requestOptions The request options passed to the request.
10191
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10084
10192
  * @param {Response} event.rawResponse The native Response object
10085
10193
  */
10086
- load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
10194
+ load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
10087
10195
  /**
10088
10196
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
10089
10197
  * listener or due to incomplete prior load request.
@@ -10100,9 +10208,10 @@ type CrudManagerListenersTypes = {
10100
10208
  * @param {string} event.responseText The raw server response text
10101
10209
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10102
10210
  * @param {object} event.requestOptions The request options passed to the request.
10211
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10103
10212
  * @param {Response} event.rawResponse The native Response object
10104
10213
  */
10105
- loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
10214
+ loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
10106
10215
  /**
10107
10216
  * Fires when registered stores get into state when they don't have any
10108
10217
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -10265,9 +10374,10 @@ type CrudManagerListeners = {
10265
10374
  * @param {object} event.response The decoded server response object.
10266
10375
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10267
10376
  * @param {object} event.requestOptions The request options passed to the request.
10377
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10268
10378
  * @param {Response} event.rawResponse The native Response object
10269
10379
  */
10270
- load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
10380
+ load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
10271
10381
  /**
10272
10382
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
10273
10383
  * listener or due to incomplete prior load request.
@@ -10284,9 +10394,10 @@ type CrudManagerListeners = {
10284
10394
  * @param {string} event.responseText The raw server response text
10285
10395
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10286
10396
  * @param {object} event.requestOptions The request options passed to the request.
10397
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10287
10398
  * @param {Response} event.rawResponse The native Response object
10288
10399
  */
10289
- loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
10400
+ loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
10290
10401
  /**
10291
10402
  * Fires when registered stores get into state when they don't have any
10292
10403
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -10660,9 +10771,10 @@ type CrudManagerConfig = {
10660
10771
  * @param {object} event.response The decoded server response object.
10661
10772
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10662
10773
  * @param {object} event.requestOptions The request options passed to the request.
10774
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10663
10775
  * @param {Response} event.rawResponse The native Response object
10664
10776
  */
10665
- onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
10777
+ onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
10666
10778
  /**
10667
10779
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
10668
10780
  * listener or due to incomplete prior load request.
@@ -10679,9 +10791,10 @@ type CrudManagerConfig = {
10679
10791
  * @param {string} event.responseText The raw server response text
10680
10792
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
10681
10793
  * @param {object} event.requestOptions The request options passed to the request.
10794
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
10682
10795
  * @param {Response} event.rawResponse The native Response object
10683
10796
  */
10684
- onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
10797
+ onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
10685
10798
  /**
10686
10799
  * Fires when registered stores get into state when they don't have any
10687
10800
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -11008,9 +11121,10 @@ export class CrudManager extends AbstractCrudManager {
11008
11121
  * @param {object} event.response The decoded server response object.
11009
11122
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
11010
11123
  * @param {object} event.requestOptions The request options passed to the request.
11124
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
11011
11125
  * @param {Response} event.rawResponse The native Response object
11012
11126
  */
11013
- onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
11127
+ onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
11014
11128
  /**
11015
11129
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
11016
11130
  * listener or due to incomplete prior load request.
@@ -11027,9 +11141,10 @@ export class CrudManager extends AbstractCrudManager {
11027
11141
  * @param {string} event.responseText The raw server response text
11028
11142
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
11029
11143
  * @param {object} event.requestOptions The request options passed to the request.
11144
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
11030
11145
  * @param {Response} event.rawResponse The native Response object
11031
11146
  */
11032
- onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
11147
+ onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
11033
11148
  /**
11034
11149
  * Fires when registered stores get into state when they don't have any
11035
11150
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -11206,7 +11321,7 @@ export class CrudManager extends AbstractCrudManager {
11206
11321
  * @param {string} [options.request.failure.rawResponse] `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
11207
11322
  * @param {object} [options.request.thisObj] `this` reference for the above `success` and `failure` functions.
11208
11323
  */
11209
- load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<any>;
11324
+ load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<CrudManagerLoadResult>;
11210
11325
  /**
11211
11326
  * Loads data to the Crud Manager
11212
11327
  * @param {object} response A simple object representing the data. The object structure matches the decoded `load` response structure: ```javascript // load static data into crudManager crudManager.loadCrudManagerData({ success : true, resources : { rows : [ { id : 1, name : 'John' }, { id : 2, name : 'Abby' } ] } }); ```
@@ -11294,6 +11409,7 @@ export class CrudManager extends AbstractCrudManager {
11294
11409
  suspendAutoSync(): void;
11295
11410
  /**
11296
11411
  * Suspends [hasChanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#event-hasChanges) and [noChanges](#Scheduler/crud/AbstractCrudManagerMixin#event-noChanges) events.
11412
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/CrudManager#function-suspendChangeTracking)
11297
11413
  */
11298
11414
  suspendChangeTracking(): void;
11299
11415
  /**
@@ -11307,7 +11423,7 @@ export class CrudManager extends AbstractCrudManager {
11307
11423
  * Usage:
11308
11424
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/CrudManager#function-sync)
11309
11425
  */
11310
- sync(): Promise<any>;
11426
+ sync(): Promise<CrudManagerSyncResult>;
11311
11427
  /**
11312
11428
  * Triggers an event, calling all registered listeners with the supplied arguments. Returning false from any listener
11313
11429
  * makes function return false.
@@ -12194,6 +12310,22 @@ type DependencyStoreConfig = {
12194
12310
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-dontRelayToMaster)
12195
12311
  */
12196
12312
  dontRelayToMaster?: string
12313
+ /**
12314
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
12315
+ * any filters to the server upon load.
12316
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-encodeFilterParams)
12317
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
12318
+ * @returns {string} The encoded value for the filter parameter.
12319
+ */
12320
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
12321
+ /**
12322
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
12323
+ * any sorters to the server upon load.
12324
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-encodeSorterParams)
12325
+ * @param {Sorter[]} sorters The sorters to encode.
12326
+ * @returns {string} The encoded value for the sort parameter.
12327
+ */
12328
+ encodeSorterParams?: (sorters: Sorter[]) => string
12197
12329
  /**
12198
12330
  * If `true`, collapsed records in original tree will be excluded from the chained store.
12199
12331
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/DependencyStore#config-excludeCollapsedRecords)
@@ -12536,7 +12668,7 @@ type DependencyStoreConfig = {
12536
12668
  */
12537
12669
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
12538
12670
  /**
12539
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
12671
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
12540
12672
  */
12541
12673
  useRestfulMethods?: boolean
12542
12674
  /**
@@ -14153,6 +14285,22 @@ type EventStoreConfig = {
14153
14285
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/EventStore#config-dontRelayToMaster)
14154
14286
  */
14155
14287
  dontRelayToMaster?: string
14288
+ /**
14289
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
14290
+ * any filters to the server upon load.
14291
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/EventStore#config-encodeFilterParams)
14292
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
14293
+ * @returns {string} The encoded value for the filter parameter.
14294
+ */
14295
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
14296
+ /**
14297
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
14298
+ * any sorters to the server upon load.
14299
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/EventStore#config-encodeSorterParams)
14300
+ * @param {Sorter[]} sorters The sorters to encode.
14301
+ * @returns {string} The encoded value for the sort parameter.
14302
+ */
14303
+ encodeSorterParams?: (sorters: Sorter[]) => string
14156
14304
  /**
14157
14305
  * If `true`, collapsed records in original tree will be excluded from the chained store.
14158
14306
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/EventStore#config-excludeCollapsedRecords)
@@ -14511,7 +14659,7 @@ type EventStoreConfig = {
14511
14659
  */
14512
14660
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
14513
14661
  /**
14514
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
14662
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
14515
14663
  */
14516
14664
  useRestfulMethods?: boolean
14517
14665
  /**
@@ -16306,6 +16454,22 @@ type ResourceStoreConfig = {
16306
16454
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore#config-dontRelayToMaster)
16307
16455
  */
16308
16456
  dontRelayToMaster?: string
16457
+ /**
16458
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
16459
+ * any filters to the server upon load.
16460
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore#config-encodeFilterParams)
16461
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
16462
+ * @returns {string} The encoded value for the filter parameter.
16463
+ */
16464
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
16465
+ /**
16466
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
16467
+ * any sorters to the server upon load.
16468
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore#config-encodeSorterParams)
16469
+ * @param {Sorter[]} sorters The sorters to encode.
16470
+ * @returns {string} The encoded value for the sort parameter.
16471
+ */
16472
+ encodeSorterParams?: (sorters: Sorter[]) => string
16309
16473
  /**
16310
16474
  * If `true`, collapsed records in original tree will be excluded from the chained store.
16311
16475
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceStore#config-excludeCollapsedRecords)
@@ -16655,7 +16819,7 @@ type ResourceStoreConfig = {
16655
16819
  */
16656
16820
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
16657
16821
  /**
16658
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
16822
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
16659
16823
  */
16660
16824
  useRestfulMethods?: boolean
16661
16825
  /**
@@ -18218,6 +18382,22 @@ type ResourceTimeRangeStoreConfig = {
18218
18382
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceTimeRangeStore#config-dontRelayToMaster)
18219
18383
  */
18220
18384
  dontRelayToMaster?: string
18385
+ /**
18386
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
18387
+ * any filters to the server upon load.
18388
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceTimeRangeStore#config-encodeFilterParams)
18389
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
18390
+ * @returns {string} The encoded value for the filter parameter.
18391
+ */
18392
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
18393
+ /**
18394
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
18395
+ * any sorters to the server upon load.
18396
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceTimeRangeStore#config-encodeSorterParams)
18397
+ * @param {Sorter[]} sorters The sorters to encode.
18398
+ * @returns {string} The encoded value for the sort parameter.
18399
+ */
18400
+ encodeSorterParams?: (sorters: Sorter[]) => string
18221
18401
  /**
18222
18402
  * If `true`, collapsed records in original tree will be excluded from the chained store.
18223
18403
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/ResourceTimeRangeStore#config-excludeCollapsedRecords)
@@ -18571,7 +18751,7 @@ type ResourceTimeRangeStoreConfig = {
18571
18751
  */
18572
18752
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
18573
18753
  /**
18574
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
18754
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
18575
18755
  */
18576
18756
  useRestfulMethods?: boolean
18577
18757
  /**
@@ -21739,6 +21919,22 @@ type TimeRangeStoreConfig = {
21739
21919
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeRangeStore#config-dontRelayToMaster)
21740
21920
  */
21741
21921
  dontRelayToMaster?: string
21922
+ /**
21923
+ * A provided function which creates an array of values for the [filterParamName](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-filterParamName) to pass
21924
+ * any filters to the server upon load.
21925
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeRangeStore#config-encodeFilterParams)
21926
+ * @param {Core.util.CollectionFilter[]} filters The filters to encode.
21927
+ * @returns {string} The encoded value for the filter parameter.
21928
+ */
21929
+ encodeFilterParams?: (filters: CollectionFilter[]) => string
21930
+ /**
21931
+ * A provided function which creates an array of values for the {#config-sortParamName} to pass
21932
+ * any sorters to the server upon load.
21933
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeRangeStore#config-encodeSorterParams)
21934
+ * @param {Sorter[]} sorters The sorters to encode.
21935
+ * @returns {string} The encoded value for the sort parameter.
21936
+ */
21937
+ encodeSorterParams?: (sorters: Sorter[]) => string
21742
21938
  /**
21743
21939
  * If `true`, collapsed records in original tree will be excluded from the chained store.
21744
21940
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/TimeRangeStore#config-excludeCollapsedRecords)
@@ -22088,7 +22284,7 @@ type TimeRangeStoreConfig = {
22088
22284
  */
22089
22285
  useRawData?: boolean|{ disableDuplicateIdCheck?: boolean, disableDefaultValue?: boolean, disableTypeConversion?: boolean }
22090
22286
  /**
22091
- * Set to ´true´ to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
22287
+ * Set to `true` to use restful [httpMethods](https://bryntum.com/products/scheduler/docs/api/Core/data/AjaxStore#config-httpMethods)
22092
22288
  */
22093
22289
  useRestfulMethods?: boolean
22094
22290
  /**
@@ -23520,9 +23716,10 @@ type ProjectCrudManagerClassListenersTypes = {
23520
23716
  * @param {object} event.response The decoded server response object.
23521
23717
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
23522
23718
  * @param {object} event.requestOptions The request options passed to the request.
23719
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
23523
23720
  * @param {Response} event.rawResponse The native Response object
23524
23721
  */
23525
- load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
23722
+ load: (event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
23526
23723
  /**
23527
23724
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
23528
23725
  * listener or due to incomplete prior load request.
@@ -23539,9 +23736,10 @@ type ProjectCrudManagerClassListenersTypes = {
23539
23736
  * @param {string} event.responseText The raw server response text
23540
23737
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
23541
23738
  * @param {object} event.requestOptions The request options passed to the request.
23739
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
23542
23740
  * @param {Response} event.rawResponse The native Response object
23543
23741
  */
23544
- loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void
23742
+ loadFail: (event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void
23545
23743
  /**
23546
23744
  * Fires when registered stores get into state when they don't have any
23547
23745
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -23704,9 +23902,10 @@ type ProjectCrudManagerClassListeners = {
23704
23902
  * @param {object} event.response The decoded server response object.
23705
23903
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
23706
23904
  * @param {object} event.requestOptions The request options passed to the request.
23905
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
23707
23906
  * @param {Response} event.rawResponse The native Response object
23708
23907
  */
23709
- load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
23908
+ load?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
23710
23909
  /**
23711
23910
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
23712
23911
  * listener or due to incomplete prior load request.
@@ -23723,9 +23922,10 @@ type ProjectCrudManagerClassListeners = {
23723
23922
  * @param {string} event.responseText The raw server response text
23724
23923
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
23725
23924
  * @param {object} event.requestOptions The request options passed to the request.
23925
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
23726
23926
  * @param {Response} event.rawResponse The native Response object
23727
23927
  */
23728
- loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
23928
+ loadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
23729
23929
  /**
23730
23930
  * Fires when registered stores get into state when they don't have any
23731
23931
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -24040,9 +24240,10 @@ type ProjectCrudManagerClassConfig = {
24040
24240
  * @param {object} event.response The decoded server response object.
24041
24241
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
24042
24242
  * @param {object} event.requestOptions The request options passed to the request.
24243
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
24043
24244
  * @param {Response} event.rawResponse The native Response object
24044
24245
  */
24045
- onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
24246
+ onLoad?: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
24046
24247
  /**
24047
24248
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
24048
24249
  * listener or due to incomplete prior load request.
@@ -24059,9 +24260,10 @@ type ProjectCrudManagerClassConfig = {
24059
24260
  * @param {string} event.responseText The raw server response text
24060
24261
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
24061
24262
  * @param {object} event.requestOptions The request options passed to the request.
24263
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
24062
24264
  * @param {Response} event.rawResponse The native Response object
24063
24265
  */
24064
- onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
24266
+ onLoadFail?: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
24065
24267
  /**
24066
24268
  * Fires when registered stores get into state when they don't have any
24067
24269
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -24336,9 +24538,10 @@ export class ProjectCrudManagerClass {
24336
24538
  * @param {object} event.response The decoded server response object.
24337
24539
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
24338
24540
  * @param {object} event.requestOptions The request options passed to the request.
24541
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
24339
24542
  * @param {Response} event.rawResponse The native Response object
24340
24543
  */
24341
- onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
24544
+ onLoad: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
24342
24545
  /**
24343
24546
  * Fired after [load request](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
24344
24547
  * listener or due to incomplete prior load request.
@@ -24355,9 +24558,10 @@ export class ProjectCrudManagerClass {
24355
24558
  * @param {string} event.responseText The raw server response text
24356
24559
  * @param {object} event.responseOptions [DEPRECATED] see `requestOptions`
24357
24560
  * @param {object} event.requestOptions The request options passed to the request.
24561
+ * @param {object} event.options The options provided to the [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
24358
24562
  * @param {Response} event.rawResponse The native Response object
24359
24563
  */
24360
- onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string
24564
+ onLoadFail: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string
24361
24565
  /**
24362
24566
  * Fires when registered stores get into state when they don't have any
24363
24567
  * not persisted change. This happens after [load](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
@@ -24529,7 +24733,7 @@ export class ProjectCrudManagerClass {
24529
24733
  * @param {string} [options.request.failure.rawResponse] `Response` object returned by the [fetch api](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API).
24530
24734
  * @param {object} [options.request.thisObj] `this` reference for the above `success` and `failure` functions.
24531
24735
  */
24532
- load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<any>;
24736
+ load(options?: { request?: { type?: 'sync'|'load', url?: string, data?: string, params?: object, success?: (rawResponse?: string) => void, failure?: (rawResponse?: string) => void, thisObj?: object } }|string): Promise<CrudManagerLoadResult>;
24533
24737
  /**
24534
24738
  * Loads data to the Crud Manager
24535
24739
  * @param {object} response A simple object representing the data. The object structure matches the decoded `load` response structure: ```javascript // load static data into crudManager crudManager.loadCrudManagerData({ success : true, resources : { rows : [ { id : 1, name : 'John' }, { id : 2, name : 'Abby' } ] } }); ```
@@ -24617,6 +24821,7 @@ export class ProjectCrudManagerClass {
24617
24821
  suspendAutoSync(): void;
24618
24822
  /**
24619
24823
  * Suspends [hasChanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/crud/AbstractCrudManagerMixin#event-hasChanges) and [noChanges](#Scheduler/crud/AbstractCrudManagerMixin#event-noChanges) events.
24824
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/ProjectCrudManager#function-suspendChangeTracking)
24620
24825
  */
24621
24826
  suspendChangeTracking(): void;
24622
24827
  /**
@@ -24630,7 +24835,7 @@ export class ProjectCrudManagerClass {
24630
24835
  * Usage:
24631
24836
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/data/mixin/ProjectCrudManager#function-sync)
24632
24837
  */
24633
- sync(): Promise<any>;
24838
+ sync(): Promise<CrudManagerSyncResult>;
24634
24839
  /**
24635
24840
  * Triggers an event, calling all registered listeners with the supplied arguments. Returning false from any listener
24636
24841
  * makes function return false.
@@ -27820,7 +28025,7 @@ type EventDragCreateConfig = {
27820
28025
  */
27821
28026
  allowResizeToZero?: boolean
27822
28027
  /**
27823
- * Use bottom handle when resizing. Only applies when owning client's `direction` is 'vertical'
28028
+ * Use bottom handle when resizing. Only applies when owning client's direction is 'vertical'
27824
28029
  */
27825
28030
  bottomHandle?: boolean
27826
28031
  /**
@@ -27868,7 +28073,7 @@ type EventDragCreateConfig = {
27868
28073
  */
27869
28074
  dynamicHandleSize?: boolean
27870
28075
  /**
27871
- * Use left handle when resizing. Only applies when owning client's `direction` is 'horizontal'
28076
+ * Use left handle when resizing. Only applies when owning client's direction is 'horizontal'
27872
28077
  */
27873
28078
  leftHandle?: boolean
27874
28079
  /**
@@ -27912,7 +28117,7 @@ type EventDragCreateConfig = {
27912
28117
  */
27913
28118
  resizeSelected?: boolean
27914
28119
  /**
27915
- * Use right handle when resizing. Only applies when owning client's `direction` is 'horizontal'
28120
+ * Use right handle when resizing. Only applies when owning client's direction is 'horizontal'
27916
28121
  */
27917
28122
  rightHandle?: boolean
27918
28123
  /**
@@ -27941,7 +28146,7 @@ type EventDragCreateConfig = {
27941
28146
  */
27942
28147
  tooltipTemplate?: (context: { startDate: Date, endDate: Date, record: TimeSpan, valid: boolean, startClockHtml: string, endClockHtml: string }) => string
27943
28148
  /**
27944
- * Use top handle when resizing. Only applies when owning client's direction` is 'vertical'
28149
+ * Use top handle when resizing. Only applies when owning client's direction is 'vertical'
27945
28150
  */
27946
28151
  topHandle?: boolean
27947
28152
  /**
@@ -29448,7 +29653,7 @@ type EventResizeConfig = {
29448
29653
  */
29449
29654
  allowResizeToZero?: boolean
29450
29655
  /**
29451
- * Use bottom handle when resizing. Only applies when owning client's `direction` is 'vertical'
29656
+ * Use bottom handle when resizing. Only applies when owning client's direction is 'vertical'
29452
29657
  */
29453
29658
  bottomHandle?: boolean
29454
29659
  /**
@@ -29492,7 +29697,7 @@ type EventResizeConfig = {
29492
29697
  */
29493
29698
  dynamicHandleSize?: boolean
29494
29699
  /**
29495
- * Use left handle when resizing. Only applies when owning client's `direction` is 'horizontal'
29700
+ * Use left handle when resizing. Only applies when owning client's direction is 'horizontal'
29496
29701
  */
29497
29702
  leftHandle?: boolean
29498
29703
  /**
@@ -29536,7 +29741,7 @@ type EventResizeConfig = {
29536
29741
  */
29537
29742
  resizeSelected?: boolean
29538
29743
  /**
29539
- * Use right handle when resizing. Only applies when owning client's `direction` is 'horizontal'
29744
+ * Use right handle when resizing. Only applies when owning client's direction is 'horizontal'
29540
29745
  */
29541
29746
  rightHandle?: boolean
29542
29747
  /**
@@ -29565,7 +29770,7 @@ type EventResizeConfig = {
29565
29770
  */
29566
29771
  tooltipTemplate?: (context: { startDate: Date, endDate: Date, record: TimeSpan, valid: boolean, startClockHtml: string, endClockHtml: string }) => string
29567
29772
  /**
29568
- * Use top handle when resizing. Only applies when owning client's direction` is 'vertical'
29773
+ * Use top handle when resizing. Only applies when owning client's direction is 'vertical'
29569
29774
  */
29570
29775
  topHandle?: boolean
29571
29776
  /**
@@ -29818,6 +30023,8 @@ type EventTooltipConfig = {
29818
30023
  /**
29819
30024
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
29820
30025
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
30026
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
30027
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-appendTo)
29821
30028
  */
29822
30029
  appendTo?: HTMLElement|string
29823
30030
  /**
@@ -29889,9 +30096,10 @@ type EventTooltipConfig = {
29889
30096
  catchEventHandlerExceptions?: boolean
29890
30097
  /**
29891
30098
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
29892
- * Set to `true` to centre the Widget in browser viewport space.
30099
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-centered)
30100
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
29893
30101
  */
29894
- centered?: boolean
30102
+ centered?: boolean|object
29895
30103
  /**
29896
30104
  * The widget which this plugin is to attach to.
29897
30105
  */
@@ -30083,10 +30291,11 @@ type EventTooltipConfig = {
30083
30291
  * @param {Core.widget.Tooltip} context.tip The tooltip instance
30084
30292
  * @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
30085
30293
  * @param {HTMLElement} context.activeTarget The target element that triggered the show
30294
+ * @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
30086
30295
  * @param {Event} context.event The raw DOM event
30087
30296
  * @returns {string,Promise<any>}
30088
30297
  */
30089
- getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
30298
+ getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
30090
30299
  /**
30091
30300
  * A config [object](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
30092
30301
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-header)
@@ -30162,10 +30371,14 @@ type EventTooltipConfig = {
30162
30371
  inputFieldAlign?: 'start'|'end'
30163
30372
  /**
30164
30373
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
30374
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
30375
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-insertBefore)
30165
30376
  */
30166
30377
  insertBefore?: HTMLElement|string
30167
30378
  /**
30168
30379
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
30380
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
30381
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-insertFirst)
30169
30382
  */
30170
30383
  insertFirst?: HTMLElement|string
30171
30384
  /**
@@ -30191,7 +30404,7 @@ type EventTooltipConfig = {
30191
30404
  */
30192
30405
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
30193
30406
  /**
30194
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
30407
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
30195
30408
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/EventTooltip#config-labelWidth)
30196
30409
  */
30197
30410
  labelWidth?: number|null
@@ -37203,7 +37416,7 @@ type DragCreateBaseConfig = {
37203
37416
  */
37204
37417
  allowResizeToZero?: boolean
37205
37418
  /**
37206
- * Use bottom handle when resizing. Only applies when owning client's `direction` is 'vertical'
37419
+ * Use bottom handle when resizing. Only applies when owning client's direction is 'vertical'
37207
37420
  */
37208
37421
  bottomHandle?: boolean
37209
37422
  /**
@@ -37251,7 +37464,7 @@ type DragCreateBaseConfig = {
37251
37464
  */
37252
37465
  dynamicHandleSize?: boolean
37253
37466
  /**
37254
- * Use left handle when resizing. Only applies when owning client's `direction` is 'horizontal'
37467
+ * Use left handle when resizing. Only applies when owning client's direction is 'horizontal'
37255
37468
  */
37256
37469
  leftHandle?: boolean
37257
37470
  /**
@@ -37295,7 +37508,7 @@ type DragCreateBaseConfig = {
37295
37508
  */
37296
37509
  resizeSelected?: boolean
37297
37510
  /**
37298
- * Use right handle when resizing. Only applies when owning client's `direction` is 'horizontal'
37511
+ * Use right handle when resizing. Only applies when owning client's direction is 'horizontal'
37299
37512
  */
37300
37513
  rightHandle?: boolean
37301
37514
  /**
@@ -37324,7 +37537,7 @@ type DragCreateBaseConfig = {
37324
37537
  */
37325
37538
  tooltipTemplate?: (context: { startDate: Date, endDate: Date, record: TimeSpan, valid: boolean, startClockHtml: string, endClockHtml: string }) => string
37326
37539
  /**
37327
- * Use top handle when resizing. Only applies when owning client's direction` is 'vertical'
37540
+ * Use top handle when resizing. Only applies when owning client's direction is 'vertical'
37328
37541
  */
37329
37542
  topHandle?: boolean
37330
37543
  /**
@@ -38291,6 +38504,8 @@ type TooltipBaseConfig = {
38291
38504
  /**
38292
38505
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
38293
38506
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
38507
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38508
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-appendTo)
38294
38509
  */
38295
38510
  appendTo?: HTMLElement|string
38296
38511
  /**
@@ -38363,9 +38578,10 @@ type TooltipBaseConfig = {
38363
38578
  catchEventHandlerExceptions?: boolean
38364
38579
  /**
38365
38580
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
38366
- * Set to `true` to centre the Widget in browser viewport space.
38581
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-centered)
38582
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
38367
38583
  */
38368
- centered?: boolean
38584
+ centered?: boolean|object
38369
38585
  /**
38370
38586
  * The widget which this plugin is to attach to.
38371
38587
  */
@@ -38557,10 +38773,11 @@ type TooltipBaseConfig = {
38557
38773
  * @param {Core.widget.Tooltip} context.tip The tooltip instance
38558
38774
  * @param {HTMLElement} context.element The Element for which the Tooltip is monitoring mouse movement
38559
38775
  * @param {HTMLElement} context.activeTarget The target element that triggered the show
38776
+ * @param {HTMLElement} [context.forElement] Alias for `activeTarget`, provided for backward compatibility
38560
38777
  * @param {Event} context.event The raw DOM event
38561
38778
  * @returns {string,Promise<any>}
38562
38779
  */
38563
- getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
38780
+ getHtml?: ((context: { tip: Tooltip, element: HTMLElement, activeTarget: HTMLElement, forElement?: HTMLElement, event: Event }) => Promise<string|Promise<any>>)|string
38564
38781
  /**
38565
38782
  * A config [object](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#typedef-PanelHeader) for the panel's header or a string in place of a `title`.
38566
38783
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-header)
@@ -38636,10 +38853,14 @@ type TooltipBaseConfig = {
38636
38853
  inputFieldAlign?: 'start'|'end'
38637
38854
  /**
38638
38855
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
38856
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38857
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-insertBefore)
38639
38858
  */
38640
38859
  insertBefore?: HTMLElement|string
38641
38860
  /**
38642
38861
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
38862
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
38863
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-insertFirst)
38643
38864
  */
38644
38865
  insertFirst?: HTMLElement|string
38645
38866
  /**
@@ -38665,7 +38886,7 @@ type TooltipBaseConfig = {
38665
38886
  */
38666
38887
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
38667
38888
  /**
38668
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
38889
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
38669
38890
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/base/TooltipBase#config-labelWidth)
38670
38891
  */
38671
38892
  labelWidth?: number|null
@@ -38882,7 +39103,7 @@ type TooltipBaseConfig = {
38882
39103
  rtl?: boolean
38883
39104
  /**
38884
39105
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
38885
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
39106
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
38886
39107
  */
38887
39108
  scrollAction?: 'hide'|'realign'|null
38888
39109
  /**
@@ -39571,8 +39792,8 @@ type PdfExportConfig = {
39571
39792
  */
39572
39793
  fileName?: string
39573
39794
  /**
39574
- * A template function used to generate a page footer. It is passed an object with ´currentPage´ and
39575
- * `totalPages´ properties.
39795
+ * A template function used to generate a page footer. It is passed an object with `currentPage` and
39796
+ * `totalPages` properties.
39576
39797
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/PdfExport#config-footerTpl)
39577
39798
  * @param {object} data Data object
39578
39799
  * @param {number} data.currentPage Current page number
@@ -39581,8 +39802,8 @@ type PdfExportConfig = {
39581
39802
  */
39582
39803
  footerTpl?: (data: { currentPage: number, totalPages: number }) => string
39583
39804
  /**
39584
- * A template function used to generate a page header. It is passed an object with ´currentPage´ and
39585
- * `totalPages´ properties.
39805
+ * A template function used to generate a page header. It is passed an object with `currentPage` and
39806
+ * `totalPages` properties.
39586
39807
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/PdfExport#config-headerTpl)
39587
39808
  * @param {object} data Data object
39588
39809
  * @param {number} data.currentPage Current page number
@@ -39940,8 +40161,8 @@ type PrintConfig = {
39940
40161
  */
39941
40162
  exporters?: Exporter[]
39942
40163
  /**
39943
- * A template function used to generate a page footer. It is passed an object with ´currentPage´ and
39944
- * `totalPages´ properties.
40164
+ * A template function used to generate a page footer. It is passed an object with `currentPage` and
40165
+ * `totalPages` properties.
39945
40166
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/Print#config-footerTpl)
39946
40167
  * @param {object} data Data object
39947
40168
  * @param {number} data.currentPage Current page number
@@ -39950,8 +40171,8 @@ type PrintConfig = {
39950
40171
  */
39951
40172
  footerTpl?: (data: { currentPage: number, totalPages: number }) => string
39952
40173
  /**
39953
- * A template function used to generate a page header. It is passed an object with ´currentPage´ and
39954
- * `totalPages´ properties.
40174
+ * A template function used to generate a page header. It is passed an object with `currentPage` and
40175
+ * `totalPages` properties.
39955
40176
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/feature/export/Print#config-headerTpl)
39956
40177
  * @param {object} data Data object
39957
40178
  * @param {number} data.currentPage Current page number
@@ -43511,7 +43732,7 @@ export class ProjectModel extends Model {
43511
43732
  */
43512
43733
  dependencyStore: DependencyStore
43513
43734
  /**
43514
- * Count all children (including sub-children) for a node (in its `firstStore´)
43735
+ * Count all children (including sub-children) for a node (in its `firstStore`)
43515
43736
  */
43516
43737
  descendantCount: number
43517
43738
  /**
@@ -44401,6 +44622,11 @@ export class RecurrenceModel extends Model {
44401
44622
  * configured time zone.
44402
44623
  */
44403
44624
  timeZone: string
44625
+ /**
44626
+ * Returns `true` if the recurrence has any non-default settings applied, meaning it has a repeat count or end
44627
+ * date, or a custom interval, or a custom set of days, months or monthDays.
44628
+ */
44629
+ hasCustomizations(): boolean;
44404
44630
  }
44405
44631
 
44406
44632
  /**
@@ -44622,9 +44848,9 @@ export class ResourceModel extends GridRowModel {
44622
44848
  imageUrl: string
44623
44849
  /**
44624
44850
  * Returns the initials (first letter of the first &amp; last space-separated word in the name) or an empty string
44625
- * if this resource has no name. You can override this method in a ResourceModel subclass to provide your own implementation
44851
+ * if this resource has no name. You can override this getter in a ResourceModel subclass to provide your own implementation.
44626
44852
  */
44627
- readonly initials: string
44853
+ get initials(): string
44628
44854
  /**
44629
44855
  * Returns `true` if the resource can be persisted.
44630
44856
  * In a flat store, a resource is always considered persistable. In a tree store, a resource is considered
@@ -44881,7 +45107,7 @@ export class ResourceTimeRangeModel extends TimeSpan {
44881
45107
  /**
44882
45108
  * The associated resource, retrieved using a relation to a ResourceStore determined by the value assigned
44883
45109
  * to `resourceId`. The relation also lets you access all time ranges on a resource through
44884
- * [timeRanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#property-timeRanges)`.
45110
+ * [timeRanges](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ResourceModel#property-timeRanges).
44885
45111
  */
44886
45112
  resource: ResourceModel
44887
45113
  /**
@@ -46378,9 +46604,9 @@ export class ResourceModelMixinClass {
46378
46604
  imageUrl: string
46379
46605
  /**
46380
46606
  * Returns the initials (first letter of the first &amp; last space-separated word in the name) or an empty string
46381
- * if this resource has no name. You can override this method in a ResourceModel subclass to provide your own implementation
46607
+ * if this resource has no name. You can override this getter in a ResourceModel subclass to provide your own implementation.
46382
46608
  */
46383
- readonly initials: string
46609
+ get initials(): string
46384
46610
  /**
46385
46611
  * Returns `true` if the resource can be persisted.
46386
46612
  * In a flat store, a resource is always considered persistable. In a tree store, a resource is considered
@@ -49555,6 +49781,8 @@ type EventEditorConfig = {
49555
49781
  /**
49556
49782
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
49557
49783
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
49784
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
49785
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-appendTo)
49558
49786
  */
49559
49787
  appendTo?: HTMLElement|string
49560
49788
  /**
@@ -49618,9 +49846,10 @@ type EventEditorConfig = {
49618
49846
  catchEventHandlerExceptions?: boolean
49619
49847
  /**
49620
49848
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
49621
- * Set to `true` to centre the Widget in browser viewport space.
49849
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-centered)
49850
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
49622
49851
  */
49623
- centered?: boolean
49852
+ centered?: boolean|object
49624
49853
  /**
49625
49854
  * Show a tool in the header to close this Popup.
49626
49855
  * The tool is available in the [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools) object
@@ -49844,10 +50073,14 @@ type EventEditorConfig = {
49844
50073
  inputFieldAlign?: 'start'|'end'
49845
50074
  /**
49846
50075
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
50076
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
50077
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-insertBefore)
49847
50078
  */
49848
50079
  insertBefore?: HTMLElement|string
49849
50080
  /**
49850
50081
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
50082
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
50083
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-insertFirst)
49851
50084
  */
49852
50085
  insertFirst?: HTMLElement|string
49853
50086
  /**
@@ -49873,7 +50106,7 @@ type EventEditorConfig = {
49873
50106
  */
49874
50107
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
49875
50108
  /**
49876
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
50109
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
49877
50110
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/EventEditor#config-labelWidth)
49878
50111
  */
49879
50112
  labelWidth?: number|null
@@ -50078,7 +50311,7 @@ type EventEditorConfig = {
50078
50311
  rtl?: boolean
50079
50312
  /**
50080
50313
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
50081
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
50314
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
50082
50315
  */
50083
50316
  scrollAction?: 'hide'|'realign'|null
50084
50317
  /**
@@ -50705,6 +50938,8 @@ type ResourceHeaderConfig = {
50705
50938
  /**
50706
50939
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
50707
50940
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
50941
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
50942
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-appendTo)
50708
50943
  */
50709
50944
  appendTo?: HTMLElement|string
50710
50945
  /**
@@ -50738,9 +50973,10 @@ type ResourceHeaderConfig = {
50738
50973
  catchEventHandlerExceptions?: boolean
50739
50974
  /**
50740
50975
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
50741
- * Set to `true` to centre the Widget in browser viewport space.
50976
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-centered)
50977
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
50742
50978
  */
50743
- centered?: boolean
50979
+ centered?: boolean|object
50744
50980
  /**
50745
50981
  * Custom CSS classes to add to element.
50746
50982
  * May be specified as a space separated string, or as an object in which property names
@@ -50818,7 +51054,7 @@ type ResourceHeaderConfig = {
50818
51054
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
50819
51055
  /**
50820
51056
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
50821
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
51057
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
50822
51058
  * property which controls when a drag should start.
50823
51059
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-draggable)
50824
51060
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -50861,9 +51097,9 @@ type ResourceHeaderConfig = {
50861
51097
  * @param {object} context Renderer context data
50862
51098
  * @param {Scheduler.model.ResourceModel} context.resourceRecord Resource whose header is being rendered
50863
51099
  * @param {DomConfig} context.elementConfig A config object used to create the element for the resource
50864
- * @returns {string} The raw HTML string to render into the header. Remember to HTML encode your content!
51100
+ * @returns {string,DomConfig,DomConfig[]} A simple string (remember to HTML encode your content!), a DomConfig (or array thereof), or a JSX element when using React
50865
51101
  */
50866
- headerRenderer?: (context: { resourceRecord: ResourceModel, elementConfig: DomConfig }) => string
51102
+ headerRenderer?: (context: { resourceRecord: ResourceModel, elementConfig: DomConfig }) => string|DomConfig|DomConfig[]
50867
51103
  /**
50868
51104
  * Widget's height, used to set element `style.height`. Either specify a valid height string or a number,
50869
51105
  * which will get 'px' appended. We recommend using CSS as the primary way to control height, but in some
@@ -50900,10 +51136,14 @@ type ResourceHeaderConfig = {
50900
51136
  ignoreParentReadOnly?: boolean
50901
51137
  /**
50902
51138
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
51139
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
51140
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-insertBefore)
50903
51141
  */
50904
51142
  insertBefore?: HTMLElement|string
50905
51143
  /**
50906
51144
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
51145
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
51146
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/ResourceHeader#config-insertFirst)
50907
51147
  */
50908
51148
  insertFirst?: HTMLElement|string
50909
51149
  /**
@@ -51045,7 +51285,7 @@ type ResourceHeaderConfig = {
51045
51285
  rtl?: boolean
51046
51286
  /**
51047
51287
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
51048
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
51288
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
51049
51289
  */
51050
51290
  scrollAction?: 'hide'|'realign'|null
51051
51291
  /**
@@ -56558,6 +56798,8 @@ type SchedulerConfig = {
56558
56798
  /**
56559
56799
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
56560
56800
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
56801
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
56802
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-appendTo)
56561
56803
  */
56562
56804
  appendTo?: HTMLElement|string
56563
56805
  /**
@@ -57168,10 +57410,14 @@ type SchedulerConfig = {
57168
57410
  inputFieldAlign?: 'start'|'end'
57169
57411
  /**
57170
57412
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
57413
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
57414
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-insertBefore)
57171
57415
  */
57172
57416
  insertBefore?: HTMLElement|string
57173
57417
  /**
57174
57418
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
57419
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
57420
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-insertFirst)
57175
57421
  */
57176
57422
  insertFirst?: HTMLElement|string
57177
57423
  /**
@@ -57191,7 +57437,7 @@ type SchedulerConfig = {
57191
57437
  */
57192
57438
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
57193
57439
  /**
57194
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
57440
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
57195
57441
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-labelWidth)
57196
57442
  */
57197
57443
  labelWidth?: number|null
@@ -66408,6 +66654,8 @@ type SchedulerBaseConfig = {
66408
66654
  /**
66409
66655
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
66410
66656
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
66657
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
66658
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-appendTo)
66411
66659
  */
66412
66660
  appendTo?: HTMLElement|string
66413
66661
  /**
@@ -67018,10 +67266,14 @@ type SchedulerBaseConfig = {
67018
67266
  inputFieldAlign?: 'start'|'end'
67019
67267
  /**
67020
67268
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
67269
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
67270
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-insertBefore)
67021
67271
  */
67022
67272
  insertBefore?: HTMLElement|string
67023
67273
  /**
67024
67274
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
67275
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
67276
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-insertFirst)
67025
67277
  */
67026
67278
  insertFirst?: HTMLElement|string
67027
67279
  /**
@@ -67041,7 +67293,7 @@ type SchedulerBaseConfig = {
67041
67293
  */
67042
67294
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
67043
67295
  /**
67044
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
67296
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
67045
67297
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-labelWidth)
67046
67298
  */
67047
67299
  labelWidth?: number|null
@@ -70684,6 +70936,10 @@ export class SchedulerBase extends TimelineBase {
70684
70936
  * Identifies an object as an instance of [Events](https://bryntum.com/products/scheduler/docs/api/Core/mixin/Events) class, or subclass thereof.
70685
70937
  */
70686
70938
  readonly isEvents: boolean
70939
+ /**
70940
+ * Checks if scheduler is in horizontal mode
70941
+ */
70942
+ readonly isHorizontal: boolean
70687
70943
  /**
70688
70944
  * Identifies an object as an instance of [LoadMaskable](https://bryntum.com/products/scheduler/docs/api/Core/mixin/LoadMaskable) class, or subclass thereof.
70689
70945
  */
@@ -70777,6 +71033,10 @@ export class SchedulerBase extends TimelineBase {
70777
71033
  * Identifies an object as an instance of [TransactionalFeatureMixin](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TransactionalFeatureMixin) class, or subclass thereof.
70778
71034
  */
70779
71035
  readonly isTransactionalFeatureMixin: boolean
71036
+ /**
71037
+ * Checks if scheduler is in vertical mode
71038
+ */
71039
+ readonly isVertical: boolean
70780
71040
  /**
70781
71041
  * By default, when the `EventStore` (and similar stores) is lazy loading, a loading indicator will be displayed
70782
71042
  * just below the timeline headers. Set this to `false` to prevent this indicator being shown.
@@ -72729,8 +72989,9 @@ export class SchedulerBase extends TimelineBase {
72729
72989
  * @param {Date,number} date the date to query for (or a date as ms)
72730
72990
  * @param {boolean,object} options `true` to return a coordinate local to the scheduler view element (defaults to true),
72731
72991
  * @param {boolean} options.local `true` if coordinate should be local to the time axis, or false to be a page coordinate
72992
+ * @param {boolean} [options.ignoreRTL] `true` to keep the coordinate measured from the start of the time axis even in RTL mode (by default horizontal coordinates are flipped to be measured from the end in RTL)
72732
72993
  */
72733
- getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean }): number;
72994
+ getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean, ignoreRTL?: boolean }): number;
72734
72995
  /**
72735
72996
  * Gets the date for an X or Y coordinate, either local to the view element or the page based on the 3rd argument.
72736
72997
  * If the coordinate is not in the currently rendered view, null will be returned unless the `allowOutOfRange`
@@ -75749,6 +76010,8 @@ type TimelineBaseConfig = {
75749
76010
  /**
75750
76011
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
75751
76012
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
76013
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
76014
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-appendTo)
75752
76015
  */
75753
76016
  appendTo?: HTMLElement|string
75754
76017
  /**
@@ -76155,10 +76418,14 @@ type TimelineBaseConfig = {
76155
76418
  inputFieldAlign?: 'start'|'end'
76156
76419
  /**
76157
76420
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
76421
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
76422
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-insertBefore)
76158
76423
  */
76159
76424
  insertBefore?: HTMLElement|string
76160
76425
  /**
76161
76426
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
76427
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
76428
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-insertFirst)
76162
76429
  */
76163
76430
  insertFirst?: HTMLElement|string
76164
76431
  /**
@@ -76171,7 +76438,7 @@ type TimelineBaseConfig = {
76171
76438
  */
76172
76439
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
76173
76440
  /**
76174
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
76441
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
76175
76442
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineBase#config-labelWidth)
76176
76443
  */
76177
76444
  labelWidth?: number|null
@@ -78520,8 +78787,9 @@ export abstract class TimelineBase extends Grid {
78520
78787
  * @param {Date,number} date the date to query for (or a date as ms)
78521
78788
  * @param {boolean,object} options `true` to return a coordinate local to the scheduler view element (defaults to true),
78522
78789
  * @param {boolean} options.local `true` if coordinate should be local to the time axis, or false to be a page coordinate
78790
+ * @param {boolean} [options.ignoreRTL] `true` to keep the coordinate measured from the start of the time axis even in RTL mode (by default horizontal coordinates are flipped to be measured from the end in RTL)
78523
78791
  */
78524
- getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean }): number;
78792
+ getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean, ignoreRTL?: boolean }): number;
78525
78793
  /**
78526
78794
  * Gets the date for an X or Y coordinate, either local to the view element or the page based on the 3rd argument.
78527
78795
  * If the coordinate is not in the currently rendered view, null will be returned unless the `allowOutOfRange`
@@ -81716,6 +81984,8 @@ type TimelineHistogramConfig = {
81716
81984
  /**
81717
81985
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
81718
81986
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
81987
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
81988
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-appendTo)
81719
81989
  */
81720
81990
  appendTo?: HTMLElement|string
81721
81991
  /**
@@ -82248,10 +82518,14 @@ type TimelineHistogramConfig = {
82248
82518
  inputFieldAlign?: 'start'|'end'
82249
82519
  /**
82250
82520
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
82521
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
82522
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-insertBefore)
82251
82523
  */
82252
82524
  insertBefore?: HTMLElement|string
82253
82525
  /**
82254
82526
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
82527
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
82528
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-insertFirst)
82255
82529
  */
82256
82530
  insertFirst?: HTMLElement|string
82257
82531
  /**
@@ -82264,7 +82538,7 @@ type TimelineHistogramConfig = {
82264
82538
  */
82265
82539
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
82266
82540
  /**
82267
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
82541
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
82268
82542
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogram#config-labelWidth)
82269
82543
  */
82270
82544
  labelWidth?: number|null
@@ -84400,6 +84674,7 @@ export class TimelineHistogram extends TimelineHistogramBase {
84400
84674
  /**
84401
84675
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
84402
84676
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
84677
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
84403
84678
  */
84404
84679
  appendTo: HTMLElement|string
84405
84680
  /**
@@ -84433,6 +84708,12 @@ export class TimelineHistogram extends TimelineHistogramBase {
84433
84708
  * An object providing the `record` and `column` for a widget embedded inside a [WidgetColumn](https://bryntum.com/products/scheduler/docs/api/Grid/column/WidgetColumn)
84434
84709
  */
84435
84710
  readonly cellInfo: CellWidgetContext
84711
+ /**
84712
+ * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
84713
+ */
84714
+ centered: boolean|{
84715
+ once?: boolean
84716
+ }
84436
84717
  /**
84437
84718
  * Custom CSS classes to add to element.
84438
84719
  * May be specified as a space separated string, or as an object in which property names
@@ -84634,10 +84915,12 @@ export class TimelineHistogram extends TimelineHistogramBase {
84634
84915
  inputFieldAlign: 'start'|'end'
84635
84916
  /**
84636
84917
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
84918
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
84637
84919
  */
84638
84920
  insertBefore: HTMLElement|string
84639
84921
  /**
84640
84922
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
84923
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
84641
84924
  */
84642
84925
  insertFirst: HTMLElement|string
84643
84926
  /**
@@ -84822,7 +85105,7 @@ export class TimelineHistogram extends TimelineHistogramBase {
84822
85105
  */
84823
85106
  labelPosition: 'before'|'above'|'align-before'|'auto'|null
84824
85107
  /**
84825
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
85108
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
84826
85109
  */
84827
85110
  labelWidth: number|null
84828
85111
  /**
@@ -86091,8 +86374,9 @@ export class TimelineHistogram extends TimelineHistogramBase {
86091
86374
  * @param {Date,number} date the date to query for (or a date as ms)
86092
86375
  * @param {boolean,object} options `true` to return a coordinate local to the scheduler view element (defaults to true),
86093
86376
  * @param {boolean} options.local `true` if coordinate should be local to the time axis, or false to be a page coordinate
86377
+ * @param {boolean} [options.ignoreRTL] `true` to keep the coordinate measured from the start of the time axis even in RTL mode (by default horizontal coordinates are flipped to be measured from the end in RTL)
86094
86378
  */
86095
- getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean }): number;
86379
+ getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean, ignoreRTL?: boolean }): number;
86096
86380
  /**
86097
86381
  * Gets the date for an X or Y coordinate, either local to the view element or the page based on the 3rd argument.
86098
86382
  * If the coordinate is not in the currently rendered view, null will be returned unless the `allowOutOfRange`
@@ -89455,6 +89739,8 @@ type TimelineHistogramBaseConfig = {
89455
89739
  /**
89456
89740
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
89457
89741
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
89742
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
89743
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-appendTo)
89458
89744
  */
89459
89745
  appendTo?: HTMLElement|string
89460
89746
  /**
@@ -89972,10 +90258,14 @@ type TimelineHistogramBaseConfig = {
89972
90258
  inputFieldAlign?: 'start'|'end'
89973
90259
  /**
89974
90260
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
90261
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
90262
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-insertBefore)
89975
90263
  */
89976
90264
  insertBefore?: HTMLElement|string
89977
90265
  /**
89978
90266
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
90267
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
90268
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-insertFirst)
89979
90269
  */
89980
90270
  insertFirst?: HTMLElement|string
89981
90271
  /**
@@ -89988,7 +90278,7 @@ type TimelineHistogramBaseConfig = {
89988
90278
  */
89989
90279
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
89990
90280
  /**
89991
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
90281
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
89992
90282
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/TimelineHistogramBase#config-labelWidth)
89993
90283
  */
89994
90284
  labelWidth?: number|null
@@ -92521,6 +92811,8 @@ type SchedulerExportDialogConfig = {
92521
92811
  /**
92522
92812
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
92523
92813
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
92814
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
92815
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-appendTo)
92524
92816
  */
92525
92817
  appendTo?: HTMLElement|string
92526
92818
  /**
@@ -92588,9 +92880,10 @@ type SchedulerExportDialogConfig = {
92588
92880
  catchEventHandlerExceptions?: boolean
92589
92881
  /**
92590
92882
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
92591
- * Set to `true` to centre the Widget in browser viewport space.
92883
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-centered)
92884
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
92592
92885
  */
92593
- centered?: boolean
92886
+ centered?: boolean|object
92594
92887
  /**
92595
92888
  * Grid instance to build export dialog for
92596
92889
  */
@@ -92822,10 +93115,14 @@ type SchedulerExportDialogConfig = {
92822
93115
  inputFieldAlign?: 'start'|'end'
92823
93116
  /**
92824
93117
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
93118
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
93119
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-insertBefore)
92825
93120
  */
92826
93121
  insertBefore?: HTMLElement|string
92827
93122
  /**
92828
93123
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
93124
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
93125
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-insertFirst)
92829
93126
  */
92830
93127
  insertFirst?: HTMLElement|string
92831
93128
  /**
@@ -92851,7 +93148,7 @@ type SchedulerExportDialogConfig = {
92851
93148
  */
92852
93149
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
92853
93150
  /**
92854
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
93151
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
92855
93152
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/export/SchedulerExportDialog#config-labelWidth)
92856
93153
  */
92857
93154
  labelWidth?: number|null
@@ -93056,7 +93353,7 @@ type SchedulerExportDialogConfig = {
93056
93353
  rtl?: boolean
93057
93354
  /**
93058
93355
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
93059
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
93356
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
93060
93357
  */
93061
93358
  scrollAction?: 'hide'|'realign'|null
93062
93359
  /**
@@ -95160,8 +95457,9 @@ export class TimelineDateMapperClass {
95160
95457
  * @param {Date,number} date the date to query for (or a date as ms)
95161
95458
  * @param {boolean,object} options `true` to return a coordinate local to the scheduler view element (defaults to true),
95162
95459
  * @param {boolean} options.local `true` if coordinate should be local to the time axis, or false to be a page coordinate
95460
+ * @param {boolean} [options.ignoreRTL] `true` to keep the coordinate measured from the start of the time axis even in RTL mode (by default horizontal coordinates are flipped to be measured from the end in RTL)
95163
95461
  */
95164
- getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean }): number;
95462
+ getCoordinateFromDate(date: Date|number, options?: boolean|{ local: boolean, ignoreRTL?: boolean }): number;
95165
95463
  /**
95166
95464
  * Gets the date for an X or Y coordinate, either local to the view element or the page based on the 3rd argument.
95167
95465
  * If the coordinate is not in the currently rendered view, null will be returned unless the `allowOutOfRange`
@@ -97973,6 +98271,8 @@ type TimelineHistogramGroupingClassConfig = {
97973
98271
  /**
97974
98272
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
97975
98273
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
98274
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
98275
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-appendTo)
97976
98276
  */
97977
98277
  appendTo?: HTMLElement|string
97978
98278
  /**
@@ -98505,10 +98805,14 @@ type TimelineHistogramGroupingClassConfig = {
98505
98805
  inputFieldAlign?: 'start'|'end'
98506
98806
  /**
98507
98807
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
98808
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
98809
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-insertBefore)
98508
98810
  */
98509
98811
  insertBefore?: HTMLElement|string
98510
98812
  /**
98511
98813
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
98814
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
98815
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-insertFirst)
98512
98816
  */
98513
98817
  insertFirst?: HTMLElement|string
98514
98818
  /**
@@ -98521,7 +98825,7 @@ type TimelineHistogramGroupingClassConfig = {
98521
98825
  */
98522
98826
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
98523
98827
  /**
98524
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
98828
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
98525
98829
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/TimelineHistogramGrouping#config-labelWidth)
98526
98830
  */
98527
98831
  labelWidth?: number|null
@@ -101655,6 +101959,8 @@ type RecurrenceConfirmationPopupConfig = {
101655
101959
  /**
101656
101960
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
101657
101961
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
101962
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
101963
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-appendTo)
101658
101964
  */
101659
101965
  appendTo?: HTMLElement|string
101660
101966
  /**
@@ -101718,9 +102024,10 @@ type RecurrenceConfirmationPopupConfig = {
101718
102024
  catchEventHandlerExceptions?: boolean
101719
102025
  /**
101720
102026
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
101721
- * Set to `true` to centre the Widget in browser viewport space.
102027
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-centered)
102028
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
101722
102029
  */
101723
- centered?: boolean
102030
+ centered?: boolean|object
101724
102031
  /**
101725
102032
  * Show a tool in the header to close this Popup.
101726
102033
  * The tool is available in the [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools) object
@@ -101944,10 +102251,14 @@ type RecurrenceConfirmationPopupConfig = {
101944
102251
  inputFieldAlign?: 'start'|'end'
101945
102252
  /**
101946
102253
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
102254
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
102255
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-insertBefore)
101947
102256
  */
101948
102257
  insertBefore?: HTMLElement|string
101949
102258
  /**
101950
102259
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
102260
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
102261
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-insertFirst)
101951
102262
  */
101952
102263
  insertFirst?: HTMLElement|string
101953
102264
  /**
@@ -101973,7 +102284,7 @@ type RecurrenceConfirmationPopupConfig = {
101973
102284
  */
101974
102285
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
101975
102286
  /**
101976
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
102287
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
101977
102288
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceConfirmationPopup#config-labelWidth)
101978
102289
  */
101979
102290
  labelWidth?: number|null
@@ -102178,7 +102489,7 @@ type RecurrenceConfirmationPopupConfig = {
102178
102489
  rtl?: boolean
102179
102490
  /**
102180
102491
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
102181
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
102492
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
102182
102493
  */
102183
102494
  scrollAction?: 'hide'|'realign'|null
102184
102495
  /**
@@ -102949,6 +103260,8 @@ type RecurrenceEditorConfig = {
102949
103260
  /**
102950
103261
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
102951
103262
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
103263
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
103264
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-appendTo)
102952
103265
  */
102953
103266
  appendTo?: HTMLElement|string
102954
103267
  /**
@@ -103012,9 +103325,10 @@ type RecurrenceEditorConfig = {
103012
103325
  catchEventHandlerExceptions?: boolean
103013
103326
  /**
103014
103327
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
103015
- * Set to `true` to centre the Widget in browser viewport space.
103328
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-centered)
103329
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
103016
103330
  */
103017
- centered?: boolean
103331
+ centered?: boolean|object
103018
103332
  /**
103019
103333
  * Show a tool in the header to close this Popup.
103020
103334
  * The tool is available in the [tools](https://bryntum.com/products/scheduler/docs/api/Core/widget/mixin/Toolable#property-tools) object
@@ -103238,10 +103552,14 @@ type RecurrenceEditorConfig = {
103238
103552
  inputFieldAlign?: 'start'|'end'
103239
103553
  /**
103240
103554
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
103555
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
103556
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-insertBefore)
103241
103557
  */
103242
103558
  insertBefore?: HTMLElement|string
103243
103559
  /**
103244
103560
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
103561
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
103562
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-insertFirst)
103245
103563
  */
103246
103564
  insertFirst?: HTMLElement|string
103247
103565
  /**
@@ -103267,7 +103585,7 @@ type RecurrenceEditorConfig = {
103267
103585
  */
103268
103586
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
103269
103587
  /**
103270
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
103588
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
103271
103589
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceEditor#config-labelWidth)
103272
103590
  */
103273
103591
  labelWidth?: number|null
@@ -103472,7 +103790,7 @@ type RecurrenceEditorConfig = {
103472
103790
  rtl?: boolean
103473
103791
  /**
103474
103792
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
103475
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
103793
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
103476
103794
  */
103477
103795
  scrollAction?: 'hide'|'realign'|null
103478
103796
  /**
@@ -104186,6 +104504,8 @@ type RecurrenceLegendButtonConfig = {
104186
104504
  /**
104187
104505
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
104188
104506
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
104507
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
104508
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-appendTo)
104189
104509
  */
104190
104510
  appendTo?: HTMLElement|string
104191
104511
  /**
@@ -104227,9 +104547,10 @@ type RecurrenceLegendButtonConfig = {
104227
104547
  catchEventHandlerExceptions?: boolean
104228
104548
  /**
104229
104549
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
104230
- * Set to `true` to centre the Widget in browser viewport space.
104550
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-centered)
104551
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
104231
104552
  */
104232
- centered?: boolean
104553
+ centered?: boolean|object
104233
104554
  /**
104234
104555
  * Custom CSS classes to add to element.
104235
104556
  * May be specified as a space separated string, or as an object in which property names
@@ -104302,7 +104623,7 @@ type RecurrenceLegendButtonConfig = {
104302
104623
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
104303
104624
  /**
104304
104625
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
104305
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
104626
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
104306
104627
  * property which controls when a drag should start.
104307
104628
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-draggable)
104308
104629
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -104377,10 +104698,14 @@ type RecurrenceLegendButtonConfig = {
104377
104698
  ignoreParentReadOnly?: boolean
104378
104699
  /**
104379
104700
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
104701
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
104702
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-insertBefore)
104380
104703
  */
104381
104704
  insertBefore?: HTMLElement|string
104382
104705
  /**
104383
104706
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
104707
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
104708
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/RecurrenceLegendButton#config-insertFirst)
104384
104709
  */
104385
104710
  insertFirst?: HTMLElement|string
104386
104711
  /**
@@ -104554,7 +104879,7 @@ type RecurrenceLegendButtonConfig = {
104554
104879
  rtl?: boolean
104555
104880
  /**
104556
104881
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
104557
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
104882
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
104558
104883
  */
104559
104884
  scrollAction?: 'hide'|'realign'|null
104560
104885
  /**
@@ -105229,6 +105554,8 @@ type RecurrenceComboConfig = {
105229
105554
  /**
105230
105555
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
105231
105556
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
105557
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
105558
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-appendTo)
105232
105559
  */
105233
105560
  appendTo?: HTMLElement|string
105234
105561
  /**
@@ -105288,9 +105615,10 @@ type RecurrenceComboConfig = {
105288
105615
  catchEventHandlerExceptions?: boolean
105289
105616
  /**
105290
105617
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
105291
- * Set to `true` to centre the Widget in browser viewport space.
105618
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-centered)
105619
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
105292
105620
  */
105293
- centered?: boolean
105621
+ centered?: boolean|object
105294
105622
  /**
105295
105623
  * A function (or the name of a function in the ownership hierarchy) called during field validation
105296
105624
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -105425,7 +105753,7 @@ type RecurrenceComboConfig = {
105425
105753
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
105426
105754
  /**
105427
105755
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
105428
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
105756
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
105429
105757
  * property which controls when a drag should start.
105430
105758
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-draggable)
105431
105759
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -105591,10 +105919,14 @@ type RecurrenceComboConfig = {
105591
105919
  inputWidth?: string|number
105592
105920
  /**
105593
105921
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
105922
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
105923
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-insertBefore)
105594
105924
  */
105595
105925
  insertBefore?: HTMLElement|string
105596
105926
  /**
105597
105927
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
105928
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
105929
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceCombo#config-insertFirst)
105598
105930
  */
105599
105931
  insertFirst?: HTMLElement|string
105600
105932
  /**
@@ -105867,7 +106199,7 @@ type RecurrenceComboConfig = {
105867
106199
  rtl?: boolean
105868
106200
  /**
105869
106201
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
105870
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
106202
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
105871
106203
  */
105872
106204
  scrollAction?: 'hide'|'realign'|null
105873
106205
  /**
@@ -106553,6 +106885,8 @@ type RecurrenceDaysComboConfig = {
106553
106885
  /**
106554
106886
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
106555
106887
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
106888
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
106889
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-appendTo)
106556
106890
  */
106557
106891
  appendTo?: HTMLElement|string
106558
106892
  /**
@@ -106612,9 +106946,10 @@ type RecurrenceDaysComboConfig = {
106612
106946
  catchEventHandlerExceptions?: boolean
106613
106947
  /**
106614
106948
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
106615
- * Set to `true` to centre the Widget in browser viewport space.
106949
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-centered)
106950
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
106616
106951
  */
106617
- centered?: boolean
106952
+ centered?: boolean|object
106618
106953
  /**
106619
106954
  * A function (or the name of a function in the ownership hierarchy) called during field validation
106620
106955
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -106749,7 +107084,7 @@ type RecurrenceDaysComboConfig = {
106749
107084
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
106750
107085
  /**
106751
107086
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
106752
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
107087
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
106753
107088
  * property which controls when a drag should start.
106754
107089
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-draggable)
106755
107090
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -106915,10 +107250,14 @@ type RecurrenceDaysComboConfig = {
106915
107250
  inputWidth?: string|number
106916
107251
  /**
106917
107252
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
107253
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
107254
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-insertBefore)
106918
107255
  */
106919
107256
  insertBefore?: HTMLElement|string
106920
107257
  /**
106921
107258
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
107259
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
107260
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceDaysCombo#config-insertFirst)
106922
107261
  */
106923
107262
  insertFirst?: HTMLElement|string
106924
107263
  /**
@@ -107191,7 +107530,7 @@ type RecurrenceDaysComboConfig = {
107191
107530
  rtl?: boolean
107192
107531
  /**
107193
107532
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
107194
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
107533
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
107195
107534
  */
107196
107535
  scrollAction?: 'hide'|'realign'|null
107197
107536
  /**
@@ -107877,6 +108216,8 @@ type RecurrenceFrequencyComboConfig = {
107877
108216
  /**
107878
108217
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
107879
108218
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
108219
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
108220
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-appendTo)
107880
108221
  */
107881
108222
  appendTo?: HTMLElement|string
107882
108223
  /**
@@ -107936,9 +108277,10 @@ type RecurrenceFrequencyComboConfig = {
107936
108277
  catchEventHandlerExceptions?: boolean
107937
108278
  /**
107938
108279
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
107939
- * Set to `true` to centre the Widget in browser viewport space.
108280
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-centered)
108281
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
107940
108282
  */
107941
- centered?: boolean
108283
+ centered?: boolean|object
107942
108284
  /**
107943
108285
  * A function (or the name of a function in the ownership hierarchy) called during field validation
107944
108286
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -108073,7 +108415,7 @@ type RecurrenceFrequencyComboConfig = {
108073
108415
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
108074
108416
  /**
108075
108417
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
108076
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
108418
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
108077
108419
  * property which controls when a drag should start.
108078
108420
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-draggable)
108079
108421
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -108239,10 +108581,14 @@ type RecurrenceFrequencyComboConfig = {
108239
108581
  inputWidth?: string|number
108240
108582
  /**
108241
108583
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
108584
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
108585
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-insertBefore)
108242
108586
  */
108243
108587
  insertBefore?: HTMLElement|string
108244
108588
  /**
108245
108589
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
108590
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
108591
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceFrequencyCombo#config-insertFirst)
108246
108592
  */
108247
108593
  insertFirst?: HTMLElement|string
108248
108594
  /**
@@ -108515,7 +108861,7 @@ type RecurrenceFrequencyComboConfig = {
108515
108861
  rtl?: boolean
108516
108862
  /**
108517
108863
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
108518
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
108864
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
108519
108865
  */
108520
108866
  scrollAction?: 'hide'|'realign'|null
108521
108867
  /**
@@ -109201,6 +109547,8 @@ type RecurrencePositionsComboConfig = {
109201
109547
  /**
109202
109548
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
109203
109549
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
109550
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
109551
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-appendTo)
109204
109552
  */
109205
109553
  appendTo?: HTMLElement|string
109206
109554
  /**
@@ -109260,9 +109608,10 @@ type RecurrencePositionsComboConfig = {
109260
109608
  catchEventHandlerExceptions?: boolean
109261
109609
  /**
109262
109610
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
109263
- * Set to `true` to centre the Widget in browser viewport space.
109611
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-centered)
109612
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
109264
109613
  */
109265
- centered?: boolean
109614
+ centered?: boolean|object
109266
109615
  /**
109267
109616
  * A function (or the name of a function in the ownership hierarchy) called during field validation
109268
109617
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -109397,7 +109746,7 @@ type RecurrencePositionsComboConfig = {
109397
109746
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
109398
109747
  /**
109399
109748
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
109400
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
109749
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
109401
109750
  * property which controls when a drag should start.
109402
109751
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-draggable)
109403
109752
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -109563,10 +109912,14 @@ type RecurrencePositionsComboConfig = {
109563
109912
  inputWidth?: string|number
109564
109913
  /**
109565
109914
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
109915
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
109916
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-insertBefore)
109566
109917
  */
109567
109918
  insertBefore?: HTMLElement|string
109568
109919
  /**
109569
109920
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
109921
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
109922
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrencePositionsCombo#config-insertFirst)
109570
109923
  */
109571
109924
  insertFirst?: HTMLElement|string
109572
109925
  /**
@@ -109839,7 +110192,7 @@ type RecurrencePositionsComboConfig = {
109839
110192
  rtl?: boolean
109840
110193
  /**
109841
110194
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
109842
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
110195
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
109843
110196
  */
109844
110197
  scrollAction?: 'hide'|'realign'|null
109845
110198
  /**
@@ -110525,6 +110878,8 @@ type RecurrenceStopConditionComboConfig = {
110525
110878
  /**
110526
110879
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
110527
110880
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
110881
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
110882
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-appendTo)
110528
110883
  */
110529
110884
  appendTo?: HTMLElement|string
110530
110885
  /**
@@ -110584,9 +110939,10 @@ type RecurrenceStopConditionComboConfig = {
110584
110939
  catchEventHandlerExceptions?: boolean
110585
110940
  /**
110586
110941
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
110587
- * Set to `true` to centre the Widget in browser viewport space.
110942
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-centered)
110943
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
110588
110944
  */
110589
- centered?: boolean
110945
+ centered?: boolean|object
110590
110946
  /**
110591
110947
  * A function (or the name of a function in the ownership hierarchy) called during field validation
110592
110948
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -110721,7 +111077,7 @@ type RecurrenceStopConditionComboConfig = {
110721
111077
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
110722
111078
  /**
110723
111079
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
110724
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
111080
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
110725
111081
  * property which controls when a drag should start.
110726
111082
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-draggable)
110727
111083
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -110887,10 +111243,14 @@ type RecurrenceStopConditionComboConfig = {
110887
111243
  inputWidth?: string|number
110888
111244
  /**
110889
111245
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
111246
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
111247
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-insertBefore)
110890
111248
  */
110891
111249
  insertBefore?: HTMLElement|string
110892
111250
  /**
110893
111251
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
111252
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
111253
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/recurrence/field/RecurrenceStopConditionCombo#config-insertFirst)
110894
111254
  */
110895
111255
  insertFirst?: HTMLElement|string
110896
111256
  /**
@@ -111163,7 +111523,7 @@ type RecurrenceStopConditionComboConfig = {
111163
111523
  rtl?: boolean
111164
111524
  /**
111165
111525
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
111166
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
111526
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
111167
111527
  */
111168
111528
  scrollAction?: 'hide'|'realign'|null
111169
111529
  /**
@@ -111817,6 +112177,8 @@ type DayButtonsConfig = {
111817
112177
  /**
111818
112178
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
111819
112179
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
112180
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
112181
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-appendTo)
111820
112182
  */
111821
112183
  appendTo?: HTMLElement|string
111822
112184
  /**
@@ -111858,9 +112220,10 @@ type DayButtonsConfig = {
111858
112220
  catchEventHandlerExceptions?: boolean
111859
112221
  /**
111860
112222
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
111861
- * Set to `true` to centre the Widget in browser viewport space.
112223
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-centered)
112224
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
111862
112225
  */
111863
- centered?: boolean
112226
+ centered?: boolean|object
111864
112227
  /**
111865
112228
  * Custom CSS class to add to element.
111866
112229
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-cls)
@@ -111946,7 +112309,7 @@ type DayButtonsConfig = {
111946
112309
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
111947
112310
  /**
111948
112311
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
111949
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
112312
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
111950
112313
  * property which controls when a drag should start.
111951
112314
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-draggable)
111952
112315
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -112020,10 +112383,14 @@ type DayButtonsConfig = {
112020
112383
  inputFieldAlign?: 'start'|'end'
112021
112384
  /**
112022
112385
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
112386
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
112387
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-insertBefore)
112023
112388
  */
112024
112389
  insertBefore?: HTMLElement|string
112025
112390
  /**
112026
112391
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
112392
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
112393
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-insertFirst)
112027
112394
  */
112028
112395
  insertFirst?: HTMLElement|string
112029
112396
  /**
@@ -112043,7 +112410,7 @@ type DayButtonsConfig = {
112043
112410
  */
112044
112411
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
112045
112412
  /**
112046
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
112413
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
112047
112414
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/DayButtons#config-labelWidth)
112048
112415
  */
112049
112416
  labelWidth?: number|null
@@ -112216,7 +112583,7 @@ type DayButtonsConfig = {
112216
112583
  rtl?: boolean
112217
112584
  /**
112218
112585
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
112219
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
112586
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
112220
112587
  */
112221
112588
  scrollAction?: 'hide'|'realign'|null
112222
112589
  /**
@@ -112887,6 +113254,8 @@ type EventColorFieldConfig = {
112887
113254
  /**
112888
113255
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
112889
113256
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
113257
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
113258
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorField#config-appendTo)
112890
113259
  */
112891
113260
  appendTo?: HTMLElement|string
112892
113261
  /**
@@ -112937,9 +113306,10 @@ type EventColorFieldConfig = {
112937
113306
  catchEventHandlerExceptions?: boolean
112938
113307
  /**
112939
113308
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
112940
- * Set to `true` to centre the Widget in browser viewport space.
113309
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorField#config-centered)
113310
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
112941
113311
  */
112942
- centered?: boolean
113312
+ centered?: boolean|object
112943
113313
  /**
112944
113314
  * A function (or the name of a function in the ownership hierarchy) called during field validation
112945
113315
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -113036,7 +113406,7 @@ type EventColorFieldConfig = {
113036
113406
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
113037
113407
  /**
113038
113408
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
113039
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
113409
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
113040
113410
  * property which controls when a drag should start.
113041
113411
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorField#config-draggable)
113042
113412
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -113144,10 +113514,14 @@ type EventColorFieldConfig = {
113144
113514
  inputWidth?: string|number
113145
113515
  /**
113146
113516
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
113517
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
113518
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorField#config-insertBefore)
113147
113519
  */
113148
113520
  insertBefore?: HTMLElement|string
113149
113521
  /**
113150
113522
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
113523
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
113524
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorField#config-insertFirst)
113151
113525
  */
113152
113526
  insertFirst?: HTMLElement|string
113153
113527
  /**
@@ -113361,7 +113735,7 @@ type EventColorFieldConfig = {
113361
113735
  rtl?: boolean
113362
113736
  /**
113363
113737
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
113364
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
113738
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
113365
113739
  */
113366
113740
  scrollAction?: 'hide'|'realign'|null
113367
113741
  /**
@@ -114015,6 +114389,8 @@ type EventColorPickerConfig = {
114015
114389
  /**
114016
114390
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
114017
114391
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
114392
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
114393
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-appendTo)
114018
114394
  */
114019
114395
  appendTo?: HTMLElement|string
114020
114396
  /**
@@ -114048,9 +114424,10 @@ type EventColorPickerConfig = {
114048
114424
  catchEventHandlerExceptions?: boolean
114049
114425
  /**
114050
114426
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
114051
- * Set to `true` to centre the Widget in browser viewport space.
114427
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-centered)
114428
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
114052
114429
  */
114053
- centered?: boolean
114430
+ centered?: boolean|object
114054
114431
  /**
114055
114432
  * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
114056
114433
  */
@@ -114148,7 +114525,7 @@ type EventColorPickerConfig = {
114148
114525
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
114149
114526
  /**
114150
114527
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
114151
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
114528
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
114152
114529
  * property which controls when a drag should start.
114153
114530
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-draggable)
114154
114531
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -114235,10 +114612,14 @@ type EventColorPickerConfig = {
114235
114612
  ignoreParentReadOnly?: boolean
114236
114613
  /**
114237
114614
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
114615
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
114616
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-insertBefore)
114238
114617
  */
114239
114618
  insertBefore?: HTMLElement|string
114240
114619
  /**
114241
114620
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
114621
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
114622
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/EventColorPicker#config-insertFirst)
114242
114623
  */
114243
114624
  insertFirst?: HTMLElement|string
114244
114625
  /**
@@ -114408,7 +114789,7 @@ type EventColorPickerConfig = {
114408
114789
  rtl?: boolean
114409
114790
  /**
114410
114791
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
114411
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
114792
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
114412
114793
  */
114413
114794
  scrollAction?: 'hide'|'realign'|null
114414
114795
  /**
@@ -115078,6 +115459,8 @@ type ProjectComboConfig = {
115078
115459
  /**
115079
115460
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
115080
115461
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
115462
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
115463
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-appendTo)
115081
115464
  */
115082
115465
  appendTo?: HTMLElement|string
115083
115466
  /**
@@ -115137,9 +115520,10 @@ type ProjectComboConfig = {
115137
115520
  catchEventHandlerExceptions?: boolean
115138
115521
  /**
115139
115522
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
115140
- * Set to `true` to centre the Widget in browser viewport space.
115523
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-centered)
115524
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
115141
115525
  */
115142
- centered?: boolean
115526
+ centered?: boolean|object
115143
115527
  /**
115144
115528
  * A function (or the name of a function in the ownership hierarchy) called during field validation
115145
115529
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -115274,7 +115658,7 @@ type ProjectComboConfig = {
115274
115658
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
115275
115659
  /**
115276
115660
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
115277
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
115661
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
115278
115662
  * property which controls when a drag should start.
115279
115663
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-draggable)
115280
115664
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -115440,10 +115824,14 @@ type ProjectComboConfig = {
115440
115824
  inputWidth?: string|number
115441
115825
  /**
115442
115826
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
115827
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
115828
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-insertBefore)
115443
115829
  */
115444
115830
  insertBefore?: HTMLElement|string
115445
115831
  /**
115446
115832
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
115833
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
115834
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ProjectCombo#config-insertFirst)
115447
115835
  */
115448
115836
  insertFirst?: HTMLElement|string
115449
115837
  /**
@@ -115720,7 +116108,7 @@ type ProjectComboConfig = {
115720
116108
  rtl?: boolean
115721
116109
  /**
115722
116110
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
115723
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
116111
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
115724
116112
  */
115725
116113
  scrollAction?: 'hide'|'realign'|null
115726
116114
  /**
@@ -116408,6 +116796,8 @@ type ResourceComboConfig = {
116408
116796
  /**
116409
116797
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
116410
116798
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
116799
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
116800
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-appendTo)
116411
116801
  */
116412
116802
  appendTo?: HTMLElement|string
116413
116803
  /**
@@ -116467,9 +116857,10 @@ type ResourceComboConfig = {
116467
116857
  catchEventHandlerExceptions?: boolean
116468
116858
  /**
116469
116859
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
116470
- * Set to `true` to centre the Widget in browser viewport space.
116860
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-centered)
116861
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
116471
116862
  */
116472
- centered?: boolean
116863
+ centered?: boolean|object
116473
116864
  /**
116474
116865
  * A function (or the name of a function in the ownership hierarchy) called during field validation
116475
116866
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -116604,7 +116995,7 @@ type ResourceComboConfig = {
116604
116995
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
116605
116996
  /**
116606
116997
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
116607
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
116998
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
116608
116999
  * property which controls when a drag should start.
116609
117000
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-draggable)
116610
117001
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -116770,10 +117161,14 @@ type ResourceComboConfig = {
116770
117161
  inputWidth?: string|number
116771
117162
  /**
116772
117163
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
117164
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
117165
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-insertBefore)
116773
117166
  */
116774
117167
  insertBefore?: HTMLElement|string
116775
117168
  /**
116776
117169
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
117170
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
117171
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceCombo#config-insertFirst)
116777
117172
  */
116778
117173
  insertFirst?: HTMLElement|string
116779
117174
  /**
@@ -117046,7 +117441,7 @@ type ResourceComboConfig = {
117046
117441
  rtl?: boolean
117047
117442
  /**
117048
117443
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
117049
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
117444
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
117050
117445
  */
117051
117446
  scrollAction?: 'hide'|'realign'|null
117052
117447
  /**
@@ -117747,6 +118142,8 @@ type ResourceFilterConfig = {
117747
118142
  /**
117748
118143
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
117749
118144
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
118145
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
118146
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-appendTo)
117750
118147
  */
117751
118148
  appendTo?: HTMLElement|string
117752
118149
  /**
@@ -117780,9 +118177,10 @@ type ResourceFilterConfig = {
117780
118177
  catchEventHandlerExceptions?: boolean
117781
118178
  /**
117782
118179
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
117783
- * Set to `true` to centre the Widget in browser viewport space.
118180
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-centered)
118181
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
117784
118182
  */
117785
- centered?: boolean
118183
+ centered?: boolean|object
117786
118184
  /**
117787
118185
  * Configure as `true` to clear selection when clicking on empty space inside the List´s element.
117788
118186
  */
@@ -117867,7 +118265,7 @@ type ResourceFilterConfig = {
117867
118265
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
117868
118266
  /**
117869
118267
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
117870
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
118268
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
117871
118269
  * property which controls when a drag should start.
117872
118270
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-draggable)
117873
118271
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -117966,10 +118364,14 @@ type ResourceFilterConfig = {
117966
118364
  ignoreParentReadOnly?: boolean
117967
118365
  /**
117968
118366
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
118367
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
118368
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-insertBefore)
117969
118369
  */
117970
118370
  insertBefore?: HTMLElement|string
117971
118371
  /**
117972
118372
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
118373
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
118374
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ResourceFilter#config-insertFirst)
117973
118375
  */
117974
118376
  insertFirst?: HTMLElement|string
117975
118377
  /**
@@ -118142,7 +118544,7 @@ type ResourceFilterConfig = {
118142
118544
  rtl?: boolean
118143
118545
  /**
118144
118546
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
118145
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
118547
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
118146
118548
  */
118147
118549
  scrollAction?: 'hide'|'realign'|null
118148
118550
  /**
@@ -118230,7 +118632,7 @@ type ResourceFilterConfig = {
118230
118632
  */
118231
118633
  ui?: string|object
118232
118634
  /**
118233
- * Configure as `false` to not use the Resource`s color field to style the checkbox
118635
+ * Configure as `false` to not use the Resource's color field to style the checkbox
118234
118636
  */
118235
118637
  useResourceColor?: boolean
118236
118638
  /**
@@ -118932,6 +119334,8 @@ type SchedulerDatePickerConfig = {
118932
119334
  /**
118933
119335
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
118934
119336
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
119337
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
119338
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-appendTo)
118935
119339
  */
118936
119340
  appendTo?: HTMLElement|string
118937
119341
  /**
@@ -119002,9 +119406,10 @@ type SchedulerDatePickerConfig = {
119002
119406
  cellRenderer?: ((renderData: { cell: HTMLElement, innerCell: HTMLElement, cellPayload: HTMLElement, date: Date, day: number, rowIndex: number[], row: HTMLElement, source: CalendarPanel, cellIndex: number[], columnIndex: number[], visibleColumnIndex: number[] }) => string|DomConfig|void)|string
119003
119407
  /**
119004
119408
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
119005
- * Set to `true` to centre the Widget in browser viewport space.
119409
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-centered)
119410
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
119006
119411
  */
119007
- centered?: boolean
119412
+ centered?: boolean|object
119008
119413
  /**
119009
119414
  * Custom CSS classes to add to element.
119010
119415
  * May be specified as a space separated string, or as an object in which property names
@@ -119139,7 +119544,7 @@ type SchedulerDatePickerConfig = {
119139
119544
  dragSelect?: boolean
119140
119545
  /**
119141
119546
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
119142
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
119547
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
119143
119548
  * property which controls when a drag should start.
119144
119549
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-draggable)
119145
119550
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -119290,10 +119695,14 @@ type SchedulerDatePickerConfig = {
119290
119695
  inputFieldAlign?: 'start'|'end'
119291
119696
  /**
119292
119697
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
119698
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
119699
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertBefore)
119293
119700
  */
119294
119701
  insertBefore?: HTMLElement|string
119295
119702
  /**
119296
119703
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
119704
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
119705
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertFirst)
119297
119706
  */
119298
119707
  insertFirst?: HTMLElement|string
119299
119708
  /**
@@ -119319,7 +119728,7 @@ type SchedulerDatePickerConfig = {
119319
119728
  */
119320
119729
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
119321
119730
  /**
119322
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
119731
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
119323
119732
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-labelWidth)
119324
119733
  */
119325
119734
  labelWidth?: number|null
@@ -119538,7 +119947,7 @@ type SchedulerDatePickerConfig = {
119538
119947
  rtl?: boolean
119539
119948
  /**
119540
119949
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
119541
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
119950
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
119542
119951
  */
119543
119952
  scrollAction?: 'hide'|'realign'|null
119544
119953
  /**
@@ -120283,6 +120692,8 @@ type TimeZoomSliderConfig = {
120283
120692
  /**
120284
120693
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
120285
120694
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
120695
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
120696
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/TimeZoomSlider#config-appendTo)
120286
120697
  */
120287
120698
  appendTo?: HTMLElement|string
120288
120699
  /**
@@ -120316,9 +120727,10 @@ type TimeZoomSliderConfig = {
120316
120727
  catchEventHandlerExceptions?: boolean
120317
120728
  /**
120318
120729
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
120319
- * Set to `true` to centre the Widget in browser viewport space.
120730
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/TimeZoomSlider#config-centered)
120731
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
120320
120732
  */
120321
- centered?: boolean
120733
+ centered?: boolean|object
120322
120734
  /**
120323
120735
  * The Scheduler, SchedulerPro or Gantt component instance to connect to. If not provided, the widget
120324
120736
  * will attempt to find a timeline component by traversing up the widget hierarchy or querying for one.
@@ -120396,7 +120808,7 @@ type TimeZoomSliderConfig = {
120396
120808
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
120397
120809
  /**
120398
120810
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
120399
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
120811
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
120400
120812
  * property which controls when a drag should start.
120401
120813
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/TimeZoomSlider#config-draggable)
120402
120814
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -120457,10 +120869,14 @@ type TimeZoomSliderConfig = {
120457
120869
  ignoreParentReadOnly?: boolean
120458
120870
  /**
120459
120871
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
120872
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
120873
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/TimeZoomSlider#config-insertBefore)
120460
120874
  */
120461
120875
  insertBefore?: HTMLElement|string
120462
120876
  /**
120463
120877
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
120878
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
120879
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/TimeZoomSlider#config-insertFirst)
120464
120880
  */
120465
120881
  insertFirst?: HTMLElement|string
120466
120882
  /**
@@ -120629,7 +121045,7 @@ type TimeZoomSliderConfig = {
120629
121045
  rtl?: boolean
120630
121046
  /**
120631
121047
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
120632
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
121048
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
120633
121049
  */
120634
121050
  scrollAction?: 'hide'|'realign'|null
120635
121051
  /**
@@ -121201,6 +121617,8 @@ type UndoRedoConfig = {
121201
121617
  /**
121202
121618
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
121203
121619
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
121620
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
121621
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-appendTo)
121204
121622
  */
121205
121623
  appendTo?: HTMLElement|string
121206
121624
  /**
@@ -121242,9 +121660,10 @@ type UndoRedoConfig = {
121242
121660
  catchEventHandlerExceptions?: boolean
121243
121661
  /**
121244
121662
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
121245
- * Set to `true` to centre the Widget in browser viewport space.
121663
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-centered)
121664
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
121246
121665
  */
121247
- centered?: boolean
121666
+ centered?: boolean|object
121248
121667
  /**
121249
121668
  * Custom CSS classes to add to element.
121250
121669
  * May be specified as a space separated string, or as an object in which property names
@@ -121327,7 +121746,7 @@ type UndoRedoConfig = {
121327
121746
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
121328
121747
  /**
121329
121748
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
121330
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
121749
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
121331
121750
  * property which controls when a drag should start.
121332
121751
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-draggable)
121333
121752
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -121401,10 +121820,14 @@ type UndoRedoConfig = {
121401
121820
  inputFieldAlign?: 'start'|'end'
121402
121821
  /**
121403
121822
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
121823
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
121824
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-insertBefore)
121404
121825
  */
121405
121826
  insertBefore?: HTMLElement|string
121406
121827
  /**
121407
121828
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
121829
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
121830
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-insertFirst)
121408
121831
  */
121409
121832
  insertFirst?: HTMLElement|string
121410
121833
  /**
@@ -121430,7 +121853,7 @@ type UndoRedoConfig = {
121430
121853
  */
121431
121854
  labelPosition?: 'before'|'above'|'align-before'|'auto'|null
121432
121855
  /**
121433
- * Sets `labelWidth´ for all children of this Container, that does not define their own `labelWidth`.
121856
+ * Sets `labelWidth` for all children of this Container, that do not define their own `labelWidth`.
121434
121857
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/UndoRedo#config-labelWidth)
121435
121858
  */
121436
121859
  labelWidth?: number|null
@@ -121611,7 +122034,7 @@ type UndoRedoConfig = {
121611
122034
  scheduler?: Widget|string
121612
122035
  /**
121613
122036
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
121614
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
122037
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
121615
122038
  */
121616
122039
  scrollAction?: 'hide'|'realign'|null
121617
122040
  /**
@@ -122224,6 +122647,8 @@ type ViewPresetComboConfig = {
122224
122647
  /**
122225
122648
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
122226
122649
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
122650
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
122651
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-appendTo)
122227
122652
  */
122228
122653
  appendTo?: HTMLElement|string
122229
122654
  /**
@@ -122266,9 +122691,10 @@ type ViewPresetComboConfig = {
122266
122691
  catchEventHandlerExceptions?: boolean
122267
122692
  /**
122268
122693
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
122269
- * Set to `true` to centre the Widget in browser viewport space.
122694
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-centered)
122695
+ * @property {boolean} [once] If `true`, the Widget will be centred on its first show, but if it is moved at runtime, it will opt out of centering for future shows.
122270
122696
  */
122271
- centered?: boolean
122697
+ centered?: boolean|object
122272
122698
  /**
122273
122699
  * A function (or the name of a function in the ownership hierarchy) called during field validation
122274
122700
  * to perform custom validity checks. The function is called as part of the [isValid](https://bryntum.com/products/scheduler/docs/api/Core/widget/Field#property-isValid)
@@ -122352,7 +122778,7 @@ type ViewPresetComboConfig = {
122352
122778
  dock?: 'top'|'bottom'|'left'|'right'|'start'|'end'|'header'|'pre-header'|object
122353
122779
  /**
122354
122780
  * *Only valid if this Widget is [floating](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-floating).*
122355
- * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a ´handleSelector´
122781
+ * Set to `true` to be able to drag a widget freely on the page. Or set to an object with a `handleSelector`
122356
122782
  * property which controls when a drag should start.
122357
122783
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-draggable)
122358
122784
  * @property {string} handleSelector CSS selector used to determine if drag can be started from a mouse-downed element inside the widget
@@ -122455,10 +122881,14 @@ type ViewPresetComboConfig = {
122455
122881
  inputWidth?: string|number
122456
122882
  /**
122457
122883
  * Element (or element id) to insert this widget before. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
122884
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
122885
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-insertBefore)
122458
122886
  */
122459
122887
  insertBefore?: HTMLElement|string
122460
122888
  /**
122461
122889
  * Element (or element id) to append this widget element to, as a first child. If provided, [appendTo](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-appendTo) config is ignored.
122890
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
122891
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/ViewPresetCombo#config-insertFirst)
122462
122892
  */
122463
122893
  insertFirst?: HTMLElement|string
122464
122894
  /**
@@ -122664,7 +123094,7 @@ type ViewPresetComboConfig = {
122664
123094
  rtl?: boolean
122665
123095
  /**
122666
123096
  * Defines what to do if document is scrolled while Widget is visible (only relevant when floating is set to `true`).
122667
- * Valid values: ´null´: do nothing, ´hide´: hide the widget or ´realign´: realign to the target if possible.
123097
+ * Valid values: `null`: do nothing, `hide`: hide the widget or `realign`: realign to the target if possible.
122668
123098
  */
122669
123099
  scrollAction?: 'hide'|'realign'|null
122670
123100
  /**