Fullcalendar

(part of package 'Fullcalendar Component') Extends designtime/SolutionModel: JSWebComponent Extends runtime: RuntimeWebComponent

The FullCalendar component is a Titanium Client wrapper around https://fullcalendar.io/. Note that some features require a premium FullCalendar license.

See https://fullcalendar.io/docs for more details.

This is a reference page; many components have detailed usage guides here.

Properties

styleClass

CSS class to be applied to the calendar container element. Type: Styleclass

---

themeSystem

Determines which theme system to use for styling the calendar. Type: String Default Value: "standard"

---

tooltipExpression

The text expression to be shown as tooltip when hovering over the calendar events. Type: Tagstring

---

Events

onDateClickMethodID(date,dateStr,dayEl,jsEvent,view,resource)

onDateClickMethodID will be called when the user clicks on a date or a time.

Parameters:

• {Date} date The clicked date.
• {String} dateStr The string representation of the clicked date.
• {Object} dayEl The DOM element representing the clicked day.
• {JSEvent} jsEvent The event object associated with the click.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.
• {CustomType<svy-fullcalendar2.ResourceObject>} [resource] Optional resource associated with the clicked date.

---

onDateDblClickMethodID(date,dateStr,dayEl,jsEvent,view,resource)

onDateClickMethodID will be called when the user double clicks on a date or a time.

Parameters:

• {Date} date The double-clicked date.
• {String} dateStr The string representation of the double-clicked date.
• {Object} dayEl The DOM element representing the clicked day.
• {JSEvent} jsEvent The event object associated with the double-click.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.
• {CustomType<svy-fullcalendar2.ResourceObject>} [resource] Optional resource associated with the clicked date.

---

onDatesSetMethodID(start,end,startStr,endStr,timeZone,view)

onDatesSetMethodID will be called after the calendar’s date range has been initially set or changed in some way and the DOM has been updated.

Parameters:

• {Date} start The start date of the current view.
• {Date} end The end date of the current view.
• {String} startStr The string representation of the start date.
• {String} endStr The string representation of the end date.
• {String} timeZone The time zone used by the calendar.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onDropMethodID(allDay,date,dateStr,draggedElement,jsEvent,resource,view)

onDropMethodID will be called when an external draggable element or an event from another calendar has been dropped onto the calendar.

Parameters:

• {Boolean} allDay Indicates if the drop is for an all-day event.
• {Date} date The date where the drop occurred.
• {String} dateStr The string representation of the drop date.
• {Object} draggedElement The DOM element that was dragged.
• {JSEvent} jsEvent The event object associated with the drop.
• {CustomType<svy-fullcalendar2.ResourceObject>} resource Optional resource associated with the drop.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventAddMethodID(event,relatedEvents)

onEventAddMethodID will be called after an event has been added to the calendar.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The added event.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.

Returns: {Boolean}

---

onEventChangeMethodID(event,oldEvent,relatedEvents)

onEventChangeMethodID will be called after an event has been modified in some way.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The modified event.
• {CustomType<svy-fullcalendar2.EventObject>} oldEvent The event state prior to modification.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.

Returns: {Boolean}

---

onEventClickMethodID(event,jsEvent,view)

onEventClickMethodID will be called when the user clicks an event.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The clicked event.
• {JSEvent} jsEvent The event object associated with the click.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventDblClickMethodID(event,jsEvent,view)

onEventDblClickMethodID will be called when the user dbl click an event.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The double-clicked event.
• {JSEvent} jsEvent The event object associated with the double-click.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventDragStartMethodID(event,jsEvent,view)

onEventDragStartMethodID will be called when event dragging begins.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event being dragged.
• {JSEvent} jsEvent The event object associated with the drag start.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventDragStopMethodID(event,jsEvent,view)

onEventDragStopMethodID will be called when event dragging stops.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event that was dragged.
• {JSEvent} jsEvent The event object associated with the drag stop.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventDropMethodID(event,relatedEvents,oldEvent,oldResource,newResource,delta,jsEvent,view)

onEventDropMethodID will be called when dragging stops and the event has moved to a different day/time.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event that was dropped.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.
• {CustomType<svy-fullcalendar2.EventObject>} oldEvent The event state before the drop.
• {CustomType<svy-fullcalendar2.ResourceObject>} oldResource The resource before the drop.
• {CustomType<svy-fullcalendar2.ResourceObject>} newResource The resource after the drop.
• {Number} delta The time change due to the drop.
• {JSEvent} jsEvent The event object associated with the drop.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

Returns: {Boolean}

---

onEventLeaveMethodID(event,relatedEvents,draggedElement,view)

onEventLeaveMethodID will be called when on a calendar when one if its events is about to be dropped onto another calendar.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event that is leaving.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.
• {Object} draggedElement The DOM element being dragged.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

Returns: {Boolean}

---

onEventMouseEnterMethodID(element,eventObject,jsEvent,view)

onEventMouseEnterMethodID will be called when the user mouses over an event. Similar to the native mouseenter.

Parameters:

• {Object} element
• {CustomType<svy-fullcalendar2.EventObject>} eventObject
• {JSEvent} jsEvent
• {CustomType<svy-fullcalendar2.ViewType>} view

---

onEventMouseLeaveMethodID(element,event,jsEvent,view)

onEventMouseLeaveMethodID will be called when the user mouses out of an event. Similar to the native mouseleave.

Parameters:

• {Object} element
• {CustomType<svy-fullcalendar2.EventObject>} event
• {JSEvent} jsEvent
• {CustomType<svy-fullcalendar2.ViewType>} view

---

onEventReceiveMethodID(event,relatedEvents,draggedElement,view)

onEventReceiveMethodID will be called when an external draggable element with associated event data was dropped onto the calendar. Or an event from another calendar.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The dropped event.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.
• {Object} draggedElement The DOM element that was dragged.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

Returns: {Boolean}

---

onEventRemoveMethodID(event,relatedEvents)

onEventRemoveMethodID will be called after an event has been removed from the calendar.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The removed event.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.

Returns: {Boolean}

---

onEventResizeMethodID(event,relatedEvents,oldEvent,endDateDelta,startDateDelta,jsEvent,view)

