@bryntum/scheduler-vue-3-thin 7.3.0 → 7.3.2

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 (56) hide show
  1. package/README.md +8 -8
  2. package/lib/chunks/{DVFhf2Ma.js → BTSObfAz.js} +6 -4
  3. package/lib/chunks/BTSObfAz.js.map +1 -0
  4. package/lib/chunks/BXIuEgYD.js.map +1 -1
  5. package/lib/chunks/{DhhzgoYL.js → CCTV8qn0.js} +3 -1
  6. package/lib/chunks/CCTV8qn0.js.map +1 -0
  7. package/lib/chunks/{kN-s_8Na.js → COFzBhB8.js} +8 -6
  8. package/lib/chunks/COFzBhB8.js.map +1 -0
  9. package/lib/chunks/DB0UHrA3.js.map +1 -1
  10. package/lib/chunks/{5o-YjSb7.js → DJSlX0qP.js} +3 -1
  11. package/lib/chunks/DJSlX0qP.js.map +1 -0
  12. package/lib/chunks/DP61St-u.js.map +1 -1
  13. package/lib/chunks/{ZkU6CtWX.js → LNqNYJck.js} +9 -7
  14. package/lib/chunks/LNqNYJck.js.map +1 -0
  15. package/lib/chunks/R69sJLmF.js.map +1 -1
  16. package/lib/chunks/{OJaN5ZWK.js → WykRcMCN.js} +6 -4
  17. package/lib/chunks/WykRcMCN.js.map +1 -0
  18. package/lib/chunks/eUISgYXE.js.map +1 -1
  19. package/lib/chunks/t8aiH3XL.js.map +1 -1
  20. package/lib/components/BryntumEventColorField.js +1 -1
  21. package/lib/components/BryntumProjectCombo.js +1 -1
  22. package/lib/components/BryntumResourceCombo.js +1 -1
  23. package/lib/components/BryntumScheduler.js +1 -1
  24. package/lib/components/BryntumSchedulerBase.js +1 -1
  25. package/lib/components/BryntumViewPresetCombo.js +1 -1
  26. package/lib/index.js +6 -6
  27. package/package.json +1 -1
  28. package/src/components/BryntumEventColorField.vue +86 -106
  29. package/src/components/BryntumEventColorFieldProps.ts +15 -0
  30. package/src/components/BryntumProjectCombo.vue +88 -110
  31. package/src/components/BryntumProjectComboProps.ts +16 -1
  32. package/src/components/BryntumResourceCombo.vue +87 -109
  33. package/src/components/BryntumResourceComboProps.ts +15 -0
  34. package/src/components/BryntumResourceFilter.vue +75 -107
  35. package/src/components/BryntumResourceFilterProps.ts +6 -0
  36. package/src/components/BryntumScheduler.vue +1432 -1928
  37. package/src/components/BryntumSchedulerBase.vue +1432 -1928
  38. package/src/components/BryntumSchedulerBaseProps.ts +12 -1
  39. package/src/components/BryntumSchedulerDatePicker.vue +91 -135
  40. package/src/components/BryntumSchedulerDatePickerProps.ts +6 -0
  41. package/src/components/BryntumSchedulerProjectModel.vue +11 -15
  42. package/src/components/BryntumSchedulerProps.ts +12 -1
  43. package/src/components/BryntumTimeZoomSlider.vue +56 -80
  44. package/src/components/BryntumTimeZoomSliderProps.ts +6 -0
  45. package/src/components/BryntumTimelineHistogram.vue +728 -1030
  46. package/src/components/BryntumTimelineHistogramProps.ts +6 -0
  47. package/src/components/BryntumUndoRedo.vue +56 -80
  48. package/src/components/BryntumUndoRedoProps.ts +7 -1
  49. package/src/components/BryntumViewPresetCombo.vue +83 -103
  50. package/src/components/BryntumViewPresetComboProps.ts +15 -0
  51. package/lib/chunks/5o-YjSb7.js.map +0 -1
  52. package/lib/chunks/DVFhf2Ma.js.map +0 -1
  53. package/lib/chunks/DhhzgoYL.js.map +0 -1
  54. package/lib/chunks/OJaN5ZWK.js.map +0 -1
  55. package/lib/chunks/ZkU6CtWX.js.map +0 -1
  56. package/lib/chunks/kN-s_8Na.js.map +0 -1
