smart-webcomponents-react
Version:
[](https://jqwidgets.com/license/)
804 lines (800 loc) • 126 kB
JavaScript
require('../source/modules/smart.scheduler');
import * as pkg from '../common/rrule.min.js';
window.rrule = { RRule: pkg.default };
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('react'), require('react-dom/client')) :
typeof define === 'function' && define.amd ? define(['exports', 'react', 'react-dom/client'], factory) :
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.scheduler = {}, global.React, global.ReactDOM));
})(this, (function (exports, React, ReactDOM) { 'use strict';
exports.Smart = void 0;
if (typeof window !== "undefined") {
exports.Smart = window.Smart;
}
/**
Scheduler displays a set ot Events in Day, Week, Month, Agenda, Timeline Day, Timeline Week, Timeline Month views.
*/
class Scheduler extends React.Component {
// Gets the id of the React component.
get id() {
if (!this._id) {
this._id = 'Scheduler' + Math.floor((1 + Math.random()) * 0x10000).toString(16).substring(1);
}
return this._id;
}
/** Specifies 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.
* Property type: number
*/
get autoScrollStep() {
return this.nativeElement ? this.nativeElement.autoScrollStep : undefined;
}
set autoScrollStep(value) {
if (this.nativeElement) {
this.nativeElement.autoScrollStep = value;
}
}
/** Controls 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.
* Property type: boolean
*/
get autoHeightAllDayCells() {
return this.nativeElement ? this.nativeElement.autoHeightAllDayCells : undefined;
}
set autoHeightAllDayCells(value) {
if (this.nativeElement) {
this.nativeElement.autoHeightAllDayCells = value;
}
}
/** Specifies 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.
* Property type: any
*/
get available() {
return this.nativeElement ? this.nativeElement.available : undefined;
}
set available(value) {
if (this.nativeElement) {
this.nativeElement.available = value;
}
}
/** 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.
* Property type: string[]
*/
get colorScheme() {
return this.nativeElement ? this.nativeElement.colorScheme : undefined;
}
set colorScheme(value) {
if (this.nativeElement) {
this.nativeElement.colorScheme = value;
}
}
/** 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.
* Property type: string | Date
*/
get currentTime() {
return this.nativeElement ? this.nativeElement.currentTime : undefined;
}
set currentTime(value) {
if (this.nativeElement) {
this.nativeElement.currentTime = value;
}
}
/** Enables 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.
* Property type: boolean
*/
get currentTimeIndicator() {
return this.nativeElement ? this.nativeElement.currentTimeIndicator : undefined;
}
set currentTimeIndicator(value) {
if (this.nativeElement) {
this.nativeElement.currentTimeIndicator = value;
}
}
/** Specifies 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.
* Property type: number
*/
get currentTimeIndicatorInterval() {
return this.nativeElement ? this.nativeElement.currentTimeIndicatorInterval : undefined;
}
set currentTimeIndicatorInterval(value) {
if (this.nativeElement) {
this.nativeElement.currentTimeIndicatorInterval = value;
}
}
/** Specifies 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.
* Property type: any[]
*/
get contextMenuDataSource() {
return this.nativeElement ? this.nativeElement.contextMenuDataSource : undefined;
}
set contextMenuDataSource(value) {
if (this.nativeElement) {
this.nativeElement.contextMenuDataSource = value;
}
}
/** Specifies 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.
* Property type: boolean
*/
get contextMenuClipboardActions() {
return this.nativeElement ? this.nativeElement.contextMenuClipboardActions : undefined;
}
set contextMenuClipboardActions(value) {
if (this.nativeElement) {
this.nativeElement.contextMenuClipboardActions = value;
}
}
/** Enables 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.
* Property type: any
*/
get eventTemplate() {
return this.nativeElement ? this.nativeElement.eventTemplate : undefined;
}
set eventTemplate(value) {
if (this.nativeElement) {
this.nativeElement.eventTemplate = value;
}
}
/** Allows 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.
* Property type: any
*/
get eventCollectorTemplate() {
return this.nativeElement ? this.nativeElement.eventCollectorTemplate : undefined;
}
set eventCollectorTemplate(value) {
if (this.nativeElement) {
this.nativeElement.eventCollectorTemplate = value;
}
}
/** Determines 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.
* Property type: SchedulerEventRenderMode | string
*/
get eventRenderMode() {
return this.nativeElement ? this.nativeElement.eventRenderMode : undefined;
}
set eventRenderMode(value) {
if (this.nativeElement) {
this.nativeElement.eventRenderMode = value;
}
}
/** 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.
* Property type: any
*/
get eventTooltipTemplate() {
return this.nativeElement ? this.nativeElement.eventTooltipTemplate : undefined;
}
set eventTooltipTemplate(value) {
if (this.nativeElement) {
this.nativeElement.eventTooltipTemplate = value;
}
}
/** Enables 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.
* Property type: any
*/
get cellTemplate() {
return this.nativeElement ? this.nativeElement.cellTemplate : undefined;
}
set cellTemplate(value) {
if (this.nativeElement) {
this.nativeElement.cellTemplate = value;
}
}
/** 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.
* Property type: string | Date
*/
get dateCurrent() {
return this.nativeElement ? this.nativeElement.dateCurrent : undefined;
}
set dateCurrent(value) {
if (this.nativeElement) {
this.nativeElement.dateCurrent = value;
}
}
/** Configures the data export settings for the Scheduler, including file format, export range, and additional export-related options.
* Property type: SchedulerDataExport
*/
get dataExport() {
return this.nativeElement ? this.nativeElement.dataExport : undefined;
}
set dataExport(value) {
if (this.nativeElement) {
this.nativeElement.dataExport = value;
}
}
/** Specifies 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:
* Property type: SchedulerEvent[]
*/
get dataSource() {
return this.nativeElement ? this.nativeElement.dataSource : undefined;
}
set dataSource(value) {
if (this.nativeElement) {
this.nativeElement.dataSource = value;
}
}
/** A callback function that allows you to customize the text displayed within the date selector in the header section. This function receives a single parameter—the currently selected date—enabling you to return a custom string based on the date value. Use this callback to modify how the date appears in the header, such as formatting the date, adding prefixes or suffixes, or localizing the displayed value.
* Property type: any
*/
get dateSelectorFormatFunction() {
return this.nativeElement ? this.nativeElement.dateSelectorFormatFunction : undefined;
}
set dateSelectorFormatFunction(value) {
if (this.nativeElement) {
this.nativeElement.dateSelectorFormatFunction = value;
}
}
/** Specifies 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.
* Property type: SchedulerDayFormat | string
*/
get dayFormat() {
return this.nativeElement ? this.nativeElement.dayFormat : undefined;
}
set dayFormat(value) {
if (this.nativeElement) {
this.nativeElement.dayFormat = value;
}
}
/** Determines 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.
* Property type: boolean
*/
get disabled() {
return this.nativeElement ? this.nativeElement.disabled : undefined;
}
set disabled(value) {
if (this.nativeElement) {
this.nativeElement.disabled = value;
}
}
/** Prevents the timeline from automatically scrolling when you drag or resize an event, ensuring that the visible timeline remains stationary during these interactions.
* Property type: boolean
*/
get disableAutoScroll() {
return this.nativeElement ? this.nativeElement.disableAutoScroll : undefined;
}
set disableAutoScroll(value) {
if (this.nativeElement) {
this.nativeElement.disableAutoScroll = value;
}
}
/** Prevents 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.
* Property type: boolean
*/
get disableDrag() {
return this.nativeElement ? this.nativeElement.disableDrag : undefined;
}
set disableDrag(value) {
if (this.nativeElement) {
this.nativeElement.disableDrag = value;
}
}
/** Prevents 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.
* Property type: boolean
*/
get disableDrop() {
return this.nativeElement ? this.nativeElement.disableDrop : undefined;
}
set disableDrop(value) {
if (this.nativeElement) {
this.nativeElement.disableDrop = value;
}
}
/** Prevents 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.
* Property type: boolean
*/
get disableResize() {
return this.nativeElement ? this.nativeElement.disableResize : undefined;
}
set disableResize(value) {
if (this.nativeElement) {
this.nativeElement.disableResize = value;
}
}
/** Prevents users from selecting or highlighting the contents of the cell, disabling any cell selection functionality.
* Property type: boolean
*/
get disableSelection() {
return this.nativeElement ? this.nativeElement.disableSelection : undefined;
}
set disableSelection(value) {
if (this.nativeElement) {
this.nativeElement.disableSelection = value;
}
}
/** Prevents the event window editor from opening, effectively disabling the ability for users to view or modify event details through the window interface.
* Property type: boolean
*/
get disableWindowEditor() {
return this.nativeElement ? this.nativeElement.disableWindowEditor : undefined;
}
set disableWindowEditor(value) {
if (this.nativeElement) {
this.nativeElement.disableWindowEditor = value;
}
}
/** Prevents 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.
* Property type: boolean
*/
get disableContextMenu() {
return this.nativeElement ? this.nativeElement.disableContextMenu : undefined;
}
set disableContextMenu(value) {
if (this.nativeElement) {
this.nativeElement.disableContextMenu = value;
}
}
/** Prevents 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.
* Property type: boolean
*/
get disableEventMenu() {
return this.nativeElement ? this.nativeElement.disableEventMenu : undefined;
}
set disableEventMenu(value) {
if (this.nativeElement) {
this.nativeElement.disableEventMenu = value;
}
}
/** Prevents 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).
* Property type: boolean
*/
get disableViewMenu() {
return this.nativeElement ? this.nativeElement.disableViewMenu : undefined;
}
set disableViewMenu(value) {
if (this.nativeElement) {
this.nativeElement.disableViewMenu = value;
}
}
/** Prevents the date selection menu from appearing, disabling the user's ability to change the current Scheduler date through the interface.
* Property type: boolean
*/
get disableDateMenu() {
return this.nativeElement ? this.nativeElement.disableDateMenu : undefined;
}
set disableDateMenu(value) {
if (this.nativeElement) {
this.nativeElement.disableDateMenu = value;
}
}
/** A callback function that allows you to define and customize the visual feedback displayed to users while an event is being dragged. This enables you to modify the appearance or content of the drag preview element according to your application's requirements.
* Property type: any
*/
get dragFeedbackFormatFunction() {
return this.nativeElement ? this.nativeElement.dragFeedbackFormatFunction : undefined;
}
set dragFeedbackFormatFunction(value) {
if (this.nativeElement) {
this.nativeElement.dragFeedbackFormatFunction = value;
}
}
/** Specifies 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.
* Property type: any
*/
get dragOffset() {
return this.nativeElement ? this.nativeElement.dragOffset : undefined;
}
set dragOffset(value) {
if (this.nativeElement) {
this.nativeElement.dragOffset = value;
}
}
/** Specifies 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:'''jsfilter: (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.
* Property type: any
*/
get filter() {
return this.nativeElement ? this.nativeElement.filter : undefined;
}
set filter(value) {
if (this.nativeElement) {
this.nativeElement.filter = value;
}
}
/** Specifies 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.
* Property type: any
*/
get filterable() {
return this.nativeElement ? this.nativeElement.filterable : undefined;
}
set filterable(value) {
if (this.nativeElement) {
this.nativeElement.filterable = value;
}
}
/** Specifies 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.
* Property type: FilterMode | string
*/
get filterMode() {
return this.nativeElement ? this.nativeElement.filterMode : undefined;
}
set filterMode(value) {
if (this.nativeElement) {
this.nativeElement.filterMode = value;
}
}
/** 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.
* Property type: SchedulerEvent[]
*/
get events() {
return this.nativeElement ? this.nativeElement.events : undefined;
}
set events(value) {
if (this.nativeElement) {
this.nativeElement.events = value;
}
}
/** Specifies 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.
* Property type: number
*/
get firstDayOfWeek() {
return this.nativeElement ? this.nativeElement.firstDayOfWeek : undefined;
}
set firstDayOfWeek(value) {
if (this.nativeElement) {
this.nativeElement.firstDayOfWeek = value;
}
}
/** Enables 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.
* Property type: any
*/
get footerTemplate() {
return this.nativeElement ? this.nativeElement.footerTemplate : undefined;
}
set footerTemplate(value) {
if (this.nativeElement) {
this.nativeElement.footerTemplate = value;
}
}
/** Indicates whether events should be organized and displayed based on their associated dates, grouping all events that occur on the same date together.
* Property type: boolean
*/
get groupByDate() {
return this.nativeElement ? this.nativeElement.groupByDate : undefined;
}
set groupByDate(value) {
if (this.nativeElement) {
this.nativeElement.groupByDate = value;
}
}
/** Specifies the direction or axis along which items are grouped, such as horizontal or vertical, affecting how elements are arranged and displayed within the interface.
* Property type: SchedulerGroupOrientation | string
*/
get groupOrientation() {
return this.nativeElement ? this.nativeElement.groupOrientation : undefined;
}
set groupOrientation(value) {
if (this.nativeElement) {
this.nativeElement.groupOrientation = value;
}
}
/** Enhances 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 '' element that will be applied to all group header cells. Within your template, you can use property bindings that correspond to properties of the group cell object. These bindings will be automatically populated with the respective values for each cell.- 'Template ID (String)': Provide the 'id' attribute of an existing HTML '' element. The identified template will be used for rendering all group header cells.- 'Custom Function': Specify a function that will be called for each group cell. The function will receive two parameters: - 'cellContent': A DOM element that acts as a container for the group cell’s content. - 'cellObj': The data object associated with the current group cell.This approach gives you full flexibility to display custom content, styles, and data for group header cells according to your requirements. If you use an HTMLTemplateElement, you can leverage dynamic property bindings that map directly to the properties of each group cell’s data object.
* Property type: any
*/
get groupTemplate() {
return this.nativeElement ? this.nativeElement.groupTemplate : undefined;
}
set groupTemplate(value) {
if (this.nativeElement) {
this.nativeElement.groupTemplate = value;
}
}
/** Specifies the resource type or category by which events are organized or grouped, enabling the display and management of events according to associated resources (such as users, rooms, equipment, or custom entities). This setting determines how events are visually separated and filtered within the application based on their linked resources.
* Property type: any
*/
get groups() {
return this.nativeElement ? this.nativeElement.groups : undefined;
}
set groups(value) {
if (this.nativeElement) {
this.nativeElement.groups = value;
}
}
/** Specifies the latest hour that will be visible on the calendar in both 'day' and 'week' views. Events scheduled after this hour will not be displayed in these views.
* Property type: number
*/
get hourEnd() {
return this.nativeElement ? this.nativeElement.hourEnd : undefined;
}
set hourEnd(value) {
if (this.nativeElement) {
this.nativeElement.hourEnd = value;
}
}
/** Specifies the starting hour of the visible time range in the 'day' and 'week' calendar views. Events or time slots before this hour will not be shown in these views.
* Property type: number
*/
get hourStart() {
return this.nativeElement ? this.nativeElement.hourStart : undefined;
}
set hourStart(value) {
if (this.nativeElement) {
this.nativeElement.hourStart = value;
}
}
/** Specifies how hours are displayed within the element, including aspects such as 12-hour or 24-hour format, inclusion of leading zeros, and any relevant separators or annotations (e.g., AM/PM).
* Property type: SchedulerHourFormat | string
*/
get hourFormat() {
return this.nativeElement ? this.nativeElement.hourFormat : undefined;
}
set hourFormat(value) {
if (this.nativeElement) {
this.nativeElement.hourFormat = value;
}
}
/** Enables customization of the Scheduler's header. The header can be specified in one of the following ways:- As an HTMLTemplateElement, allowing you to define a reusable template for the header's content.- As a string representing the id of an existing HTML template element in the DOM.- As a function that provides advanced customization. The function receives the following parameter: - headerContent: The container element for the header, which you can modify or populate as needed.This flexibility lets you tailor the Scheduler's header to fit your specific design or functional requirements.
* Property type: any
*/
get headerTemplate() {
return this.nativeElement ? this.nativeElement.headerTemplate : undefined;
}
set headerTemplate(value) {
if (this.nativeElement) {
this.nativeElement.headerTemplate = value;
}
}
/** Specifies the placement of the Date selector within the Header section of the component, allowing you to control where the Date selector appears relative to other header elements.
* Property type: SchedulerHeaderDatePosition | string
*/
get headerDatePosition() {
return this.nativeElement ? this.nativeElement.headerDatePosition : undefined;
}
set headerDatePosition(value) {
if (this.nativeElement) {
this.nativeElement.headerDatePosition = value;
}
}
/** Defines and customizes the appearance and layout of the header navigation controls, including their colors, fonts, spacing, and interactive states. This setting allows you to adjust how navigation elements are presented in the header section of the application or website.
* Property type: SchedulerHeaderNavigationStyle | string
*/
get headerNavigationStyle() {
return this.nativeElement ? this.nativeElement.headerNavigationStyle : undefined;
}
set headerNavigationStyle(value) {
if (this.nativeElement) {
this.nativeElement.headerNavigationStyle = value;
}
}
/** Specifies the exact location of the view selector control within the header section of the element, allowing you to control where the selector appears in relation to other header components.
* Property type: SchedulerHeaderViewPosition | string
*/
get headerViewPosition() {
return this.nativeElement ? this.nativeElement.headerViewPosition : undefined;
}
set headerViewPosition(value) {
if (this.nativeElement) {
this.nativeElement.headerViewPosition = value;
}
}
/** Specifies whether the 'All Day' container—which displays events scheduled to last the entire day—is visible or hidden. When set to true, the container and its all-day events will not be displayed; when false, they will be shown.
* Property type: boolean
*/
get hideAllDay() {
return this.nativeElement ? this.nativeElement.hideAllDay : undefined;
}
set hideAllDay(value) {
if (this.nativeElement) {
this.nativeElement.hideAllDay = value;
}
}
/** Specifies whether the days defined in the 'nonworkingDays' property should be visually hidden from view (e.g., not displayed in the calendar or schedule UI), rather than simply marked as non-working. When set to true, all days listed in 'nonworkingDays' will be completely omitted from the display. When set to false, these days remain visible but may be styled differently to indicate their non-working status.
* Property type: boolean
*/
get hideNonworkingWeekdays() {
return this.nativeElement ? this.nativeElement.hideNonworkingWeekdays : undefined;
}
set hideNonworkingWeekdays(value) {
if (this.nativeElement) {
this.nativeElement.hideNonworkingWeekdays = value;
}
}
/** Enhances the calendar's month view by controlling the visibility and interactivity of "other month" days—those that do not belong to the currently displayed month. When this option is enabled:- Days from previous or next months are displayed as inactive background cells.- Events 'cannot' be created, dragged, or dropped onto these "other month" days.- Events that 'start' on "other month" days are hidden; only events that 'end' on these days may be partially shown.- Resizing of events cannot begin or end on "other month" days.- Overall, "other month" days serve purely as visual placeholders, preventing user interaction or event association.
* Property type: boolean
*/
get hideOtherMonthDays() {
return this.nativeElement ? this.nativeElement.hideOtherMonthDays : undefined;
}
set hideOtherMonthDays(value) {
if (this.nativeElement) {
this.nativeElement.hideOtherMonthDays = value;
}
}
/** Specifies whether the 'Today' button is visible in the user interface. When set to true, the 'Today' button will be hidden; when set to false, the button will be displayed.
* Property type: boolean
*/
get hideTodayButton() {
return this.nativeElement ? this.nativeElement.hideTodayButton : undefined;
}
set hideTodayButton(value) {
if (this.nativeElement) {
this.nativeElement.hideTodayButton = value;
}
}
/** Controls the visibility of checkable items within the view selection menu. When enabled, checkable items are hidden from the menu; when disabled, checkable items are displayed, allowing users to select or deselect individual views.
* Property type: boolean
*/
get hideViewMenuCheckableItems() {
return this.nativeElement ? this.nativeElement.hideViewMenuCheckableItems : undefined;
}
set hideViewMenuCheckableItems(value) {
if (this.nativeElement) {
this.nativeElement.hideViewMenuCheckableItems = value;
}
}
/** Specifies whether weekend days (typically Saturday and Sunday) should be displayed or hidden in the calendar view. If set to true, weekend days will be hidden; if set to false, weekend days will be visible.
* Property type: boolean
*/
get hideWeekend() {
return this.nativeElement ? this.nativeElement.hideWeekend : undefined;
}
set hideWeekend(value) {
if (this.nativeElement) {
this.nativeElement.hideWeekend = value;
}
}
/** Specifies where the legend is displayed within the Scheduler component. By default, the legend appears in the footer section, but it can be configured to display in the header instead. This setting allows you to customize the placement of the legend to better fit your application's layout and user experience requirements.
* Property type: SchedulerLegendLocation | string
*/
get legendLocation() {
return this.nativeElement ? this.nativeElement.legendLocation : undefined;
}
set legendLocation(value) {
if (this.nativeElement) {
this.nativeElement.legendLocation = value;
}
}
/** Specifies the placement of the legend within the chart area. By default, the legend appears on the 'near' side (typically aligned to the left or top, depending on chart orientation). Setting this property to 'far' positions the legend on the opposite side (right or bottom), allowing customization of the legend's location to better suit your layout needs.
* Property type: SchedulerLegendPosition | string
*/
get legendPosition() {
return this.nativeElement ? this.nativeElement.legendPosition : undefined;
}
set legendPosition(value) {
if (this.nativeElement) {
this.nativeElement.legendPosition = value;
}
}
/** Specifies how the legend items are arranged within the chart, such as organizing them in a horizontal row, vertical column, or a customized layout. This property controls the visual structure and ordering of items displayed in the legend.
* Property type: SchedulerLegendLayout | string
*/
get legendLayout() {
return this.nativeElement ? this.nativeElement.legendLayout : undefined;
}
set legendLayout(value) {
if (this.nativeElement) {
this.nativeElement.legendLayout = value;
}
}
/** Specifies the maximum number of items that can be displayed in the legend as a horizontal list. If the number of legend items exceeds this value, the legend will automatically switch to a dropdown menu format for better readability and usability.
* Property type: number
*/
get legendLayoutMenuBreakpoint() {
return this.nativeElement ? this.nativeElement.legendLayoutMenuBreakpoint : undefined;
}
set legendLayoutMenuBreakpoint(value) {
if (this.nativeElement) {
this.nativeElement.legendLayoutMenuBreakpoint = value;
}
}
/** Controls the scroll increment when using the mouse wheel or trackpad. Setting this property to a positive number specifies the distance (in pixels, lines, or a defined unit) that the content will scroll with each wheel or trackpad movement. A higher value increases the scroll distance per step, while a lower value results in finer, more precise scrolling.
* Property type: number
*/
get mouseWheelStep() {
return this.nativeElement ? this.nativeElement.mouseWheelStep : undefined;
}
set mouseWheelStep(value) {
if (this.nativeElement) {
this.nativeElement.mouseWheelStep = value;
}
}
/** Specifies whether the horizontal scrollbar is visible. If set to true, a horizontal scrollbar will appear when the content overflows the container’s width; if false, the scrollbar will be hidden regardless of overflow.
* Property type: HorizontalScrollBarVisibility | string
*/
get horizontalScrollBarVisibility() {
return this.nativeElement ? this.nativeElement.horizontalScrollBarVisibility : undefined;
}
set horizontalScrollBarVisibility(value) {
if (this.nativeElement) {
this.nativeElement.horizontalScrollBarVisibility = value;
}
}
/** Sets or retrieves the 'unlockKey', a unique value required to unlock and access the product’s full features or functionality.
* Property type: string
*/
get unlockKey() {
return this.nativeElement ? this.nativeElement.unlockKey : undefined;
}
set unlockKey(value) {
if (this.nativeElement) {
this.nativeElement.unlockKey = value;
}
}
/** Specifies the language and regional settings used to display all interface elements, dates, and messages within the Scheduler component. This setting ensures that the Scheduler is localized according to the selected language.
* Property type: string
*/
get locale() {
return this.nativeElement ? this.nativeElement.locale : undefined;
}
set locale(value) {
if (this.nativeElement) {
this.nativeElement.locale = value;
}
}
/** Determines the latest date that can be displayed or selected in the Scheduler, effectively setting an upper limit for the Scheduler's visible or selectable date range.
* Property type: string | Date
*/
get max() {
return this.nativeElement ? this.nativeElement.max : undefined;
}
set max(value) {
if (this.nativeElement) {
this.nativeElement.max = value;
}
}
/** Specifies the maximum number of events that can be displayed in each Scheduler cell. If this property is set to null (the default value), the Scheduler automatically calculates how many events can fit in a cell based on the available space and the size of each event. Setting a specific value overrides this behavior and limits the number of visible events per cell to the specified maximum. Events exceeding this limit may be hidden or grouped into an overflow indicator, depending on the Scheduler’s configuration.
* Property type: number | null
*/
get maxEventsPerCell() {
return this.nativeElement ? this.nativeElement.maxEventsPerCell : undefined;
}
set maxEventsPerCell(value) {
if (this.nativeElement) {
this.nativeElement.maxEventsPerCell = value;
}
}
/** Specifies the earliest date that can be displayed or selected in the Scheduler. This property restricts navigation and date selection to dates on or after the defined minimum view date.
* Property type: string | Date
*/
get min() {
return this.nativeElement ? this.nativeElement.min : undefined;
}
set min(value) {
if (this.nativeElement) {
this.nativeElement.min = value;
}
}
/** Defines or retrieves an object containing all the text strings displayed by the element, allowing for easy localization of the user interface. This property should be used together with the locale property to dynamically present content in the user's preferred language or region. Each key in the object represents a specific string that can be customized or translated as needed."
* Property type: any
*/
get messages() {
return this.nativeElement ? this.nativeElement.messages : undefined;
}
set messages(value) {
if (this.nativeElement) {
this.nativeElement.messages = value;
}
}
/** Specifies how minutes are displayed and formatted within the Scheduler component. This setting controls the appearance of minute values in time slots, event times, and related areas, ensuring consistency in how minutes are presented to users (e.g., "5", "05", or "5 min").
* Property type: MinuteFormat | string
*/
get minuteFormat() {
return this.nativeElement ? this.nativeElement.minuteFormat : undefined;
}
set minuteFormat(value) {
if (this.nativeElement) {
this.nativeElement.minuteFormat = value;
}
}
/** Specifies the format in which month names are displayed within the Scheduler component. This setting controls whether full month names (e.g., "January"), abbreviated names (e.g., "Jan"), or custom formats appear in the Scheduler's interface wherever month names are shown.
* Property type: MonthFormat | string
*/
get monthFormat() {
return this.nativeElement ? this.nativeElement.monthFormat : undefined;
}
set monthFormat(value) {
if (this.nativeElement) {
this.nativeElement.monthFormat = value;
}
}
/** Specifies which days of the week are considered nonworking, using an array of numbers from 0 to 6, where 0 represents the first day of the week (e.g., Sunday or Monday, depending on your locale), and 6 represents the last day. These designated nonworking days will be visually distinguished within the Timeline component by applying a different background color. The specific color used for nonworking days is controlled by a configurable CSS variable, allowing for easy theming and customization.
* Property type: any
*/
get nonworkingDays() {
return this.nativeElement ? this.nativeElement.nonworkingDays : undefined;
}
set nonworkingDays(value) {
if (this.nativeElement) {
this.nativeElement.nonworkingDays = value;
}
}
/** Specifies the nonworking hours within a day. The nonworking hours are defined using an array, where each element represents either a single hour (as a number) or a range of hours (as an array containing the start and end hours, separated by a comma). For example, '[0, [13, 15], 23]' marks hour 0, hours 13 through 15 (inclusive), and hour 23 as nonworking. On the timeline, cells corresponding to these nonworking hours are visually distinguished by a different color from the working hours.
* Property type: any
*/
get nonworkingHours() {
return this.nativeElement ? this.nativeElement.nonworkingHours : undefined;
}
set nonworkingHours(value) {