onEventResizeMethodID will be called when resizing stops and the event has changed in duration.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The resized event.
• {Array<CustomType<svy-fullcalendar2.EventObject>>} relatedEvents Array of related events.
• {CustomType<svy-fullcalendar2.EventObject>} oldEvent The event state before resizing.
• {Number} endDateDelta The change in the event's end date.
• {Number} startDateDelta The change in the event's start date.
• {JSEvent} jsEvent The event object associated with the resize.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

Returns: {Boolean}

---

onEventResizeStartMethodID(event,jsEvent,view)

onEventResizeStartMethodID will be called when event resizing begins.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event being resized.
• {JSEvent} jsEvent The event object associated with the resize start.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventResizeStopMethodID(event,jsEvent,view)

onEventResizeStopMethodID will be called when event resizing stops.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event that was resized.
• {JSEvent} jsEvent The event object associated with the resize stop.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onEventRightClickMethodID(event,jsEvent,view)

onEventRightClickMethodID will be called when the user right-clicks an event.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} event The event object that was right-clicked.
• {JSEvent} jsEvent The JavaScript event object associated with the right-click.
• {CustomType<svy-fullcalendar2.ViewType>} view The current view object of the calendar.

---

onEventsSetMethodID(events)

onEventsSetMethodID will be called after event data is initialized OR changed in any way.

Parameters:

• {Array<CustomType<svy-fullcalendar2.EventObject>>} events Array of current events.

---

onLoadingMethodID(isLoading)

onLoadingMethodID will be called when event or resource fetching starts/stops.

Parameters:

• {Boolean} isLoading Indicates if the calendar is currently loading data.

---

onMouseEnter(eventObject,jsEvent,view)

onMouseEnter will be called when the user mouses over an event. Similar to the native mouseenter.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} eventObject The event object being hovered.
• {JSEvent} jsEvent The event object associated with the hover.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onMouseLeave(eventObject,jsEvent,view)

onMouseLeave will be called when the user mouses out of an event. Similar to the native mouseleave.

Parameters:

• {CustomType<svy-fullcalendar2.EventObject>} eventObject The event object being hovered.
• {JSEvent} jsEvent The event object associated with the hover.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onNavLinkDayClickMethodID(date,jsEvent)

onNavLinkDayClickMethodID when navLinks setting is true, will be called when the user clicks on a day. onDateClickMethodID will not be called in this scenario.

Parameters:

• {Date} date The clicked date.
• {JSEvent} jsEvent The event object associated with the click.

---

onNavLinkWeekClickMethodID(date,jsEvent)

onNavLinkWeekClickMethodID when navLinks setting is true, will be called when the user clicks on a week.

Parameters:

• {Date} date The clicked week date.
• {JSEvent} jsEvent The event object associated with the click.

---

onResourceAddMethodID(resource)

onResourceAddMethodID will be called after a resource has been added to the calendar.

Parameters:

• {CustomType<svy-fullcalendar2.ResourceObject>} resource The added resource.

Returns: {Boolean}

---

onResourceChangeMethodID(oldResource,newResource)

onResourceChangeMethodID will be called after a resource has been modified in some way.

Parameters:

• {CustomType<svy-fullcalendar2.ResourceObject>} oldResource The resource before modification.
• {Object} newResource The new resource data.

Returns: {Boolean}

---

onResourceRemoveMethodID(resource)

onResourceRemoveMethodID will be called after a resource has been removed from the calendar.

Parameters:

• {CustomType<svy-fullcalendar2.ResourceObject>} resource The removed resource.

Returns: {Boolean}

---

onResourcesSetMethodID(resources)

onResourcesSetMethodID will be called after resource data is initialized OR changed in any way.

Parameters:

• {Array<CustomType<svy-fullcalendar2.ResourceObject>>} resources Array of current resources.

---

onSelectMethodID(start,end,startStr,endStr,allDay,jsEvent,view,resource)

onSelectMethodID will be called when a date/time selection is made.

Parameters:

• {Date} start The start date/time of the selection.
• {Date} end The end date/time of the selection.
• {String} startStr The string representation of the start date/time.
• {String} endStr The string representation of the end date/time.
• {Boolean} allDay Indicates if the selection is for an all-day event.
• {JSEvent} jsEvent The event object associated with the selection.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.
• {CustomType<svy-fullcalendar2.ResourceObject>} [resource] Optional resource associated with the selection.

---

onUnselectMethodID(jsEvent,view)

onUnselectMethodID will be called when the current selection is cleared.

Parameters:

• {JSEvent} jsEvent The event object associated with the unselect action.
• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onViewDidMountMethodID(view)

onViewDidMountMethodID will be called right after the view has been added to the DOM.

Parameters:

• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onViewWillUnmountMethodID(view)

onViewWillUnmountMethodID will be called right before the view will be removed from the DOM.

Parameters:

• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

onWindowResizeMethodID(view)

onWindowResizeMethodID will be called after the calendar’s dimensions have been changed due to the browser window being resized.

Parameters:

• {CustomType<svy-fullcalendar2.ViewType>} view The current calendar view.

---

API

addEvent(event,source)

Adds an event to calendar.

Parameters:

• {CustomType<svy-fullcalendar2.EventParsing>} event The event object to be added to the calendar.
• {Object} [source] The source object specifying the origin of the event (e.g., a specific event source).

Returns: CustomType<svy-fullcalendar2.EventObject> The newly added event object.

---

addEventSource(source)

Dynamically adds an event source.

Parameters:

• {CustomType<svy-fullcalendar2.FunctionEventSource>} source The event source object to add to the calendar.

---

addResource(resource,scrollTo)

Allows programmatic rendering of a new resource on the calendar after the initial set of resources has already been displayed.

Parameters:

• {CustomType<svy-fullcalendar2.ResourceObject>} resource The resource object to be added.
• {Boolean} [scrollTo] Whether to scroll to the newly added resource.

---

batchRendering(func)

A way to group operations that cause rerenders.

Parameters:

• {Function} func The function containing the operations to group together.

---

changeView(viewName,dateOrRange)

Gets the View Object for the current view.

Parameters:

• {String} viewName The name of the view to switch to (e.g., 'dayGridMonth', 'timeGridWeek').
• {Object} [dateOrRange] Optional date or date range to navigate to within the specified view.

---

destroy()

Restores the container element to the state before FullCalendar was initialized.

---

formatDate(date,settings)

A method that formats a date into a string. It inherits the locale and time zone settings of the calendar it’s called on.

Parameters:

• {Object} date The date object to be formatted.
• {Object} settings An object containing formatting settings, such as locale and time zone preferences.

