ServoyCloudSupportSamplesOpen SourceCommunity

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

Type: styleclass

themeSystem

Type: string Default Value: "standard"

tooltipExpression

The text expression to be shown as tooltip when hovering over the calendar events. Use double curly brackets to evaluate {{propertyName}} the event's properties. Example

This is the event title:{{title}}. The event starts at: {{start}}. Description: {{data.description}}

Type: tagstring

Events

onDateClickMethodID

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

Parameters:

date date dateStr string dayEl object jsEvent JSEvent view ViewType resource ResourceObject

onDateDblClickMethodID

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

Parameters:

date date dateStr string dayEl object jsEvent JSEvent view ViewType resource ResourceObject

onDatesSetMethodID

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:

start date end date startStr string endStr string timeZone string view ViewType

onDropMethodID

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

Parameters:

allDay boolean date date dateStr string draggedElement object jsEvent JSEvent resource ResourceObject view ViewType

onEventAddMethodID

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

@return {boolean} if it returns false, the event add action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[]

Returns: boolean

onEventChangeMethodID

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

@return {boolean} if it returns false, the event change action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject oldEvent EventObject relatedEvents EventObject[]

Returns: boolean

onEventClickMethodID

onEventClickMethodID will be called when the user clicks an event.

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventDblClickMethodID

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

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventDragStartMethodID

onEventDragStartMethodID will be called when event dragging begins.

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventDragStopMethodID

onEventDragStopMethodID will be called when event dragging stops.

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventDropMethodID

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

@return {boolean} if it returns false, the event drop action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[] oldEvent EventObject oldResource ResourceObject newResource ResourceObject delta int jsEvent JSEvent view ViewType

Returns: boolean

onEventLeaveMethodID

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

@return {boolean} if it returns false, the event leave action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[] draggedElement object view ViewType

Returns: boolean

onEventMouseEnterMethodID

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

Parameters:

element object eventObject EventObject jsEvent JSEvent view ViewType

onEventMouseLeaveMethodID

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

Parameters:

element object event EventObject jsEvent JSEvent view ViewType

onEventReceiveMethodID

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

@return {boolean} if it returns false, the event receive action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[] draggedElement object view ViewType

Returns: boolean

onEventRemoveMethodID

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

@return {boolean} if it returns false, the event remove action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[]

Returns: boolean

onEventResizeMethodID

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

@return {boolean} if it returns false, the event resize action will be reverted, otherwise (true) the action is considered valid

Parameters:

event EventObject relatedEvents EventObject[] oldEvent EventObject endDateDelta int startDateDelta int jsEvent JSEvent view ViewType

Returns: boolean

onEventResizeStartMethodID

onEventResizeStartMethodID will be called when event resizing begins.

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventResizeStopMethodID

onEventResizeStopMethodID will be called when event resizing stops.

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventRightClickMethodID

Parameters:

event EventObject jsEvent JSEvent view ViewType

onEventsSetMethodID

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

Parameters:

events EventObject[]

onLoadingMethodID

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

Parameters:

isLoading boolean

onMouseEnter

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

Parameters:

eventObject EventObject jsEvent JSEvent view ViewType

onMouseLeave

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

Parameters:

eventObject EventObject jsEvent JSEvent view ViewType

onNavLinkDayClickMethodID

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 jsEvent JSEvent

onNavLinkWeekClickMethodID

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

Parameters:

date date jsEvent JSEvent

onResourceAddMethodID

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

@return {boolean} if it returns false, the resource add action will be reverted, otherwise (true) the action is considered valid

Parameters:

resource ResourceObject

Returns: boolean

onResourceChangeMethodID

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

@return {boolean} if it returns false, the resource change action will be reverted, otherwise (true) the action is considered valid

Parameters:

oldResource ResourceObject newResource object

Returns: boolean

onResourceRemoveMethodID

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

@return {boolean} if it returns false, the resource remove action will be reverted, otherwise (true) the action is considered valid

Parameters:

resource ResourceObject

Returns: boolean

onResourcesSetMethodID

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

Parameters:

resources ResourceObject[]

onSelectMethodID

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

Parameters:

start date end date startStr string endStr string allDay boolean jsEvent JSEvent view ViewType resource ResourceObject

onUnselectMethodID

