RecurringEvents
Mixin

A mixin that adds functionality related to recurring events to the Scheduler and Calendar widgets.

The main purpose of the code in here is displaying a special confirmation when the user interacts with recurring events and their occurrences (via drag-drop/resize/delete etc.). See this in action in the recurrence demo found in Calendar and Scheduler.

Recurring event data structure

Recurring timespans can have a recurrenceRule specified defining the repetition pattern (based on the RFC-5545. You can also provide exceptionDates to the data to exclude certain dates. See sample data below for an event record which repeats weekly on Tuesdays and Thursdays at 12pm-1pm (except March 28, 2024).

{
    id: 7,
    startDate: '2021-10-12T12:00:00',
    endDate: '2021-10-12T13:00:00',
    name: 'Lunch',
    resourceId: 123,
    recurrenceRule: 'FREQ=WEEKLY;BYDAY=TU,TH',
    exceptionDates: ['2024-03-28']
}

To enable this functionality in the Scheduler, set enableRecurringEvents to true.

Configs

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

recurrenceConfirmationPopup : RecurrenceConfirmationPopupConfig

The confirmation dialog shown when a recurring event is edited.

The user is given the opportunity to either change just the occurrence being edited, or all occurrences from that point onwards.

The {Scheduler.view.recurrence.RecurrenceConfirmationPopup} may be reconfigured from its default configuration by specifying a config object here.

Has a corresponding runtime recurrenceConfirmationPopup property.
enableRecurringEvents : Boolean/Objectfalse
Enables showing occurrences of recurring events across the scheduler's time axis. If you want to disable the recurrence popup, you can choose set the defaultAction to future to affect all future occurrences, or single to just affect the currently selected event.

Enables extra recurrence UI fields in the system-provided event editor (not in Scheduler Pro's task editor).
- defaultAction : 'single'/'future'
  Default action

Properties

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

isRecurringEvents : Booleantrue

READONLY

static

ADVANCED

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

recurrenceConfirmationPopup : RecurrenceConfirmationPopupConfig

The confirmation dialog shown when a recurring event is edited.

The user is given the opportunity to either change just the occurrence being edited, or all occurrences from that point onwards.

The {Scheduler.view.recurrence.RecurrenceConfirmationPopup} may be reconfigured from its default configuration by specifying a config object here.

Has a corresponding recurrenceConfirmationPopup config.
isRecurringEvents : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

removeEvents( eventRecords, callback )
: Boolean

internal

ASYNC

Internal utility function to remove events. Used when pressing Delete or Backspace or when clicking the delete button in the event editor. Triggers a preventable beforeEventDelete or beforeAssignmentDelete event.

This function is asynchronous because it potentially has to show a RecurrenceConfirmationPopup which prompts the user to confirm the operation.

In these cases, the Promise is resolved when the user clicks the desired outcome.

Triggers: beforeEventDelete, beforeAssignmentDelete
getOccurrencesFor( recurringEvent )
: TimeSpan[]

Returns occurrences of the provided recurring event across the date range of this Scheduler.

Events

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

beforeAssignmentDelete

ASYNC

PREVENTABLE
Fires before an assignment is removed. Can be triggered by user pressing Delete or Backspace or by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which case records should be "manually" removed after confirmation.

Note that the handler must be async to be able to await the confirmation dialog and must return false to immediately veto the removal.
```
scheduler.on({
    async beforeAssignmentDelete() {
        const result = await MessageDialog.confirm({
            title   : 'Please confirm',
            message : 'Do you want to delete this assignment?'
        });
        // Return false to prevent default onward processing if user does not confirm
        return (result === MessageDialog.yesButton);
    }
});
```
beforeEventDelete

ASYNC

PREVENTABLE
Fires before an event is removed. Can be triggered by user pressing Delete or Backspace or by the event editor. Return false to immediately veto the removal (or a Promise yielding true or false for async vetoing).

Can for example be used to display a custom dialog to confirm deletion, in which case records should be "manually" removed after confirmation:
```
scheduler.on({
    async beforeEventDelete() {
        const result = await MessageDialog.confirm({
            title   : 'Please confirm',
            message : 'Do you want to delete this task?'
        });
        // Return false to prevent default onward processing if user does not confirm
        return (result === MessageDialog.yesButton);
    }
});
```

Event handlers

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

onBeforeAssignmentDelete

ASYNC

PREVENTABLE
Called before an assignment is removed. Can be called by user pressing Delete or Backspace or by the event editor. Can for example be used to display a custom dialog to confirm deletion, in which case records should be "manually" removed after confirmation.

Note that the handler must be async to be able to await the confirmation dialog and must return false to immediately veto the removal.
```
scheduler.on({
    async beforeAssignmentDelete() {
        const result = await MessageDialog.confirm({
            title   : 'Please confirm',
            message : 'Do you want to delete this assignment?'
        });
        // Return false to prevent default onward processing if user does not confirm
        return (result === MessageDialog.yesButton);
    }
});
```
onBeforeEventDelete

ASYNC

PREVENTABLE
Called before an event is removed. Can be called by user pressing Delete or Backspace or by the event editor. Return false to immediately veto the removal (or a Promise yielding true or false for async vetoing).

Can for example be used to display a custom dialog to confirm deletion, in which case records should be "manually" removed after confirmation:
```
scheduler.on({
    async beforeEventDelete() {
        const result = await MessageDialog.confirm({
            title   : 'Please confirm',
            message : 'Do you want to delete this task?'
        });
        // Return false to prevent default onward processing if user does not confirm
        return (result === MessageDialog.yesButton);
    }
});
```

Source path

Scheduler/view/mixin/RecurringEvents.js

Demo

examples/recurrence

Inheritance tree1

RecurringEvents

RecurringEvents
Mixin

Recurring event data structure

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree1

Contents

RecurringEvents Mixin

Recurring event data structure

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree1

Contents

RecurringEvents
Mixin