RayCraftDocs
v1.0.3 raycraft.dev
On this page

Scheduler

Complete

Day, week, month, agenda, year and timeline views with events placed by time, overlapping events side by side, drag and drop to move an event, Shift with the arrow keys as the keyboard way, and a panel with a date and time field that opens when an event is selected, so events can also be moved on touch screens. All-day events (AllDay) sit in a row above the hours, and a red line marks the current time. The week and day views work in the visible hours (DayStartHour to DayEndHour).

Example

Scheduler control

Parameters

ParameterTypeDescription
AgendaDaysintDays listed by the Agenda view (default 30).
AutoScrollboolScrolls the day and week views to the current time or the start of the working hours (default true).
BlockedRangesIEnumerable<SchedulerBlockedRange>Periods that cannot be booked (all resources or one).
CategoriesIEnumerable<SchedulerCategory>Labels along the horizontal axis.
ClassstringExtra CSS classes added to the root element.
ContextMenuItemsFunc<SchedulerContextTarget, IEnumerable<MenuCommand>>Returns extra commands for the context menu of an event, a time slot or a day; they are added after the built-in commands. Receives the target (kind, event, start time, resource). Opens on right click, the Menu key and Shift+F10.
DateDateTimeAny date inside the shown period. Use with @bind-Date.
DayEndHourintHour where the day grid ends (default 20).
DayStartHourintFirst hour of the day grid (default 7).
EditableboolAllows moving events by dragging or with the keyboard.
EventsIEnumerable<SchedulerEvent>SchedulerEvent objects; moving an event changes its Start and End.
EventTemplateRenderFragment<SchedulerEvent>Draws the content of an event instead of its title (a second line, badges); gets the event. SchedulerEvent.CssClass adds a CSS class to the event element.
FirstDayOfWeekDayOfWeek?First weekday; defaults to the current language.
GroupByResourceboolDay view: one column per resource.
HideNonWorkDaysboolLeaves non-working days out of the week view.
HideWeekendsboolLeaves Saturday and Sunday out of the week view.
MaxEventsPerDayintEvents shown in a day before the +n more link (default 3).
MaxVisibleResourcesintHow many resource columns the grouped day view shows before a button reveals the rest (0 = all).
PreventOverlapboolRefuses changes that make a timed event overlap another event of the same resource.
ResourceFilterThresholdintThe number of resources above which a filter box is shown in the grouped and timeline views (default 8).
ResourcesIEnumerable<SchedulerResource>Rooms, people or equipment (SchedulerResource with Id and Name). Events point to one with ResourceId.
SeriesCheckDaysintHow many days ahead the occurrences of a repeating event are checked for overlaps and blocked ranges when it is saved (default 90).
ShowContextMenuboolOpens a menu on the right mouse button, the Menu key and Shift+F10 (default true).
ShowEventEditorboolOpens the event editor dialog to create and change events.
ShowICalendarboolAdds import and export of iCalendar (.ics) files.
ShowLegendboolShows the clickable legend.
ShowMovePanelboolShows the date and time panel for the selected event (default true).
ShowNavigatorboolShows a month calendar beside the views for quick navigation.
ShowPrintboolAdds a Print button that prints the table.
ShowQuickInfoboolShows a details panel with edit and delete for the selected event.
ShowSearchboolAdds a search box that filters the events.
ShowWorkHoursboolShades the time outside work hours and days.
SlotMinutesintLength of a slot: 5, 10, 15, 20, 30 or 60.
StylestringInline style added to the root element.
TimelineDaysintHow many days the Timeline view shows (1, 7, 14 or 30; any number from 1 to 60). With more than one day the header shows days and the view scrolls sideways.
TimeZonestringZone the grid is shown in (a system time zone id such as Europe/Sofia).
ViewSchedulerViewDay, Week, Month, Agenda, Year or Timeline. Use with @bind-View.
ViewsIReadOnlyList<SchedulerView>The views the Scheduler offers, in this order (the keys 1 to 9 follow it). One view hides the view switcher; a View that is not in the list becomes the first one. OnRangeChanged still reports the shown range (a single day for Day).
WorkDaysIEnumerable<DayOfWeek>Working days (default Monday to Friday).
WorkEndHourintHour where work ends (default 17).
WorkStartHourintFirst working hour (default 9).

Events

EventTypeDescription
DateChangedEventCallback<DateTime>
OnConflictEventCallback<SchedulerConflict>Raised when a change was refused because of an overlap or a blocked period.
OnEventChangedEventCallback<SchedulerEvent>Raised after an event was moved.
OnEventClickEventCallback<SchedulerEvent>Raised with the clicked event.
OnEventCreatedEventCallback<SchedulerEvent>Raised after an event was created or imported.
OnEventDeletedEventCallback<SchedulerEvent>Raised after an event or series was deleted.
OnRangeChangedEventCallback<SchedulerRange>Raised with the shown period when the date or the view changes.
OnReminderEventCallback<SchedulerEvent>Raised once per occurrence when its reminder time is reached.
OnSlotClickEventCallback<DateTime>Raised with the start time of the clicked slot; also enables the New event button.
OnSlotSelectedEventCallback<SchedulerSlot>Raised when an empty slot is clicked, with its start, end and the resource of the column or row (SchedulerSlot).
TimelineDaysChangedEventCallback<int>
ViewChangedEventCallback<SchedulerView>

Package

Scheduler is part of RayCraft Complete. Package: RayCraft.Blazor.Complete. It comes from the private RayCraft feed and needs an active license. See Getting started.