onUnselectMethodID will be called when the current selection is cleared.

Parameters:

jsEvent JSEvent view ViewType

onViewDidMountMethodID

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

Parameters:

view ViewType

onViewWillUnmountMethodID

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

Parameters:

view ViewType

onWindowResizeMethodID

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

Parameters:

view ViewType

API

addEvent

Adds an event to calendar.

@param {CustomType<svy-fullcalendar2.EventParsing>} event @param {Object} source @return {CustomType<svy-fullcalendar2.EventObject>}

Parameters:

event EventParsing source object (optional)

Returns: EventObject

addEventSource

Dynamically adds an event source.

@param {CustomType<svy-fullcalendar2.EventSource>} source

Parameters:

source FunctionEventSource

addResource

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

@param {CustomType<svy-fullcalendar2.ResourceObject>} resource @param {Boolean} [scrollTo]

Parameters:

resource ResourceObject scrollTo boolean (optional)

batchRendering

A way to group operations that cause rerenders.

@param {Function} func

Parameters:

func function

changeView

Gets the View Object for the current view.

@param {String} viewName @param {Object} [dateOrRange]

Parameters:

viewName string dateOrRange object (optional)

destroy

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

formatDate

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

@param {Object} date @param {Object} settings @return {String}

Parameters:

date object settings object

Returns: string

formatIso

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

@param {Object} date @param {Boolean} [omitTime] @return {String}

Parameters:

date object omitTime boolean (optional)

Returns: string

formatRangeCalendar

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.

@param {Object} start @param {Object} end @param {Object} settings @return {String}

Parameters:

start object end object settings object

Returns: string

formatRangeEvent

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.

@param {String} eventID @param {Object} formatConfig

Parameters:

eventID string formatConfig object

fullCalendar

Parameters:

calendarOptions FullCalendarOptions renderOnCurrentView boolean (optional)

getCalendarEvents

Getter for all calendar events.

@return {Array<CustomType<svy-fullcalendar2.EventObject>>}

Returns: EventObject[]

getChildren

Returns a list of a resource’s child resources.

@param {String} id @return {Array<CustomType<svy-fullcalendar2.ResourceObject>>}

Parameters:

id string

Returns: ResourceObject[]

getDate

Returns a Date for the current date of the calendar.

@return {Date}

Returns: date

getEventById

Gets a calendar event using a given ID.

@param {String} id @return {CustomType<svy-fullcalendar2.EventObject>}

Parameters:

id string

Returns: EventObject

getEventResources

Gets the Resources associated with the given event.

@param {String} eventID @return {Array<CustomType<svy-fullcalendar2.ResourceObject>>}

Parameters:

eventID string

Returns: ResourceObject[]

getEventSourceById

Retrieves a specific Event Source Object.

@param {String} eventID @return {CustomType<svy-fullcalendar2.EventSource>}

Parameters:

id string

Returns: EventSource

getEventSources

Retrieves all Event Source Objects.

@return {Array<CustomType<svy-fullcalendar2.EventSource>>}

Returns: EventSource[]

getFullCalendarOptions

Returns: FullCalendarOptions

getOption

Gets the value of an option from the calendar.

@param {String} name @return {Object}

Parameters:

name string

Returns: object

getParent

Returns the parent Resource of a child resource.

@param {String} id @return {CustomType<svy-fullcalendar2.ResourceObject>}

Parameters:

id string

Returns: ResourceObject

getResourceById

A method that retrieves a specific Resource Object in memory.

@param {Object} resourceId @return {CustomType<svy-fullcalendar2.ResourceObject>}

Parameters:

resourceId object

Returns: ResourceObject

getResourceEvents

Gets the Resources associated with the given event.

@param {String} id @return {Array<CustomType<svy-fullcalendar2.ResourceObject>>}

Parameters:

id string

Returns: ResourceObject[]

getResources

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

@return {Array<CustomType<svy-fullcalendar2.ResourceObject>>}

Returns: ResourceObject[]

getTopLevelResources

A method that retrieves only top-level Resources.

@return {Array<CustomType<svy-fullcalendar2.ResourceObject>>}

Returns: ResourceObject[]

getView

Gets the View Object for the current view.

@return {CustomType<svy-fullcalendar2.ViewType>}

Returns: ViewType

gotoDate

