EventSettings

Defines the configuration for event data binding and field mapping in the scheduler. Supports local data arrays, remote data sources, and custom field definitions.

Props

The following table outlines the props for the EventSettings:

NameTypeDefaultDescription
allowAdding
boolean
true

Enables or disables event creation capabilities for end users. When disabled, users cannot add new events to the scheduler.

allowDeleting
boolean
true

Enables or disables event deletion capabilities for end users. When disabled, users cannot remove existing events from the scheduler.

allowEditing
boolean
true

Enables or disables event editing capabilities for end users. When disabled, existing events cannot be modified.

dataSource
Record<string, unknown[]> | DataManager
[ ]

The event data source for the scheduler. Accepts an array of JavaScript objects or a DataManager instance for remote data. Automatically bound to the scheduler upon initialization.

enableIndicator
boolean
false

When enabled, events expand to fill available space, with overflow managed by the "more events" indicator. Improves readability in cells with many events.

fields
{ id: 'Id', subject: 'Subject', startTime: 'StartTime', endTime: 'EndTime', isAllDay: 'IsAllDay', location: 'Location', description: 'Description' }

Maps database or object properties to scheduler event fields (id, subject, startTime, etc.). Allows flexible integration with existing data structures without requiring data transformation.

ignoreWhitespace
boolean
false

When enabled, ignores empty space below events within cells, allowing tighter event packing. Useful for maximizing cell usage in views with many events.

query
Query
null

Applies a predefined query to the data source for filtering, sorting, or custom operations. Particularly useful when working with remote data sources requiring complex query logic.

spannedEventPlacement
'AllDayRow'

Determines how spanned events (longer than 24 hours) are rendered: in an all-day row or within time slot rows. Default behavior displays them in the all-day section for clarity.

template
(props: EventModel) => node
null

Accepts a custom React component to render event content across all views. Can be overridden by view-level event templates for specific views.