Scheduler Blazor API

Scheduler Properties

NameTypeDefaultDescription
AutoScrollStepint30Specifies how quickly the calendar view scrolls vertically or horizontally when a user drags an event near the edge of the view. Adjusting this value controls the speed at which the calendar auto-scrolls during drag-and-drop event operations, enhancing user navigation for long or densely populated calendars.
AutoHeightAllDayCellsboolfalseControls whether the height of all-day cells in the Day and Week calendar views automatically adjusts based on the number of events scheduled in each cell. When enabled, all-day cells will dynamically expand or contract in height to fit all contained events; when disabled, the cell height remains fixed regardless of the number of events.
AvailableIEnumerable<object>N/ASpecifies an array of objects, each representing a time interval with start and end properties. Both the start and end fields are ISO 8601 formatted date-time strings (e.g., "2022-10-25T12:00:00.000Z") that indicate the beginning and end of the interval, respectively. Example:

'''json
[
{
"start": "2022-10-25T12:00:00.000Z",
"end": "2022-10-25T13:00:00.000Z"
}
]
'''

This format is typically used to represent a list of time ranges, where each object defines one range with a precise start and end timestamp in UTC.
ColorSchemestring[]new string[]{}Specifies the color scheme used for the event background selector within the event window editor, defining the appearance and color options available for users when customizing the background of event windows.
CurrentTimeobjectnew Date()Specifies the reference time that the Scheduler uses to display the current time indicator. By default, this is set to the current date and time (today). You can customize this value to display the indicator at a specific time, which is useful for testing or demonstrating features independent of the actual system clock.
CurrentTimeIndicatorboolfalseEnables or disables the display of the current time indicator within the view. When enabled, a visual marker or line is shown on the relevant view cells to highlight the present time, helping users easily identify the current point in the schedule or calendar interface.
CurrentTimeIndicatorIntervalint1Specifies the frequency, in seconds, at which the currentTimeIndicator is updated or refreshed. This setting controls how often the indicator reflects the current time, allowing you to adjust the real-time accuracy of the display.
ContextMenuDataSourceIEnumerable<object>N/ASpecifies which items will be displayed in the context menu when it is activated by the user, allowing you to control the visibility of specific context menu options based on the current application state or user actions.
ContextMenuClipboardActionsboolfalseSpecifies whether clipboard shortcuts (copy, paste, and cut actions) are displayed in the Scheduler's context menu. When enabled, users can access and perform clipboard operations directly from the context menu for scheduled events. Disabling this option hides clipboard shortcut commands from the menu.
EventTemplateobjectN/AEnables customization of the content displayed within event elements. This option accepts one of the following:

- An 'HTMLTemplateElement' to define the layout and content for all event elements. Property bindings within the template can be used, and they will automatically map to the relevant properties of each event object.
- The 'id' (as a string) of an 'HTMLTemplateElement', which will be used for rendering all events.
- A custom function to generate event content dynamically. This function is called for each event and receives the following parameters:
- 'eventContent' – The content container element for the specific event.
- 'eventObj' – The JavaScript object representing the event’s data.

Using an 'HTMLTemplateElement' allows you to leverage property bindings (e.g., '{{propertyName}}') within the template, enabling dynamic insertion of event-specific values when rendering each event element.
EventCollectorTemplateobjectN/AAllows you to customize the content displayed by event collector elements. The customization can be provided in one of the following forms:

- 'HTMLTemplateElement': Directly supply an 'HTMLTemplateElement'. This template will be cloned and applied to all event collector entries. You can define property bindings within the template, and these will be mapped to the corresponding properties of the event object for each entry.
- 'String (Template ID)': Provide the string ID of an 'HTMLTemplateElement' present in the DOM. The element with this ID will be used as the template as described above.
- 'Function': Provide a function that will be invoked for each event. This function receives the following parameters:
- 'eventContent': The container element for the event's content, which you can modify or populate.
- 'eventObj': The event data object itself, allowing you to access event-specific information.

When using a template, dynamic property bindings are supported—you can reference fields from the 'eventObj' directly within your template markup.