Moves the calendar to an arbitrary date.

@param {Date} date

Parameters:

date date

incrementDate

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

@param {Object} delta

Parameters:

delta object

moveDates

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

@param {String} eventID @param {Object} delta

Parameters:

eventID string delta object

moveEnd

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

@param {String} eventID @param {Object} delta

Parameters:

eventID string delta object

moveStart

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

@param {String} eventID @param {Object} delta

Parameters:

eventID string delta object

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

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

@param {String} eventSourceID

Parameters:

eventSourceID string

refetchEvents

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

refetchResources

Causes the resource data to be fetched and freshly rerendered.

removeEvent

Removes an event from the calendar.

@param {String} eventID

Parameters:

eventID string

removeEventSource

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

@param {String} eventSourceID

Parameters:

eventSourceID string

removeResource

Programmatically removes a resource from the calendar.

@param {String} id

Parameters:

id string

render

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

scrollToTime

Programatically scroll the current view to the given time.

@param {Object} durationInput

Parameters:

durationInput object

select

A method for programmatically selecting a period of time.

@param {Object} dateOrObj @param {Object} [endDate]

Parameters:

dateOrObj object endDate object (optional)

setAllDay

Sets whether an event is considered all-day.

@param {String} eventID @param {Boolean} allDay @param {Object} [settings]

Parameters:

eventID string allDay boolean settings object (optional)

setDates

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

@param {String} eventID @param {Object} start @param {Object} end @param {Object} [options]

Parameters:

eventID string start object end object options object (optional)

setEnd

Sets an event’s end date.

@param {String} eventID @param {Object} date

Parameters:

eventID string date object

setEventResources

Sets the Resources associated with the given event.

@param {String} eventID @param {Array<CustomType<svy-fullcalendar2.ResourceObject>>} resources

Parameters:

eventID string resources ResourceObject[]

setExtendedPropEvent

Modifies a single property in an events' extendedProps hash.

@param {String} eventID @param {String} name @param {Object} value

Parameters:

eventID string name string value object

setExtendedPropResource

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

@param {String} id @param {String} name @param {Object} value

Parameters:

id string name string value object

setOption

Sets an option for the calendar.

@param {String} name @param {Object} value

Parameters:

name string value object

setPropEvent

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

@param {String} eventID @param {String} name @param {Object} value

Parameters:

eventID string name string value object

setPropResource

Modifies any of the properties of a Resource Object.

@param {String} id @param {String} name @param {Object} value

Parameters:

id string name string value object

setStart

Sets an event’s start date.

@param {String} eventID @param {Object} date @param {Object} [options]

Parameters:

eventID string date object options object (optional)

toPlainObjectEvent

Serializes an Event API Object to a plain object.

@param {String} eventID @param {Object} [settings]

Parameters:

eventID string settings object (optional)

toPlainObjectResource

Serializes a Resource API Object to a plain object.

@param {String} id @param {Object} [settings]

Parameters:

id string settings object (optional)

today

Moves the calendar to the current date.

unselect

A method for programmatically clearing the current selection.

updateFullCalendar

Parameters:

option string value object

Types

ArrayEventSource

scripting type: CustomType<svy-fullcalendar2.ArrayEventSource>

EventObject

scripting type: CustomType<svy-fullcalendar2.EventObject>

EventParsing

scripting type: CustomType<svy-fullcalendar2.EventParsing>

EventSource

scripting type: CustomType<svy-fullcalendar2.EventSource>

FullCalendar

scripting type: CustomType<svy-fullcalendar2.FullCalendar>

FullCalendarOptions

scripting type: CustomType<svy-fullcalendar2.FullCalendarOptions>

  • allDayClassNames

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

scripting type: CustomType<svy-fullcalendar2.FunctionEventSource>

GoogleCalendarEventSource

scripting type: CustomType<svy-fullcalendar2.GoogleCalendarEventSource>

JSONEventSource

scripting type: CustomType<svy-fullcalendar2.JSONEventSource>

ResourceObject

scripting type: CustomType<svy-fullcalendar2.ResourceObject>

ViewType

scripting type: CustomType<svy-fullcalendar2.ViewType>

iCalendarEventSource

scripting type: CustomType<svy-fullcalendar2.iCalendarEventSource>

PreviousFoundset ListNextGauge

Last updated