The type of data stored in the Event class.
The type of metadata stored in the schedule.
Creates a new calendar given a span, type, size, moving functions, and optionally some default properties for the calendar.
The first day on the calendar.
The last day on the calendar.
The calendar type used for describing the calendar and splitting it.
The number of calendar types in this calendar.
The function to move the start day.
The function to move the end by.
The default properties for this calendar.
The array of days in this calendar and their events.
The function (if any) which sorts the events on a calendar day.
The array of scheduled events added to the calendar.
When true events will be added to days "outside" the calendar. Days
outside the calendar are days filled in when Calendar.fill is true.
More specifically days that are in Calendar.filled and not in
Calendar.span.
If the calendar should be filled in so the first day of the calendar is Sunday and the last day is Saturday.
The full span of days represented on the calendar. This may be different
than the Calendar.span when Calendar.fill is true and the
calendar is representing months or years and the days need to start on
Sunday and end on Saturday.
The number of days in the calendar specified by Calendar.span.
When true an event instance will be created for each time specified on
the schedule. If the schedule specifies an all day event then only one
event is added to a day. This is typically done when displaying days or
weeks and events can be displayed on a timeline.
The minimum number of days in the calendar no matter what the type or size is. This can be used to display a month with a constant number of weeks - because not all months contain the same number of weeks.
The function used to move the end day of the calendar when functions like Calendar.next or Calendar.prev are called.
The function used to move the start day of the calendar when functions like Calendar.next or Calendar.prev are called.
A function to use when parsing meta input into the desired type.
A function to use when parsing meta input into the desired type.
When true a CalendarEvent instance exists on each CalendarDay
the event covers even if the event didn't start on that day.
A selection of days on the calendar. If no days are selected this is null.
This is merely used to keep the selection flags in CalendarDay updated
via Calendar.refreshSelection.
The size of the calendar. When the calendar type is...
The span of days in the calendar.
The type of calendar.
When true CalendarEvent.col will be set so when visually displaying
the event based on start and end time any events that overlap with each
other will be "indented" to see the event below it.
When true CalendarEvent.row will be set so when visually displaying
the event with others multi-day events will align and not overlap.
The array of visible events on the calendar. This is built based on the span of the schedule in the given event and also the Event.visible flag.
Returns the end day of the calendar. If this calendar is filled, this may not represent the very last day in the calendar.
Returns the start day of the calendar. If this calendar is filled, this may not represent the very first day in the calendar.
Adds the given event to this calendar if it doesn't exist already (or
allowDuplicates is true).
The event to add to the calendar.
If an event can be added more than once.
When true the Calendar.refreshEvents will not be
called after the event is added.
Adds the given events to this calendar if they don't exist already (or
allowDuplicates is true).
The events to add to the calendar.
If an event can be added more than once.
When true the Calendar.refreshEvents will not be
called after the events are added.
Returns the events for the given day optionally looking at schedule times, optionally looking at events which cover multiple days, and optionally sorted with the given function.
The day to find events for.
When true an event is added to the result for each time
specified in the schedule.
When true events which don't start on the given day but do
overlap are added to the result.
The function to sort the events by, if any.
An array of events that occurred on the given day.
Finds the event given one of the ways to identify the event.
The refrence to the event or null if not found.
Gets the calendar day for the given day.
The day to get the calendar day for.
The reference to the calendar day, or null if the given input is not on this calendar.
Iterates over all days in this calendar and passes each day to iterator.
Shifts the calendar days by the given amount.
The amount to shift the calendar by.
When true Calendar.refresh will not be called
after calendar is moved.
Moves the calenndar to the next set of days.
The amount to shift the calendar by.
When true Calendar.refresh will not be called
after calendar is moved.
Moves the calenndar to the previous set of days.
The amount to shift the calendar by.
When true Calendar.refresh will not be called
after calendar is moved.
Refreshes the days and events in this calendar based on the start and end days, the calendar properties, and its eventss.
The current day to update the calendar days via CalendarDay.updateCurrent.
Refreshes the CalendarEvent.col property as described in the link.
Updates the days with the current day via CalendarDay.updateCurrent.
The new current day.
Updates the CalendarDay.events based on the events in this calendar and the following properties:
Refreshes the CalendarEvent.row property as described in the link.
Updates the selection flags in CalendarDay based on the Calendar.selection property.
Updates the list of visible schedules.
Removes the given event if it exists on the calendar.
The event to remove if it exists.
When true the Calendar.refreshEvents will not be
called after the event is removed.
Removes the list of events if they exist in the calendar.
The array of events to remove if they exist. If no
events are passed (via null) then all events will be removed
from the calendar.
When true the Calendar.refreshEvents will not be
called after the events are removed.
Updates Calendar.days to match the span of days in the calendar.
Updates the Calendar.filled span based on Calendar.start, Calendar.end, and Calendar.fill properties.
Changes the calendar possibly morphing it to a different type or size if specified in the given input. If the type and size are not morphed then the following properties may be updated:
If CalendarInput.delayRefresh is not given with true then
Calendar.refresh will be called once the calendar properties have been
updated.
The new properties for this calendar to overwrite with.
Sets the given events to this calendar replacing the current list of events.
The events to set to the calendar.
When true the Calendar.refreshEvents will not be
called after the events are added.
Splits up this calendar into an iterable collection of calendars. The
resulting iterator will return size / by number of calendars.
The new size of the resulting calendars. If the the size of the current calendar is not divisible by this value the resulting calendars may cover more or less than this calendar covers.
An iterator for the calendars produced.
Returns the summary of the span of time this calendar represents.
Converts this calendar to input which can be used to later recreate this calendar. The only properties of the calendar which will be loss is the Calendar.eventSorter property because it is a function.
A function to convert Event.data to a plain object if it is not already.
A function to convert values in Schedule.meta to plain objects if they are not alreday.
The input generated from this calendar.
Sets the selection of the calendar to nothing.
Sets the Calendar.eventsOutside value and returns this for method
chaining.
The new value.
Sets the Calendar.listTimes value and returns this for method
chaining.
The new value.
Sets the Calendar.minimumSize value and returns this for method
chaining.
The new value.
Sets the Calendar.repeatCovers value and returns this for method
chaining.
The new value.
Sets the Calendar.updateColumns value and returns this for method
chaining.
The new value.
If the columns should be updated now if updateColumns is
true.
Sets the Calendar.updateRows value and returns this for method
chaining.
The new value.
If the rows should be updated now if updateRows is true.
Creates a calendar based around days optionally focused around a given day.
The number of days in the calendar.
The day to focus the calendar on.
The value which describes how days are added around the given
day. The default value will center the calendar around the given day.
When the value is 0 the given day is the first day in the calendar,
and when the value is 1 the given day is the last day in the calendar.
The default properties for the calendar.
A new calendar instance.
Creates a calendar based around a given unit optionally focused around a given day.
The unit of the calendar.
The day to focus the calendar on.
The value which describes how months are added around the given
day. The default value will center the calendar around the given day.
When the value is 0 the given day is the first day in the calendar,
and when the value is 1 the given day is the last day in the calendar.
The default properties for the calendar.
A new calendar instance.
Creates a calendar based on the given input.
The input which has at least the type specified.
A new calendar instance.
Creates a calendar based around months optionally focused around a given day.
The day to focus the calendar on.
The value which describes how months are added around the given
day. The default value will center the calendar around the given day.
When the value is 0 the given day is the first day in the calendar,
and when the value is 1 the given day is the last day in the calendar.
The default properties for the calendar.
A new calendar instance.
Creates a calendar based around weeks optionally focused around a given day.
The day to focus the calendar on.
The value which describes how weeks are added around the given
day. The default value will center the calendar around the given day.
When the value is 0 the given day is the first day in the calendar,
and when the value is 1 the given day is the last day in the calendar.
The default properties for the calendar.
A new calendar instance.
Creates a calendar based around years optionally focused around a given day.
The day to focus the calendar on.
The value which describes how years are added around the given
day. The default value will center the calendar around the given day.
When the value is 0 the given day is the first day in the calendar,
and when the value is 1 the given day is the last day in the calendar.
The default properties for the calendar.
A new calendar instance.
A map of functions and properties by Units used to create or morph Calendars.
Generated using TypeDoc
A collection of CalendarDays, the events on the calendar, and all CalendarEvents generated based on the events.