GetEventsMixin
Mixin

A mixin containing functionality for retrieving a range of events, mainly used during rendering.

Consumed by EventStore in Calendar, Scheduler & Scheduler Pro and TaskStore in Gantt.

No results

Properties

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

isGetEventsMixin : Booleantrue

READONLY

static

ADVANCED

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

isGetEventsMixin : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

getEventsAsArray( )

private

Internal implementation for getEvents to use when not using dateMap.
getEventsAsMap( )

private

Internal implementation for getEvents to use when using dateMap.
getNextAvailableDateRange( options )
: Object/undefined

This function will find the next available start date where the provided duration fits without causing any conflicts. It begins by checking the provided resources on the provided startDate. And if any conflicting events is found, it restarts searching from the last of the conflicting events and continues like this until a matching time slot is found.
getEventCounts( options )
Returns a Map, keyed by YYYY-MM-DD date keys containing event counts for all the days between the passed startDate and endDate. Occurrences of recurring events are included.

Example:
```
 eventCounts = eventStore.getEventCounts({
     startDate : scheduler.timeAxis.startDate,
     endDate   : scheduler.timeAxis.endDate
 });
```
getEvents( options )
: EventModel[]/Map
Returns an array of events for the date range specified by the startDate and endDate options.

By default, for any date, this includes any event which intersects that date.

To only include events that are fully contained within the date range, pass the allowPartial option as false.

By default, any occurrences of recurring events are included in the resulting array (not applicable in Gantt). If that is not required, pass the includeOccurrences option as false.

Note that if includeOccurrences is true, the start date and end date options are mandatory. The method must know what range of occurrences needs to be generated and returned.

Example:
```
 visibleEvents = eventStore.getEvents({
     resourceRecord : myResource,
     startDate      : scheduler.timeAxis.startDate,
     endDate        : scheduler.timeAxis.endDate
 });
```
isDateRangeAvailable( startDate, endDate, excludeEvent, resourceRecord )
: Boolean

Checks if a date range is available for a given resource.

Note that when asked to check a 0 duration range, any 0 duration events at the same point in time will be considered overlapping.

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

loadDateRange
Fired when a range of events is requested from the getEvents method.

This event fires every time a range of events is requested from the store.

An application may have one of two levels of interest in events being read from a store.
1. To be notified when any event block is requested regardless of what the date range is.
2. To be notified when a new date range is requested.
This event allows both types of application to be written. The changed property is set if a different date range is requested.
```
new Scheduler({
    eventStore : {
        listeners : {
            loadDateRange({ new : { startDate, endDate }, changed }) {
                // Load new data if user is requesting a different time window.
                if (changed) {
                    fetch(...);
                }
            }
        }
    },
    ...
});
```

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onLoadDateRange
Called when a range of events is requested from the getEvents method.

This handler is called every time a range of events is requested from the store.

An application may have one of two levels of interest in events being read from a store.
1. To be notified when any event block is requested regardless of what the date range is.
2. To be notified when a new date range is requested.
This event allows both types of application to be written. The changed property is set if a different date range is requested.
```
new Scheduler({
    eventStore : {
        listeners : {
            loadDateRange({ new : { startDate, endDate }, changed }) {
                // Load new data if user is requesting a different time window.
                if (changed) {
                    fetch(...);
                }
            }
        }
    },
    ...
});
```

Source path

Scheduler/data/mixin/GetEventsMixin.js

Inheritance tree1

GetEventsMixin

GetEventsMixin Mixin