EventSettings
Configures event data binding and field mapping for the scheduler component. Supports local data arrays, remote data sources via DataManager, and custom field definitions for flexible data integration. Enables customization of data source operations, event visibility controls, and advanced rendering options like event indicators.
Props
The following table outlines the props for the EventSettings:
| Name | Type | Default | Description |
|---|---|---|---|
| allowAdding | boolean | true | Enables or disables the ability to create new events in the scheduler. When disabled, users cannot add new events to the scheduler. |
| allowDeleting | boolean | true | Enables or disables the ability to delete events from the scheduler. When disabled, users cannot remove existing events from the scheduler. |
| allowEditing | boolean | true | Enables or disables the ability to edit existing events in the scheduler. When disabled, existing events cannot be modified. |
| dataSource | Record<string, unknown[]> | DataManager | [ ] | The event data source for the scheduler, supporting local arrays or remote DataManager instances. Events are automatically bound to the scheduler upon initialization without requiring manual configuration. |
| editFollowingEvents | boolean | false | Enables or disables the "Following Events" option in recurrence edit/delete dialogs. When enabled, users can choose to edit or delete this and all following occurrences of a recurring event. When disabled, only "Edit Event" and "Edit Series" options are shown. The following events feature allows splitting a recurring series at a specific date into two independent series. |
| enableIndicator | boolean | false | When enabled, events automatically expand to fill available cell space with excess events managed by a "+n more" indicator. Improves readability for cells containing many events without compromising layout stability. |
| fields | { id: 'Id', subject: 'Subject', startTime: 'StartTime', endTime: 'EndTime', isAllDay: 'IsAllDay', location: 'Location', description: 'Description' } | Maps your data source field names to scheduler event properties (id, subject, startTime, etc.). Eliminates the need for data transformation, directly connecting your existing data structure to the scheduler. | |
| ignoreWhitespace | boolean | false | When enabled, removes vertical gaps between events in cells, allowing tighter, more compact event packing. Maximizes cell usage when displaying many events in high-density scheduling scenarios. |
| query | Query | null | Applies a pre-configured query to the data source for filtering, sorting, or advanced operations. Essential when working with remote data sources requiring complex filtering, sorting, or pagination logic. |
| resourceColorField | string | null | Specifies the resource name used to determine which resource level's color will be applied to appointments when scheduler grouping is enabled. |
| spannedEventPlacement | 'AllDayRow' | Determines how multi-day events (longer than 24 hours) are positioned in the scheduler. Set to 'AllDayRow' to display in the all-day section for clarity, or within time slots for compact layouts. | |
| template | (props: EventModel) => node | null | Provides a custom React component to render event content across all scheduler views. Individual view-level templates take precedence over this root-level template when both are configured. |