@@ -58,6 +58,8 @@ export declare type BryntumSchedulerBaseProps = {
58
58
  /**
59
59
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
60
60
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
61
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
62
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-appendTo)
61
63
  */
62
64
  appendTo ? : HTMLElement|string
63
65
  /**
@@ -665,10 +667,14 @@ export declare type BryntumSchedulerBaseProps = {
665
667
  inputFieldAlign ? : 'start'|'end'
666
668
  /**
667
669
  * 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.
670
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
671
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-insertBefore)
668
672
  */
669
673
  insertBefore ? : HTMLElement|string
670
674
  /**
671
675
  * 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.
676
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
677
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-insertFirst)
672
678
  */
673
679
  insertFirst ? : HTMLElement|string
674
680
  /**
@@ -921,7 +927,12 @@ export declare type BryntumSchedulerBaseProps = {
921
927
  * Can be omitted in favor of individual store configs or [crudManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
922
928
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/SchedulerBase#config-project)
923
929
  */
924
- project ? : ProjectModel|ProjectModelConfig|object
930
+ project ? : ProjectModel|ProjectModelConfig|object|null
931
+ /**
932
+ * The project model class to use when creating the project instance. Override this to use a custom project
933
+ * model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
934
+ */
935
+ projectModelClass ? : typeof ProjectModel
925
936
  /**
926
937
  * Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
927
938
  * `'month'`, `'week'` and `'day'`.
@@ -56,6 +56,8 @@ defineProps<{
56
56
  /**
57
57
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
58
58
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
59
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
60
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-appendTo)
59
61
  */
60
62
  appendTo ? : HTMLElement|string
61
63
  /**
@@ -416,10 +418,14 @@ defineProps<{
416
418
  inputFieldAlign ? : 'start'|'end'
417
419
  /**
418
420
  * 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.
421
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
422
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertBefore)
419
423
  */
420
424
  insertBefore ? : HTMLElement|string
421
425
  /**
422
426
  * 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.
427
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
428
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertFirst)
423
429
  */
424
430
  insertFirst ? : HTMLElement|string
425
431
  /**
@@ -863,30 +869,24 @@ const emit = defineEmits<{
863
869
  * Fires before an object is destroyed.
864
870
  * @param {string} e Event name
865
871
  * @param {object} params Event parameters
866
- * @param {string} params.e Event name
867
- * @param {object} params.params Event parameters
868
- * @param {object} params.params.event Event object
869
- * @param {Core.Base} params.params.event.source The Object that is being destroyed.
872
+ * @param {object} params.event Event object
873
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
870
874
  */
871
875
  (e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
872
876
  /**
873
877
  * Triggered before a widget is hidden. Return `false` to prevent the action.
874
878
  * @param {string} e Event name
875
879
  * @param {object} params Event parameters
876
- * @param {string} params.e Event name
877
- * @param {object} params.params Event parameters
878
- * @param {object} params.params.event Event object
879
- * @param {Core.widget.Widget} params.params.event.source The widget being hidden.
880
+ * @param {object} params.event Event object
881
+ * @param {Core.widget.Widget} params.event.source The widget being hidden.
880
882
  */
881
- (e: 'beforeHide', params: ((event: { source: Widget }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
883
+ (e: 'beforeHide', params: ((event: { source: Widget }) => boolean|void)|string): boolean|void
882
884
  /**
883
885
  * Fires before this CalendarPanel refreshes in response to changes in its month.
884
886
  * @param {string} e Event name
885
887
  * @param {object} params Event parameters
886
- * @param {string} params.e Event name
887
- * @param {object} params.params Event parameters
888
- * @param {object} params.params.event Event object
889
- * @param {Core.widget.DatePicker} params.params.event.source This DatePicker.
888
+ * @param {object} params.event Event object
889
+ * @param {Core.widget.DatePicker} params.event.source This DatePicker.
890
890
  */
891
891
  (e: 'beforeRefresh', params: ((event: { source: DatePicker }) => void)|string): void
892
892
  /**
@@ -894,148 +894,122 @@ const emit = defineEmits<{
894
894
  * want to modify the UI before data is loaded (e.g. set some input field to be readonly)
895
895
  * @param {string} e Event name
896
896
  * @param {object} params Event parameters
897
- * @param {string} params.e Event name
898
- * @param {object} params.params Event parameters
899
- * @param {object} params.params.event Event object
900
- * @param {Core.widget.Container} params.params.event.source The container
901
- * @param {Core.data.Model} params.params.event.record The record
897
+ * @param {object} params.event Event object
898
+ * @param {Core.widget.Container} params.event.source The container
899
+ * @param {Core.data.Model} params.event.record The record
902
900
  */
903
901
  (e: 'beforeSetRecord', params: ((event: { source: Container, record: Model }) => void)|string): void
904
902
  /**
905
903
  * Triggered before a widget is shown. Return `false` to prevent the action.
906
904
  * @param {string} e Event name
907
905
  * @param {object} params Event parameters
908
- * @param {string} params.e Event name
909
- * @param {object} params.params Event parameters
910
- * @param {object} params.params.event Event object
911
- * @param {Core.widget.Widget,any} params.params.event.source The widget being shown
906
+ * @param {object} params.event Event object
907
+ * @param {Core.widget.Widget,any} params.event.source The widget being shown
912
908
  */
913
909
  (e: 'beforeShow', params: ((event: { source: Widget|any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
914
910
  /**
915
911
  * Fired before state is applied to the source. Allows editing the state object or preventing the operation.
916
912
  * @param {string} e Event name
917
913
  * @param {object} params Event parameters
918
- * @param {string} params.e Event name
919
- * @param {object} params.params Event parameters
920
- * @param {object} params.params.event Event object
921
- * @param {any} params.params.event.state State object config
914
+ * @param {object} params.event Event object
915
+ * @param {any} params.event.state State object config
922
916
  */
923
- (e: 'beforeStateApply', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
917
+ (e: 'beforeStateApply', params: ((event: { state: any }) => boolean|void)|string): boolean|void
924
918
  /**
925
919
  * Fired before state is saved by the StateProvider. Allows editing the state object or preventing the operation.
926
920
  * @param {string} e Event name
927
921
  * @param {object} params Event parameters
928
- * @param {string} params.e Event name
929
- * @param {object} params.params Event parameters
930
- * @param {object} params.params.event Event object
931
- * @param {any} params.params.event.state State object config
922
+ * @param {object} params.event Event object
923
+ * @param {any} params.event.state State object config
932
924
  */
933
- (e: 'beforeStateSave', params: ((event: { state: any }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
925
+ (e: 'beforeStateSave', params: ((event: { state: any }) => boolean|void)|string): boolean|void
934
926
  /**
935
927
  * Fires when any other event is fired from the object.
936
928
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#event-catchAll)
937
929
  * @param {string} e Event name
938
930
  * @param {object} params Event parameters
939
- * @param {string} params.e Event name
940
- * @param {object} params.params Event parameters
941
- * @param {object} params.params.event Event object
942
- * @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
943
- * @param {string} params.params.event.event.type The type of the event which is caught by the listener
931
+ * @param {object} params.event Event object
932
+ * @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
933
+ * @param {string} params.event.event.type The type of the event which is caught by the listener
944
934
  */
945
935
  (e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
946
936
  /**
947
937
  * Fired when a date cell is clicked.
948
938
  * @param {string} e Event name
949
939
  * @param {object} params Event parameters
950
- * @param {string} params.e Event name
951
- * @param {object} params.params Event parameters
952
- * @param {object} params.params.event Event object
953
- * @param {HTMLElement} params.params.event.cell The clicked cell element.
954
- * @param {Date} params.params.event.date The date represented by the cell.
955
- * @param {number[]} params.params.event.week The week array `[year, weekNumber]`.
956
- * @param {Event} params.params.event.domEvent The original DOM event.
940
+ * @param {object} params.event Event object
941
+ * @param {HTMLElement} params.event.cell The clicked cell element.
942
+ * @param {Date} params.event.date The date represented by the cell.
943
+ * @param {number[]} params.event.week The week array `[year, weekNumber]`.
944
+ * @param {Event} params.event.domEvent The original DOM event.
957
945
  */
958
946
  (e: 'cellClick', params: ((event: { cell: HTMLElement, date: Date, week: number[], domEvent: Event }) => void)|string): void
959
947
  /**
960
948
  * Fires when a Panel is collapsed using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
961
949
  * @param {string} e Event name
962
950
  * @param {object} params Event parameters
963
- * @param {string} params.e Event name
964
- * @param {object} params.params Event parameters
965
- * @param {object} params.params.event Event object
966
- * @param {Core.widget.Panel} params.params.event.source This Panel.
951
+ * @param {object} params.event Event object
952
+ * @param {Core.widget.Panel} params.event.source This Panel.
967
953
  */
968
954
  (e: 'collapse', params: ((event: { source: Panel }) => void)|string): void
969
955
  /**
970
956
  * Fires when the date of this CalendarPanel is set.
971
957
  * @param {string} e Event name
972
958
  * @param {object} params Event parameters
973
- * @param {string} params.e Event name
974
- * @param {object} params.params Event parameters
975
- * @param {object} params.params.event Event object
976
- * @param {Date} params.params.event.value The new date.
977
- * @param {Date} params.params.event.oldValue The old date.
978
- * @param {object} params.params.event.changes An object which contains properties which indicate what part of the date changed.
979
- * @param {boolean} params.params.event.changes.d True if the date changed in any way.
980
- * @param {boolean} params.params.event.changes.w True if the week changed (including same week in a different year).
981
- * @param {boolean} params.params.event.changes.m True if the month changed (including same month in a different year).
982
- * @param {boolean} params.params.event.changes.y True if the year changed.
959
+ * @param {object} params.event Event object
960
+ * @param {Date} params.event.value The new date.
961
+ * @param {Date} params.event.oldValue The old date.
962
+ * @param {object} params.event.changes An object which contains properties which indicate what part of the date changed.
963
+ * @param {boolean} params.event.changes.d True if the date changed in any way.
964
+ * @param {boolean} params.event.changes.w True if the week changed (including same week in a different year).
965
+ * @param {boolean} params.event.changes.m True if the month changed (including same month in a different year).
966
+ * @param {boolean} params.event.changes.y True if the year changed.
983
967
  */
984
968
  (e: 'dateChange', params: ((event: { value: Date, oldValue: Date, changes: { d: boolean, w: boolean, m: boolean, y: boolean } }) => void)|string): void
985
969
  /**
986
970
  * Fires when an object is destroyed.
987
971
  * @param {string} e Event name
988
972
  * @param {object} params Event parameters
989
- * @param {string} params.e Event name
990
- * @param {object} params.params Event parameters
991
- * @param {object} params.params.event Event object
992
- * @param {Core.Base} params.params.event.source The Object that is being destroyed.
973
+ * @param {object} params.event Event object
974
+ * @param {Core.Base} params.event.source The Object that is being destroyed.
993
975
  */
994
976
  (e: 'destroy', params: ((event: { source: Base }) => void)|string): void
995
977
  /**
996
978
  * Fires when a field is mutated and the state of the [hasChanges](https://bryntum.com/products/scheduler/docs/api/Core/widget/Container#property-hasChanges) property changes
997
979
  * @param {string} e Event name
998
980
  * @param {object} params Event parameters
999
- * @param {string} params.e Event name
1000
- * @param {object} params.params Event parameters
1001
- * @param {object} params.params.event Event object
1002
- * @param {Core.widget.Container} params.params.event.source The container.
1003
- * @param {boolean} params.params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
981
+ * @param {object} params.event Event object
982
+ * @param {Core.widget.Container} params.event.source The container.
983
+ * @param {boolean} params.event.dirty The dirty state of the Container - `true` if there are any fields which have been changed since initial load.
1004
984
  */
1005
985
  (e: 'dirtyStateChange', params: ((event: { source: Container, dirty: boolean }) => void)|string): void
1006
986
  /**
1007
987
  * Triggered when a widget's [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element) is available.
1008
988
  * @param {string} e Event name
1009
989
  * @param {object} params Event parameters
1010
- * @param {string} params.e Event name
1011
- * @param {object} params.params Event parameters
1012
- * @param {object} params.params.event Event object
1013
- * @param {HTMLElement} params.params.event.element The Widget's element.
990
+ * @param {object} params.event Event object
991
+ * @param {HTMLElement} params.event.element The Widget's element.
1014
992
  */
1015
993
  (e: 'elementCreated', params: ((event: { element: HTMLElement }) => void)|string): void
1016
994
  /**
1017
995
  * Fires when a Panel is expanded using the [collapsible](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-collapsible) setting.
1018
996
  * @param {string} e Event name
1019
997
  * @param {object} params Event parameters
1020
- * @param {string} params.e Event name
1021
- * @param {object} params.params Event parameters
1022
- * @param {object} params.params.event Event object
1023
- * @param {Core.widget.Panel} params.params.event.source This Panel.
998
+ * @param {object} params.event Event object
999
+ * @param {Core.widget.Panel} params.event.source This Panel.
1024
1000
  */
1025
1001
  (e: 'expand', params: ((event: { source: Panel }) => void)|string): void
1026
1002
  /**
1027
1003
  * Fired when focus enters this Widget.
1028
1004
  * @param {string} e Event name
1029
1005
  * @param {object} params Event parameters
1030
- * @param {string} params.e Event name
1031
- * @param {object} params.params Event parameters
1032
- * @param {object} params.params.event Event object
1033
- * @param {Core.widget.Widget} params.params.event.source This Widget
1034
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1035
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1036
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1037
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1038
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1006
+ * @param {object} params.event Event object
1007
+ * @param {Core.widget.Widget} params.event.source This Widget
1008
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1009
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1010
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1011
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1012
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1039
1013
  */
1040
1014
  (e: 'focusIn', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1041
1015
  /**
@@ -1044,25 +1018,21 @@ const emit = defineEmits<{
1044
1018
  * will not trigger this event. This is when focus exits this widget completely.
1045
1019
  * @param {string} e Event name
1046
1020
  * @param {object} params Event parameters
1047
- * @param {string} params.e Event name
1048
- * @param {object} params.params Event parameters
1049
- * @param {object} params.params.event Event object
1050
- * @param {Core.widget.Widget} params.params.event.source This Widget
1051
- * @param {HTMLElement} params.params.event.fromElement The element which lost focus.
1052
- * @param {HTMLElement} params.params.event.toElement The element which gained focus.
1053
- * @param {Core.widget.Widget} params.params.event.fromWidget The widget which lost focus.
1054
- * @param {Core.widget.Widget} params.params.event.toWidget The widget which gained focus.
1055
- * @param {boolean} params.params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1021
+ * @param {object} params.event Event object
1022
+ * @param {Core.widget.Widget} params.event.source This Widget
1023
+ * @param {HTMLElement} params.event.fromElement The element which lost focus.
1024
+ * @param {HTMLElement} params.event.toElement The element which gained focus.
1025
+ * @param {Core.widget.Widget} params.event.fromWidget The widget which lost focus.
1026
+ * @param {Core.widget.Widget} params.event.toWidget The widget which gained focus.
1027
+ * @param {boolean} params.event.backwards `true` if the `toElement` is before the `fromElement` in document order.
1056
1028
  */
1057
1029
  (e: 'focusOut', params: ((event: { source: Widget, fromElement: HTMLElement, toElement: HTMLElement, fromWidget: Widget, toWidget: Widget, backwards: boolean }) => void)|string): void
1058
1030
  /**
1059
1031
  * Triggered after a widget was hidden
1060
1032
  * @param {string} e Event name
1061
1033
  * @param {object} params Event parameters
1062
- * @param {string} params.e Event name
1063
- * @param {object} params.params Event parameters
1064
- * @param {object} params.params.event Event object
1065
- * @param {Core.widget.Widget} params.params.event.source The widget
1034
+ * @param {object} params.event Event object
1035
+ * @param {Core.widget.Widget} params.event.source The widget
1066
1036
  */
1067
1037
  (e: 'hide', params: ((event: { source: Widget }) => void)|string): void
1068
1038
  /**
@@ -1071,21 +1041,17 @@ const emit = defineEmits<{
1071
1041
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#event-paint)
1072
1042
  * @param {string} e Event name
1073
1043
  * @param {object} params Event parameters
1074
- * @param {string} params.e Event name
1075
- * @param {object} params.params Event parameters
1076
- * @param {object} params.params.event Event object
1077
- * @param {Core.widget.Widget} params.params.event.source The widget being painted.
1078
- * @param {boolean} params.params.event.firstPaint `true` if this is the first paint.
1044
+ * @param {object} params.event Event object
1045
+ * @param {Core.widget.Widget} params.event.source The widget being painted.
1046
+ * @param {boolean} params.event.firstPaint `true` if this is the first paint.
1079
1047
  */
1080
1048
  (e: 'paint', params: ((event: { source: Widget, firstPaint: boolean }) => void)|string): void
1081
1049
  /**
1082
1050
  * Fired when a Widget's read only state is toggled
1083
1051
  * @param {string} e Event name
1084
1052
  * @param {object} params Event parameters
1085
- * @param {string} params.e Event name
1086
- * @param {object} params.params Event parameters
1087
- * @param {object} params.params.event Event object
1088
- * @param {boolean} params.params.event.readOnly Read only or not
1053
+ * @param {object} params.event Event object
1054
+ * @param {boolean} params.event.readOnly Read only or not
1089
1055
  */
1090
1056
  (e: 'readOnly', params: ((event: { readOnly: boolean }) => void)|string): void
1091
1057
  /**
@@ -1101,14 +1067,12 @@ const emit = defineEmits<{
1101
1067
  * Fired when the encapsulating element of a Widget resizes *only when [monitorResize](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#config-monitorResize) is `true`*.
1102
1068
  * @param {string} e Event name
1103
1069
  * @param {object} params Event parameters
1104
- * @param {string} params.e Event name
1105
- * @param {object} params.params Event parameters
1106
- * @param {object} params.params.event Event object
1107
- * @param {Core.widget.Widget} params.params.event.source This Widget
1108
- * @param {number} params.params.event.width The new width
1109
- * @param {number} params.params.event.height The new height
1110
- * @param {number} params.params.event.oldWidth The old width
1111
- * @param {number} params.params.event.oldHeight The old height
1070
+ * @param {object} params.event Event object
1071
+ * @param {Core.widget.Widget} params.event.source This Widget
1072
+ * @param {number} params.event.width The new width
1073
+ * @param {number} params.event.height The new height
1074
+ * @param {number} params.event.oldWidth The old width
1075
+ * @param {number} params.event.oldHeight The old height
1112
1076
  */
1113
1077
  (e: 'resize', params: ((event: { source: Widget, width: number, height: number, oldWidth: number, oldHeight: number }) => void)|string): void
1114
1078
  /**
@@ -1116,45 +1080,37 @@ const emit = defineEmits<{
1116
1080
  * this will fire upon deselection and selection of dates.
1117
1081
  * @param {string} e Event name
1118
1082
  * @param {object} params Event parameters
1119
- * @param {string} params.e Event name
1120
- * @param {object} params.params Event parameters
1121
- * @param {object} params.params.event Event object
1122
- * @param {Date[]} params.params.event.selection The selected dates. If [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/DatePicker#config-multiSelect) is specified this may be a two element array specifying start and end dates.
1123
- * @param {Date[]} params.params.event.oldSelection The previously selected dates. If [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/DatePicker#config-multiSelect) is specified this may be a two element array specifying start and end dates.
1124
- * @param {boolean} params.params.event.userAction This will be `true` if the change was caused by user interaction as opposed to programmatic setting.
1083
+ * @param {object} params.event Event object
1084
+ * @param {Date[]} params.event.selection The selected dates. If [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/DatePicker#config-multiSelect) is specified this may be a two element array specifying start and end dates.
1085
+ * @param {Date[]} params.event.oldSelection The previously selected dates. If [multiSelect](https://bryntum.com/products/scheduler/docs/api/Core/widget/DatePicker#config-multiSelect) is specified this may be a two element array specifying start and end dates.
1086
+ * @param {boolean} params.event.userAction This will be `true` if the change was caused by user interaction as opposed to programmatic setting.
1125
1087
  */
1126
1088
  (e: 'selectionChange', params: ((event: { selection: Date[], oldSelection: Date[], userAction: boolean }) => void)|string): void
1127
1089
  /**
1128
1090
  * Triggered after a widget is shown.
1129
1091
  * @param {string} e Event name
1130
1092
  * @param {object} params Event parameters
1131
- * @param {string} params.e Event name
1132
- * @param {object} params.params Event parameters
1133
- * @param {object} params.params.event Event object
1134
- * @param {Core.widget.Widget} params.params.event.source The widget
1093
+ * @param {object} params.event Event object
1094
+ * @param {Core.widget.Widget} params.event.source The widget
1135
1095
  */
1136
1096
  (e: 'show', params: ((event: { source: Widget }) => void)|string): void
1137
1097
  /**
1138
1098
  * A header [tool](https://bryntum.com/products/scheduler/docs/api/Core/widget/Panel#config-tools) has been clicked.
1139
1099
  * @param {string} e Event name
1140
1100
  * @param {object} params Event parameters
1141
- * @param {string} params.e Event name
1142
- * @param {object} params.params Event parameters
1143
- * @param {object} params.params.event Event object
1144
- * @param {Core.widget.Tool} params.params.event.source This Panel.
1145
- * @param {Core.widget.Tool} params.params.event.tool The tool which is being clicked.
1101
+ * @param {object} params.event Event object
1102
+ * @param {Core.widget.Tool} params.event.source This Panel.
1103
+ * @param {Core.widget.Tool} params.event.tool The tool which is being clicked.
1146
1104
  */
1147
1105
  (e: 'toolClick', params: ((event: { source: Tool, tool: Tool }) => void)|string): void
1148
1106
  /**
1149
1107
  * Fired when a week number cell is clicked.
1150
1108
  * @param {string} e Event name
1151
1109
  * @param {object} params Event parameters
1152
- * @param {string} params.e Event name
1153
- * @param {object} params.params Event parameters
1154
- * @param {object} params.params.event Event object
1155
- * @param {Date} params.params.event.date The start date of the week.
1156
- * @param {number[]} params.params.event.week The week array `[year, weekNumber]`.
1157
- * @param {Event} params.params.event.domEvent The original DOM event.
1110
+ * @param {object} params.event Event object
1111
+ * @param {Date} params.event.date The start date of the week.
1112
+ * @param {number[]} params.event.week The week array `[year, weekNumber]`.
1113
+ * @param {Event} params.event.domEvent The original DOM event.
1158
1114
  */
1159
1115
  (e: 'weekCellClick', params: ((event: { date: Date, week: number[], domEvent: Event }) => void)|string): void
1160
1116
  }>();
@@ -41,6 +41,8 @@ export declare type BryntumSchedulerDatePickerProps = {
41
41
  /**
42
42
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
43
43
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
44
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
45
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-appendTo)
44
46
  */
45
47
  appendTo ? : HTMLElement|string
46
48
  /**
@@ -401,10 +403,14 @@ export declare type BryntumSchedulerDatePickerProps = {
401
403
  inputFieldAlign ? : 'start'|'end'
402
404
  /**
403
405
  * 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.
406
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
407
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertBefore)
404
408
  */
405
409
  insertBefore ? : HTMLElement|string
406
410
  /**
407
411
  * 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.
412
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
413
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/widget/SchedulerDatePicker#config-insertFirst)
408
414
  */
409
415
  insertFirst ? : HTMLElement|string
410
416
  /**
@@ -284,15 +284,13 @@ const emit = defineEmits<{
284
284
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#event-change)
285
285
  * @param {string} e Event name
286
286
  * @param {object} params Event parameters
287
- * @param {string} params.e Event name
288
- * @param {object} params.params Event parameters
289
- * @param {object} params.params.event Event object
290
- * @param {Scheduler.model.ProjectModel,any} params.params.event.source This project
291
- * @param {Core.data.Store} params.params.event.store Affected store
292
- * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.params.event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
293
- * @param {Core.data.Model} params.params.event.record Changed record, for actions that affects exactly one record (`'update'`)
294
- * @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
295
- * @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
287
+ * @param {object} params.event Event object
288
+ * @param {Scheduler.model.ProjectModel,any} params.event.source This project
289
+ * @param {Core.data.Store} params.event.store Affected store
290
+ * @param {'remove','removeAll','add','clearchanges','filter','update','dataset','replace'} params.event.action Name of action which triggered the change. May be one of: * `'remove'` * `'removeAll'` * `'add'` * `'clearchanges'` * `'filter'` * `'update'` * `'dataset'` * `'replace'`
291
+ * @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
292
+ * @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
293
+ * @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
296
294
  */
297
295
  (e: 'change', params: ((event: { source: ProjectModel|any, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
298
296
  /**
@@ -300,12 +298,10 @@ const emit = defineEmits<{
300
298
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/model/ProjectModel#event-dataReady)
301
299
  * @param {string} e Event name
302
300
  * @param {object} params Event parameters
303
- * @param {string} params.e Event name
304
- * @param {object} params.params Event parameters
305
- * @param {object} params.params.event Event object
306
- * @param {Scheduler.model.ProjectModel,any} params.params.event.source The project
307
- * @param {boolean} params.params.event.isInitialCommit Flag that shows if this commit is initial
308
- * @param {Set<any>} params.params.event.records Set of all [Model](https://bryntum.com/products/scheduler/docs/api/Core/data/Model)s that were modified in the completed transaction. Use the [modifications](https://bryntum.com/products/scheduler/docs/api/Core/data/Model#property-modifications) property of each Model to identify modified fields.
301
+ * @param {object} params.event Event object
302
+ * @param {Scheduler.model.ProjectModel,any} params.event.source The project
303
+ * @param {boolean} params.event.isInitialCommit Flag that shows if this commit is initial
304
+ * @param {Set<any>} params.event.records Set of all [Model](https://bryntum.com/products/scheduler/docs/api/Core/data/Model)s that were modified in the completed transaction. Use the [modifications](https://bryntum.com/products/scheduler/docs/api/Core/data/Model#property-modifications) property of each Model to identify modified fields.
309
305
  */
310
306
  (e: 'dataReady', params: ((event: { source: ProjectModel|any, isInitialCommit: boolean, records: Set<any> }) => void)|string): void
311
307
  }>();
@@ -58,6 +58,8 @@ export declare type BryntumSchedulerProps = {
58
58
  /**
59
59
  * Element (or the id of an element) to append this widget's element to. Can be configured, or set once at
60
60
  * runtime. To access the element of a rendered widget, see [element](https://bryntum.com/products/scheduler/docs/api/Core/widget/Widget#property-element).
61
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
62
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-appendTo)
61
63
  */
62
64
  appendTo ? : HTMLElement|string
63
65
  /**
@@ -665,10 +667,14 @@ export declare type BryntumSchedulerProps = {
665
667
  inputFieldAlign ? : 'start'|'end'
666
668
  /**
667
669
  * 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.
670
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
671
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-insertBefore)
668
672
  */
669
673
  insertBefore ? : HTMLElement|string
670
674
  /**
671
675
  * 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.
676
+ * <div class="note">When creating nested trees of widgets, this should only be used on the outermost widget.
677
+ * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-insertFirst)
672
678
  */
673
679
  insertFirst ? : HTMLElement|string
674
680
  /**
@@ -921,7 +927,12 @@ export declare type BryntumSchedulerProps = {
921
927
  * Can be omitted in favor of individual store configs or [crudManager](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/mixin/SchedulerStores#config-crudManager) config.
922
928
  * [More...](https://bryntum.com/products/scheduler/docs/api/Scheduler/view/Scheduler#config-project)
923
929
  */
924
- project ? : ProjectModel|ProjectModelConfig|object
930
+ project ? : ProjectModel|ProjectModelConfig|object|null
931
+ /**
932
+ * The project model class to use when creating the project instance. Override this to use a custom project
933
+ * model class. In SchedulerPro and Gantt, this is overridden to use their respective project model classes.
934
+ */
935
+ projectModelClass ? : typeof ProjectModel
925
936
  /**
926
937
  * Range used to set the length of the time axis when used as a component of a Calendar. Suitable units are
927
938
  * `'month'`, `'week'` and `'day'`.