This flexibility allows you to fully control the structure, layout, and dynamic content of each event as it is rendered by the event collector.
EventRenderModeSchedulerEventRenderModeSchedulerEventRenderMode.ModernDetermines the rendering style for events displayed within the Scheduler component.



  • classic – Events are visually arranged side-by-side within each cell, with their sizes adjusted to ensure they fit entirely within the cell boundaries. If multiple events overlap in the same time slot, they are compressed horizontally to avoid overflow and remain fully visible within the cell.


  • modern – Events adhere to their specified CSS size properties, such as height and width, rather than automatically resizing to fit the cell. If there are more events than can visibly fit within a cell, an "event collector" (typically a counter or indicator) is displayed that, when clicked, reveals the hidden events in a popup or modal. On mobile devices, due to limited screen space, only event collectors are shown within each cell, requiring the user to tap to view the full list of events.

EventTooltipTemplateobjectN/A

Enables the customization of the content displayed within the event menu tooltip. When a user clicks on an event element, a menu opens showing detailed information about that event. You can define this content in one of three ways:

- 'HTMLTemplateElement': Provide a template element that will be applied to all events. Inside the template, you can use property bindings referencing the event object’s properties for dynamic content generation.
- 'String (Template ID)': Pass the ID of an 'HTMLTemplateElement' as a string to use that template for all event tooltips.
- 'Function': Supply a callback function that is invoked for each event. This function receives the following parameters:
- 'eventContent': The container element or node where the event’s menu content should be rendered or modified.
- 'eventObj': The event data object with all event properties.

Using an HTMLTemplateElement allows you to seamlessly bind event properties within the template’s markup, making it easy to display custom information for each event.

This option gives you full flexibility to design and control the appearance and content of the event details menu, ensuring it matches your application's needs and styling.
CellTemplateobjectN/AEnables customization of the timeline cell content. This option accepts one of the following:

- 'HTMLTemplateElement': A template element whose content will be used for all timeline cells. When using a template, you can define property bindings within the template, which will be replaced with the corresponding values for each cell at render time.
- 'String (template ID)': The ID of an HTMLTemplateElement defined elsewhere in the DOM. The referenced template's content will be applied to all cells.
- 'Function': A callback function that will be invoked for each cell. The function receives the following parameters:
- 'cellContent': The container element for the cell’s content.
- 'cellDate': A date object representing the specific date of the cell.

This flexibility allows you to either use a standard HTML template for all cells or provide a custom rendering function to dynamically generate cell content based on cell data. When using an HTMLTemplateElement, you can include dynamic bindings within the template, which will be populated with the appropriate cell values during rendering.
DateCurrentobjectnew Date()Specifies the date that is currently displayed in the Scheduler view, allowing you to control which day, week, or month is shown to users. This property can be set programmatically to change the visible date or used to track which date the user is viewing in the Scheduler interface.
DataExportSchedulerDataExportN/AConfigures the data export settings for the Scheduler, including file format, export range, and additional export-related options.
DataSourceIEnumerable<ISchedulerDataSource>N/ASpecifies the list of events that will be displayed within the Timeline component. Each event must be represented as an object with the following required properties:
DayFormatSchedulerDayFormatSchedulerDayFormat.ShortSpecifies the display format for the day component of dates shown in the timeline. This setting controls how days are rendered, such as numeric (e.g., "12"), abbreviated (e.g., "Mon"), or full weekday names (e.g., "Monday"), to match the desired presentation style in the timeline.
DisabledboolfalseDetermines whether the element is interactive or non-interactive. When enabled, the element can receive user input and respond to events. When disabled, the element becomes inactive, preventing user interaction and applying any default disabled styling.
DisableAutoScrollboolfalsePrevents the timeline from automatically scrolling when you drag or resize an event, ensuring that the visible timeline remains stationary during these interactions.
DisableDragboolfalsePrevents users from dragging and repositioning events within the calendar interface. Events will remain fixed in their original positions, and any attempt to move them via drag-and-drop functionality will be disabled.
DisableDropboolfalsePrevents events from being removed or discarded when system resources are limited or when buffer overflows occur. All incoming events will be retained and processed, ensuring no loss of event data.
DisableResizeboolfalsePrevents users from resizing events within the calendar interface, ensuring event durations remain fixed and cannot be adjusted through drag-and-drop or other resizing actions.
DisableSelectionboolfalsePrevents users from selecting or highlighting the contents of the cell, disabling any cell selection functionality.
DisableWindowEditorboolfalsePrevents the event window editor from opening, effectively disabling the ability for users to view or modify event details through the window interface.
DisableContextMenuboolfalsePrevents the default context menu from appearing when users right-click on events or cells. This disables the standard browser context menu and any custom right-click actions for these elements.
DisableEventMenuboolfalsePrevents the event menu from appearing when a user clicks on an event or collector. This setting effectively disables the popup menu that typically provides event-related options or actions upon selection, ensuring that no event menu is shown during user interaction.
DisableViewMenuboolfalsePrevents users from accessing the view selection menu in the Scheduler, thereby disabling the ability to switch between different Scheduler views (such as day, week, or month).
DisableDateMenuboolfalsePrevents the date selection menu from appearing, disabling the user's ability to change the current Scheduler date through the interface.
DragOffsetIEnumerable<object>N/ASpecifies the distance and direction that the drag feedback widget is shifted relative to the user’s pointer during a drag operation. This offset customizes where the feedback appears in relation to the pointer, allowing for better visual alignment or to avoid obscuring elements beneath the pointer.
FilterIEnumerable<object>N/ASpecifies the filtering criteria for events in the Scheduler. The filter property supports two formats: an 'array of filter objects' or a 'custom filtering function'.

