v7.3.0

RecurringTimeSpansMixin
Mixin

This mixin provides recurrence functionality to a store containing TimeSpan models. Normally you don't need to interact with this mixin directly.

No results

Configs

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

autoAdjustRecurrence : Booleanfalse

When a recurring event base is rescheduled, the new start date may not conform with the recurrence pattern if for example certain weekdays are selected, such as to repeat every Monday.

By default, changing the startDate to a date that is not visited by the recurrence pattern does not recalculate that pattern. It merely changes the date at which that pattern begins.

So if an event is explicitly configured to repeat every Monday (The recurrenceRule contains BYDAY=MO) and the base event is changed by any means to have its startDate on the following Tuesday, visually, the effect would be that the base event "disappears" and the following occurrences do not move.

The recurrence pattern still repeats every Monday. It's just that the pattern is calculated starting from a different date.

To have a rescheduling change to a recurring event base recalculate the recurrence pattern to conform to the new start date - to include that date in the pattern - configure autoAdjustRecurrence as true

Has a corresponding runtime autoAdjustRecurrence property.

Properties

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

isRecurringTimeSpansMixin : Booleantrue

READONLY

static

ADVANCED

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

autoAdjustRecurrence : Booleanfalse

When a recurring event base is rescheduled, the new start date may not conform with the recurrence pattern if for example certain weekdays are selected, such as to repeat every Monday.

By default, changing the startDate to a date that is not visited by the recurrence pattern does not recalculate that pattern. It merely changes the date at which that pattern begins.

So if an event is explicitly configured to repeat every Monday (The recurrenceRule contains BYDAY=MO) and the base event is changed by any means to have its startDate on the following Tuesday, visually, the effect would be that the base event "disappears" and the following occurrences do not move.

The recurrence pattern still repeats every Monday. It's just that the pattern is calculated starting from a different date.

To have a rescheduling change to a recurring event base recalculate the recurrence pattern to conform to the new start date - to include that date in the pattern - configure autoAdjustRecurrence as true

Has a corresponding autoAdjustRecurrence config.
isRecurringTimeSpansMixin : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

onDataChange( event )

private

Responds to mutations of the underlying storage Collection.

Maintain indices for fast finding of events by date.
allIndexOf( recordOrId )
: Number

internal

Returns the index of the specified record in the full (unfiltered) dataset.

Overrides the base implementation to resolve occurrences: if an occurrence of a recurring timespan is passed, the lookup is performed against its base recurring timespan instead, since occurrences are never added to the store directly.
getOccurrencesForTimeSpan( )

private

Builds occurrences for the provided timespan across the provided date range.
getRecurringTimeSpans( )
: TimeSpan[]

Returns all the recurring timespans.
isRecurrenceRelatedFieldChange( timeSpan, wasSet )
: Boolean

internal

The method restricts which field modifications should trigger timespan occurrences building. By default, any field change of a recurring timespan causes the rebuilding.

Source path

Scheduler/data/mixin/RecurringTimeSpansMixin.js

Inheritance tree1

RecurringTimeSpansMixin

Contents