EventFields

Maps scheduler event model properties to corresponding data source fields. Enables the scheduler to correctly interpret event data from various data structures.

Props

The following table outlines the props for the EventFields:

NameTypeDefaultDescription
description
string
'Description'

Maps the event description or detailed notes field. Provides additional context or instructions for the event.

endTime
string
'EndTime'

Maps the event end time field. Must be provided for all valid event objects. Determines when an event concludes on the scheduler.

id
string
'Id'

Maps the unique event identifier field. Required to perform add, delete and edit actions.

isAllDay
string
'IsAllDay'

Maps the all-day event indicator field. When true, the event spans the entire day regardless of time. Useful for marking holidays, birthdays, or full-day activities.

isBlock
string
'IsBlock'

Maps the block event indicator that reserves a time slot to prevent other events from being scheduled. Useful for blocking meetings, maintenance windows, or unavailable time periods.

isReadonly
string
'IsReadonly'

Maps the read-only flag indicating whether an event can be modified. When true, the event cannot be edited or deleted by users.

location
string
'Location'

Maps the event location or venue field displayed to users. Helps users understand where the event takes place.

startTime
string
'StartTime'

Maps the event start time field. Must be provided for all valid event objects. Determines when an event begins on the scheduler.

subject
string
'Subject'

Maps the event title or heading field displayed in the scheduler. Provides a brief description or name for each event.