Returns: String The formatted date string based on the provided settings.

---

formatIso(date,omitTime)

Formats a date into an ISO8601 string. Outputs a UTC offset appropriate to the calendar it’s called on.

Parameters:

• {Object} date The date to format.
• {Boolean} [omitTime] Whether to omit the time portion from the formatted string.

Returns: String The formatted ISO8601 date string.

---

formatRangeCalendar(start,end,settings)

Formats two dates, a start and an end, into a string.

settings is an object that holds any of the date format config options. It also accepts the following additional properties: separator — what will be inserted between the two dates. a ' - ' by default isExclusive — if true, the given end date will be considered the exclusive end of the range, meaning date just before the end will be rendered instead. Useful if you need to format an exclusive-end whole-day range.

Parameters:

• {Object} start The start date of the range to format.
• {Object} end The end date of the range to format.
• {Object} settings An object containing formatting settings and options.

Returns: String The formatted date range string.

---

formatRangeEvent(eventID,formatConfig)

Formats an event’s dates into a string.

Accepts a date formatter.

If the event doesn’t have an end, then the start will be formatted alone.

Parameters:

• {String} eventID The unique identifier of the event.
• {Object} formatConfig Configuration for formatting the dates (e.g., date format, locale).

---

fullCalendar(calendarOptions,renderOnCurrentView)

Initializes the FullCalendar component with the specified configuration options. If the calendar has already been initialized and any configuration options have changed, the calendar will be destroyed and re-rendered with the updated options.

Example:

 @type {svy-fullcalendar.FullCalendarOptions} var options = { eventSources: [ {events: [{ title: "lunch event", start: new Date() }]}], selectable: true, editable: true, initialView: 'dayGridMonth', } elements.fullcalendarElementName.fullCalendar(options);

**Parameters:**

