Schedule a Demo
☰
Skip to main content

Scheduler

Properties | Events | Methods

Enables the scheduling, viewing, and management of events or appointments based on specified dates and times.

Scheduler

Properties​

Custom​

Schedule Setting​

'schedulesetting' JSON Defines the configuration options for scheduling and displaying events or appointments.

Enable Context Menu​

'enableContextMenu' Boolean If a drilldown is assigned, it will be shown in the context menu.

Show Quick Info​

'showQuickInfo' Boolean The quick information popup will be shown in the calendar if showQuickInfo is true; otherwise, the popup will not be displayed.

Enable Tooltips​

'eventRendered' Boolean Used to enable the tooltip and display additional field information in the Scheduler control.

Default​

'default' String Defaults to the current date when opening the Scheduler.

Fixed Date​

'initialDate' String Defaults to a predefined date when the Scheduler is opened.

Earliest Event​

'showRecurrenceEditor' Boolean Automatically navigates to the date of the earliest scheduled event.

Field Min/Max​

'selectedDate' JSON-Single Navigates automatically to the minimum or maximum date of the field specified in Field Mapping.

Direction​
'stype' String

Specifies the navigation to either the earliest (minimum) or latest (maximum) date.

Field​

'fldname' String Specifies the field used to define the start and end times of an event.

Applicable Views​

'applicableViews' String The Scheduler supports the following views: Day, Week, Work Week, Month, and Agenda.

Default View​

'currentView' String Sets the initial calendar view, such as Month, Day, or Week.

Field Mapping​

'FieldMapping' JSON Maps each Scheduler property to the matching column name in the data source.

ID​

'id' String Defines the unique identifier for the event.

Subject​

'subject' String Defines the subject or title of the event.

Start Time​

'startTime' String Defines the start date and time of the event.

End Time​

'endTime' String Defines the end date and time of the event.

Location​

'TooltipBehavior' String Defines the location where the event takes place.

Description​

'description' String Defines the description of the event.

Recurrence Rule​

'recurrenceRule' String Defines the recurring pattern of a Scheduler event.

Recurrence Exception​

'recurrenceException' String Defines specific occurrences to be excluded from a recurring event series.

Recurrence ID​

'recurrenceID' String Identifies the parent event of a recurring event series.

Tooltip Behavior​

'tooltipConfig' JSON Defines how the tooltip is positioned and displayed.

Position​

'position' String Defines the position of the tooltip.

Opens On​

'opensOn' String Defines whether the tooltip appears on hover, click, or through a custom trigger.

Width​

'width' String Defines the width of the tooltip.

Tooltip Fields​

'tooltipFields' JSON-Multiple Defines the rows displayed inside the tooltip, from top to bottom.

Field​

'field' String Defines the field displayed in the tooltip.

Label​

'label' String Defines the label displayed in the tooltip.

'isHeader' Boolean Defines whether the field is displayed as the header of the tooltip.

Date​

'date' Boolean Defines whether the date is displayed in the tooltip.

Format​

'format' String Defines the tooltip format, such as date, date-time, or time.

Action​

'drildownclk' json A user-initiated action performed through the interface, such as exporting data, refreshing the screen, or navigating to another screen.

Events​

Applicable event is On change (Onchange)

Methods​

No methods are specified for the Scheduler control.