@bryntum/schedulerpro-vue-3-thin 7.2.4 → 7.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/lib/chunks/{BhUeT19h.js → 7vz3cAx6.js} +9 -7
- package/lib/chunks/7vz3cAx6.js.map +1 -0
- package/lib/chunks/{9jfNe_y3.js → B1SaPsRu.js} +16 -8
- package/lib/chunks/B1SaPsRu.js.map +1 -0
- package/lib/chunks/{D4JDuI0s.js → B4dVznPx.js} +1 -8
- package/lib/chunks/B4dVznPx.js.map +1 -0
- package/lib/chunks/{DwzPrR90.js → B8GKehTJ.js} +10 -8
- package/lib/chunks/B8GKehTJ.js.map +1 -0
- package/lib/chunks/{C41opZKx.js → BhXv58eE.js} +23 -14
- package/lib/chunks/BhXv58eE.js.map +1 -0
- package/lib/chunks/{Dz-up1_i.js → BhfdqXGU.js} +10 -8
- package/lib/chunks/BhfdqXGU.js.map +1 -0
- package/lib/chunks/{CJFZbm_i.js → Bk2bIVfG.js} +25 -13
- package/lib/chunks/Bk2bIVfG.js.map +1 -0
- package/lib/chunks/{DlNFp5e-.js → C1vi1h_N.js} +13 -11
- package/lib/chunks/C1vi1h_N.js.map +1 -0
- package/lib/chunks/{DYBe70El.js → CEQZr1q6.js} +20 -11
- package/lib/chunks/CEQZr1q6.js.map +1 -0
- package/lib/chunks/{BTT_cGQU.js → CPjow0gO.js} +8 -9
- package/lib/chunks/CPjow0gO.js.map +1 -0
- package/lib/chunks/{BRGc8bUJ.js → Cb_akueu.js} +16 -13
- package/lib/chunks/Cb_akueu.js.map +1 -0
- package/lib/chunks/{BJPdcix1.js → Cc_DPp3S.js} +8 -6
- package/lib/chunks/Cc_DPp3S.js.map +1 -0
- package/lib/chunks/{BjTPjWi9.js → Cr5VTUbs.js} +10 -8
- package/lib/chunks/Cr5VTUbs.js.map +1 -0
- package/lib/chunks/{j8JzZ-07.js → D-hmgVVF.js} +13 -11
- package/lib/chunks/D-hmgVVF.js.map +1 -0
- package/lib/chunks/{BpAvqwr_.js → D-v-Wqj4.js} +25 -13
- package/lib/chunks/D-v-Wqj4.js.map +1 -0
- package/lib/chunks/{BbI7XKMd.js → D0hJ3P6L.js} +5 -3
- package/lib/chunks/D0hJ3P6L.js.map +1 -0
- package/lib/chunks/{CGbW6pgm.js → DPA-xEW5.js} +8 -9
- package/lib/chunks/DPA-xEW5.js.map +1 -0
- package/lib/chunks/{CuODT2-U.js → XQWZfDOm.js} +7 -5
- package/lib/chunks/XQWZfDOm.js.map +1 -0
- package/lib/chunks/{MOjUZ-Rj.js → eKXSEOkn.js} +7 -5
- package/lib/chunks/eKXSEOkn.js.map +1 -0
- package/lib/chunks/{DGV7a5Xo.js → edcDjaO2.js} +7 -5
- package/lib/chunks/edcDjaO2.js.map +1 -0
- package/lib/chunks/{BO8FwQoh.js → n2IZFQjR.js} +10 -8
- package/lib/chunks/n2IZFQjR.js.map +1 -0
- package/lib/chunks/{M0cBUV91.js → zY4Qxi9x.js} +8 -6
- package/lib/chunks/zY4Qxi9x.js.map +1 -0
- package/lib/components/BryntumCalendarEditor.js +1 -1
- package/lib/components/BryntumCalendarField.js +1 -1
- package/lib/components/BryntumConstraintTypePicker.js +1 -1
- package/lib/components/BryntumCostAccrualField.js +1 -1
- package/lib/components/BryntumDependencyTypePicker.js +1 -1
- package/lib/components/BryntumEffortField.js +1 -1
- package/lib/components/BryntumEndDateField.js +1 -1
- package/lib/components/BryntumModelCombo.js +1 -1
- package/lib/components/BryntumRateTableField.js +1 -1
- package/lib/components/BryntumResourceEditor.js +1 -1
- package/lib/components/BryntumResourceGrid.js +1 -1
- package/lib/components/BryntumResourceHistogram.js +1 -1
- package/lib/components/BryntumResourceTypeField.js +1 -1
- package/lib/components/BryntumResourceUtilization.js +1 -1
- package/lib/components/BryntumSchedulerPro.js +1 -1
- package/lib/components/BryntumSchedulerProBase.js +1 -1
- package/lib/components/BryntumSchedulerProProjectModel.js +1 -1
- package/lib/components/BryntumSchedulingDirectionPicker.js +1 -1
- package/lib/components/BryntumSchedulingModePicker.js +1 -1
- package/lib/components/BryntumStartDateField.js +1 -1
- package/lib/components/BryntumThemeCombo.js +57 -0
- package/lib/components/BryntumThemeCombo.js.map +1 -0
- package/lib/components/BryntumTimeline.js +1 -1
- package/lib/components/BryntumVersionGrid.js +1 -1
- package/lib/index.js +22 -22
- package/package.json +1 -1
- package/src/components/BryntumCalendarEditor.vue +191 -292
- package/src/components/BryntumCalendarEditorProps.ts +123 -177
- package/src/components/BryntumCalendarField.vue +172 -260
- package/src/components/BryntumCalendarFieldProps.ts +96 -143
- package/src/components/BryntumConstraintTypePicker.vue +172 -260
- package/src/components/BryntumConstraintTypePickerProps.ts +96 -143
- package/src/components/BryntumCostAccrualField.vue +172 -260
- package/src/components/BryntumCostAccrualFieldProps.ts +96 -143
- package/src/components/BryntumDependencyTypePicker.vue +172 -260
- package/src/components/BryntumDependencyTypePickerProps.ts +96 -143
- package/src/components/BryntumEffortField.vue +153 -224
- package/src/components/BryntumEffortFieldProps.ts +82 -114
- package/src/components/BryntumEndDateField.vue +159 -228
- package/src/components/BryntumEndDateFieldProps.ts +84 -114
- package/src/components/BryntumModelCombo.vue +172 -260
- package/src/components/BryntumModelComboProps.ts +96 -143
- package/src/components/BryntumRateTableField.vue +172 -260
- package/src/components/BryntumRateTableFieldProps.ts +96 -143
- package/src/components/BryntumResourceEditor.vue +190 -290
- package/src/components/BryntumResourceEditorProps.ts +122 -175
- package/src/components/BryntumResourceGrid.vue +730 -1045
- package/src/components/BryntumResourceGridProps.ts +192 -263
- package/src/components/BryntumResourceHistogram.vue +1098 -1539
- package/src/components/BryntumResourceHistogramProps.ts +292 -402
- package/src/components/BryntumResourceTypeField.vue +172 -260
- package/src/components/BryntumResourceTypeFieldProps.ts +96 -143
- package/src/components/BryntumResourceUtilization.vue +1114 -1561
- package/src/components/BryntumResourceUtilizationProps.ts +293 -404
- package/src/components/BryntumSchedulerPro.vue +2099 -2820
- package/src/components/BryntumSchedulerProBase.vue +2099 -2820
- package/src/components/BryntumSchedulerProBaseProps.ts +413 -556
- package/src/components/BryntumSchedulerProProjectModel.vue +192 -289
- package/src/components/BryntumSchedulerProProjectModelProps.ts +59 -88
- package/src/components/BryntumSchedulerProProps.ts +413 -556
- package/src/components/BryntumSchedulingDirectionPicker.vue +172 -260
- package/src/components/BryntumSchedulingDirectionPickerProps.ts +96 -143
- package/src/components/BryntumSchedulingModePicker.vue +173 -262
- package/src/components/BryntumSchedulingModePickerProps.ts +97 -145
- package/src/components/BryntumStartDateField.vue +161 -232
- package/src/components/BryntumStartDateFieldProps.ts +86 -118
- package/src/components/BryntumThemeCombo.vue +60 -0
- package/src/components/BryntumTimeline.vue +1846 -2517
- package/src/components/BryntumTimelineProps.ts +371 -519
- package/src/components/BryntumVersionGrid.vue +727 -1050
- package/src/components/BryntumVersionGridProps.ts +186 -261
- package/lib/chunks/9jfNe_y3.js.map +0 -1
- package/lib/chunks/BJPdcix1.js.map +0 -1
- package/lib/chunks/BO8FwQoh.js.map +0 -1
- package/lib/chunks/BRGc8bUJ.js.map +0 -1
- package/lib/chunks/BTT_cGQU.js.map +0 -1
- package/lib/chunks/BbI7XKMd.js.map +0 -1
- package/lib/chunks/BhUeT19h.js.map +0 -1
- package/lib/chunks/BjTPjWi9.js.map +0 -1
- package/lib/chunks/BpAvqwr_.js.map +0 -1
- package/lib/chunks/C41opZKx.js.map +0 -1
- package/lib/chunks/CGbW6pgm.js.map +0 -1
- package/lib/chunks/CJFZbm_i.js.map +0 -1
- package/lib/chunks/CuODT2-U.js.map +0 -1
- package/lib/chunks/D4JDuI0s.js.map +0 -1
- package/lib/chunks/DGV7a5Xo.js.map +0 -1
- package/lib/chunks/DYBe70El.js.map +0 -1
- package/lib/chunks/DlNFp5e-.js.map +0 -1
- package/lib/chunks/DwzPrR90.js.map +0 -1
- package/lib/chunks/Dz-up1_i.js.map +0 -1
- package/lib/chunks/M0cBUV91.js.map +0 -1
- package/lib/chunks/MOjUZ-Rj.js.map +0 -1
- package/lib/chunks/j8JzZ-07.js.map +0 -1
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
|
|
11
11
|
import { getCurrentInstance, onBeforeUnmount, onMounted, provide, ref, watch, toRaw } from 'vue';
|
|
12
12
|
|
|
13
|
-
import type { Base, DurationUnit, Model, ModelConfig, StateTrackingManager as CoreStateTrackingManager, Store, StoreConfig } from '@bryntum/core-thin';
|
|
13
|
+
import type { Base, DurationUnit, FetchCredentials, HttpMethod, Model, ModelConfig, StateTrackingManager as CoreStateTrackingManager, Store, StoreConfig } from '@bryntum/core-thin';
|
|
14
14
|
import type { AbstractCrudManager, CrudManagerRequestResponse, CrudManagerStoreDescriptor, LazyLoadCrudManagerRequestParams, ProjectModel as SchedulerProjectModel, ResourceTimeRangeModel, ResourceTimeRangeModelConfig, ResourceTimeRangeStore, ResourceTimeRangeStoreConfig, TimeRangeStore, TimeSpan, TimeSpanConfig } from '@bryntum/scheduler-thin';
|
|
15
15
|
import type { AssignmentModel, AssignmentModelConfig, AssignmentStore, AssignmentStoreConfig, CalendarManagerStore, CalendarManagerStoreConfig, CalendarModel, CalendarModelConfig, DependencyModel, DependencyModelConfig, DependencyStore, DependencyStoreConfig, EventModel, EventModelConfig, EventStore, EventStoreConfig, ProjectModelListeners, ResourceAllocationInfo, ResourceModel, ResourceModelConfig, ResourceStore, ResourceStoreConfig, StateTrackingManagerConfig } from '@bryntum/schedulerpro-thin';
|
|
16
16
|
import { ProjectModel } from '@bryntum/schedulerpro-thin';
|
|
@@ -23,16 +23,14 @@ defineProps<{
|
|
|
23
23
|
* If this flag is set to `true` (default) when a start/end date is set on the event, a corresponding
|
|
24
24
|
* `start-no-earlier/later-than` constraint is added, automatically. This is done in order to
|
|
25
25
|
* keep the event "attached" to this date, according to the user intention.
|
|
26
|
-
* ...
|
|
27
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-addConstraintOnDateSet)
|
|
26
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-addConstraintOnDateSet)
|
|
28
27
|
*/
|
|
29
28
|
addConstraintOnDateSet ? : Boolean
|
|
30
29
|
/**
|
|
31
30
|
* This config manages DST correction in the scheduling engine. It only has effect when DST transition hour is
|
|
32
31
|
* working time. Usually a DST transition occurs on a Sunday, so with non-working weekends the DST correction logic
|
|
33
32
|
* is not involved.
|
|
34
|
-
* ...
|
|
35
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-adjustDurationToDST)
|
|
33
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-adjustDurationToDST)
|
|
36
34
|
*/
|
|
37
35
|
adjustDurationToDST ? : Boolean
|
|
38
36
|
/**
|
|
@@ -68,8 +66,7 @@ defineProps<{
|
|
|
68
66
|
autoCalculatePercentDoneForParentTasks ? : Boolean
|
|
69
67
|
/**
|
|
70
68
|
* Specify `true` to automatically call [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method on the next frame after creation.
|
|
71
|
-
* ...
|
|
72
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-autoLoad)
|
|
69
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-autoLoad)
|
|
73
70
|
*/
|
|
74
71
|
autoLoad ? : Boolean
|
|
75
72
|
/**
|
|
@@ -90,8 +87,7 @@ defineProps<{
|
|
|
90
87
|
/**
|
|
91
88
|
* An object where property names with a truthy value indicate which events should bubble up the ownership
|
|
92
89
|
* hierarchy when triggered.
|
|
93
|
-
* ...
|
|
94
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-bubbleEvents)
|
|
90
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-bubbleEvents)
|
|
95
91
|
*/
|
|
96
92
|
bubbleEvents ? : object
|
|
97
93
|
/**
|
|
@@ -125,46 +121,39 @@ defineProps<{
|
|
|
125
121
|
calendarsData ? : CalendarModel[]
|
|
126
122
|
/**
|
|
127
123
|
* Set to `true` to call onXXX method names (e.g. `onShow`, `onClick`), as an easy way to listen for events.
|
|
128
|
-
* ...
|
|
129
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-callOnFunctions)
|
|
124
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-callOnFunctions)
|
|
130
125
|
*/
|
|
131
126
|
callOnFunctions ? : Boolean
|
|
132
127
|
/**
|
|
133
128
|
* By default, if an event handler throws an exception, the error propagates up the stack and the
|
|
134
129
|
* application state is undefined. Code which follows the event handler will *not* be executed.
|
|
135
|
-
* ...
|
|
136
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-catchEventHandlerExceptions)
|
|
130
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-catchEventHandlerExceptions)
|
|
137
131
|
*/
|
|
138
132
|
catchEventHandlerExceptions ? : Boolean
|
|
139
133
|
/**
|
|
140
134
|
* Child nodes. To allow loading children on demand, specify `children : true` in your data. Omit the field for leaf
|
|
141
135
|
* tasks.
|
|
142
|
-
* ...
|
|
143
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-children)
|
|
136
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-children)
|
|
144
137
|
*/
|
|
145
138
|
children ? : Boolean|object[]|Model[]|ModelConfig[]
|
|
146
139
|
/**
|
|
147
140
|
* Sets the list of stores controlled by the CRUD manager.
|
|
148
|
-
* ...
|
|
149
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-crudStores)
|
|
141
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-crudStores)
|
|
150
142
|
*/
|
|
151
143
|
crudStores ? : Store[]|string[]|CrudManagerStoreDescriptor[]|StoreConfig[]
|
|
152
144
|
/**
|
|
153
145
|
* The number of days per month.
|
|
154
|
-
* ...
|
|
155
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-daysPerMonth)
|
|
146
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-daysPerMonth)
|
|
156
147
|
*/
|
|
157
148
|
daysPerMonth ? : number
|
|
158
149
|
/**
|
|
159
150
|
* The number of days per week.
|
|
160
|
-
* ...
|
|
161
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-daysPerWeek)
|
|
151
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-daysPerWeek)
|
|
162
152
|
*/
|
|
163
153
|
daysPerWeek ? : number
|
|
164
154
|
/**
|
|
165
155
|
* Enables early rendering in SchedulerPro, by postponing calculations to after the first refresh.
|
|
166
|
-
* ...
|
|
167
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-delayCalculation)
|
|
156
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-delayCalculation)
|
|
168
157
|
*/
|
|
169
158
|
delayCalculation ? : Boolean
|
|
170
159
|
/**
|
|
@@ -175,8 +164,7 @@ defineProps<{
|
|
|
175
164
|
/**
|
|
176
165
|
* The source of the calendar for dependencies (the calendar used for taking dependencies lag into account).
|
|
177
166
|
* Possible values are:
|
|
178
|
-
* ...
|
|
179
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-dependenciesCalendar)
|
|
167
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-dependenciesCalendar)
|
|
180
168
|
*/
|
|
181
169
|
dependenciesCalendar ? : 'ToEvent'|'FromEvent'|'Project'
|
|
182
170
|
/**
|
|
@@ -203,16 +191,14 @@ defineProps<{
|
|
|
203
191
|
/**
|
|
204
192
|
* Set to `true` to enable calculation progress notifications.
|
|
205
193
|
* When enabled the project fires [progress](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-progress) event.
|
|
206
|
-
* ...
|
|
207
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-enableProgressNotifications)
|
|
194
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-enableProgressNotifications)
|
|
208
195
|
*/
|
|
209
196
|
enableProgressNotifications ? : Boolean
|
|
210
197
|
/**
|
|
211
198
|
* Configuration of the JSON encoder used by the *Crud Manager*.
|
|
199
|
+
* @property {object} encoder.requestData Static data to send with the data request. ```javascript new CrudManager({ // add static "foo" property to all requests data encoder : { requestData : { foo : 'Bar' } }, ... }); ``` The above snippet will result adding "foo" property to all requests data: ```json { "requestId" : 756, "type" : "load", "foo" : "Bar", "stores" : [ ... ```
|
|
212
200
|
*/
|
|
213
|
-
encoder ? : {
|
|
214
|
-
requestData?: object
|
|
215
|
-
}
|
|
201
|
+
encoder ? : { requestData: object }
|
|
216
202
|
/**
|
|
217
203
|
* The constructor of the event model class, to be used in the project. Will be set as the
|
|
218
204
|
* [modelClass](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Store#config-modelClass) property of the [eventStore](#SchedulerPro/model/ProjectModel#property-eventStore)
|
|
@@ -249,15 +235,13 @@ defineProps<{
|
|
|
249
235
|
forceSync ? : Boolean
|
|
250
236
|
/**
|
|
251
237
|
* The number of hours per day.
|
|
252
|
-
* ...
|
|
253
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-hoursPerDay)
|
|
238
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-hoursPerDay)
|
|
254
239
|
*/
|
|
255
240
|
hoursPerDay ? : number
|
|
256
241
|
/**
|
|
257
242
|
* Unique identifier for the record. Might be mapped to another dataSource using idField, but always exposed as
|
|
258
243
|
* record.id. Will get a generated value if none is specified in records data.
|
|
259
|
-
* ...
|
|
260
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-id)
|
|
244
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-id)
|
|
261
245
|
*/
|
|
262
246
|
id ? : string|number
|
|
263
247
|
/**
|
|
@@ -268,8 +252,7 @@ defineProps<{
|
|
|
268
252
|
/**
|
|
269
253
|
* Set to `false` to only include the id of a removed parent node in the request to the backend (also
|
|
270
254
|
* affects programmatic calls to get [changes](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#property-changes) etc.), and not the ids of its children.
|
|
271
|
-
* ...
|
|
272
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-includeChildrenInRemoveRequest)
|
|
255
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-includeChildrenInRemoveRequest)
|
|
273
256
|
*/
|
|
274
257
|
includeChildrenInRemoveRequest ? : Boolean
|
|
275
258
|
/**
|
|
@@ -284,44 +267,38 @@ defineProps<{
|
|
|
284
267
|
* [lazyLoad](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Store#config-lazyLoad). If set on a parent record at load time, that parent will not cause any
|
|
285
268
|
* more child load requests. If omitted, it will be automatically set to `true` when a load request receives fewer
|
|
286
269
|
* child records than requested.
|
|
287
|
-
* ...
|
|
288
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-isFullyLoaded)
|
|
270
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-isFullyLoaded)
|
|
289
271
|
*/
|
|
290
272
|
isFullyLoaded ? : Boolean
|
|
291
273
|
/**
|
|
292
274
|
* Project data as a JSON string, used to populate its stores.
|
|
293
|
-
* ...
|
|
294
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-json)
|
|
275
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-json)
|
|
295
276
|
*/
|
|
296
277
|
json ? : string
|
|
297
278
|
/**
|
|
298
279
|
* If set to `true`, or a config object, this makes the CrudManager load records only when needed. When a record
|
|
299
280
|
* or a date range that is not already loaded is requested, a load request will be made to the specified URL.
|
|
300
281
|
* More more details about lazy loading, see the [guide](https://bryntum.com/products/schedulerpro/docs/api/Grid/guides/data/lazyloading.md)
|
|
301
|
-
* @param {
|
|
302
|
-
* @param {number} lazyLoad.chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
|
|
282
|
+
* @param {number} chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
|
|
303
283
|
* @param {DurationUnit} bufferUnit Used together with bufferAmount to calculate the start and end dates of each load request. The value is added to the current visible start or end date. Defaults to the visible time span length (does not affect ResourceStore).
|
|
304
284
|
* @param {number} bufferAmount See `bufferUnit`
|
|
305
285
|
*/
|
|
306
|
-
lazyLoad ? : Boolean|{
|
|
286
|
+
lazyLoad ? : Boolean|{ chunkSize: number, bufferUnit: DurationUnit, bufferAmount: number }
|
|
307
287
|
/**
|
|
308
288
|
* The listener set for this object.
|
|
309
|
-
* ...
|
|
310
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-listeners)
|
|
289
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-listeners)
|
|
311
290
|
*/
|
|
312
291
|
listeners ? : ProjectModelListeners
|
|
313
292
|
/**
|
|
314
293
|
* Convenience shortcut to set only the url to load from, when you do not need to supply any other config
|
|
315
294
|
* options in the `load` section of the `transport` config.
|
|
316
|
-
* ...
|
|
317
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-loadUrl)
|
|
295
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-loadUrl)
|
|
318
296
|
*/
|
|
319
297
|
loadUrl ? : string
|
|
320
298
|
/**
|
|
321
299
|
* Maximum range the project calendars can iterate.
|
|
322
300
|
* The value is defined in milliseconds and by default equals `5 years` roughly.
|
|
323
|
-
* ...
|
|
324
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-maxCalendarRange)
|
|
301
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-maxCalendarRange)
|
|
325
302
|
*/
|
|
326
303
|
maxCalendarRange ? : number
|
|
327
304
|
/**
|
|
@@ -360,15 +337,13 @@ defineProps<{
|
|
|
360
337
|
* Setting this to `true` (default) vetoes [silenceInitialCommit](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-silenceInitialCommit) effect
|
|
361
338
|
* by preventing silent changes accepting
|
|
362
339
|
* on initial data loading if some scheduling issue gets resolved during it.
|
|
363
|
-
* ...
|
|
364
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-preventSilencingOnIssueResolve)
|
|
340
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-preventSilencingOnIssueResolve)
|
|
365
341
|
*/
|
|
366
342
|
preventSilencingOnIssueResolve ? : Boolean
|
|
367
343
|
/**
|
|
368
344
|
* Flag the record as read-only on the UI level, preventing the end user from manipulating it using editing
|
|
369
345
|
* features such as cell editing and event dragging.
|
|
370
|
-
* ...
|
|
371
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-readOnly)
|
|
346
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-readOnly)
|
|
372
347
|
*/
|
|
373
348
|
readOnly ? : Boolean
|
|
374
349
|
/**
|
|
@@ -382,16 +357,14 @@ defineProps<{
|
|
|
382
357
|
* If set to `true`, this makes the CrudManager load pages of data, instead of loading the complete dataset at
|
|
383
358
|
* once. The requests made to the [loadUrl](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#config-loadUrl) will contain
|
|
384
359
|
* params with info about the current dataset being requested:
|
|
385
|
-
* ...
|
|
386
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-remotePaging)
|
|
360
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-remotePaging)
|
|
387
361
|
*/
|
|
388
362
|
remotePaging ? : Boolean
|
|
389
363
|
/**
|
|
390
364
|
* When the CrudManager/Project is configured with [lazyLoad](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/mixin/LazyLoadCrudManager#config-lazyLoad) set to `true`, you can configure
|
|
391
365
|
* your own data fetching logic by implementing this function. Doing this will override the built-in fetching
|
|
392
366
|
* mechanism using the [loadUrl](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/data/CrudManager#config-loadUrl).
|
|
393
|
-
* ...
|
|
394
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-requestData)
|
|
367
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-requestData)
|
|
395
368
|
* @param {LazyLoadCrudManagerRequestParams} params Object containing info of what data is requested
|
|
396
369
|
* @returns {CrudManagerRequestResponse}
|
|
397
370
|
*/
|
|
@@ -463,8 +436,7 @@ defineProps<{
|
|
|
463
436
|
* Experimental hook that lets the app determine if a bound dataset needs syncing with the store or not, and
|
|
464
437
|
* if it does - which records that should be processed. Only called for stores that are configured with
|
|
465
438
|
* `syncDataOnLoad: true` (which is the default in the React, Angular and Vue wrappers).
|
|
466
|
-
* ...
|
|
467
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-shouldSyncDataOnLoad)
|
|
439
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-shouldSyncDataOnLoad)
|
|
468
440
|
* @param {object} options Options passed by the store to this hook
|
|
469
441
|
* @param {Core.data.Store} options.store Store about to be synced
|
|
470
442
|
* @param {Core.data.Model} options.records Records currently in the store
|
|
@@ -474,22 +446,19 @@ defineProps<{
|
|
|
474
446
|
shouldSyncDataOnLoad ? : (options: { store: Store, records: Model, data: object[] }) => Set<any>|Boolean
|
|
475
447
|
/**
|
|
476
448
|
* Silences propagations caused by the project loading.
|
|
477
|
-
* ...
|
|
478
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-silenceInitialCommit)
|
|
449
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-silenceInitialCommit)
|
|
479
450
|
*/
|
|
480
451
|
silenceInitialCommit ? : Boolean
|
|
481
452
|
/**
|
|
482
453
|
* When `true` the project's manually scheduled tasks duration will include only working periods of time.
|
|
483
454
|
* When `false` such tasks will ignore working time calendars and treat all intervals as working.
|
|
484
|
-
* ...
|
|
485
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-skipNonWorkingTimeInDurationWhenSchedulingManually)
|
|
455
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-skipNonWorkingTimeInDurationWhenSchedulingManually)
|
|
486
456
|
*/
|
|
487
457
|
skipNonWorkingTimeInDurationWhenSchedulingManually ? : Boolean
|
|
488
458
|
/**
|
|
489
459
|
* When `true` the project's manually scheduled tasks will adjust their proposed start/end dates to skip non-working
|
|
490
460
|
* time.
|
|
491
|
-
* ...
|
|
492
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-skipNonWorkingTimeWhenSchedulingManually)
|
|
461
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-skipNonWorkingTimeWhenSchedulingManually)
|
|
493
462
|
*/
|
|
494
463
|
skipNonWorkingTimeWhenSchedulingManually ? : Boolean
|
|
495
464
|
/**
|
|
@@ -506,30 +475,26 @@ defineProps<{
|
|
|
506
475
|
* store to use it by id. Store identifier is used as a container name holding corresponding store data
|
|
507
476
|
* while transferring them to/from the server. By default, `id` property is used. And in case a
|
|
508
477
|
* container identifier has to differ this config can be used:
|
|
509
|
-
* ...
|
|
510
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-storeIdProperty)
|
|
478
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-storeIdProperty)
|
|
511
479
|
*/
|
|
512
480
|
storeIdProperty ? : string
|
|
513
481
|
/**
|
|
514
482
|
* When `true` the Crud Manager does not require all updated and removed records to be mentioned in the
|
|
515
483
|
* *sync* response. In this case response should include only server side changes.
|
|
516
|
-
* ...
|
|
517
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-supportShortSyncResponse)
|
|
484
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-supportShortSyncResponse)
|
|
518
485
|
*/
|
|
519
486
|
supportShortSyncResponse ? : Boolean
|
|
520
487
|
/**
|
|
521
488
|
* An array of store identifiers sets an alternative sync responses apply order.
|
|
522
489
|
* By default, the order in which sync responses are applied to the stores is the same as they
|
|
523
490
|
* registered in. But in case of some tricky dependencies between stores this order can be changed:
|
|
524
|
-
* ...
|
|
525
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-syncApplySequence)
|
|
491
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-syncApplySequence)
|
|
526
492
|
*/
|
|
527
493
|
syncApplySequence ? : string[]|CrudManagerStoreDescriptor[]
|
|
528
494
|
/**
|
|
529
495
|
* Convenience shortcut to set only the url to sync to, when you do not need to supply any other config
|
|
530
496
|
* options in the `sync` section of the `transport` config.
|
|
531
|
-
* ...
|
|
532
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-syncUrl)
|
|
497
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-syncUrl)
|
|
533
498
|
*/
|
|
534
499
|
syncUrl ? : string
|
|
535
500
|
/**
|
|
@@ -560,14 +525,12 @@ defineProps<{
|
|
|
560
525
|
* Set to a IANA time zone (i.e. `Europe/Stockholm`) or a UTC offset in minutes (i.e. `-120`). This will
|
|
561
526
|
* convert all events, tasks and time ranges to the specified time zone or offset. It will also affect the
|
|
562
527
|
* displayed timeline's headers as well at the start and end date of it.
|
|
563
|
-
* ...
|
|
564
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-timeZone)
|
|
528
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-timeZone)
|
|
565
529
|
*/
|
|
566
530
|
timeZone ? : string|number
|
|
567
531
|
/**
|
|
568
532
|
* Specifies the output format of [toJSON](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/model/mixin/ProjectModelCommon#function-toJSON).
|
|
569
|
-
* ...
|
|
570
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-toJSONResultFormat)
|
|
533
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-toJSONResultFormat)
|
|
571
534
|
*/
|
|
572
535
|
toJSONResultFormat ? : 'inlineData'|'model'
|
|
573
536
|
/**
|
|
@@ -584,28 +547,36 @@ defineProps<{
|
|
|
584
547
|
trackResponseType ? : Boolean
|
|
585
548
|
/**
|
|
586
549
|
* Configuration of the AJAX requests used by *Crud Manager* to communicate with a server-side.
|
|
587
|
-
* ...
|
|
588
|
-
* [
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
}
|
|
550
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-transport)
|
|
551
|
+
* @property {object} [transport.load] Load requests configuration:
|
|
552
|
+
* @property {string} [transport.load.url] URL to request for data loading.
|
|
553
|
+
* @property {HttpMethod} [transport.load.method] HTTP method to be used for load requests.
|
|
554
|
+
* @property {FetchCredentials} [transport.load.credentials] The request credentials option to use for load requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
|
|
555
|
+
* @property {string} [transport.load.paramName] Name of the parameter that will contain a serialized `load` request. The value is mandatory for requests using `GET` method (default for `load`) so if the value is not provided `data` string is used as default. This value is optional for HTTP methods like `POST` and `PUT`, the request body will be used for data transferring in these cases.
|
|
556
|
+
* @property {object} [transport.load.params] An object containing extra HTTP parameters to pass to the server when sending a `load` request. ```javascript transport : { load : { url : 'http://mycool-server.com/load.php', // HTTP request parameter used to pass serialized "load"-requests paramName : 'data', // pass extra HTTP request parameter // so resulting URL will look like: http://mycool-server.com/load.php?userId=123456&data=... params : { userId : '123456' } }, ... } ```
|
|
557
|
+
* @property {Record<string, string>} [transport.load.headers] An object containing headers to pass to each server request. ```javascript transport : { load : { url : 'http://mycool-server.com/load.php', // HTTP request parameter used to pass serialized "load"-requests paramName : 'data', // specify Content-Type for "load" requests headers : { 'Content-Type' : 'application/json' } }, ... } ```
|
|
558
|
+
* @property {object} [transport.sync] Sync requests (`sync` in further text) configuration:
|
|
559
|
+
* @property {string} [transport.sync.url] URL to request for `sync`.
|
|
560
|
+
* @property {HttpMethod} [transport.sync.method] HTTP request method to be used for `sync`.
|
|
561
|
+
* @property {FetchCredentials} [transport.sync.credentials] The request credentials option to use for sync requests. Corresponds to the standard <a href="https://developer.mozilla.org/en-US/docs/Web/API/Request/credentials">Fetch API `credentials`</a> option.
|
|
562
|
+
* @property {string} [transport.sync.paramName] Name of the parameter in which `sync` data will be transferred. This value is optional for requests using methods like `POST` and `PUT`, the request body will be used for data transferring in this case (default for `sync`). And the value is mandatory for requests using `GET` method (if the value is not provided `data` string will be used as fallback).
|
|
563
|
+
* @property {object} [transport.sync.params] HTTP parameters to pass with an HTTP request handling `sync`. ```javascript transport : { sync : { url : 'http://mycool-server.com/sync.php', // extra HTTP request parameter params : { userId : '123456' } }, ... } ```
|
|
564
|
+
* @property {Record<string, string>} [transport.sync.headers] HTTP headers to pass with an HTTP request handling `sync`. ```javascript transport : { sync : { url : 'http://mycool-server.com/sync.php', // specify Content-Type for "sync" requests headers : { 'Content-Type' : 'application/json' } }, ... } ```
|
|
565
|
+
*/
|
|
566
|
+
transport ? : { load?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> }, sync?: { url?: string, method?: HttpMethod, credentials?: FetchCredentials, paramName?: string, params?: object, headers?: Record<string, string> } }
|
|
594
567
|
/**
|
|
595
568
|
* By default, the stores of a project use the raw data objects passed to them as the data source for their
|
|
596
569
|
* records if data is loaded remotely (using an `AjaxStore` or a `CrudManager`). For data supplied inline,
|
|
597
570
|
* the data objects are instead by default cloned to avoid the original data object being modified by the
|
|
598
571
|
* store.
|
|
599
|
-
* ...
|
|
600
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-useRawData)
|
|
572
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-useRawData)
|
|
601
573
|
*/
|
|
602
574
|
useRawData ? : Boolean
|
|
603
575
|
/**
|
|
604
576
|
* This config validates the response structure for requests made by the Crud Manager.
|
|
605
577
|
* When `true`, the Crud Manager checks every parsed response structure for errors
|
|
606
578
|
* and if the response format is invalid, a warning is logged to the browser console.
|
|
607
|
-
* ...
|
|
608
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-validateResponse)
|
|
579
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-validateResponse)
|
|
609
580
|
*/
|
|
610
581
|
validateResponse ? : Boolean
|
|
611
582
|
/**
|
|
@@ -624,75 +595,61 @@ const emit = defineEmits<{
|
|
|
624
595
|
* Fires before an object is destroyed.
|
|
625
596
|
* @param {string} e Event name
|
|
626
597
|
* @param {object} params Event parameters
|
|
627
|
-
* @param {
|
|
628
|
-
* @param {
|
|
629
|
-
* @param {object} params.params.event Event object
|
|
630
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
598
|
+
* @param {object} params.event Event object
|
|
599
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
631
600
|
*/
|
|
632
601
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
633
602
|
/**
|
|
634
603
|
* Fires before [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) is sent. Return `false` to cancel load request.
|
|
635
604
|
* @param {string} e Event name
|
|
636
605
|
* @param {object} params Event parameters
|
|
637
|
-
* @param {
|
|
638
|
-
* @param {
|
|
639
|
-
* @param {object} params.
|
|
640
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
641
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
606
|
+
* @param {object} params.event Event object
|
|
607
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
608
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
642
609
|
*/
|
|
643
|
-
(e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) =>
|
|
610
|
+
(e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) => boolean|void)|string): boolean|void
|
|
644
611
|
/**
|
|
645
612
|
* Fires before loaded data get applied to the stores. Return `false` to prevent data applying.
|
|
646
613
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
647
614
|
* @param {string} e Event name
|
|
648
615
|
* @param {object} params Event parameters
|
|
649
|
-
* @param {
|
|
650
|
-
* @param {
|
|
651
|
-
* @param {object} params.
|
|
652
|
-
* @param {
|
|
653
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
654
|
-
* @param {object} params.params.event.options Options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
616
|
+
* @param {object} params.event Event object
|
|
617
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
618
|
+
* @param {object} params.event.response The decoded server response object.
|
|
619
|
+
* @param {object} params.event.options Options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
655
620
|
*/
|
|
656
|
-
(e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) =>
|
|
621
|
+
(e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) => boolean|void)|string): boolean|void
|
|
657
622
|
/**
|
|
658
623
|
* Fires before server response gets applied to the stores. Return `false` to prevent data applying.
|
|
659
624
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
660
625
|
* @param {string} e Event name
|
|
661
626
|
* @param {object} params Event parameters
|
|
662
|
-
* @param {
|
|
663
|
-
* @param {
|
|
664
|
-
* @param {
|
|
665
|
-
* @param {
|
|
666
|
-
* @param {'sync','load'} params.params.event.requestType The request type (`sync` or `load`).
|
|
667
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
627
|
+
* @param {object} params.event Event object
|
|
628
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
629
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
630
|
+
* @param {object} params.event.response The decoded server response object.
|
|
668
631
|
*/
|
|
669
|
-
(e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) =>
|
|
632
|
+
(e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) => boolean|void)|string): boolean|void
|
|
670
633
|
/**
|
|
671
634
|
* Fires before a request is sent to the server.
|
|
672
|
-
* ...
|
|
673
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSend)
|
|
635
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSend)
|
|
674
636
|
* @param {string} e Event name
|
|
675
637
|
* @param {object} params Event parameters
|
|
676
|
-
* @param {
|
|
677
|
-
* @param {
|
|
678
|
-
* @param {object} params.params
|
|
679
|
-
* @param {
|
|
680
|
-
* @param {object} params.
|
|
681
|
-
* @param {'sync','load'} params.params.event.requestType CrudManager request type (`load`/`sync`)
|
|
682
|
-
* @param {object} params.params.event.requestConfig Configuration object for Ajax request call
|
|
638
|
+
* @param {object} params.event Event object
|
|
639
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.crudManager The CRUD manager.
|
|
640
|
+
* @param {object} params.event.params HTTP request params to be passed in the request URL.
|
|
641
|
+
* @param {'sync','load'} params.event.requestType CrudManager request type (`load`/`sync`)
|
|
642
|
+
* @param {object} params.event.requestConfig Configuration object for Ajax request call
|
|
683
643
|
*/
|
|
684
644
|
(e: 'beforeSend', params: ((event: { crudManager: AbstractCrudManager, params: object, requestType: 'sync'|'load', requestConfig: object }) => Promise<void>)|string): Promise<void>
|
|
685
645
|
/**
|
|
686
646
|
* Fires before [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) is sent. Return `false` to cancel sync request.
|
|
687
|
-
* ...
|
|
688
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSync)
|
|
647
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSync)
|
|
689
648
|
* @param {string} e Event name
|
|
690
649
|
* @param {object} params Event parameters
|
|
691
|
-
* @param {
|
|
692
|
-
* @param {
|
|
693
|
-
* @param {object} params.
|
|
694
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
695
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
650
|
+
* @param {object} params.event Event object
|
|
651
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
652
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
696
653
|
*/
|
|
697
654
|
(e: 'beforeSync', params: ((event: { source: AbstractCrudManager, pack: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
698
655
|
/**
|
|
@@ -700,79 +657,64 @@ const emit = defineEmits<{
|
|
|
700
657
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
701
658
|
* @param {string} e Event name
|
|
702
659
|
* @param {object} params Event parameters
|
|
703
|
-
* @param {
|
|
704
|
-
* @param {
|
|
705
|
-
* @param {object} params.
|
|
706
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
707
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
660
|
+
* @param {object} params.event Event object
|
|
661
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
662
|
+
* @param {object} params.event.response The decoded server response object.
|
|
708
663
|
*/
|
|
709
|
-
(e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) =>
|
|
664
|
+
(e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) => boolean|void)|string): boolean|void
|
|
710
665
|
/**
|
|
711
666
|
* Fires when any other event is fired from the object.
|
|
712
|
-
* ...
|
|
713
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-catchAll)
|
|
667
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-catchAll)
|
|
714
668
|
* @param {string} e Event name
|
|
715
669
|
* @param {object} params Event parameters
|
|
716
|
-
* @param {
|
|
717
|
-
* @param {
|
|
718
|
-
* @param {
|
|
719
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
720
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
670
|
+
* @param {object} params.event Event object
|
|
671
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
672
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
721
673
|
*/
|
|
722
674
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
723
675
|
/**
|
|
724
676
|
* Fired when data in any of the projects stores changes.
|
|
725
|
-
* ...
|
|
726
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-change)
|
|
677
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-change)
|
|
727
678
|
* @param {string} e Event name
|
|
728
679
|
* @param {object} params Event parameters
|
|
729
|
-
* @param {
|
|
730
|
-
* @param {
|
|
731
|
-
* @param {
|
|
732
|
-
* @param {
|
|
733
|
-
* @param {Core.data.
|
|
734
|
-
* @param {
|
|
735
|
-
* @param {
|
|
736
|
-
* @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
737
|
-
* @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
680
|
+
* @param {object} params.event Event object
|
|
681
|
+
* @param {Scheduler.model.SchedulerProjectModel,any} params.event.source This project
|
|
682
|
+
* @param {Core.data.Store} params.event.store Affected store
|
|
683
|
+
* @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'`
|
|
684
|
+
* @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
685
|
+
* @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
686
|
+
* @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
738
687
|
*/
|
|
739
688
|
(e: 'change', params: ((event: { source: SchedulerProjectModel|any, store: Store, action: 'remove'|'removeAll'|'add'|'clearchanges'|'filter'|'update'|'dataset'|'replace', record: Model, records: Model[], changes: object }) => void)|string): void
|
|
740
689
|
/**
|
|
741
690
|
* Fired when the Engine detects a computation cycle.
|
|
742
691
|
* @param {string} e Event name
|
|
743
692
|
* @param {object} params Event parameters
|
|
744
|
-
* @param {
|
|
745
|
-
* @param {object} params.
|
|
746
|
-
* @param {
|
|
747
|
-
* @param {object} params.
|
|
748
|
-
* @param {Function} params.
|
|
749
|
-
* @param {
|
|
750
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
751
|
-
* @param {Function} params.params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('cycle', ({ continueWithResolutionResult }) => { // cancel changes in case of a cycle continueWithResolutionResult(EffectResolutionResult.Cancel); }) ``` Where `EffectResolutionResult.Cancel` results in cancelling the changes.
|
|
693
|
+
* @param {object} params.event Event object
|
|
694
|
+
* @param {object} params.event.schedulingIssue Scheduling error describing the case:
|
|
695
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the cycle description
|
|
696
|
+
* @param {object} params.event.schedulingIssue.cycle Object providing the cycle info
|
|
697
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
698
|
+
* @param {Function} params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('cycle', ({ continueWithResolutionResult }) => { // cancel changes in case of a cycle continueWithResolutionResult(EffectResolutionResult.Cancel); }) ``` Where `EffectResolutionResult.Cancel` results in cancelling the changes.
|
|
752
699
|
*/
|
|
753
700
|
(e: 'cycle', params: ((event: { schedulingIssue: { getDescription: Function, cycle: object, getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
754
701
|
/**
|
|
755
702
|
* Fired when the engine has finished its calculations and the results has been written back to the records.
|
|
756
|
-
* ...
|
|
757
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-dataReady)
|
|
703
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-dataReady)
|
|
758
704
|
* @param {string} e Event name
|
|
759
705
|
* @param {object} params Event parameters
|
|
760
|
-
* @param {
|
|
761
|
-
* @param {
|
|
762
|
-
* @param {
|
|
763
|
-
* @param {
|
|
764
|
-
* @param {boolean} params.params.event.isInitialCommit Flag that shows if this commit is initial
|
|
765
|
-
* @param {Set<any>} params.params.event.records Set of all [Model](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Model)s that were modified in the completed transaction. Use the [modifications](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Model#property-modifications) property of each Model to identify modified fields.
|
|
706
|
+
* @param {object} params.event Event object
|
|
707
|
+
* @param {SchedulerPro.model.ProjectModel} params.event.source The project
|
|
708
|
+
* @param {boolean} params.event.isInitialCommit Flag that shows if this commit is initial
|
|
709
|
+
* @param {Set<any>} params.event.records Set of all [Model](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Model)s that were modified in the completed transaction. Use the [modifications](https://bryntum.com/products/schedulerpro/docs/api/Core/data/Model#property-modifications) property of each Model to identify modified fields.
|
|
766
710
|
*/
|
|
767
711
|
(e: 'dataReady', params: ((event: { source: ProjectModel, isInitialCommit: boolean, records: Set<any> }) => void)|string): void
|
|
768
712
|
/**
|
|
769
713
|
* Fires when an object is destroyed.
|
|
770
714
|
* @param {string} e Event name
|
|
771
715
|
* @param {object} params Event parameters
|
|
772
|
-
* @param {
|
|
773
|
-
* @param {
|
|
774
|
-
* @param {object} params.params.event Event object
|
|
775
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
716
|
+
* @param {object} params.event Event object
|
|
717
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
776
718
|
*/
|
|
777
719
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
778
720
|
/**
|
|
@@ -780,40 +722,33 @@ const emit = defineEmits<{
|
|
|
780
722
|
* not provide any working periods of time which makes the calendar usage impossible.
|
|
781
723
|
* @param {string} e Event name
|
|
782
724
|
* @param {object} params Event parameters
|
|
783
|
-
* @param {
|
|
784
|
-
* @param {object} params.
|
|
785
|
-
* @param {
|
|
786
|
-
* @param {
|
|
787
|
-
* @param {Function} params.
|
|
788
|
-
* @param {Function} params.
|
|
789
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
790
|
-
* @param {Function} params.params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('emptyCalendar', ({ schedulingIssue, continueWithResolutionResult }) => { // apply the first resolution and continue schedulingIssue.getResolutions()[0].resolve(); continueWithResolutionResult(EffectResolutionResult.Resume); }) ```
|
|
725
|
+
* @param {object} params.event Event object
|
|
726
|
+
* @param {object} params.event.schedulingIssue Scheduling error describing the case:
|
|
727
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the error description
|
|
728
|
+
* @param {Function} params.event.schedulingIssue.getCalendar Returns the calendar that must be fixed
|
|
729
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
730
|
+
* @param {Function} params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('emptyCalendar', ({ schedulingIssue, continueWithResolutionResult }) => { // apply the first resolution and continue schedulingIssue.getResolutions()[0].resolve(); continueWithResolutionResult(EffectResolutionResult.Resume); }) ```
|
|
791
731
|
*/
|
|
792
732
|
(e: 'emptyCalendar', params: ((event: { schedulingIssue: { getDescription: Function, getCalendar: Function, getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
793
733
|
/**
|
|
794
734
|
* Fires when data in any of the registered data stores is changed.
|
|
795
|
-
* ...
|
|
796
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-hasChanges)
|
|
735
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-hasChanges)
|
|
797
736
|
* @param {string} e Event name
|
|
798
737
|
* @param {object} params Event parameters
|
|
799
|
-
* @param {
|
|
800
|
-
* @param {
|
|
801
|
-
* @param {object} params.params.event Event object
|
|
802
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
738
|
+
* @param {object} params.event Event object
|
|
739
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
803
740
|
*/
|
|
804
741
|
(e: 'hasChanges', params: ((event: { source: AbstractCrudManager }) => void)|string): void
|
|
805
742
|
/**
|
|
806
743
|
* Fires on successful [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) completion after data gets loaded to the stores.
|
|
807
744
|
* @param {string} e Event name
|
|
808
745
|
* @param {object} params Event parameters
|
|
809
|
-
* @param {
|
|
810
|
-
* @param {
|
|
811
|
-
* @param {object} params.
|
|
812
|
-
* @param {
|
|
813
|
-
* @param {object} params.
|
|
814
|
-
* @param {
|
|
815
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
816
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
746
|
+
* @param {object} params.event Event object
|
|
747
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
748
|
+
* @param {object} params.event.response The decoded server response object.
|
|
749
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
750
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
751
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
817
752
|
*/
|
|
818
753
|
(e: 'load', params: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
819
754
|
/**
|
|
@@ -821,84 +756,71 @@ const emit = defineEmits<{
|
|
|
821
756
|
* listener or due to incomplete prior load request.
|
|
822
757
|
* @param {string} e Event name
|
|
823
758
|
* @param {object} params Event parameters
|
|
824
|
-
* @param {
|
|
825
|
-
* @param {
|
|
826
|
-
* @param {object} params.
|
|
827
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
828
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
759
|
+
* @param {object} params.event Event object
|
|
760
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
761
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
829
762
|
*/
|
|
830
763
|
(e: 'loadCanceled', params: ((event: { source: AbstractCrudManager, pack: object }) => void)|string): void
|
|
831
764
|
/**
|
|
832
765
|
* Fires when a [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) fails.
|
|
833
766
|
* @param {string} e Event name
|
|
834
767
|
* @param {object} params Event parameters
|
|
835
|
-
* @param {
|
|
836
|
-
* @param {
|
|
837
|
-
* @param {object} params.
|
|
838
|
-
* @param {
|
|
839
|
-
* @param {object} params.
|
|
840
|
-
* @param {
|
|
841
|
-
* @param {
|
|
842
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
843
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
768
|
+
* @param {object} params.event Event object
|
|
769
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
770
|
+
* @param {object} params.event.response The decoded server response object.
|
|
771
|
+
* @param {string} params.event.responseText The raw server response text
|
|
772
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
773
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
774
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
844
775
|
*/
|
|
845
776
|
(e: 'loadFail', params: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
846
777
|
/**
|
|
847
778
|
* Fires when registered stores get into state when they don't have any
|
|
848
779
|
* not persisted change. This happens after [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) or [sync](#Scheduler/crud/AbstractCrudManagerMixin#function-sync) request
|
|
849
780
|
* completion. Or this may happen after a record update which turns its fields back to their original state.
|
|
850
|
-
* ...
|
|
851
|
-
* [View online docs...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-noChanges)
|
|
781
|
+
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-noChanges)
|
|
852
782
|
* @param {string} e Event name
|
|
853
783
|
* @param {object} params Event parameters
|
|
854
|
-
* @param {
|
|
855
|
-
* @param {
|
|
856
|
-
* @param {object} params.params.event Event object
|
|
857
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
784
|
+
* @param {object} params.event Event object
|
|
785
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
858
786
|
*/
|
|
859
787
|
(e: 'noChanges', params: ((event: { source: AbstractCrudManager }) => void)|string): void
|
|
860
788
|
/**
|
|
861
789
|
* Fired during the Engine calculation if [enableProgressNotifications](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-enableProgressNotifications) config is `true`
|
|
862
790
|
* @param {string} e Event name
|
|
863
791
|
* @param {object} params Event parameters
|
|
864
|
-
* @param {
|
|
865
|
-
* @param {
|
|
866
|
-
* @param {
|
|
867
|
-
* @param {
|
|
868
|
-
* @param {
|
|
869
|
-
* @param {number} params.params.event.remaining The number of remaining operations
|
|
870
|
-
* @param {'storePopulation','propagating'} params.params.event.phase The phase of the calculation, either 'storePopulation' when data is getting loaded, or 'propagating' when data is getting calculated
|
|
792
|
+
* @param {object} params.event Event object
|
|
793
|
+
* @param {SchedulerPro.model.ProjectModel} params.event.source The owning project
|
|
794
|
+
* @param {number} params.event.total The total number of operations
|
|
795
|
+
* @param {number} params.event.remaining The number of remaining operations
|
|
796
|
+
* @param {'storePopulation','propagating'} params.event.phase The phase of the calculation, either 'storePopulation' when data is getting loaded, or 'propagating' when data is getting calculated
|
|
871
797
|
*/
|
|
872
798
|
(e: 'progress', params: ((event: { source: ProjectModel, total: number, remaining: number, phase: 'storePopulation'|'propagating' }) => void)|string): void
|
|
873
799
|
/**
|
|
874
800
|
* Fires on successful request completion after data gets applied to the stores.
|
|
875
801
|
* @param {string} e Event name
|
|
876
802
|
* @param {object} params Event parameters
|
|
877
|
-
* @param {
|
|
878
|
-
* @param {
|
|
879
|
-
* @param {
|
|
880
|
-
* @param {
|
|
881
|
-
* @param {
|
|
882
|
-
* @param {object} params.
|
|
883
|
-
* @param {
|
|
884
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
885
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
803
|
+
* @param {object} params.event Event object
|
|
804
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
805
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
806
|
+
* @param {object} params.event.response The decoded server response object.
|
|
807
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
808
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
809
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
886
810
|
*/
|
|
887
811
|
(e: 'requestDone', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
888
812
|
/**
|
|
889
813
|
* Fires when a request fails.
|
|
890
814
|
* @param {string} e Event name
|
|
891
815
|
* @param {object} params Event parameters
|
|
892
|
-
* @param {
|
|
893
|
-
* @param {
|
|
894
|
-
* @param {
|
|
895
|
-
* @param {
|
|
896
|
-
* @param {
|
|
897
|
-
* @param {object} params.
|
|
898
|
-
* @param {
|
|
899
|
-
* @param {
|
|
900
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
901
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
816
|
+
* @param {object} params.event Event object
|
|
817
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
818
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
819
|
+
* @param {object} params.event.response The decoded server response object.
|
|
820
|
+
* @param {string} params.event.responseText The raw server response text
|
|
821
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
822
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
823
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
902
824
|
*/
|
|
903
825
|
(e: 'requestFail', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
904
826
|
/**
|
|
@@ -906,78 +828,66 @@ const emit = defineEmits<{
|
|
|
906
828
|
* new revision.
|
|
907
829
|
* @param {string} e Event name
|
|
908
830
|
* @param {object} params Event parameters
|
|
909
|
-
* @param {
|
|
910
|
-
* @param {
|
|
911
|
-
* @param {
|
|
912
|
-
* @param {string} params.
|
|
913
|
-
* @param {
|
|
914
|
-
* @param {string} params.params.event.clientId ID of the client instance. Used to distinguish own revisions from the broadcast channel
|
|
915
|
-
* @param {object} params.params.event.changes Object with changes constituting revision
|
|
831
|
+
* @param {object} params.event Event object
|
|
832
|
+
* @param {string} params.event.localRevisionId ID of the local revision. Backend should send it in the broadcast channel
|
|
833
|
+
* @param {string} [params.event.conflictResolutionFor] ID of the revision with a conflict which was resolved by this revision
|
|
834
|
+
* @param {string} params.event.clientId ID of the client instance. Used to distinguish own revisions from the broadcast channel
|
|
835
|
+
* @param {object} params.event.changes Object with changes constituting revision
|
|
916
836
|
*/
|
|
917
837
|
(e: 'revisionNotification', params: ((event: { localRevisionId: string, conflictResolutionFor?: string, clientId: string, changes: object }) => void)|string): void
|
|
918
838
|
/**
|
|
919
839
|
* Fired when the Engine detects a scheduling conflict.
|
|
920
840
|
* @param {string} e Event name
|
|
921
841
|
* @param {object} params Event parameters
|
|
922
|
-
* @param {
|
|
923
|
-
* @param {object} params.
|
|
924
|
-
* @param {
|
|
925
|
-
* @param {object} params.
|
|
926
|
-
* @param {Function} params.
|
|
927
|
-
* @param {
|
|
928
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Function to get possible resolutions
|
|
929
|
-
* @param {Function} params.params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('schedulingConflict', ({ schedulingIssue, continueWithResolutionResult }) => { // apply the first resolution and continue schedulingIssue.getResolutions()[0].resolve(); continueWithResolutionResult(EffectResolutionResult.Resume); }) ``` Where `EffectResolutionResult.Resume` results in a resolution being applied and current transaction should be continued.
|
|
842
|
+
* @param {object} params.event Event object
|
|
843
|
+
* @param {object} params.event.schedulingIssue The conflict details:
|
|
844
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the conflict description
|
|
845
|
+
* @param {object[]} params.event.schedulingIssue.intervals Array of conflicting intervals
|
|
846
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Function to get possible resolutions
|
|
847
|
+
* @param {Function} params.event.continueWithResolutionResult Function to call after a resolution is chosen to proceed with the Engine calculations: ```javascript project.on('schedulingConflict', ({ schedulingIssue, continueWithResolutionResult }) => { // apply the first resolution and continue schedulingIssue.getResolutions()[0].resolve(); continueWithResolutionResult(EffectResolutionResult.Resume); }) ``` Where `EffectResolutionResult.Resume` results in a resolution being applied and current transaction should be continued.
|
|
930
848
|
*/
|
|
931
849
|
(e: 'schedulingConflict', params: ((event: { schedulingIssue: { getDescription: Function, intervals: object[], getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
932
850
|
/**
|
|
933
851
|
* Fires on successful [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) completion.
|
|
934
852
|
* @param {string} e Event name
|
|
935
853
|
* @param {object} params Event parameters
|
|
936
|
-
* @param {
|
|
937
|
-
* @param {
|
|
938
|
-
* @param {object} params.
|
|
939
|
-
* @param {
|
|
940
|
-
* @param {object} params.
|
|
941
|
-
* @param {
|
|
942
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
943
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
854
|
+
* @param {object} params.event Event object
|
|
855
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
856
|
+
* @param {object} params.event.response The decoded server response object.
|
|
857
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
858
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
859
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
944
860
|
*/
|
|
945
861
|
(e: 'sync', params: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
946
862
|
/**
|
|
947
863
|
* Fires after [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) was canceled by some [beforeSync](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeSync) listener.
|
|
948
864
|
* @param {string} e Event name
|
|
949
865
|
* @param {object} params Event parameters
|
|
950
|
-
* @param {
|
|
951
|
-
* @param {
|
|
952
|
-
* @param {object} params.
|
|
953
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
954
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
866
|
+
* @param {object} params.event Event object
|
|
867
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
868
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
955
869
|
*/
|
|
956
870
|
(e: 'syncCanceled', params: ((event: { source: AbstractCrudManager, pack: object }) => void)|string): void
|
|
957
871
|
/**
|
|
958
872
|
* Fires after [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) was delayed due to incomplete previous one.
|
|
959
873
|
* @param {string} e Event name
|
|
960
874
|
* @param {object} params Event parameters
|
|
961
|
-
* @param {
|
|
962
|
-
* @param {
|
|
963
|
-
* @param {object} params.
|
|
964
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
965
|
-
* @param {object} params.params.event.arguments The arguments of [sync](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) call.
|
|
875
|
+
* @param {object} params.event Event object
|
|
876
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
877
|
+
* @param {object} params.event.arguments The arguments of [sync](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) call.
|
|
966
878
|
*/
|
|
967
879
|
(e: 'syncDelayed', params: ((event: { source: AbstractCrudManager, arguments: object }) => void)|string): void
|
|
968
880
|
/**
|
|
969
881
|
* Fires when a [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) fails.
|
|
970
882
|
* @param {string} e Event name
|
|
971
883
|
* @param {object} params Event parameters
|
|
972
|
-
* @param {
|
|
973
|
-
* @param {
|
|
974
|
-
* @param {object} params.
|
|
975
|
-
* @param {
|
|
976
|
-
* @param {object} params.
|
|
977
|
-
* @param {
|
|
978
|
-
* @param {
|
|
979
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
980
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
884
|
+
* @param {object} params.event Event object
|
|
885
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
886
|
+
* @param {object} params.event.response The decoded server response object.
|
|
887
|
+
* @param {string} params.event.responseText The raw server response text
|
|
888
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
889
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
890
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
981
891
|
*/
|
|
982
892
|
(e: 'syncFail', params: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
983
893
|
}>();
|
|
@@ -1116,16 +1026,9 @@ const widgetData = {
|
|
|
1116
1026
|
'trackProjectModelChanges'
|
|
1117
1027
|
],
|
|
1118
1028
|
propertyNames : [
|
|
1119
|
-
'allChildren',
|
|
1120
|
-
'allUnfilteredChildren',
|
|
1121
1029
|
'descendantCount',
|
|
1122
|
-
'hasGeneratedId',
|
|
1123
1030
|
'inlineData',
|
|
1124
|
-
'internalId',
|
|
1125
|
-
'isCommitting',
|
|
1126
1031
|
'isCreating',
|
|
1127
|
-
'isValid',
|
|
1128
|
-
'previousSiblingsTotalCount',
|
|
1129
1032
|
'segmentModelClass',
|
|
1130
1033
|
'visibleDescendantCount'
|
|
1131
1034
|
],
|