EventStoreMixin
Mixin

This is a mixin, containing functionality related to managing events.

It is consumed by the regular EventStore class and the Scheduler Pro's EventStore class.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

removeUnassignedEvent : Booleantrue

Configure with true to also remove the event when removing the last assignment from the linked AssignmentStore. This config has no effect when using EventStore in legacy resourceId-mode.
singleAssignment : Boolean
Configure with true to force single-resource mode, an event can only be assigned to a single resource. If not provided, the mode will be inferred from
1. presence of an assignment store (i.e. multi-assignment)
2. presence of resourceId in the event store data (i.e. single assignment mode)
loadPriority : Number

private

CrudManager must load stores in the correct order. Lowest first.
syncPriority : Number

private

CrudManager must sync stores in the correct order. Lowest first.
lazyLoad : Boolean/Object
If set to true, or a config object, this makes the store load new records when needed. When a record that is not already loaded is requested, the requestData function is called. Please read the guide to learn more on how to configure lazy loading.
Parameters
- bufferUnit : DurationUnit
  
  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.
- bufferAmount : Number
  
  See bufferUnit
- dateFormat : String
  
  The format used to convert startDate and endDate parameters passed to the load request querystring. Defaults to YYYY-MM-DD (e.g. 2024-03-11). Only used if a readUrl is configured on the store. See DateHelper for details about formatting dates.
- loadFullResourceRange : Boolean
  
  If the ResourceStore is not lazy loaded, set this to true to load events, assignments and/or resource time ranges for all resources with every load request.
- useResourceIds : Boolean
  
  Set to true to always provide resourceIds in the request params, instead of a resource startIndex and count

Properties

Properties are getters/setters or publicly accessible variables on this class

isEventStoreMixin : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of EventStoreMixin class, or subclass thereof.

isEventStoreMixin : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of EventStoreMixin class, or subclass thereof.
data : EventModelConfig
Applies a new dataset to the EventStore. Use it to plug externally fetched data into the store.

NOTE: Dates, durations and relations (assignments, resources) on the events are determined async by a calculation engine. Thus they cannot be directly accessed after assigning the new dataset.

For example:
```
eventStore.data = [{ startDate, duration }];
// eventStore.first.endDate is not yet calculated
```
To guarantee data is in a calculated state, wait for calculations for finish:
```
eventStore.data = [{ startDate, duration }];
await eventStore.project.commitAsync();
// eventStore.first.endDate is calculated
```
Alternatively use loadDataAsync() instead:
```
await eventStore.loadDataAsync([{ startDate, duration }]);
// eventStore.first.endDate is calculated
```
modelClass : EventModel

Class used to represent records. Defaults to class EventModel.

Functions

Functions are methods available for calling on the class

assignEventToResource( event, resource, removeExistingAssignmentsfalse )
: AssignmentModel[]

Creates and adds assignment record for a given event and a resource.
getAssignmentsForEvent( event )
: AssignmentModel[]

Returns all assignments for a given event.
getAssignmentsForResource( resource )
: AssignmentModel[]

Returns all assignments for a given resource.
isEventAssignedToResource( event, resource )
: Boolean

Checks whether an event is assigned to a resource.
reassignEventFromResourceToResource( event, oldResource, newResource )

Reassigns an event from an old resource to a new resource
removeAssignmentsForEvent( event )

Removes all assignments for given event
removeAssignmentsForResource( resource )

Removes all assignments for given resource
unassignEventFromResource( event, resource )

Removes assignment record for a given event and a resource.
add( records, silent )
: EventModel[]
Add events to the store.

NOTE: Dates, durations and references (assignments, resources) on the events are determined async by a calculation engine. Thus they cannot be directly accessed after using this function.

For example:
```
eventStore.add({ startDate, duration });
// endDate is not yet calculated
```
To guarantee data is in a calculated state, wait for calculations for finish:
```
eventStore.add({ startDate, duration });
await eventStore.project.commitAsync();
// endDate is calculated
```
Alternatively use addAsync() instead:
```
await eventStore.addAsync({ startDate, duration });
// endDate is calculated
```
addAsync( records, silent )
: EventModel[]

ASYNC
Add events to the store and triggers calculations directly after. Await this function to have up to date data on the added events.
```
await eventStore.addAsync({ startDate, duration });
// endDate is calculated
```
append( record )

Appends a new record to the store
loadDataAsync( data )
: Promise

ASYNC
Applies a new dataset to the EventStore and triggers calculations directly after. Use it to plug externally fetched data into the store.
```
await eventStore.loadDataAsync([{ startDate, duration }]);
// eventStore.first.endDate is calculated
```
forEachScheduledEvent( fn, thisObj )
Calls the supplied iterator function once for every scheduled event, providing these arguments
- event : the event record
- startDate : the event start date
- endDate : the event end date
Returning false cancels the iteration.
getTotalTimeSpan( )
: Object

Returns an object defining the earliest start date and the latest end date of all the events in the store.
isEventPersistable( event )
: Boolean

Checks if given event record is persistable. By default it always is, override EventModels isPersistable if you need custom logic.
filterEventsForResource( resource, fn, thisObj )
: EventModel[]

private

Filters the events associated with a resource, based on the function provided. An array will be returned for those events where the passed function returns true.
getEventsForResource( resource )
: EventModel[]

Returns all events assigned to a resource. NOTE: this does not include occurrences of recurring events. Use the getEvents API to include occurrences of recurring events.
getResourcesForEvent( event )
: ResourceModel[]

Returns all resources assigned to an event.
requestData( options )
: Promise

ASYNC
In an EventStore or ResourceTimeRangeStore which is configured with lazyLoad, the function provided here is called when a combination of the visible date range and the visible range of resources has not yet been loaded. If the ResourceStore is not configured with lazyLoad, the resource range will include all the loaded resources. When implementing this, it is expected that what is returned is an object with a data property containing the records from startDate to endDate for a range of resources starting at startIndex and with the length specified in the count param.

Base implementation does nothing, either use AjaxStore which implements it, or create your own subclass with an implementation.
```
class MyEventStore extends EventStore {
   async requestData(params){
      const response = await fetch('https://api.bryntum.com/events/?' + new URLSearchParams(params));
      return await response.json();
   }
}
```
unload( options )

Only available if the store is configured as lazyLoad.

The records matching the provided parameters will be removed from the Store and reloaded the next they are needed.

Provide an array of records or record ids, or provide a combination of resource records (or ids) and/or a date range. Do not combine the records params with the resources and startDate and endDate params.

Source path

Scheduler/data/mixin/EventStoreMixin.js

Inheritance tree1

EventStoreMixin

EventStoreMixin Mixin