@bryntum/schedulerpro-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.
- package/README.md +9 -9
- package/lib/chunks/{BFFz1c24.js → 7vz3cAx6.js} +6 -4
- package/lib/chunks/7vz3cAx6.js.map +1 -0
- package/lib/chunks/{oM3gO3yH.js → B1SaPsRu.js} +3 -1
- package/lib/chunks/B1SaPsRu.js.map +1 -0
- package/lib/chunks/B4dVznPx.js.map +1 -1
- package/lib/chunks/{Pb5GbfMi.js → B8GKehTJ.js} +6 -4
- package/lib/chunks/B8GKehTJ.js.map +1 -0
- package/lib/chunks/{CvNpXefN.js → BhXv58eE.js} +7 -5
- package/lib/chunks/BhXv58eE.js.map +1 -0
- package/lib/chunks/{DmFXOMJ5.js → BhfdqXGU.js} +6 -4
- package/lib/chunks/BhfdqXGU.js.map +1 -0
- package/lib/chunks/{b8yreHIz.js → Bk2bIVfG.js} +3 -1
- package/lib/chunks/Bk2bIVfG.js.map +1 -0
- package/lib/chunks/{s35t-2ke.js → C1vi1h_N.js} +6 -4
- package/lib/chunks/C1vi1h_N.js.map +1 -0
- package/lib/chunks/{CqtUB81W.js → CEQZr1q6.js} +3 -1
- package/lib/chunks/CEQZr1q6.js.map +1 -0
- package/lib/chunks/CPjow0gO.js.map +1 -1
- package/lib/chunks/{BNBuOpUp.js → Cb_akueu.js} +10 -8
- package/lib/chunks/Cb_akueu.js.map +1 -0
- package/lib/chunks/{BIkGnHve.js → Cc_DPp3S.js} +6 -4
- package/lib/chunks/Cc_DPp3S.js.map +1 -0
- package/lib/chunks/{Bp7aU5Ia.js → Cr5VTUbs.js} +11 -9
- package/lib/chunks/Cr5VTUbs.js.map +1 -0
- package/lib/chunks/{yF4wtntA.js → D-hmgVVF.js} +12 -10
- package/lib/chunks/D-hmgVVF.js.map +1 -0
- package/lib/chunks/{D1a3F6m-.js → D-v-Wqj4.js} +3 -1
- package/lib/chunks/D-v-Wqj4.js.map +1 -0
- package/lib/chunks/D0hJ3P6L.js.map +1 -1
- package/lib/chunks/DPA-xEW5.js.map +1 -1
- package/lib/chunks/{C3Dz-ovY.js → XQWZfDOm.js} +5 -3
- package/lib/chunks/XQWZfDOm.js.map +1 -0
- package/lib/chunks/{DdbMybqv.js → eKXSEOkn.js} +3 -1
- package/lib/chunks/eKXSEOkn.js.map +1 -0
- package/lib/chunks/{DjFBhm9P.js → edcDjaO2.js} +6 -4
- package/lib/chunks/edcDjaO2.js.map +1 -0
- package/lib/chunks/{p1r0F5YC.js → n2IZFQjR.js} +9 -7
- package/lib/chunks/n2IZFQjR.js.map +1 -0
- package/lib/chunks/{W-pa3HyX.js → zY4Qxi9x.js} +5 -3
- package/lib/chunks/zY4Qxi9x.js.map +1 -0
- 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/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/BryntumSchedulingDirectionPicker.js +1 -1
- package/lib/components/BryntumSchedulingModePicker.js +1 -1
- package/lib/components/BryntumStartDateField.js +1 -1
- package/lib/components/BryntumTimeline.js +1 -1
- package/lib/index.js +18 -18
- package/package.json +1 -1
- package/src/components/BryntumCalendarEditor.vue +70 -106
- package/src/components/BryntumCalendarEditorProps.ts +6 -0
- package/src/components/BryntumCalendarField.vue +87 -109
- package/src/components/BryntumCalendarFieldProps.ts +15 -0
- package/src/components/BryntumConstraintTypePicker.vue +87 -109
- package/src/components/BryntumConstraintTypePickerProps.ts +15 -0
- package/src/components/BryntumCostAccrualField.vue +87 -109
- package/src/components/BryntumCostAccrualFieldProps.ts +15 -0
- package/src/components/BryntumDependencyTypePicker.vue +87 -109
- package/src/components/BryntumDependencyTypePickerProps.ts +15 -0
- package/src/components/BryntumEffortField.vue +82 -102
- package/src/components/BryntumEffortFieldProps.ts +15 -0
- package/src/components/BryntumEndDateField.vue +87 -107
- package/src/components/BryntumEndDateFieldProps.ts +16 -1
- package/src/components/BryntumModelCombo.vue +87 -109
- package/src/components/BryntumModelComboProps.ts +15 -0
- package/src/components/BryntumRateTableField.vue +87 -109
- package/src/components/BryntumRateTableFieldProps.ts +15 -0
- package/src/components/BryntumResourceEditor.vue +70 -106
- package/src/components/BryntumResourceEditorProps.ts +6 -0
- package/src/components/BryntumResourceGrid.vue +536 -756
- package/src/components/BryntumResourceGridProps.ts +12 -1
- package/src/components/BryntumResourceHistogram.vue +780 -1092
- package/src/components/BryntumResourceHistogramProps.ts +12 -1
- package/src/components/BryntumResourceTypeField.vue +87 -109
- package/src/components/BryntumResourceTypeFieldProps.ts +15 -0
- package/src/components/BryntumResourceUtilization.vue +796 -1114
- package/src/components/BryntumResourceUtilizationProps.ts +12 -1
- package/src/components/BryntumSchedulerPro.vue +1620 -2196
- package/src/components/BryntumSchedulerProBase.vue +1620 -2196
- package/src/components/BryntumSchedulerProBaseProps.ts +12 -1
- package/src/components/BryntumSchedulerProProjectModel.vue +140 -190
- package/src/components/BryntumSchedulerProProjectModelProps.ts +9 -7
- package/src/components/BryntumSchedulerProProps.ts +12 -1
- package/src/components/BryntumSchedulingDirectionPicker.vue +87 -109
- package/src/components/BryntumSchedulingDirectionPickerProps.ts +15 -0
- package/src/components/BryntumSchedulingModePicker.vue +87 -109
- package/src/components/BryntumSchedulingModePickerProps.ts +15 -0
- package/src/components/BryntumStartDateField.vue +87 -107
- package/src/components/BryntumStartDateFieldProps.ts +16 -1
- package/src/components/BryntumTimeline.vue +1432 -1928
- package/src/components/BryntumTimelineProps.ts +12 -1
- package/src/components/BryntumVersionGrid.vue +534 -764
- package/src/components/BryntumVersionGridProps.ts +7 -1
- package/lib/chunks/BFFz1c24.js.map +0 -1
- package/lib/chunks/BIkGnHve.js.map +0 -1
- package/lib/chunks/BNBuOpUp.js.map +0 -1
- package/lib/chunks/Bp7aU5Ia.js.map +0 -1
- package/lib/chunks/C3Dz-ovY.js.map +0 -1
- package/lib/chunks/CqtUB81W.js.map +0 -1
- package/lib/chunks/CvNpXefN.js.map +0 -1
- package/lib/chunks/D1a3F6m-.js.map +0 -1
- package/lib/chunks/DdbMybqv.js.map +0 -1
- package/lib/chunks/DjFBhm9P.js.map +0 -1
- package/lib/chunks/DmFXOMJ5.js.map +0 -1
- package/lib/chunks/Pb5GbfMi.js.map +0 -1
- package/lib/chunks/W-pa3HyX.js.map +0 -1
- package/lib/chunks/b8yreHIz.js.map +0 -1
- package/lib/chunks/oM3gO3yH.js.map +0 -1
- package/lib/chunks/p1r0F5YC.js.map +0 -1
- package/lib/chunks/s35t-2ke.js.map +0 -1
- package/lib/chunks/yF4wtntA.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';
|
|
@@ -117,6 +117,7 @@ defineProps<{
|
|
|
117
117
|
/**
|
|
118
118
|
* The initial data, to fill the [calendarManagerStore](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#property-calendarManagerStore) with.
|
|
119
119
|
* Should be an array of [CalendarModel](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/CalendarModel) or its configuration objects.
|
|
120
|
+
* @deprecated 6.3.0 Use [calendars](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-calendars) instead
|
|
120
121
|
*/
|
|
121
122
|
calendarsData ? : CalendarModel[]
|
|
122
123
|
/**
|
|
@@ -279,12 +280,11 @@ defineProps<{
|
|
|
279
280
|
* If set to `true`, or a config object, this makes the CrudManager load records only when needed. When a record
|
|
280
281
|
* or a date range that is not already loaded is requested, a load request will be made to the specified URL.
|
|
281
282
|
* More more details about lazy loading, see the [guide](https://bryntum.com/products/schedulerpro/docs/api/Grid/guides/data/lazyloading.md)
|
|
282
|
-
* @param {
|
|
283
|
-
* @param {number} lazyLoad.chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
|
|
283
|
+
* @param {number} chunkSize The number of records to be loaded before and after the requested index (only affects the ResourceStore).
|
|
284
284
|
* @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).
|
|
285
285
|
* @param {number} bufferAmount See `bufferUnit`
|
|
286
286
|
*/
|
|
287
|
-
lazyLoad ? : Boolean|{
|
|
287
|
+
lazyLoad ? : Boolean|{ chunkSize: number, bufferUnit: DurationUnit, bufferAmount: number }
|
|
288
288
|
/**
|
|
289
289
|
* The listener set for this object.
|
|
290
290
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-listeners)
|
|
@@ -551,18 +551,20 @@ defineProps<{
|
|
|
551
551
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-transport)
|
|
552
552
|
* @property {object} [transport.load] Load requests configuration:
|
|
553
553
|
* @property {string} [transport.load.url] URL to request for data loading.
|
|
554
|
-
* @property {
|
|
554
|
+
* @property {HttpMethod} [transport.load.method] HTTP method to be used for load requests.
|
|
555
|
+
* @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
556
|
* @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
557
|
* @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
558
|
* @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
559
|
* @property {object} [transport.sync] Sync requests (`sync` in further text) configuration:
|
|
559
560
|
* @property {string} [transport.sync.url] URL to request for `sync`.
|
|
560
|
-
* @property {
|
|
561
|
+
* @property {HttpMethod} [transport.sync.method] HTTP request method to be used for `sync`.
|
|
562
|
+
* @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.
|
|
561
563
|
* @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).
|
|
562
564
|
* @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' } }, ... } ```
|
|
563
565
|
* @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' } }, ... } ```
|
|
564
566
|
*/
|
|
565
|
-
transport ? : { load?: { url?: string, method?:
|
|
567
|
+
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> } }
|
|
566
568
|
/**
|
|
567
569
|
* By default, the stores of a project use the raw data objects passed to them as the data source for their
|
|
568
570
|
* records if data is loaded remotely (using an `AjaxStore` or a `CrudManager`). For data supplied inline,
|
|
@@ -594,61 +596,51 @@ const emit = defineEmits<{
|
|
|
594
596
|
* Fires before an object is destroyed.
|
|
595
597
|
* @param {string} e Event name
|
|
596
598
|
* @param {object} params Event parameters
|
|
597
|
-
* @param {
|
|
598
|
-
* @param {
|
|
599
|
-
* @param {object} params.params.event Event object
|
|
600
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
599
|
+
* @param {object} params.event Event object
|
|
600
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
601
601
|
*/
|
|
602
602
|
(e: 'beforeDestroy', params: ((event: { source: Base }) => void)|string): void
|
|
603
603
|
/**
|
|
604
604
|
* Fires before [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) is sent. Return `false` to cancel load request.
|
|
605
605
|
* @param {string} e Event name
|
|
606
606
|
* @param {object} params Event parameters
|
|
607
|
-
* @param {
|
|
608
|
-
* @param {
|
|
609
|
-
* @param {object} params.
|
|
610
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
611
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
607
|
+
* @param {object} params.event Event object
|
|
608
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
609
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
612
610
|
*/
|
|
613
|
-
(e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) =>
|
|
611
|
+
(e: 'beforeLoad', params: ((event: { source: AbstractCrudManager, pack: object }) => boolean|void)|string): boolean|void
|
|
614
612
|
/**
|
|
615
613
|
* Fires before loaded data get applied to the stores. Return `false` to prevent data applying.
|
|
616
614
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
617
615
|
* @param {string} e Event name
|
|
618
616
|
* @param {object} params Event parameters
|
|
619
|
-
* @param {
|
|
620
|
-
* @param {
|
|
621
|
-
* @param {object} params.
|
|
622
|
-
* @param {
|
|
623
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
624
|
-
* @param {object} params.params.event.options Options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
617
|
+
* @param {object} params.event Event object
|
|
618
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
619
|
+
* @param {object} params.event.response The decoded server response object.
|
|
620
|
+
* @param {object} params.event.options Options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
625
621
|
*/
|
|
626
|
-
(e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) =>
|
|
622
|
+
(e: 'beforeLoadApply', params: ((event: { source: AbstractCrudManager, response: object, options: object }) => boolean|void)|string): boolean|void
|
|
627
623
|
/**
|
|
628
624
|
* Fires before server response gets applied to the stores. Return `false` to prevent data applying.
|
|
629
625
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
630
626
|
* @param {string} e Event name
|
|
631
627
|
* @param {object} params Event parameters
|
|
632
|
-
* @param {
|
|
633
|
-
* @param {
|
|
634
|
-
* @param {
|
|
635
|
-
* @param {
|
|
636
|
-
* @param {'sync','load'} params.params.event.requestType The request type (`sync` or `load`).
|
|
637
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
628
|
+
* @param {object} params.event Event object
|
|
629
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
630
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
631
|
+
* @param {object} params.event.response The decoded server response object.
|
|
638
632
|
*/
|
|
639
|
-
(e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) =>
|
|
633
|
+
(e: 'beforeResponseApply', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object }) => boolean|void)|string): boolean|void
|
|
640
634
|
/**
|
|
641
635
|
* Fires before a request is sent to the server.
|
|
642
636
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSend)
|
|
643
637
|
* @param {string} e Event name
|
|
644
638
|
* @param {object} params Event parameters
|
|
645
|
-
* @param {
|
|
646
|
-
* @param {
|
|
647
|
-
* @param {object} params.params
|
|
648
|
-
* @param {
|
|
649
|
-
* @param {object} params.
|
|
650
|
-
* @param {'sync','load'} params.params.event.requestType CrudManager request type (`load`/`sync`)
|
|
651
|
-
* @param {object} params.params.event.requestConfig Configuration object for Ajax request call
|
|
639
|
+
* @param {object} params.event Event object
|
|
640
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.crudManager The CRUD manager.
|
|
641
|
+
* @param {object} params.event.params HTTP request params to be passed in the request URL.
|
|
642
|
+
* @param {'sync','load'} params.event.requestType CrudManager request type (`load`/`sync`)
|
|
643
|
+
* @param {object} params.event.requestConfig Configuration object for Ajax request call
|
|
652
644
|
*/
|
|
653
645
|
(e: 'beforeSend', params: ((event: { crudManager: AbstractCrudManager, params: object, requestType: 'sync'|'load', requestConfig: object }) => Promise<void>)|string): Promise<void>
|
|
654
646
|
/**
|
|
@@ -656,11 +648,9 @@ const emit = defineEmits<{
|
|
|
656
648
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-beforeSync)
|
|
657
649
|
* @param {string} e Event name
|
|
658
650
|
* @param {object} params Event parameters
|
|
659
|
-
* @param {
|
|
660
|
-
* @param {
|
|
661
|
-
* @param {object} params.
|
|
662
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
663
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
651
|
+
* @param {object} params.event Event object
|
|
652
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
653
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
664
654
|
*/
|
|
665
655
|
(e: 'beforeSync', params: ((event: { source: AbstractCrudManager, pack: object }) => Promise<boolean>|boolean|void)|string): Promise<boolean>|boolean|void
|
|
666
656
|
/**
|
|
@@ -668,23 +658,19 @@ const emit = defineEmits<{
|
|
|
668
658
|
* This event can be used for server data preprocessing. To achieve it user can modify the `response` object.
|
|
669
659
|
* @param {string} e Event name
|
|
670
660
|
* @param {object} params Event parameters
|
|
671
|
-
* @param {
|
|
672
|
-
* @param {
|
|
673
|
-
* @param {object} params.
|
|
674
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
675
|
-
* @param {object} params.params.event.response The decoded server response object.
|
|
661
|
+
* @param {object} params.event Event object
|
|
662
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
663
|
+
* @param {object} params.event.response The decoded server response object.
|
|
676
664
|
*/
|
|
677
|
-
(e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) =>
|
|
665
|
+
(e: 'beforeSyncApply', params: ((event: { source: AbstractCrudManager, response: object }) => boolean|void)|string): boolean|void
|
|
678
666
|
/**
|
|
679
667
|
* Fires when any other event is fired from the object.
|
|
680
668
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-catchAll)
|
|
681
669
|
* @param {string} e Event name
|
|
682
670
|
* @param {object} params Event parameters
|
|
683
|
-
* @param {
|
|
684
|
-
* @param {
|
|
685
|
-
* @param {
|
|
686
|
-
* @param {{[key: string]: any, type: string}} params.params.event.event The Object that contains event details
|
|
687
|
-
* @param {string} params.params.event.event.type The type of the event which is caught by the listener
|
|
671
|
+
* @param {object} params.event Event object
|
|
672
|
+
* @param {{[key: string]: any, type: string}} params.event.event The Object that contains event details
|
|
673
|
+
* @param {string} params.event.event.type The type of the event which is caught by the listener
|
|
688
674
|
*/
|
|
689
675
|
(e: 'catchAll', params: ((event: {[key: string]: any, type: string}) => void)|string): void
|
|
690
676
|
/**
|
|
@@ -692,29 +678,25 @@ const emit = defineEmits<{
|
|
|
692
678
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-change)
|
|
693
679
|
* @param {string} e Event name
|
|
694
680
|
* @param {object} params Event parameters
|
|
695
|
-
* @param {
|
|
696
|
-
* @param {
|
|
697
|
-
* @param {
|
|
698
|
-
* @param {
|
|
699
|
-
* @param {Core.data.
|
|
700
|
-
* @param {
|
|
701
|
-
* @param {
|
|
702
|
-
* @param {Core.data.Model[]} params.params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
703
|
-
* @param {object} params.params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
681
|
+
* @param {object} params.event Event object
|
|
682
|
+
* @param {Scheduler.model.SchedulerProjectModel,any} params.event.source This project
|
|
683
|
+
* @param {Core.data.Store} params.event.store Affected store
|
|
684
|
+
* @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'`
|
|
685
|
+
* @param {Core.data.Model} params.event.record Changed record, for actions that affects exactly one record (`'update'`)
|
|
686
|
+
* @param {Core.data.Model[]} params.event.records Changed records, passed for all actions except `'removeAll'`
|
|
687
|
+
* @param {object} params.event.changes Passed for the `'update'` action, info on which record fields changed
|
|
704
688
|
*/
|
|
705
689
|
(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
|
|
706
690
|
/**
|
|
707
691
|
* Fired when the Engine detects a computation cycle.
|
|
708
692
|
* @param {string} e Event name
|
|
709
693
|
* @param {object} params Event parameters
|
|
710
|
-
* @param {
|
|
711
|
-
* @param {object} params.
|
|
712
|
-
* @param {
|
|
713
|
-
* @param {object} params.
|
|
714
|
-
* @param {Function} params.
|
|
715
|
-
* @param {
|
|
716
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
717
|
-
* @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.
|
|
694
|
+
* @param {object} params.event Event object
|
|
695
|
+
* @param {object} params.event.schedulingIssue Scheduling error describing the case:
|
|
696
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the cycle description
|
|
697
|
+
* @param {object} params.event.schedulingIssue.cycle Object providing the cycle info
|
|
698
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
699
|
+
* @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.
|
|
718
700
|
*/
|
|
719
701
|
(e: 'cycle', params: ((event: { schedulingIssue: { getDescription: Function, cycle: object, getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
720
702
|
/**
|
|
@@ -722,22 +704,18 @@ const emit = defineEmits<{
|
|
|
722
704
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-dataReady)
|
|
723
705
|
* @param {string} e Event name
|
|
724
706
|
* @param {object} params Event parameters
|
|
725
|
-
* @param {
|
|
726
|
-
* @param {
|
|
727
|
-
* @param {
|
|
728
|
-
* @param {
|
|
729
|
-
* @param {boolean} params.params.event.isInitialCommit Flag that shows if this commit is initial
|
|
730
|
-
* @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.
|
|
707
|
+
* @param {object} params.event Event object
|
|
708
|
+
* @param {SchedulerPro.model.ProjectModel} params.event.source The project
|
|
709
|
+
* @param {boolean} params.event.isInitialCommit Flag that shows if this commit is initial
|
|
710
|
+
* @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.
|
|
731
711
|
*/
|
|
732
712
|
(e: 'dataReady', params: ((event: { source: ProjectModel, isInitialCommit: boolean, records: Set<any> }) => void)|string): void
|
|
733
713
|
/**
|
|
734
714
|
* Fires when an object is destroyed.
|
|
735
715
|
* @param {string} e Event name
|
|
736
716
|
* @param {object} params Event parameters
|
|
737
|
-
* @param {
|
|
738
|
-
* @param {
|
|
739
|
-
* @param {object} params.params.event Event object
|
|
740
|
-
* @param {Core.Base} params.params.event.source The Object that is being destroyed.
|
|
717
|
+
* @param {object} params.event Event object
|
|
718
|
+
* @param {Core.Base} params.event.source The Object that is being destroyed.
|
|
741
719
|
*/
|
|
742
720
|
(e: 'destroy', params: ((event: { source: Base }) => void)|string): void
|
|
743
721
|
/**
|
|
@@ -745,14 +723,12 @@ const emit = defineEmits<{
|
|
|
745
723
|
* not provide any working periods of time which makes the calendar usage impossible.
|
|
746
724
|
* @param {string} e Event name
|
|
747
725
|
* @param {object} params Event parameters
|
|
748
|
-
* @param {
|
|
749
|
-
* @param {object} params.
|
|
750
|
-
* @param {
|
|
751
|
-
* @param {
|
|
752
|
-
* @param {Function} params.
|
|
753
|
-
* @param {Function} params.
|
|
754
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
755
|
-
* @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); }) ```
|
|
726
|
+
* @param {object} params.event Event object
|
|
727
|
+
* @param {object} params.event.schedulingIssue Scheduling error describing the case:
|
|
728
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the error description
|
|
729
|
+
* @param {Function} params.event.schedulingIssue.getCalendar Returns the calendar that must be fixed
|
|
730
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Returns possible resolutions
|
|
731
|
+
* @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); }) ```
|
|
756
732
|
*/
|
|
757
733
|
(e: 'emptyCalendar', params: ((event: { schedulingIssue: { getDescription: Function, getCalendar: Function, getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
758
734
|
/**
|
|
@@ -760,53 +736,47 @@ const emit = defineEmits<{
|
|
|
760
736
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-hasChanges)
|
|
761
737
|
* @param {string} e Event name
|
|
762
738
|
* @param {object} params Event parameters
|
|
763
|
-
* @param {
|
|
764
|
-
* @param {
|
|
765
|
-
* @param {object} params.params.event Event object
|
|
766
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
739
|
+
* @param {object} params.event Event object
|
|
740
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
767
741
|
*/
|
|
768
742
|
(e: 'hasChanges', params: ((event: { source: AbstractCrudManager }) => void)|string): void
|
|
769
743
|
/**
|
|
770
744
|
* 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.
|
|
771
745
|
* @param {string} e Event name
|
|
772
746
|
* @param {object} params Event parameters
|
|
773
|
-
* @param {
|
|
774
|
-
* @param {
|
|
775
|
-
* @param {object} params.
|
|
776
|
-
* @param {
|
|
777
|
-
* @param {object} params.
|
|
778
|
-
* @param {object} params.
|
|
779
|
-
* @param {
|
|
780
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
747
|
+
* @param {object} params.event Event object
|
|
748
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
749
|
+
* @param {object} params.event.response The decoded server response object.
|
|
750
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
751
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
752
|
+
* @param {object} params.event.options The options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
753
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
781
754
|
*/
|
|
782
|
-
(e: 'load', params: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
755
|
+
(e: 'load', params: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string): void
|
|
783
756
|
/**
|
|
784
757
|
* Fired after [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) was canceled by some [beforeLoad](#Scheduler/crud/AbstractCrudManagerMixin#event-beforeLoad)
|
|
785
758
|
* listener or due to incomplete prior load request.
|
|
786
759
|
* @param {string} e Event name
|
|
787
760
|
* @param {object} params Event parameters
|
|
788
|
-
* @param {
|
|
789
|
-
* @param {
|
|
790
|
-
* @param {object} params.
|
|
791
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
792
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
761
|
+
* @param {object} params.event Event object
|
|
762
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
763
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
793
764
|
*/
|
|
794
765
|
(e: 'loadCanceled', params: ((event: { source: AbstractCrudManager, pack: object }) => void)|string): void
|
|
795
766
|
/**
|
|
796
767
|
* Fires when a [load request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) fails.
|
|
797
768
|
* @param {string} e Event name
|
|
798
769
|
* @param {object} params Event parameters
|
|
799
|
-
* @param {
|
|
800
|
-
* @param {
|
|
801
|
-
* @param {object} params.
|
|
802
|
-
* @param {
|
|
803
|
-
* @param {object} params.
|
|
804
|
-
* @param {
|
|
805
|
-
* @param {object} params.
|
|
806
|
-
* @param {
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
(e: 'loadFail', params: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
770
|
+
* @param {object} params.event Event object
|
|
771
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
772
|
+
* @param {object} params.event.response The decoded server response object.
|
|
773
|
+
* @param {string} params.event.responseText The raw server response text
|
|
774
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
775
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
776
|
+
* @param {object} params.event.options The options provided to the [load](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-load) method.
|
|
777
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
778
|
+
*/
|
|
779
|
+
(e: 'loadFail', params: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, options: object, rawResponse: Response }) => void)|string): void
|
|
810
780
|
/**
|
|
811
781
|
* Fires when registered stores get into state when they don't have any
|
|
812
782
|
* 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
|
|
@@ -814,54 +784,46 @@ const emit = defineEmits<{
|
|
|
814
784
|
* [More...](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#event-noChanges)
|
|
815
785
|
* @param {string} e Event name
|
|
816
786
|
* @param {object} params Event parameters
|
|
817
|
-
* @param {
|
|
818
|
-
* @param {
|
|
819
|
-
* @param {object} params.params.event Event object
|
|
820
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
787
|
+
* @param {object} params.event Event object
|
|
788
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
821
789
|
*/
|
|
822
790
|
(e: 'noChanges', params: ((event: { source: AbstractCrudManager }) => void)|string): void
|
|
823
791
|
/**
|
|
824
792
|
* Fired during the Engine calculation if [enableProgressNotifications](https://bryntum.com/products/schedulerpro/docs/api/SchedulerPro/model/ProjectModel#config-enableProgressNotifications) config is `true`
|
|
825
793
|
* @param {string} e Event name
|
|
826
794
|
* @param {object} params Event parameters
|
|
827
|
-
* @param {
|
|
828
|
-
* @param {
|
|
829
|
-
* @param {
|
|
830
|
-
* @param {
|
|
831
|
-
* @param {
|
|
832
|
-
* @param {number} params.params.event.remaining The number of remaining operations
|
|
833
|
-
* @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
|
|
795
|
+
* @param {object} params.event Event object
|
|
796
|
+
* @param {SchedulerPro.model.ProjectModel} params.event.source The owning project
|
|
797
|
+
* @param {number} params.event.total The total number of operations
|
|
798
|
+
* @param {number} params.event.remaining The number of remaining operations
|
|
799
|
+
* @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
|
|
834
800
|
*/
|
|
835
801
|
(e: 'progress', params: ((event: { source: ProjectModel, total: number, remaining: number, phase: 'storePopulation'|'propagating' }) => void)|string): void
|
|
836
802
|
/**
|
|
837
803
|
* Fires on successful request completion after data gets applied to the stores.
|
|
838
804
|
* @param {string} e Event name
|
|
839
805
|
* @param {object} params Event parameters
|
|
840
|
-
* @param {
|
|
841
|
-
* @param {
|
|
842
|
-
* @param {
|
|
843
|
-
* @param {
|
|
844
|
-
* @param {
|
|
845
|
-
* @param {object} params.
|
|
846
|
-
* @param {
|
|
847
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
848
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
806
|
+
* @param {object} params.event Event object
|
|
807
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
808
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
809
|
+
* @param {object} params.event.response The decoded server response object.
|
|
810
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
811
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
812
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
849
813
|
*/
|
|
850
814
|
(e: 'requestDone', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
851
815
|
/**
|
|
852
816
|
* Fires when a request fails.
|
|
853
817
|
* @param {string} e Event name
|
|
854
818
|
* @param {object} params Event parameters
|
|
855
|
-
* @param {
|
|
856
|
-
* @param {
|
|
857
|
-
* @param {
|
|
858
|
-
* @param {
|
|
859
|
-
* @param {
|
|
860
|
-
* @param {object} params.
|
|
861
|
-
* @param {
|
|
862
|
-
* @param {
|
|
863
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
864
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
819
|
+
* @param {object} params.event Event object
|
|
820
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
821
|
+
* @param {'sync','load'} params.event.requestType The request type (`sync` or `load`).
|
|
822
|
+
* @param {object} params.event.response The decoded server response object.
|
|
823
|
+
* @param {string} params.event.responseText The raw server response text
|
|
824
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
825
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
826
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
865
827
|
*/
|
|
866
828
|
(e: 'requestFail', params: ((event: { source: AbstractCrudManager, requestType: 'sync'|'load', response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
867
829
|
/**
|
|
@@ -869,78 +831,66 @@ const emit = defineEmits<{
|
|
|
869
831
|
* new revision.
|
|
870
832
|
* @param {string} e Event name
|
|
871
833
|
* @param {object} params Event parameters
|
|
872
|
-
* @param {
|
|
873
|
-
* @param {
|
|
874
|
-
* @param {
|
|
875
|
-
* @param {string} params.
|
|
876
|
-
* @param {
|
|
877
|
-
* @param {string} params.params.event.clientId ID of the client instance. Used to distinguish own revisions from the broadcast channel
|
|
878
|
-
* @param {object} params.params.event.changes Object with changes constituting revision
|
|
834
|
+
* @param {object} params.event Event object
|
|
835
|
+
* @param {string} params.event.localRevisionId ID of the local revision. Backend should send it in the broadcast channel
|
|
836
|
+
* @param {string} [params.event.conflictResolutionFor] ID of the revision with a conflict which was resolved by this revision
|
|
837
|
+
* @param {string} params.event.clientId ID of the client instance. Used to distinguish own revisions from the broadcast channel
|
|
838
|
+
* @param {object} params.event.changes Object with changes constituting revision
|
|
879
839
|
*/
|
|
880
840
|
(e: 'revisionNotification', params: ((event: { localRevisionId: string, conflictResolutionFor?: string, clientId: string, changes: object }) => void)|string): void
|
|
881
841
|
/**
|
|
882
842
|
* Fired when the Engine detects a scheduling conflict.
|
|
883
843
|
* @param {string} e Event name
|
|
884
844
|
* @param {object} params Event parameters
|
|
885
|
-
* @param {
|
|
886
|
-
* @param {object} params.
|
|
887
|
-
* @param {
|
|
888
|
-
* @param {object} params.
|
|
889
|
-
* @param {Function} params.
|
|
890
|
-
* @param {
|
|
891
|
-
* @param {Function} params.params.event.schedulingIssue.getResolutions Function to get possible resolutions
|
|
892
|
-
* @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.
|
|
845
|
+
* @param {object} params.event Event object
|
|
846
|
+
* @param {object} params.event.schedulingIssue The conflict details:
|
|
847
|
+
* @param {Function} params.event.schedulingIssue.getDescription Returns the conflict description
|
|
848
|
+
* @param {object[]} params.event.schedulingIssue.intervals Array of conflicting intervals
|
|
849
|
+
* @param {Function} params.event.schedulingIssue.getResolutions Function to get possible resolutions
|
|
850
|
+
* @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.
|
|
893
851
|
*/
|
|
894
852
|
(e: 'schedulingConflict', params: ((event: { schedulingIssue: { getDescription: Function, intervals: object[], getResolutions: Function }, continueWithResolutionResult: Function }) => void)|string): void
|
|
895
853
|
/**
|
|
896
854
|
* Fires on successful [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) completion.
|
|
897
855
|
* @param {string} e Event name
|
|
898
856
|
* @param {object} params Event parameters
|
|
899
|
-
* @param {
|
|
900
|
-
* @param {
|
|
901
|
-
* @param {object} params.
|
|
902
|
-
* @param {
|
|
903
|
-
* @param {object} params.
|
|
904
|
-
* @param {
|
|
905
|
-
* @param {object} params.params.event.requestOptions The request options passed to the request.
|
|
906
|
-
* @param {Response} params.params.event.rawResponse The native Response object
|
|
857
|
+
* @param {object} params.event Event object
|
|
858
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
859
|
+
* @param {object} params.event.response The decoded server response object.
|
|
860
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
861
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
862
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
907
863
|
*/
|
|
908
864
|
(e: 'sync', params: ((event: { source: AbstractCrudManager, response: object, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
909
865
|
/**
|
|
910
866
|
* 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.
|
|
911
867
|
* @param {string} e Event name
|
|
912
868
|
* @param {object} params Event parameters
|
|
913
|
-
* @param {
|
|
914
|
-
* @param {
|
|
915
|
-
* @param {object} params.
|
|
916
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
917
|
-
* @param {object} params.params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
869
|
+
* @param {object} params.event Event object
|
|
870
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
871
|
+
* @param {object} params.event.pack The data package which contains data for all stores managed by the crud manager.
|
|
918
872
|
*/
|
|
919
873
|
(e: 'syncCanceled', params: ((event: { source: AbstractCrudManager, pack: object }) => void)|string): void
|
|
920
874
|
/**
|
|
921
875
|
* Fires after [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) was delayed due to incomplete previous one.
|
|
922
876
|
* @param {string} e Event name
|
|
923
877
|
* @param {object} params Event parameters
|
|
924
|
-
* @param {
|
|
925
|
-
* @param {
|
|
926
|
-
* @param {object} params.
|
|
927
|
-
* @param {Scheduler.crud.AbstractCrudManager} params.params.event.source The CRUD manager.
|
|
928
|
-
* @param {object} params.params.event.arguments The arguments of [sync](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) call.
|
|
878
|
+
* @param {object} params.event Event object
|
|
879
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager.
|
|
880
|
+
* @param {object} params.event.arguments The arguments of [sync](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) call.
|
|
929
881
|
*/
|
|
930
882
|
(e: 'syncDelayed', params: ((event: { source: AbstractCrudManager, arguments: object }) => void)|string): void
|
|
931
883
|
/**
|
|
932
884
|
* Fires when a [sync request](https://bryntum.com/products/schedulerpro/docs/api/Scheduler/crud/AbstractCrudManagerMixin#function-sync) fails.
|
|
933
885
|
* @param {string} e Event name
|
|
934
886
|
* @param {object} params Event parameters
|
|
935
|
-
* @param {
|
|
936
|
-
* @param {
|
|
937
|
-
* @param {object} params.
|
|
938
|
-
* @param {
|
|
939
|
-
* @param {object} params.
|
|
940
|
-
* @param {
|
|
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
|
|
887
|
+
* @param {object} params.event Event object
|
|
888
|
+
* @param {Scheduler.crud.AbstractCrudManager} params.event.source The CRUD manager instance.
|
|
889
|
+
* @param {object} params.event.response The decoded server response object.
|
|
890
|
+
* @param {string} params.event.responseText The raw server response text
|
|
891
|
+
* @param {object} params.event.responseOptions [DEPRECATED] see `requestOptions`
|
|
892
|
+
* @param {object} params.event.requestOptions The request options passed to the request.
|
|
893
|
+
* @param {Response} params.event.rawResponse The native Response object
|
|
944
894
|
*/
|
|
945
895
|
(e: 'syncFail', params: ((event: { source: AbstractCrudManager, response: object, responseText: string, responseOptions: object, requestOptions: object, rawResponse: Response }) => void)|string): void
|
|
946
896
|
}>();
|