EventFields

Maps scheduler event model properties to corresponding data source fields. Enables the scheduler to correctly interpret event data from various data structures with minimal transformation overhead. Supports configuration of all standard event fields including recurrence rules, read-only flags, and blocking indicators.

Props

The following table outlines the props for the EventFields:

NameTypeDefaultDescription
description
string
'Description'

Maps the event description or detailed notes field that provides supplementary information. Displayed in event detail views, tooltips, or custom event templates.

endTime
string
'EndTime'

Maps the event end time field that determines when an event concludes on the scheduler. This field is required for all valid event records.

id
string
'Id'

Maps the unique event identifier field enabling add, update, and delete operations. This field is essential for all CRUD operations in the scheduler.

isAllDay
string
'IsAllDay'

Maps the boolean flag indicating all-day events that span entire days without specific times. Ideal for holidays, birthdays, task deadlines, or any events not tied to specific hours.

isBlock
string
'IsBlock'

Maps the blocking flag indicating whether an event reserves a time slot blocking other event scheduling. Useful for maintenance windows, meetings, blocked time, or unavailable periods.

isReadonly
string
'IsReadonly'

Maps the read-only flag indicating whether an event can be modified or deleted by users. When true, the event is protected from editing or deletion operations.

location
string
'Location'

Maps the event location or venue field displayed alongside event details for context. Helps users understand where the event takes place (physical or virtual location).

recurrenceException
string
'RecurrenceException'

Maps the recurrence exception rule field in RFC 5545 format (e.g., 'EXDATE=2024-01-01,2024-02-01'). Specifies dates or rules for excluding specific occurrences from a recurring event series.

recurrenceID
string | number
'RecurrenceID'

Maps the parent recurring event identifier linking individual exception occurrences to the original series. Used internally to manage and track modified instances within a recurring event series.

recurrenceRule
string
'RecurrenceRule'

Maps the recurrence rule field in RFC 5545 format (e.g., 'FREQ=DAILY;INTERVAL=1;UNTIL=2025-12-31'). Defines how events repeat across days, weeks, months, or years for recurring event management.

startTime
string
'StartTime'

Maps the event start time field that determines when an event begins on the scheduler. This field is required for all valid event records.

subject
string
'Subject'

Maps the event title or subject field displayed in the scheduler's event cells. Provides a concise name or description for each event.