JavaScript/jQuery Scheduler Types

AllDayPanelMode

Specifies the display mode for the All day panel.

Type:

Literal Union

Accepted Values: 'all' | 'allDay' | 'hidden'

Used in:

AppointmentAddedEvent

The type of the appointmentAdded event handler's argument.

import { AppointmentAddedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentAddingEvent

The type of the appointmentAdding event handler's argument.

import { AppointmentAddingEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentClickEvent

The type of the appointmentClick event handler's argument.

import { AppointmentClickEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentCollectorTemplateData

Information about a cell overflow indicator.

import { AppointmentCollectorTemplateData } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentContextMenuEvent

The type of the appointmentContextMenu event handler's argument.

import { AppointmentContextMenuEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentDblClickEvent

The type of the appointmentDblClick event handler's argument.

import { AppointmentDblClickEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentDeletedEvent

The type of the appointmentDeleted event handler's argument.

import { AppointmentDeletedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentDeletingEvent

The type of the appointmentDeleting event handler's argument.

import { AppointmentDeletingEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentFormIconsShowMode

Specifies icon visibility within the Appointment Edit Form.

Type:

Literal Union

Accepted Values: 'both' | 'main' | 'recurrence' | 'none'

The Scheduler Appointment Edit Form consists of two parts: a general information group and a recurrence settings group. Implement AppointmentFormIconsShowMode values in editing.form.iconsShowMode to configure icon visibility as follows:

  • "both"
    Display icons in both general information and recurrence settings groups.
  • "main"
    Display icons in the general information group only.
  • "recurrence"
    Display icons in the recurrence settings group only.
  • "none"
    Hide icons in both groups.

Used in:

AppointmentFormOpeningEvent

The type of the appointmentFormOpening event handler's argument.

import { AppointmentFormOpeningEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentFormProperties

import { AppointmentFormProperties } from "devextreme/ui/scheduler"
Type: FormProperties |

Object

AppointmentRenderedEvent

The type of the appointmentRendered event handler's argument.

import { AppointmentRenderedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentTemplateData

import { AppointmentTemplateData } from "devextreme/ui/scheduler"
Type: TargetedAppointmentInfo

Used in:

AppointmentTooltipShowingAppointmentInfo

Specifies appointments information in AppointmentTooltipShowingEvent.

import { AppointmentTooltipShowingAppointmentInfo } from "devextreme/ui/scheduler"
Type:

Object

AppointmentTooltipShowingEvent

The type of the appointmentTooltipShowing event handler's argument.

import { AppointmentTooltipShowingEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentTooltipTemplateData

import { AppointmentTooltipTemplateData } from "devextreme/ui/scheduler"
Type: TargetedAppointmentInfo |

Object

Used in:

AppointmentUpdatedEvent

The type of the appointmentUpdated event handler's argument.

import { AppointmentUpdatedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

AppointmentUpdatingEvent

The type of the appointmentUpdating event handler's argument.

import { AppointmentUpdatingEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

CellAppointmentsLimit

Specifies the limit of full-sized appointments displayed per cell. Applies to all views except "agenda".

Type:

Literal Union

Accepted Values: 'auto' | 'unlimited'

Used in:

CellClickEvent

The type of the cellClick event handler's argument.

import { CellClickEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

CellContextMenuEvent

The type of the cellContextMenu event handler's argument.

import { CellContextMenuEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

ContentReadyEvent

The type of the contentReady event handler's argument.

import { ContentReadyEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

DateNavigatorItemProperties

import { DateNavigatorItemProperties } from "devextreme/ui/scheduler"
Type: dxButtonGroup_Options |

Object

DisposingEvent

The type of the disposing event handler's argument.

import { DisposingEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

InitializedEvent

The type of the initialized event handler's argument.

import { InitializedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

Occurrence

An object that contains information about an appointment occurrence. The getOccurrences method returns objects of this type.

import { Occurrence } from "devextreme/ui/scheduler"
Type:

Object

An occurrence is an appointment instance that falls within the specified interval. Recurring appointments can generate multiple occurrences.

OptionChangedEvent

The type of the optionChanged event handler's argument.

import { OptionChangedEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

RecurrenceEditMode

Specifies the edit mode for recurring appointments.

Type:

Literal Union

Accepted Values: 'dialog' | 'occurrence' | 'series'

Used in:

SchedulerPredefinedDateNavigatorItem

Specifies names for date navigator parts.

Type:

Literal Union

Accepted Values: 'prev' | 'next' | 'dateInterval'

Used in:

SchedulerPredefinedToolbarItem

Specifies predefined items for the Scheduler toolbar.

Type:

Literal Union

Accepted Values: 'today' | 'dateNavigator' | 'viewSwitcher'
See Also

Used in:

SchedulerScrollToAlign

Specifies the alignment of the date in the view.

Type:

Literal Union

Accepted Values: 'start' | 'center'

Available values:

  • 'start' - the date is aligned with the start of the view (top for vertical scrolling or left for horizontal scrolling).
  • 'center' - the date is aligned with the center of the view.

Used in:

SelectionEndEvent

The type of the selectionEnd event handler's argument.

import { SelectionEndEvent } from "devextreme/ui/scheduler"
Type:

Object

Used in:

SnapToCellsMode

Specifies how the Scheduler snaps appointments to the grid.

Type:

Literal Union

Accepted Values: 'always' | 'auto' | 'never'

The following snapToCellsMode values are available:

  • "always": Scheduler snaps all appointments to the grid.
  • "auto": Only appointments that occupy two or fewer cells are snapped to the grid.
  • "never": Scheduler does not snap appointments to the grid.

Used in:

ViewType

Specifies the type of view

Type:

Literal Union

Accepted Values: 'agenda' | 'day' | 'month' | 'timelineDay' | 'timelineMonth' | 'timelineWeek' | 'timelineWorkWeek' | 'week' | 'workWeek'

Used in: