RecurrenceLegend
A static class allowing to get a human readable description of the provided recurrence.
const event = new EventModel({
startDate : new Date(2018, 6, 3),
endDate : new Date(2018, 6, 4)
});
const recurrence = new RecurrenceModel({
frequency : 'WEEKLY',
days : ['MO', 'TU', 'WE']
});
event.recurrence = recurrence;
// "Weekly on Mon, Tue and Wed"
RecurrenceLegend.getLegend(recurrence);
Configs
3
Configs
3Properties
3
Properties
3Class hierarchy
isLocalizableLocalizable
Functions
4
Functions
4Other
getLegendstatic
Returns the provided recurrence description. The recurrence might be assigned to a timespan model, in this case the timespan start date should be provided in the second argument.
| Parameter | Type | Description |
|---|---|---|
recurrenceRecurrence | RecurrenceModel | model. |
timeSpanStartDate | Date | The recurring timespan start date. Can be omitted if the recurrence is assigned to a timespan model (and the timespan has startDate filled). Then start date will be retrieved from the model. |
Returns: String -
The recurrence description.