> - {[CustomType\<svy\-fullcalendar2\.FullCalendarOptions\>](#fullcalendaroptions)} calendarOptions                The configuration options for the FullCalendar component\.                 These options include properties for event sources, calendar behavior, styling, and views\.                 Refer to the FullCalendar documentation for the complete list of options\.
> - {[Boolean](../../../servoycore/dev-api/js-lib/boolean.md)} [renderOnCurrentView]                Indicates whether the calendar should re\-render in the current view when the configuration is updated\.                 If false, the calendar will reset to the default view\.

***

### getCalendarEvents\(\)

Getter for all calendar events\.

**Returns:** [Array\<CustomType\<svy\-fullcalendar2\.EventObject\>\>](#eventobject) An array containing all event objects currently displayed in the calendar\. 
***

### getChildren\(id\)

Returns a list of a resource’s child resources\.

**Parameters:**

> - {[String](../../../servoycore/dev-api/js-lib/string.md)} id The unique identifier of the parent resource\.

**Returns:** [Array\<CustomType\<svy\-fullcalendar2\.ResourceObject\>\>](#resourceobject) An array of child resource objects\. 
***

### getDate\(\)

Returns a Date for the current date of the calendar\.

**Returns:** [Date](../../../servoycore/dev-api/js-lib/date.md) The current date displayed by the calendar\. 
***

### getEventById\(id\)

Gets a calendar event using a given ID\.

**Parameters:**

> - {[String](../../../servoycore/dev-api/js-lib/string.md)} id The unique identifier of the event to retrieve\.

**Returns:** [CustomType\<svy\-fullcalendar2\.EventObject\>](#eventobject) The event object corresponding to the provided ID\. 
***

### getEventResources\(eventID\)

Gets the Resources associated with the given event\.

**Parameters:**

> - {[String](../../../servoycore/dev-api/js-lib/string.md)} eventID The unique identifier of the event\.

**Returns:** [Array\<CustomType\<svy\-fullcalendar2\.ResourceObject\>\>](#resourceobject) An array of resources associated with the event\. 
***

### getEventSourceById\(id\)

Retrieves a specific Event Source Object\.

**Parameters:**

> - {[String](../../../servoycore/dev-api/js-lib/string.md)} id The unique identifier of the event source to retrieve\.

**Returns:** [CustomType\<svy\-fullcalendar2\.EventSource\>](#eventsource) The event source object corresponding to the provided ID\. 
***

### getEventSources\(\)

Retrieves all Event Source Objects\.

**Returns:** [Array\<CustomType\<svy\-fullcalendar2\.EventSource\>\>](#eventsource) An array of all event source objects in the calendar\. 
***

### getFullCalendarOptions\(\)

Retrieves the current configuration options for the FullCalendar component\.  
These options define the behavior, appearance, and data sources of the calendar\.

**Example:**
```js
var options = elements.fullcalendarElementName.getFullCalendarOptions();
// Example usage: Update a specific calendar option and reinitialize the calendar
options.scrollTime = '09:00:00';
elements.fullcalendarElementName.fullCalendar(options, true);

Returns: CustomType<svy-fullcalendar2.FullCalendarOptions> The current configuration options for the FullCalendar component. If the options are not set, it returns `null`.

---

getOption(name)

Gets the value of an option from the calendar.

Parameters:

• {String} name The name of the option to retrieve (e.g., 'theme', 'locale', or 'headerToolbar').

Returns: Object The current value of the specified option.

---

getParent(id)

Returns the parent Resource of a child resource.

Parameters:

• {String} id The unique identifier of the child resource.

Returns: CustomType<svy-fullcalendar2.ResourceObject> The parent resource object.

---

getResourceById(resourceId)

A method that retrieves a specific Resource Object in memory.

Parameters:

• {Object} resourceId The unique identifier of the resource to retrieve.

Returns: CustomType<svy-fullcalendar2.ResourceObject> The resource object corresponding to the provided ID.

---

getResourceEvents(id)

Gets the Resources associated with the given event.

Parameters:

• {String} id The unique identifier of the event.

Returns: Array<CustomType<svy-fullcalendar2.ResourceObject>> An array of resources associated with the specified event.

---

getResources()

A method that retrieves all Resources, including children, as a single flat list.

Returns: Array<CustomType<svy-fullcalendar2.ResourceObject>> An array of all resource objects, including child resources.

---

getTopLevelResources()

A method that retrieves only top-level Resources.

Returns: Array<CustomType<svy-fullcalendar2.ResourceObject>> An array of top-level resource objects.

---

getView()

Gets the View Object for the current view.

Returns: CustomType<svy-fullcalendar2.ViewType> The view object representing the currently active calendar view (e.g., month, week, or day view).

---

gotoDate(date)

Moves the calendar to an arbitrary date.

Parameters:

• {Date} date The target date to move the calendar to.

---

incrementDate(delta)

Moves the calendar forward/backward an arbitrary amount of time.

Parameters:

• {Object} delta The time period to increment or decrement (e.g., { days: 7 } ).

---

moveDates(eventID,delta)

Will move an event’s start and end dates by a specific period of time.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} delta The duration to move the start and end dates by (e.g., { days: 1 } ).

---

moveEnd(eventID,delta)

Will move an event’s end date by a specific period of time.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} delta The duration to move the end date by (e.g., { days: 1 } ).

---

moveStart(eventID,delta)

Will move an event’s start date by a specific period of time.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} delta The duration to move the start date by (e.g., { days: 1 } ).

---

next()

Moves the calendar one step forward (by a month or week for example).

If the calendar is in dayGridMonth view, will move the calendar forward one month. If the calendar is in dayGridWeek or timeGridWeek, will move the calendar forward one week. If the calendar is in dayGridDay or timeGridDay, will move the calendar forward one day.

---

nextYear()

Moves the calendar forward one year.

---

prev()

Moves the calendar one step back (by a month or week for example).

If the calendar is in dayGridMonth view, will move the calendar back one month. If the calendar is in dayGridWeek or timeGridWeek, will move the calendar back one week. If the calendar is in dayGridDay or timeGridDay, will move the calendar back one day.

---

prevYear()

Moves the calendar back one year.

---

refetchEventSource(eventSourceID)

Refetches events from all sources and rerenders them on the screen.

Parameters:

• {String} eventSourceID The unique identifier of the event source to refetch.

---

refetchEvents()

Refetches events from all sources and rerenders them on the screen.

---

refetchResources()

Causes the resource data to be fetched and freshly rerendered.

---

removeEvent(eventID)

Removes an event from the calendar.

Parameters:

• {String} eventID The unique identifier of the event to remove.

---

removeEventSource(eventSourceID)

Removes all events associated with this source and prevents it from being fetched again.

Parameters:

• {String} eventSourceID The unique identifier of the event source to remove.

---

removeResource(id)

Programmatically removes a resource from the calendar.

Parameters:

• {String} id The unique identifier of the resource to remove.

---

render()

Will initially render a calendar, or if it is already rendered, will rerender it.

---

scrollToTime(durationInput)

Programatically scroll the current view to the given time.

Parameters:

• {Object} durationInput The duration to scroll to (e.g., '09:00:00').

---

select(dateOrObj,endDate)

A method for programmatically selecting a period of time.

Parameters:

• {Object} dateOrObj The start date or object representing the range to select.
• {Object} [endDate] Optional end date for the selection range.

---

setAllDay(eventID,allDay,settings)

Sets whether an event is considered all-day.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Boolean} allDay Whether the event should be marked as all-day.
• {Object} [settings] Optional settings for configuring the all-day property.

---

setDates(eventID,start,end,options)

Sets an event’s start date, end date, and allDay properties at the same time.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} start The new start date for the event.
• {Object} end The new end date for the event.
• {Object} [options] Optional settings for configuring how the dates are set.

---

setEnd(eventID,date)

Sets an event’s end date.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} date The new end date for the event.

---

setEventResources(eventID,resources)

Sets the Resources associated with the given event.

Parameters:

• {String} eventID The unique identifier of the event.
• {Array<CustomType<svy-fullcalendar2.ResourceObject>>} resources An array of resources to associate with the event.

---

setExtendedPropEvent(eventID,name,value)

Modifies a single property in an events' extendedProps hash.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {String} name The name of the extended property to modify.
• {Object} value The new value to assign to the specified extended property.

---

setExtendedPropResource(id,name,value)

Modifies a single property in an Resource Object’s extendedProps hash.

Parameters:

• {String} id The unique identifier of the resource to modify.
• {String} name The name of the extended property to modify.
• {Object} value The new value to assign to the extended property.

---

setOption(name,value)

Sets an option for the calendar.

Parameters:

• {String} name The name of the option to set (e.g., 'theme', 'locale', or 'headerToolbar').
• {Object} value The value to assign to the specified option.

---

setPropEvent(eventID,name,value)

Modifies any of the non-date-related properties of an event.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {String} name The name of the property to modify (e.g., 'title' or 'color').
• {Object} value The new value to assign to the specified property.

---

setPropResource(id,name,value)

Modifies any of the properties of a Resource Object.

Parameters:

• {String} id The unique identifier of the resource to modify.
• {String} name The name of the property to modify.
• {Object} value The new value to assign to the property.

---

setStart(eventID,date,options)

Sets an event’s start date.

Parameters:

• {String} eventID The unique identifier of the event to modify.
• {Object} date The new start date for the event.
• {Object} [options] Optional settings for configuring how the start date is set.

---

toPlainObjectEvent(eventID,settings)

Serializes an Event API Object to a plain object.

Parameters:

• {String} eventID The unique identifier of the event.
• {Object} [settings] Optional settings for customizing the serialization process.

---

toPlainObjectResource(id,settings)

Serializes a Resource API Object to a plain object.

Parameters:

• {String} id The unique identifier of the resource.
• {Object} [settings] Optional settings for customizing the serialization process.

---

today()

Moves the calendar to the current date.

---

unselect()

A method for programmatically clearing the current selection.

---

updateFullCalendar(option,value)

Updates a specific configuration option for the FullCalendar component and forces the calendar to re-render. This method allows you to dynamically adjust the calendar's behavior or appearance without requiring a full reinitialization.

Example:

// Update the scroll time to start the calendar at 1 PM
elements.fullcalendarElementName.updateFullCalendar('scrollTime', '13:00:00');

Parameters:

• {String} option The name of the configuration option to update (e.g., 'scrollTime', 'editable').
• {Object} value The new value for the specified configuration option.

---

Types

ArrayEventSource

Represents an event source that is an array of events. scripting type: CustomType<svy-fullcalendar2.ArrayEventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• events

  • Array of event objects provided by the source.

  • Type: EventObject[]
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

EventObject

Represents an event object in the calendar. scripting type: CustomType<svy-fullcalendar2.EventObject>

• allDay

  • Indicates if the event is an all-day event.

  • Type: boolean
• backgroundColor

  • The background color of the event.

  • Type: color
• borderColor

  • The border color of the event.

  • Type: color
• classNames

  • Array of CSS class names for the event.

  • Type: object
• constraint

  • Constraint applied to the event.

  • Type: object
• display

  • Display mode for the event.

  • Type: string
• durationEditable

  • Indicates if the event's duration is editable.

  • Type: boolean
• editable

  • Indicates if the event is editable.

  • Type: boolean
• end

  • The end date/time of the event.

  • Type: object
• endStr

  • String representation of the end date/time.

  • Type: string
• extendedProps

  • Extended properties for the event.

  • Type: object
• groupId

  • Identifier used to group related events.

  • Type: object
• id

  • Unique identifier of the event.

  • Type: object
• overlap

  • Determines if the event can overlap with others.

  • Type: boolean
• resourceEditable

  • Indicates if the event's resource is editable.

  • Type: boolean
• resourceId

  • The resource identifier associated with the event.

  • Type: string
• resourceIds

  • Array of resource identifiers for the event.

  • Type: string[]
• source

  • Source information for the event.

  • Type: EventSource
• start

  • The start date/time of the event.

  • Type: object
• startEditable

  • Indicates if the event's start time is editable.

  • Type: boolean
• startStr

  • String representation of the start date/time.

  • Type: string
• textColor

  • The text color of the event.

  • Type: color
• title

  • The title of the event.

  • Type: tagstring
• url

  • URL associated with the event.

  • Type: string

EventParsing

Represents an event parsed for addition to the calendar. scripting type: CustomType<svy-fullcalendar2.EventParsing>

• allDay

  • Indicates if the event is an all-day event.

  • Type: boolean
• allow

  • Flag or value allowing/disallowing specific behaviors.

  • Type: boolean
• backgroundColor

  • The background color of the event.

  • Type: color
• borderColor

  • The border color of the event.

  • Type: color
• className

  • CSS class name(s) to be applied to the event.

  • Type: object
• classNames

  • Array of CSS class names for the event.

  • Type: object
• color

  • The color assigned to the event.

  • Type: color
• constraint

  • Constraint for dragging or resizing the event.

  • Type: object
• data

  • Additional data associated with the event.

  • Type: object
• date

  • The event's date (alternative to start).

  • Type: object
• daysOfWeek

  • Array representing the days of the week for recurring events.

  • Type: int[]
• display

  • Display mode for the event.

  • Type: string
• durationEditable

  • Indicates if the event's duration is editable.

  • Type: boolean
• editable

  • Indicates if the event is editable.

  • Type: boolean
• end

  • The end date/time of the event.

  • Type: object
• endRecur

  • End recurrence date for repeating events.

  • Type: object
• endTime

  • The end time for recurring events.

  • Type: object
• extendedProps

  • Extended properties for the event.

  • Type: object
• groupId

  • Identifier for grouping related events.

  • Type: object
• id

  • Unique identifier of the event.

  • Type: object
• overlap

  • Determines if the event can overlap with others.

  • Type: boolean
• resourceEditable

  • Indicates if the event's resource is editable.

  • Type: boolean
• resourceId

  • The resource identifier associated with the event.

  • Type: string
• resourceIds

  • Array of resource identifiers if the event is associated with multiple resources.

  • Type: string[]
• rrule

  • Recurrence rule for the event.

  • Type: object
• start

  • The start date/time of the event.

  • Type: object
• startEditable

  • Indicates if the event's start time is editable.

  • Type: boolean
• startRecur

  • Start recurrence date for repeating events.

  • Type: object
• startTime

  • The start time for recurring events.

  • Type: object
• textColor

  • The text color of the event.

  • Type: color
• title

  • The title of the event.

  • Type: tagstring
• url

  • URL associated with the event.

  • Type: string

EventSource

Represents an event source for the calendar. scripting type: CustomType<svy-fullcalendar2.EventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• events

  • The events provided by the source.

  • Type: object
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

FullCalendar

Represents the FullCalendar instance. scripting type: CustomType<svy-fullcalendar2.FullCalendar>

• options

  • The configuration options for the FullCalendar instance.

  • Type: FullCalendarOptions

FullCalendarOptions

scripting type: CustomType<svy-fullcalendar2.FullCalendarOptions>

• allDayClassNames

  • A ClassName Input

  • Type: object
• allDayContent

  • A Content Injection Input

  • Type: object
• allDayDidMount

  • Callback called right after the element was added to the DOM.

  • Type: object
• allDayMaintainDuration

  • Determines how an event's duration should be mutated when it is dragged from a timed section to an all-day section and vice versa.

  • Type: boolean
• allDayText

  • The text titling the 'all-day' slot at the top of the calendar.

  • Type: tagstring
• allDayWillUnmount

  • Callback called right before the element will be removed from the DOM.

  • Type: object
• aspectRatio

  • The width-to-height aspect ratio of the calendar.

  • Type: double
• bootstrapFontAwesome

  • Determines which icons are displayed in buttons of the headerToolbar/footerToolbar when Bootstrap 4 theming is on. This setting does not apply to Bootstrap 5 theming. Use buttonIcons instead.

  • Type: object
• businessHours

  • Emphasizes certain time slots on the calendar. By default, Monday-Friday, 9am-5pm.

  • Type: object
• buttonIcons

  • Icons that will be displayed in buttons of the headerToolbar/footerToolbar.

  • Type: object
• buttonText

  • Text that will be displayed on buttons of the headerToolbar/footerToolbar.

  • Type: object
• contentHeight

  • The height of the view area of the calendar. By default, this option is unset and the calendar's height is calculated by aspectRatio.

  • Type: object
• customButtons

  • Defines custom buttons that can be used in the headerToolbar/footerToolbar.

  • Type: object
• dateAlignment

  • Determines the first visible day of a custom view.

  • Type: string
• dateIncrement

  • How far into the future/past the calendar navigates when prev/next is executed.

  • Type: object
• dayCellClassNames

  • A ClassName Input for adding classNames to the <td> cell

  • Type: object
• dayCellContent

  • A Content Injection Input. Generated content is inserted inside the inner-most wrapper of the day cell. It does not replace the <td> cell.

  • Type: object
• dayCellDidMount

  • Callback called right after the <td> has been added to the DOM

  • Type: object
• dayCellWillUnmount

  • Callback called right before the <td> will be removed from the DOM

  • Type: object
• dayHeaderClassNames

  • A ClassName Input for adding classNames to the header <th> cell

  • Type: object
• dayHeaderContent

  • A Content Injection Input. Generated content is inserted inside the inner-most wrapper of the header cell. It does not replace the <th> cell.

  • Type: object
• dayHeaderDidMount

  • Callback called right after the <th> has been added to the DOM.

  • Type: object
• dayHeaderFormat

  • Determines the text that will be displayed on the calendar's column headings.

  • Type: object
• dayHeaderWillUnmount

  • Callback called right before the <th> will be removed from the DOM.

  • Type: object
• dayHeaders

  • Whether the day headers should appear. For the Month, TimeGrid, and DayGrid views.

  • Type: boolean
• dayMaxEventRows

  • In dayGrid view, the max number of stacked event levels within a given day. This includes the +more link if present. The rest will show up in a popover.

  • Type: object
• dayMaxEvents

  • In, dayGrid view, the max number of events within a given day, not counting the +more link. The rest will show up in a popover.

  • Type: object
• dayMinWidth

  • If specified, when the calendar gets narrow enough where day cells can no longer meet their dayMinWidth, horizontal scrollbars will appear.

  • Type: object
• dayPopoverFormat

  • Determines the date format of title of the popover created by the moreLinkClick option.

  • Type: object
• defaultAllDay

  • Determines the default value for each Event Object's allDay property when it is unspecified.

  • Type: boolean
• defaultAllDayEventDuration

  • A fallback duration for all-day Event Objects without a specified end value.

  • Type: object
• defaultRangeSeparator

  • The separator text used for date-formatting ranges throughout the API.

  • Type: string
• defaultTimedEventDuration

  • A fallback duration for timed Event Objects without a specified end value.

  • Type: object
• direction

  • The direction that elements in the calendar are rendered. Either left-to-right or right-to-left.

  • Type: object
• displayEventEnd

  • Whether or not to display an event's end time.

  • Type: boolean
• displayEventTime

  • Whether or not to display the text for an event's date/time.

  • Type: boolean
• dragRevertDuration

  • Time it takes for an event to revert to its original position after an unsuccessful drag.

  • Type: int
• dragScroll

  • Whether to automatically scoll the scroll-containers during event drag-and-drop and date selecting.

  • Type: boolean
• dropAccept

  • Provides a way to filter which external elements can be dropped onto the calendar.

  • Type: object
• droppable

  • Determines if external draggable elements or events from other calendars can be dropped onto the calendar.

  • Type: boolean
• duration

  • Sets the exact duration of a custom view.

  • Type: object
• editable

  • Determines whether the events on the calendar can be modified.

  • Type: boolean
• endParam

  • A parameter of this name will be sent to each JSON event feed. It describes the exclusive end of the interval being fetched.

  • Type: string
• eventAllow

  • Callback function to have exact programmatic control over where an event can be dropped.

  • Type: object
• eventBackgroundColor

  • Sets the background color for all events on the calendar. Any CSS color format is supported.

  • Type: string
• eventBorderColor

  • Sets the border color for all events on the calendar. Any CSS color format is supported.

  • Type: string
• eventClassNames

  • A ClassName Input for adding classNames to the outermost event element. If supplied as a callback function, it is called every time the associated event data changes.

  • Type: object
• eventColor

  • Sets the background and border colors for all events on the calendar. Any CSS color format is supported.

  • Type: string
• eventConstraint

  • Limits event dragging and resizing to certain windows of time.

  • Type: object
• eventContent

  • A Content Injection Input. Generated content is inserted inside the inner-most wrapper of the event element. If supplied as a callback function, it is called every time the associated event data changes.

  • Type: object
• eventDataTransform

  • A hook for transforming custom data into a standard Event object.

  • Type: object
• eventDidMount

  • Callback called right after the element has been added to the DOM. If the event data changes, this is NOT called again.

  • Type: object
• eventDisplay

  • Controls which preset rendering style events use.

  • Type: string
• eventDragMinDistance

  • How many pixels the user's mouse/touch must move before an event drag activates.

  • Type: int
• eventDurationEditable

  • Allow events' durations to be editable through resizing.

  • Type: boolean
• eventLongPressDelay

  • For touch devices, the amount of time the user must hold down before an event becomes draggable.

  • Type: int
• eventMaxStack

  • For timeline view, the maximum number of events that stack top-to-bottom. For timeGrid view, the maximum number of events that stack left-to-right.

  • Type: int
• eventMinHeight

  • In timeGrid view, the minimum height an event is allowed to be.

  • Type: int
• eventMinWidth

  • In timeline view, the minimum width an event is allowed to be.

  • Type: int
• eventOrder

  • Determines the ordering (sort) events within the same day.

  • Type: object
• eventOrderStrict

  • Ensures the eventOrder setting is strictly followed.

  • Type: boolean
• eventOverlap

  • Determines if events being dragged and resized are allowed to overlap each other.

  • Type: boolean
• eventResizableFromStart

  • Whether the user can resize an event from its starting edge.

  • Type: boolean
• eventShortHeight

  • In timeGrid view, the height threshold for when an event has a 'short' style.

  • Type: int
• eventSourceFailure

  • Callback called when any of the event sources fails. Probably because an AJAX request failed.

  • Type: object
• eventSourceSuccess

  • A function that gets called when fetching succeeds. It can transform the response. Gets called for any type of Event source.

  • Type: object
• eventSources

  • A way to specify multiple event sources.

  • Type: EventSource[]
• eventStartEditable

  • Allow events' start times to be editable through dragging.

  • Type: boolean
• eventTextColor

  • Sets the text color for all events on the calendar. Any CSS color format is supported.

  • Type: string
• eventTimeFormat

  • Determines the time-text that will be displayed on each event.

  • Type: object
• eventWillUnmount

  • Callback called right before the element will be removed from the DOM.

  • Type: object
• events

  • An array of Event Objects that will be displayed on the calendar.

  • Type: object
• expandRows

  • If the rows of a given view don't take up the entire height, they will expand to fit.

  • Type: int
• firstDay

  • The day that each week begins.

  • Type: int
• fixedWeekCount

  • Determines the number of weeks displayed in a month view.

  • Type: boolean
• footerToolbar

  • Defines the controls at the bottom of the calendar.

  • Type: object
• forceEventDuration

  • A flag to force assignment of an event's end if it is unspecified.

  • Type: boolean
• handleWindowResize

  • Whether to automatically resize the calendar when the browser window resizes.

  • Type: boolean
• headerToolbar

  • Defines the buttons and title at the top of the calendar.

  • Type: object
• height

  • Sets the height of the entire calendar, including header and footer. By default, this option is unset and the calendar's height is calculated by aspectRatio.

  • Type: object
• hiddenDays

  • Exclude certain days-of-the-week from being displayed.

  • Type: int[]
• initialDate

  • The initial date displayed when the calendar first loads.

  • Type: object
• initialView

  • The initial view when the calendar loads. The default value is 'dayGridMonth'

  • Type: string
• isRTL

  • Displays the calendar in right-to-left mode.

  • Type: boolean
• lazyFetching

  • Determines when event fetching should occur.

  • Type: boolean
• locale

  • Current component locale (affects texts,formatting and weeknumber/first day of week).

  • Type: object
• locales

  • Specify multiple locales with the ability to switch between them after pageload.

  • Type: object
• longPressDelay

  • For touch devices, the amount of time the user must hold down before an event becomes draggable or a date becomes selectable.

  • Type: int
• monthMode

  • Specifies whether the month view should render in a fixed mode. When enabled, the calendar displays a consistent number of weeks in the month view, even if the month starts or ends mid-week.

  • Type: boolean
• moreLinkClassNames

  • A ClassName Input for adding classNames

  • Type: object
• moreLinkClick

  • Determines the action taken when the user clicks on a 'more' link created by the dayMaxEventRows or dayMaxEvents options.

  • Type: object
• moreLinkContent

  • A Content Injection Input

  • Type: object
• moreLinkDidMount

  • Callback called right after the link has been added to the DOM

  • Type: object
• moreLinkText

  • More link text

  • Type: object
• moreLinkWillUnmount

  • Callback called right before the link will be removed from the DOM

  • Type: object
• navLinkDayClick

  • Determines what happens upon a day heading nav-link click.

  • Type: object
• navLinkWeekClick

  • Determines what happens upon a week-number nav-link click.

  • Type: object
• navLinks

  • Determines if day names and week names are clickable.

  • Type: boolean
• nextDayThreshold

  • When an event's end time spans into another day, the minimum time it must be in order for it to render as if it were on that day.

  • Type: object
• noEventsText

  • No Events Text

  • Type: string
• now

  • Explicitly sets the 'today' date of the calendar. This is the day that is normally highlighted in yellow.

  • Type: object
• nowIndicator

  • Whether or not to display a marker indicating the current time.

  • Type: boolean
• nowIndicatorClassNames

  • A ClassName Input for adding classNames.

  • Type: object
• nowIndicatorContent

  • A Content Injection Input.

  • Type: object
• nowIndicatorDidMount

  • Callback called after before the now indicator will be added to the DOM.

  • Type: object
• nowIndicatorWillUnmount

  • Callback called right before the now indicator will be removed from the DOM.

  • Type: object
• plugins

  • Plugins list. Currently this list will be auto filled in Titanium Client.

  • Type: object
• progressiveEventRendering

  • When to render multiple asynchronous event sources in an individual or batched manner.

  • Type: boolean
• rerenderDelay

  • The amount of milliseconds to wait before rerendering anything on a calendar.

  • Type: int
• resourceAreaWidth

  • Determines the width of the area that contains the list of resources.Default: 30%.

  • Type: string
• resources

  • Tells the calendar to display resources from an input.

  • Type: object
• schedulerLicenseKey

  • The license key you must enter to use premium features.

  • Type: string
• scrollTime

  • Determines how far forward the scroll pane is initially scrolled.

  • Type: object
• scrollTimeReset

  • Whether the view should scroll to scrollTime every time the date range changes.

  • Type: boolean
• selectAllow

  • Callback function to have exact programmatic control over where the user can select.

  • Type: object
• selectConstraint

  • Limits user selection to certain windows of time.

  • Type: object
• selectLongPressDelay

  • For touch devices, the amount of time the user must hold down before a date becomes selectable.

  • Type: int
• selectMinDistance

  • The minimum distance the user's mouse must travel after a mousedown, before a selection is allowed. A non-zero value is useful for differentiating a selection from a dateClick.

  • Type: int
• selectMirror

  • Whether to draw a 'placeholder' event while the user is dragging.

  • Type: boolean
• selectOverlap

  • Determines whether the user is allowed to select periods of time that are occupied by events.

  • Type: boolean
• selectable

  • Allows a user to highlight multiple days or timeslots by clicking and dragging.

  • Type: boolean
• showNonCurrentDates

  • In month view, whether dates in the previous or next month should be rendered at all.

  • Type: boolean
• slotDuration

  • The frequency for displaying time slots.

  • Type: object
• slotEventOverlap

  • Determines if timed events in TimeGrid view should visually overlap.

  • Type: boolean
• slotLabelDidMount

  • Callback called right after the element is added to the DOM.

  • Type: object
• slotLabelFormat

  • Determines the text that will be displayed within a time slot.

  • Type: string
• slotLabelInterval

  • The frequency that the time slots should be labelled with text.

  • Type: object
• slotLabelWillUnmount

  • Callback called right before the element will be removed from the DOM.

  • Type: object
• slotLaneClassNames

  • A ClassName Input.

  • Type: object
• slotLaneContent

  • A Content Injection Input

  • Type: object
• slotLaneDidMount

  • Callback called right after the element is added to the DOM.

  • Type: object
• slotLaneWillUnmount

  • Callback called right before the element will be removed from the DOM.

  • Type: object
• slotMaxTime

  • Determines the last time slot that will be displayed for each day. In line with the discussion about the Event object, it is important to stress that this should be specified as an exclusive end time.

  • Type: object
• slotMinTime

  • Determines the first time slot that will be displayed for each day.

  • Type: object
• slotMinWidth

  • Determines how wide each of the time-axis slots will be. Specified as a number of pixels. When not specified, a reasonable value will be automatically computed.

  • Type: int
• snapDuration

  • The time interval at which a dragged event will snap to the time axis. Also affects the granularity at which selections can be made.

  • Type: object
• startParam

  • A parameter of this name will be sent to each JSON event feed. It describes the start of the interval being fetched.

  • Type: string
• stickyFooterScrollbar

  • Whether to fix the view's horizontal scrollbar to the bottom of the viewport while scrolling.

  • Type: object
• stickyHeaderDates

  • Whether to fix the date-headers at the top of the calendar to the viewport while scrolling.

  • Type: object
• themeSystem

  • Renders the calendar with a given theme system. Default: 'standard'

  • Type: string
• timeZone

  • A time zone is a region of the world that serves as a context for displaying dates. It affects a Calendar instance. Default value is browser timezone.

  • Type: string
• timeZoneParam

  • A parameter of this name will be sent to each JSON event feed. It describes the timezone of the startParam and endParam values, as well as the desired timezone of the returned events.

  • Type: string
• titleFormat

  • Determines the text that will be displayed in the headerToolbar's title.

  • Type: object
• titleRangeSeparator

  • Determines the separator text when formatting the date range in the toolbar title.

  • Type: string
• unselectAuto

  • Whether clicking elsewhere on the page will cause the current selection to be cleared.

  • Type: boolean
• unselectCancel

  • A way to specify elements that will ignore the unselectAuto option.

  • Type: string
• validRange

  • Limits which dates the user can navigate to and where events can go.

  • Type: object
• viewClassNames

  • A ClassName Input for adding classNames to the root view element. called whenever the view changes.

  • Type: object
• viewDidMount

  • Callback called right after the view has been added to the DOM.

  • Type: object
• viewHeight

  • View height.

  • Type: object
• viewWillUnmount

  • Callback called right before the view will be removed from the DOM

  • Type: object
• views

  • The available views of this component.

  • Type: object
• visibleRange

  • Sets the exact date range that is visible in a view.

  • Type: object
• weekNumberCalculation

  • The method for calculating week numbers that are displayed with the weekNumbers setting.

  • Type: object
• weekNumberClassNames

  • A ClassName Input for adding classNames

  • Type: object
• weekNumberContent

  • A Content Injection Input.

  • Type: object
• weekNumberDidMount

  • Callback called right after the week number div has been added to the DOM

  • Type: object
• weekNumberFormat

  • If the rows of a given view don't take up the entire height, they will expand to fit.

  • Type: object
• weekNumberWillUnmount

  • Callback called right before the week number div will be removed from the DOM

  • Type: object
• weekNumbers

  • Determines if week numbers should be displayed on the calendar.

  • Type: boolean
• weekText

  • The heading text for week numbers. Also affects weeks in date formatting.

  • Type: string
• weekends

  • Whether to include Saturday/Sunday columns in any of the calendar views.

  • Type: boolean
• windowResizeDelay

  • The time the calendar will wait to adjust its size after a window resize occurs, in milliseconds.

  • Type: int

FunctionEventSource

Represents an event source provided by a function. scripting type: CustomType<svy-fullcalendar2.FunctionEventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• events

  • Function that returns events for this source.

  • Type: function
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

GoogleCalendarEventSource

Represents an event source provided by Google Calendar. scripting type: CustomType<svy-fullcalendar2.GoogleCalendarEventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• googleCalendarApiKey

  • The Google Calendar API key.

  • Type: string
• googleCalendarId

  • The Google Calendar ID.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

JSONEventSource

Represents an event source provided as a JSON feed. scripting type: CustomType<svy-fullcalendar2.JSONEventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

ResourceObject

Represents a resource used in the calendar. scripting type: CustomType<svy-fullcalendar2.ResourceObject>

• children

  • An array of child resources.

  • Type: ResourceObject[]
• eventAllow

  • Rules determining whether events are allowed for this resource.

  • Type: object
• eventBackgroundColor

  • Background color for events associated with the resource.

  • Type: color
• eventBorderColor

  • Border color for events associated with the resource.

  • Type: color
• eventClassNames

  • CSS class names applied to events associated with the resource.

  • Type: styleclass
• eventConstraint

  • Constraints applied to events for this resource.

  • Type: object
• eventOverlap

  • Settings controlling event overlap behavior related to this resource.

  • Type: object
• eventTextColor

  • Text color for events associated with the resource.

  • Type: color
• extendedProps

  • Additional extended properties for the resource.

  • Type: object
• id

  • Unique identifier of the resource.

  • Type: object
• parentId

  • Identifier of the parent resource.

  • Type: object
• title

  • The display title of the resource.

  • Type: tagstring

ViewType

Represents the view type of the calendar. scripting type: CustomType<svy-fullcalendar2.ViewType>

• activeEnd

  • The end date of the active range.

  • Type: date
• activeStart

  • The start date of the active range.

  • Type: date
• currentEnd

  • The end date of the current view.

  • Type: date
• currentStart

  • The start date of the current view.

  • Type: date
• dateEnv

  • The date environment object containing locale and timezone information.

  • Type: object
• title

  • The title of the view.

  • Type: string
• type

  • The type of the current view (e.g. 'month', 'week', 'day').

  • Type: string

iCalendarEventSource

Represents an event source provided by an iCalendar feed. scripting type: CustomType<svy-fullcalendar2.iCalendarEventSource>

• allDayDefault

  • Default all-day event setting for events from this source.

  • Type: boolean
• allow

  • Allowance property for events.

  • Type: object
• backgroundColor

  • The background color for events.

  • Type: color
• borderColor

  • The border color for events.

  • Type: color
• className

  • CSS class names for events from this source.

  • Type: string[]
• color

  • The primary color for events.

  • Type: color
• constraint

  • Constraint applied to events from this source.

  • Type: object
• data

  • Additional data for events from this source.

  • Type: object
• defaultAllDay

  • Default all-day value for events.

  • Type: boolean
• display

  • Display mode for events.

  • Type: string
• durationEditable

  • Indicates if event durations are editable.

  • Type: boolean
• editable

  • Indicates if events from this source are editable.

  • Type: boolean
• eventDataTransform

  • Function to transform event data.

  • Type: object
• failure

  • Failure callback for event fetching.

  • Type: object
• format

  • Format string used for event dates.

  • Type: string
• id

  • Unique identifier for the event source.

  • Type: object
• overlap

  • Determines if events can overlap.

  • Type: boolean
• startEditable

  • Indicates if event start times are editable.

  • Type: boolean
• success

  • Success callback for event fetching.

  • Type: object
• textColor

  • The text color for events.

  • Type: color
• url

  • URL for fetching events.

  • Type: string

---