'Array of Filter Objects'
Each object in the array represents a distinct filtering rule, and must include the following attributes:

- 'name': The name of the Scheduler event property to filter by (for example, '"price"' or '"roomId"').
- 'value': The condition against which the event property will be evaluated. This can be:
- A static value—used as the comparison target based on the current 'filterMode'. For example:
'''json
[{ "name": "price", "value": 25 }]
'''
This filters events to only those where the 'price' property matches '25'.
- A function—enables advanced, custom filtering logic for that property. The function receives the value of the specified event property and should return 'true' (to keep the event) or 'false' (to exclude the event).
Example:
'''js
[
{ name: 'roomId', value: (id) => ['2', '3'].includes(String(id)) }
]
'''
This example filters in only the events whose 'roomId' property is ''2'' or ''3''. All other events are filtered out.

'Function as Filter'
Alternatively, you may assign a function directly to the 'filter' property for full control over filtering logic. This callback function receives each Scheduler event as its single argument and should return 'true' to include or 'false' to exclude the event.
Example:
'''js
filter: (event) => event.status === 'confirmed' && event.attendees.length > 2
'''
This custom function ensures only confirmed events with more than two attendees are shown in the Scheduler.

'Summary:'
- Use an 'array of filter objects' for property-based filtering, supporting simple values or custom functions for each attribute.
- Use a 'function' for comprehensive, event-level filtering based on any combination of criteria.

This flexibility allows you to implement straightforward or highly customized filtering logic to match your application's requirements.
FilterableIEnumerable<object>N/ASpecifies whether filtering functionality is enabled for the Scheduler component. When set to true, users can filter scheduled items based on defined criteria; when false, filtering options are disabled and all items are displayed without filtering.
FilterModeFilterModeFilterMode.EqualsSpecifies the method used to filter or process data, such as applying different algorithms or rules to control how information is displayed, sorted, or selected. The chosen filter mode affects how results are generated and presented.
EventsIEnumerable<ISchedulerEvent>A getter method that retrieves and returns an array containing all event objects currently managed by the Scheduler. Each event object in the array represents a scheduled event with its associated properties and details.
FirstDayOfWeekint0Specifies which day will be considered the first day of the week in the Scheduler component. By default, this is set to Sunday. You can configure this setting to start the week on any preferred day (e.g., Monday, Tuesday) to better match regional and user preferences. This affects how weeks are displayed and navigated within the Scheduler.
FooterTemplateobjectN/AEnables customization of the Scheduler's footer area. The footer content can be provided in one of the following ways:

- As an HTMLTemplateElement.
- By specifying the id of an existing HTML template as a string.
- By passing a function with the following parameter:
- footerContainer – The container element for the footer, which you can use to programmatically modify or populate the footer’s content.

This flexibility allows you to define the Scheduler's footer using markup, template references, or custom logic as needed.
GroupByDateboolfalseIndicates whether events should be organized and displayed based on their associated dates, grouping all events that occur on the same date together.
GroupOrientationSchedulerGroupOrientationSchedulerGroupOrientation.HorizontalSpecifies the direction or axis along which items are grouped, such as horizontal or vertical, affecting how elements are arranged and displayed within the interface.
GroupTemplateobjectN/AEnhances customization for group cell headers by allowing you to define how each group cell is rendered within the header section. You can specify one of the following as the template:

- 'HTMLTemplateElement': Supply an HTML '