Event Fields in the React Scheduler
Event fields define how appointment data is structured and bound to the Scheduler. Use built-in fields for standard properties, map custom data keys to the Scheduler schema, or extend events with custom fields.
Built-in fields
The Scheduler event object supports the following built-in fields:
| Field name | Description |
|---|---|
id | The id field needs to be defined as mandatory and this field usually assigns a unique ID value to each of the events. |
subject | The subject field is optional, and usually assigns the summary text to each of the events. |
startTime | The startTime field defines the start time of an event and it is mandatory to provide it for any of the valid event objects. |
endTime | The endTime field defines the end time of an event and it is mandatory to provide the end time for any of the valid event objects. |
location | It maps the location field from the dataSource and the location text value will be displayed over the events. |
description | It maps the description field from the dataSource and denotes the event description which is optional. |
isAllDay | The isAllDay field is mapped from the dataSource and is used to denote whether an event is created for an entire day or for specific time alone. Usually, an event with isAllDay field set to true will be considered as an all-day event. |
isReadonly | It maps the isReadonly field from dataSource. It is mainly used to make specific appointments as readonly when set to true. |
isBlock | It maps the isBlock field from dataSource. It is used to block the particular time ranges in the Scheduler and prevents the event creation on those time slots. |
Binding different field names
If your data source uses field names different from the Scheduler defaults, map them using eventSettings.fields. For example, map TravelSummary to subject or DepartureTime to startTime.
Adding custom fields
Extend events with custom fields beyond the built-in properties. Add fields like Status, Priority, or IsHoliday directly to your event data—no mapping required in eventSettings. Custom fields are accessible for internal processing and application logic.
This example adds a custom Priority field and renders high-priority events with a distinct color.